asteroid_spinprops 1.1.2__tar.gz → 1.2.1__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: asteroid_spinprops
-Version: 1.1.2
+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.1.2 → 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.1.2 → asteroid_spinprops-1.2.1}/asteroid_spinprops/ssolib/modelfit.py

@@ -2,6 +2,7 @@ import numpy as np
 import pandas as pd
 
 import asteroid_spinprops.ssolib.utils as utils
+import asteroid_spinprops.ssolib.periodest as periodest
 
 from fink_utils.sso.spins import (
     estimate_sso_params,
@@ -21,6 +22,7 @@ def get_fit_params(
     p0=None,
     alt_spin=False,
     period_in=None,
+    period_quality_flag=False,
     terminator=False,
 ):
     """
@@ -49,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.
 
@@ -128,6 +133,10 @@ def get_fit_params(
                             residuals_dataframe, p_min=pmin, p_max=pmax, k_free=True
                         )
                     )
+                    if period_quality_flag:
+                        _, Nbs = periodest.perform_residual_resampling(
+                            resid_df=residuals_dataframe, p_min=pmin, p_max=pmax, k=int(k_val)
+                            )
                 except KeyError:
                     # If more than 10 terms are required switch to fast rotator:
                     pmin, pmax = 5e-3, 5e-2
@@ -137,6 +146,10 @@ def get_fit_params(
                                 residuals_dataframe, p_min=pmin, p_max=pmax, k_free=True
                             )
                         )
+                        if period_quality_flag:
+                            _, Nbs = periodest.perform_residual_resampling(
+                                resid_df=residuals_dataframe, p_min=pmin, p_max=pmax, k=int(k_val)
+                                )
                     except Exception:
                         SOCCA_opt = {"Failed at period search after": 4}
                         return SOCCA_opt
@@ -153,16 +166,55 @@ def get_fit_params(
                 )
 
                 ra0, dec0 = shg1g2_params["alpha0"], shg1g2_params["delta0"]
-                
+
                 if pole_blind is True:
                     ra_init, dec_init = utils.generate_initial_points(
                         ra0, dec0, dec_shift=45
                     )
 
                 else:
-                    ra0_antipodal, dec0_antipodal = utils.flip_spin(ra0, dec0)
-                    ra_init = [ra0, ra0_antipodal]
-                    dec_init = [dec0, dec0_antipodal]
+                    rarange = np.arange(0, 360, 10)
+                    decrange = np.arange(-90, 90, 5)
+                    rms_landscape = np.ones(shape=(len(rarange), len(decrange)))
+
+                    for i, ra0 in enumerate(rarange):
+                        for j, dec0 in enumerate(decrange):
+
+                            all_residuals = []
+
+                            for ff in np.unique(data["cfid"].values[0]):
+                                cond_ff  = data["cfid"].values[0] == ff
+
+                                pha = [np.radians(data["Phase"].values[0][cond_ff]),
+                                    np.radians(data["ra"].values[0][cond_ff]),
+                                    np.radians(data["dec"].values[0][cond_ff])]
+
+                                H  = shg1g2_params[f"H_{ff}"]
+                                G1 = shg1g2_params[f"G1_{ff}"]
+                                G2 = shg1g2_params[f"G2_{ff}"]
+                                R  = shg1g2_params["R"]
+
+                                C = func_hg1g2_with_spin(pha, H, G1, G2, R,
+                                                        np.radians(ra0), np.radians(dec0))
+
+                                Obs = data["cmred"].values[0][cond_ff]
+
+                                all_residuals.append(Obs - C)
+
+                            all_residuals = np.concatenate(all_residuals)
+                            rms_landscape[j, i] = np.sqrt(np.mean(all_residuals**2))
+
+                    interp_vals = utils.gaussian_interpolate(rms_landscape, factor=4, sigma=1.0)
+                    ny, nx = interp_vals.shape
+                    [rarange[0], rarange[-1], decrange[0], decrange[-1]]
+                    ra_vals  = np.linspace(rarange.min(),  rarange.max(),  nx)
+                    dec_vals = np.linspace(decrange.min(), decrange.max(), ny)
+                    ys, xs = utils.detect_local_minima(interp_vals)
+                    ra_minima  = ra_vals[xs]
+                    dec_minima = dec_vals[ys]
+
+                    ra_init = ra_minima
+                    dec_init = dec_minima
 
                 H_key = next(
                     (f"H_{i}" for i in range(1, 7) if f"H_{i}" in shg1g2_params),
@@ -198,6 +250,23 @@ def get_fit_params(
                 try:
                     rms = np.array(rms)
                     SOCCA_opt = model[rms.argmin()]
+                    if period_quality_flag:
+                        try:
+                            DeltaF1 = signal_peaks[1] - signal_peaks[2]
+                            f_obs = 2 / period_sy
+                            y_trumpet = utils.trumpet(
+                                DeltaF1, 1, f_obs
+                            )
+                            alias_flag = (DeltaF1 - y_trumpet) * 100
+                            if alias_flag < 1:
+                                SOCCA_opt["Period_class"] = 1 # True
+                            else:
+                                SOCCA_opt["Period_class"] = 0 # Alias
+                            SOCCA_opt["Nbs"] = Nbs
+                        except Exception:
+                            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.1.2 → 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.1.2 → asteroid_spinprops-1.2.1}/asteroid_spinprops/ssolib/utils.py

@@ -418,3 +418,73 @@ def generate_initial_points(ra, dec, dec_shift=45):
                 ra_list.append(wrap_longitude(temp_ra + offset))
                 dec_list.append(shifted_dec)
     return ra_list, dec_list
+
+def gaussian_interpolate(data, factor=4, sigma=1.0):
+    """
+    Reproduce matplotlib's `interpolation="gaussian"` effect.
+    factor : upsampling factor
+    sigma  : Gaussian smoothing strength
+    """
+    from scipy.ndimage import zoom, gaussian_filter
+
+    # Step 1: upsample (mimics interpolation grid)
+    up = zoom(data, factor, order=1)  # bilinear before smoothing
+    
+    # Step 2: apply gaussian smoothing
+    smoothed = gaussian_filter(up, sigma=sigma)
+    
+    return smoothed
+
+def detect_local_minima(arr):
+    import scipy.ndimage.filters as filters
+    import scipy.ndimage.morphology as morphology
+
+    # https://stackoverflow.com/questions/3684484/peak-detection-in-a-2d-array/3689710#3689710
+    # https://stackoverflow.com/questions/3986345/how-to-find-the-local-minima-of-a-smooth-multidimensional-array-in-numpy
+    """
+    Takes an array and detects the troughs using the local maximum filter.
+    Returns a boolean mask of the troughs (i.e. 1 when
+    the pixel's value is the neighborhood maximum, 0 otherwise)
+    """
+    neighborhood = morphology.generate_binary_structure(len(arr.shape),2)
+    
+    footprint = np.ones((15, 15))
+    local_min = filters.minimum_filter(arr, footprint=footprint) == arr
+
+    background = (arr==0)
+    eroded_background = morphology.binary_erosion(
+        background, structure=neighborhood, border_value=1)
+
+    detected_minima = local_min ^ eroded_background
+    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
+
+    elif peak_diff_1 < 0 and f_obs < f_feat:
+        return -2 * f_obs
+
+    elif peak_diff_1 > 0 and f_obs < f_feat:
+        return 2 * f_obs
+
+    elif peak_diff_1 < 0 and f_obs > f_feat:
+        return -2 * f_feat
+
+    return 0.0

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

@@ -1,6 +1,6 @@
 [project]
 name = "asteroid_spinprops"
-version = "1.1.2"
+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"}