asteroid_spinprops 1.0.1__tar.gz → 1.1.1__tar.gz

{asteroid_spinprops-1.0.1 → asteroid_spinprops-1.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: asteroid_spinprops
-Version: 1.0.1
+Version: 1.1.1
 Summary: Collection of tools used for fitting sHG1G2 and SOCCA photometric models to sparse asteroid photometry
 License: MIT
 Author: Odysseas

{asteroid_spinprops-1.0.1 → asteroid_spinprops-1.1.1}/asteroid_spinprops/ssolib/modelfit.py

@@ -7,7 +7,7 @@ from fink_utils.sso.spins import (
     estimate_sso_params,
     func_hg1g2_with_spin,
 )
-from asteroid_spinprops.ssolib.periodest import get_period_estimate
+from asteroid_spinprops.ssolib.periodest import get_period_estimate, get_multiterm_period_estimate, perform_residual_resampling
 
 
 def get_fit_params(
@@ -30,20 +30,20 @@ def get_fit_params(
 
     Parameters
     ----------
-    data : pandas.DataFrame
+    data : pandas.DataFrame single-row
         Input dataset containing photometry and geometry with columns:
         - 'cmred': reduced magnitudes
         - 'csigmapsf': uncertainties
         - 'Phase': solar phase angles (deg)
         - 'cfid': filter IDs
         - 'ra', 'dec': coordinates (deg)
-        - 'cjd': observation times
+        - 'cjd': observation times (light-time corrected)
         Optional (for terminator fits):
         - 'ra_s', 'dec_s': sub-solar point coordinates (deg)
     flavor : str
-        Model type to fit. Must be 'SHG1G2' or 'SSHG1G2'.
+        Model type to fit. Must be 'SHG1G2' or 'SOCCA'.
     shg1g2_constrained : bool, optional
-        Whether to constrain the SSHG1G2 fit using a prior SHG1G2 solution. Default True.
+        Whether to constrain the SOCCA fit using a prior SHG1G2 solution. Default True.
     blind_scan : bool, optional
         If True, perform a small grid search over initial pole positions and periods. Default True.
     p0 : list, optional
@@ -51,7 +51,7 @@ def get_fit_params(
     survey_filter : str or None, optional
         If 'ZTF' or 'ATLAS', only data from that survey are used. Default None uses all data.
     alt_spin : bool, optional
-        For SSHG1G2 constrained fits, use the antipodal spin solution. Default False.
+        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.
     terminator : bool, optional
@@ -63,7 +63,7 @@ def get_fit_params(
         If `flavor='SHG1G2'`:
             dict
                 Best-fit SHG1G2 parameters.
-        If `flavor='SSHG1G2'`:
+        If `flavor='SOCCA'`:
             dict
                 Best-fit SOCCA parameters.
 
@@ -77,7 +77,7 @@ def get_fit_params(
     Raises
     ------
     ValueError
-        If `flavor` is not 'SHG1G2' or 'SSHG1G2'.
+        If `flavor` is not 'SHG1G2' or 'SOCCA'.
     """
 
     if survey_filter is None:
@@ -115,7 +115,7 @@ def get_fit_params(
             )
 
         return Afit
-    if flavor == "SSHG1G2":
+    if flavor == "SOCCA":
         if shg1g2_constrained is True:
             shg1g2_params = get_fit_params(
                 data=data, flavor="SHG1G2", survey_filter=survey_filter
@@ -124,8 +124,24 @@ def get_fit_params(
                 data, model_parameters=shg1g2_params
             )
             if period_in is None:
-                sg, _, _ = get_period_estimate(residuals_dataframe=residuals_dataframe)
-                period_sy = 2 / sg[2][0]
+                # Period search boundaries (in days)
+                pmin, pmax = 5e-2, 1e4
+                try:
+                    p_in, k_val, p_rms, signal_peaks, window_peaks = (
+                        get_multiterm_period_estimate(
+                            residuals_dataframe, p_min=pmin, p_max=pmax, k_free=True
+                        )
+                    )
+                except KeyError:
+                    # If more than 10 terms are required switch to fast rotator:
+                    pmin, pmax = 5e-3, 5e-2
+
+                    p_in, k_val, p_rms, signal_peaks, window_peaks = (
+                        get_multiterm_period_estimate(
+                            residuals_dataframe, p_min=pmin, p_max=pmax, k_free=True
+                        )
+                    )
+                period_sy = p_in
             else:
                 period_sy = period_in
 
@@ -162,22 +178,22 @@ def get_fit_params(
                             0.1,
                         ]  # phi 0
 
-                        sshg1g2 = get_fit_params(
+                        SOCCA = get_fit_params(
                             data,
-                            "SSHG1G2",
+                            "SOCCA",
                             shg1g2_constrained=False,
                             p0=p_in,
                             terminator=terminator,
                         )
                         try:
-                            rms.append(sshg1g2["rms"])
-                            model.append(sshg1g2)
+                            rms.append(SOCCA["rms"])
+                            model.append(SOCCA)
                         except Exception:
                             continue
                 rms = np.array(rms)
-                sshg1g2_opt = model[rms.argmin()]
+                SOCCA_opt = model[rms.argmin()]
 
-                return sshg1g2_opt
+                return SOCCA_opt
             else:
                 period_si_t, alt_period_si_t, _ = utils.estimate_sidereal_period(
                     data=data, model_parameters=shg1g2_params, synodic_period=period_sy
@@ -245,14 +261,14 @@ def get_fit_params(
                     ra=np.radians(data["ra"].values[0][filter_mask]),
                     dec=np.radians(data["dec"].values[0][filter_mask]),
                     jd=data["cjd"].values[0][filter_mask],
-                    model="SSHG1G2",
+                    model="SSHG1G2", # We should call this SOCCA
                     p0=p0,
                 )
                 return Afit
 
         if shg1g2_constrained is False:
             if p0 is None:
-                print("Initialize SSHG1G2 first!")
+                print("Initialize SOCCA first!")
             if p0 is not None:
                 if terminator:
                     Afit = estimate_sso_params(
@@ -283,8 +299,8 @@ def get_fit_params(
                         terminator=terminator,
                     )
                 return Afit
-    if flavor not in ["SHG1G2", "SSHG1G2"]:
-        print("Model must either be SHG1G2 or SSHG1G2, not {}".format(flavor))
+    if flavor not in ["SHG1G2", "SOCCA"]:
+        print("Model must either be SHG1G2 or SOCCA, not {}".format(flavor))
 
 
 def get_model_points(data, params):

{asteroid_spinprops-1.0.1 → asteroid_spinprops-1.1.1}/asteroid_spinprops/ssolib/periodest.py

@@ -122,7 +122,7 @@ def get_period_estimate(residuals_dataframe, p_min=0.03, p_max=2):
     )
 
 
-def get_multiband_period_estimate(
+def get_multiterm_period_estimate(
     residuals_dataframe, p_min=0.03, p_max=2, k_free=True, k_val=None
 ):
     """
@@ -337,7 +337,7 @@ def perform_residual_resampling(resid_df, p_min, p_max, k=1):
     ----------
     resid_df : pandas.DataFrame
         DataFrame of residuals containing columns required for `get_period_estimate`
-        or `get_multiband_period_estimate`.
+        or `get_multiterm_period_estimate`.
     p_min : float
         Minimum period to search (days).
     p_max : float
@@ -356,7 +356,7 @@ def perform_residual_resampling(resid_df, p_min, p_max, k=1):
     Notes
     -----
     - Performs 25 bootstrap resamples by default.
-    - For k=1, uses `get_period_estimate`; for k>1, uses `get_multiband_period_estimate`.
+    - For k=1, uses `get_period_estimate`; for k>1, uses `get_multiterm_period_estimate`.
     """
 
     if k == 1:
@@ -373,13 +373,13 @@ def perform_residual_resampling(resid_df, p_min, p_max, k=1):
         cond = np.abs(Pog - Pbs) / Pog < 1e-2
         Nbs = np.sum(np.ones(25)[cond])
     if k > 1:
-        Pog, _, _ = 24 / get_multiband_period_estimate(
+        Pog, _, _ = 24 / get_multiterm_period_estimate(
             resid_df, p_min=p_min, p_max=p_max, k_free=False, k_val=k
         )
         Pbs = np.zeros(25)
         for n in range(25):
             BS_df = resid_df.sample(n=len(resid_df), replace=True)
-            Pbs[n], _, _ = 24 / get_multiband_period_estimate(
+            Pbs[n], _, _ = 24 / get_multiterm_period_estimate(
                 BS_df, p_min=p_min, p_max=p_max, k_free=False, k_val=k
             )
         cond = np.abs(Pog - Pbs) / Pog < 1e-2

{asteroid_spinprops-1.0.1 → asteroid_spinprops-1.1.1}/pyproject.toml

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