asteroid_spinprops 1.2.0__tar.gz → 1.2.1__tar.gz

{asteroid_spinprops-1.2.0 → asteroid_spinprops-1.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: asteroid_spinprops
-Version: 1.2.0
+Version: 1.2.1
 Summary: Collection of tools used for fitting sHG1G2 and SOCCA photometric models to sparse asteroid photometry
 License: MIT
 Author: Odysseas
@@ -111,13 +111,13 @@ pdf["jd_ltc"] = pdf["cjd"] - pdf["Observer_SSO_distance_column"] / c_kmday  # li
 
 Your input DataFrame must therefore include:
 
-- time of observation  
-- PSF magnitude and uncertainty  
-- filter ID  
-- RA, Dec  
-- phase angle  
-- heliocentric distance (`Obj_Sun_LTC_km`)  
-- observer-centric distance (`Range_LTC_km`)
+- time of observation                               (JD)
+- PSF magnitude and uncertainty         
+- filter ID         
+- RA, Dec                                           (Degrees)                
+- phase angle                       
+- heliocentric distance                             (AU)
+- observer-centric distance                         (AU)
 
 The preprocessing step renames these fields to the Fink schema, computes reduced magnitudes, and applies the light-time correction to the observation timestamps.
 
@@ -138,10 +138,23 @@ numeric_filter = inv + 1
 pdf_s["cfid"].values[0] = numeric_filter
 
 # --- Data cleaning and filtering ---
-clean_data, errorbar_rejects = dataprep.errorbar_filtering(data=pdf_s, mlimit=0.7928)
+clean_data, errorbar_rejects = dataprep.errorbar_filtering(data=pdf_s, mlimit=0.7928) # mag limit from the LCDB
 clean_data, projection_rejects = dataprep.projection_filtering(data=clean_data)
 clean_data, iterative_rejects = dataprep.iterative_filtering(data=clean_data)
 
+# --- Fit SOCCA ---
+SOCCA_params = modelfit.get_fit_params(
+        data=clean_data,
+        flavor="SOCCA",
+        shg1g2_constrained=True,
+        pole_blind=False,
+        period_blind=True,
+        period_in=None,
+        period_quality_flag=True
+    )
+
+
+## --- Or step-by-step --- ##
 # --- Fit SHG1G2 model ---
 shg1g2_params = modelfit.get_fit_params(
     data=clean_data,
@@ -167,13 +180,15 @@ _, Nbs = periodest.perform_residual_resampling(
     k=int(k_val)
 )
 
-# --- Fit SSHG1G2 (spin + multiband) model ---
+# --- Fit SOCCA model ---
 SOCCA_params = modelfit.get_fit_params(
     data=clean_data,
     flavor="SSHG1G2",
     shg1g2_constrained=True,
-    blind_scan=True,
+    period_blind=False,
+    pole_blind=False,
     period_in=p_in,
+    period_quality_flag=False
 )
 ```
 

{asteroid_spinprops-1.2.0 → asteroid_spinprops-1.2.1}/README.md

@@ -83,13 +83,13 @@ pdf["jd_ltc"] = pdf["cjd"] - pdf["Observer_SSO_distance_column"] / c_kmday  # li
 
 Your input DataFrame must therefore include:
 
-- time of observation  
-- PSF magnitude and uncertainty  
-- filter ID  
-- RA, Dec  
-- phase angle  
-- heliocentric distance (`Obj_Sun_LTC_km`)  
-- observer-centric distance (`Range_LTC_km`)
+- time of observation                               (JD)
+- PSF magnitude and uncertainty         
+- filter ID         
+- RA, Dec                                           (Degrees)                
+- phase angle                       
+- heliocentric distance                             (AU)
+- observer-centric distance                         (AU)
 
 The preprocessing step renames these fields to the Fink schema, computes reduced magnitudes, and applies the light-time correction to the observation timestamps.
 
@@ -110,10 +110,23 @@ numeric_filter = inv + 1
 pdf_s["cfid"].values[0] = numeric_filter
 
 # --- Data cleaning and filtering ---
-clean_data, errorbar_rejects = dataprep.errorbar_filtering(data=pdf_s, mlimit=0.7928)
+clean_data, errorbar_rejects = dataprep.errorbar_filtering(data=pdf_s, mlimit=0.7928) # mag limit from the LCDB
 clean_data, projection_rejects = dataprep.projection_filtering(data=clean_data)
 clean_data, iterative_rejects = dataprep.iterative_filtering(data=clean_data)
 
+# --- Fit SOCCA ---
+SOCCA_params = modelfit.get_fit_params(
+        data=clean_data,
+        flavor="SOCCA",
+        shg1g2_constrained=True,
+        pole_blind=False,
+        period_blind=True,
+        period_in=None,
+        period_quality_flag=True
+    )
+
+
+## --- Or step-by-step --- ##
 # --- Fit SHG1G2 model ---
 shg1g2_params = modelfit.get_fit_params(
     data=clean_data,
@@ -139,13 +152,15 @@ _, Nbs = periodest.perform_residual_resampling(
     k=int(k_val)
 )
 
-# --- Fit SSHG1G2 (spin + multiband) model ---
+# --- Fit SOCCA model ---
 SOCCA_params = modelfit.get_fit_params(
     data=clean_data,
     flavor="SSHG1G2",
     shg1g2_constrained=True,
-    blind_scan=True,
+    period_blind=False,
+    pole_blind=False,
     period_in=p_in,
+    period_quality_flag=False
 )
 ```
 

{asteroid_spinprops-1.2.0 → asteroid_spinprops-1.2.1}/asteroid_spinprops/ssolib/modelfit.py

@@ -51,13 +51,16 @@ def get_fit_params(
     period_blind : bool, optional
         If True, perform a small grid search over initial periods. Default True.
     pole_blind : bool, optional
-        If True, perform a grid search over initial poles. Default True.
+        If True, perform a grid search over 12 initial poles all over a sphere. Default True.
+        If False, produce the sHG1G2 rms error landscape and initialize SOCCA poles on its local minima     
     p0 : list, optional
         Initial guess parameters for the fit. Required if `shg1g2_constrained=False`.
     alt_spin : bool, optional
         For SOCCA constrained fits, use the antipodal spin solution. Default False.
     period_in : float, optional
         Input synodic period (days) to override automatic estimation. Default None.
+    period_quality_flag : bool, optional
+        Provide bootstrap score, alias/true (0/1) flags and period fit rms for the period estimates
     terminator : bool, optional
         If True, include self-shading in the fit. Default False.
 
@@ -194,9 +197,9 @@ def get_fit_params(
                                 C = func_hg1g2_with_spin(pha, H, G1, G2, R,
                                                         np.radians(ra0), np.radians(dec0))
 
-                                O = data["cmred"].values[0][cond_ff]
+                                Obs = data["cmred"].values[0][cond_ff]
 
-                                all_residuals.append(O - C)
+                                all_residuals.append(Obs - C)
 
                             all_residuals = np.concatenate(all_residuals)
                             rms_landscape[j, i] = np.sqrt(np.mean(all_residuals**2))
@@ -256,12 +259,14 @@ def get_fit_params(
                             )
                             alias_flag = (DeltaF1 - y_trumpet) * 100
                             if alias_flag < 1:
-                                SOCCA_opt["Period_class"] = "true"
+                                SOCCA_opt["Period_class"] = 1 # True
                             else:
-                                SOCCA_opt["Period_class"] = "alias"
+                                SOCCA_opt["Period_class"] = 0 # Alias
                             SOCCA_opt["Nbs"] = Nbs
                         except Exception:
-                            SOCCA_opt["Period_class"] = "class_error"
+                            SOCCA_opt["Period_class"] = -1 # Classification error
+                    SOCCA_opt["prms"] = p_rms
+                    SOCCA_opt["k_terms"] = k_val
                 except Exception:
                     SOCCA_opt = {"Failed at SOCCA inversion": 5}
                 return SOCCA_opt

{asteroid_spinprops-1.2.0 → asteroid_spinprops-1.2.1}/asteroid_spinprops/ssolib/periodest.py

@@ -123,7 +123,7 @@ def get_period_estimate(residuals_dataframe, p_min=0.03, p_max=2):
 
 
 def get_multiterm_period_estimate(
-    residuals_dataframe, p_min=0.03, p_max=2, k_free=True, k_val=None
+    residuals_dataframe, p_min=0.03, p_max=2, k_free=True, k_val=None, k_max=4
 ):
     """
     Estimate the period of a multiband time series using a multiband Lomb-Scargle model.
@@ -148,7 +148,8 @@ def get_multiterm_period_estimate(
         If True, automatically scan multiple base-term complexities to choose optimal model. Default True.
     k_val : int, optional
         Fixed number of base terms to use if `k_free=False`. Default None.
-
+    k_max : int
+        Maximum number of terms to use for the multiterm LS periodogram. Default 4
     Returns
     -------
     tuple
@@ -175,7 +176,7 @@ def get_multiterm_period_estimate(
     residuals = np.zeros(len(residuals_dataframe["filters"].values))
     bands = np.unique(residuals_dataframe["filters"].values)
     if k_free:
-        for k in range(1, 11):
+        for k in range(1, k_max + 1):
             model = LombScargleMultiband(
                 residuals_dataframe["jd"].values,
                 residuals_dataframe["residuals"].values,

{asteroid_spinprops-1.2.0 → asteroid_spinprops-1.2.1}/asteroid_spinprops/ssolib/utils.py

@@ -459,6 +459,22 @@ def detect_local_minima(arr):
     return np.where(detected_minima)       
 
 def trumpet(peak_diff_1, f_feat, f_obs):
+    """
+    Implementation of the alias/true flagging algorithm.
+
+    Parameters
+    ----------
+    peak_diff_1 : float
+        The difference between the 2nd and 3rd highest peaks of the periodogram
+    f_feat : float
+        The feature frequency.
+    f_obs : float
+        The 1st highest peak if the periodogram
+    Returns
+    -------
+    The assumed true frequency peak difference value if the peak is true,
+    otherwise zero.
+    """
     if peak_diff_1 > 0 and f_obs > f_feat:
         return 2 * f_feat
 

{asteroid_spinprops-1.2.0 → asteroid_spinprops-1.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "asteroid_spinprops"
-version = "1.2.0"
+version = "1.2.1"
 description = "Collection of tools used for fitting sHG1G2 and SOCCA photometric models to sparse asteroid photometry"
 authors = [
     {name = "Odysseas",email = "odysseas.xenos@proton.me"}