asteroid_spinprops 1.0.1__py3-none-any.whl → 1.1.2__py3-none-any.whl

asteroid_spinprops/ssolib/modelfit.py

@@ -7,16 +7,18 @@ 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_multiterm_period_estimate,
+)
 
 
 def get_fit_params(
     data,
     flavor,
     shg1g2_constrained=True,
-    blind_scan=True,
+    period_blind=True,
+    pole_blind=True,
     p0=None,
-    survey_filter=None,
     alt_spin=False,
     period_in=None,
     terminator=False,
@@ -30,28 +32,28 @@ 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.
-    blind_scan : bool, optional
-        If True, perform a small grid search over initial pole positions and periods. Default True.
+        Whether to constrain the SOCCA fit using a prior SHG1G2 solution. Default True.
+    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.
     p0 : list, optional
         Initial guess parameters for the fit. Required if `shg1g2_constrained=False`.
-    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 +65,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,59 +79,72 @@ 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:
-        filter_mask = np.array(data["cfid"].values[0]) >= 0
-    if survey_filter == "ZTF":
-        filter_mask = (np.array(data["cfid"].values[0]) == 1) | (
-            np.array(data["cfid"].values[0]) == 2
-        )
-    if survey_filter == "ATLAS":
-        filter_mask = (np.array(data["cfid"].values[0]) == 3) | (
-            np.array(data["cfid"].values[0]) == 4
-        )
     if flavor == "SHG1G2":
         if p0 is None:
             Afit = estimate_sso_params(
-                magpsf_red=data["cmred"].values[0][filter_mask],
-                sigmapsf=data["csigmapsf"].values[0][filter_mask],
-                phase=np.radians(data["Phase"].values[0][filter_mask]),
-                filters=data["cfid"].values[0][filter_mask],
-                ra=np.radians(data["ra"].values[0][filter_mask]),
-                dec=np.radians(data["dec"].values[0][filter_mask]),
+                magpsf_red=data["cmred"].values[0],
+                sigmapsf=data["csigmapsf"].values[0],
+                phase=np.radians(data["Phase"].values[0]),
+                filters=data["cfid"].values[0],
+                ra=np.radians(data["ra"].values[0]),
+                dec=np.radians(data["dec"].values[0]),
                 model="SHG1G2",
             )
 
         if p0 is not None:
             Afit = estimate_sso_params(
-                magpsf_red=data["cmred"].values[0][filter_mask],
-                sigmapsf=data["csigmapsf"].values[0][filter_mask],
-                phase=np.radians(data["Phase"].values[0][filter_mask]),
-                filters=data["cfid"].values[0][filter_mask],
-                ra=np.radians(data["ra"].values[0][filter_mask]),
-                dec=np.radians(data["dec"].values[0][filter_mask]),
+                magpsf_red=data["cmred"].values[0],
+                sigmapsf=data["csigmapsf"].values[0],
+                phase=np.radians(data["Phase"].values[0]),
+                filters=data["cfid"].values[0],
+                ra=np.radians(data["ra"].values[0]),
+                dec=np.radians(data["dec"].values[0]),
                 model="SHG1G2",
                 p0=p0,
             )
 
         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
-            )
-            residuals_dataframe = make_residuals_df(
-                data, model_parameters=shg1g2_params
+                data=data, flavor="SHG1G2"
             )
+            try:
+                residuals_dataframe = make_residuals_df(
+                    data, model_parameters=shg1g2_params
+                )
+            except Exception:
+                SOCCA_opt = {"Failed at period search preliminary steps": 3}
+                return SOCCA_opt
             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
+                    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 Exception:
+                        SOCCA_opt = {"Failed at period search after": 4}
+                        return SOCCA_opt
+                period_sy = p_in
             else:
                 period_sy = period_in
 
-            if blind_scan is True:
+            if period_blind is True:
                 rms = []
                 model = []
 
@@ -138,10 +153,16 @@ 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
+                    )
 
-                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]
 
                 H_key = next(
                     (f"H_{i}" for i in range(1, 7) if f"H_{i}" in shg1g2_params),
@@ -162,22 +183,24 @@ 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()]
-
-                return sshg1g2_opt
+                try:
+                    rms = np.array(rms)
+                    SOCCA_opt = model[rms.argmin()]
+                except Exception:
+                    SOCCA_opt = {"Failed at SOCCA inversion": 5}
+                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
@@ -238,53 +261,53 @@ def get_fit_params(
 
                 # Constrained Fit
                 Afit = estimate_sso_params(
-                    data["cmred"].values[0][filter_mask],
-                    data["csigmapsf"].values[0][filter_mask],
-                    np.radians(data["Phase"].values[0][filter_mask]),
-                    data["cfid"].values[0][filter_mask],
-                    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",
+                    data["cmred"].values[0],
+                    data["csigmapsf"].values[0],
+                    np.radians(data["Phase"].values[0]),
+                    data["cfid"].values[0],
+                    ra=np.radians(data["ra"].values[0]),
+                    dec=np.radians(data["dec"].values[0]),
+                    jd=data["cjd"].values[0],
+                    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(
-                        data["cmred"].values[0][filter_mask],
-                        data["csigmapsf"].values[0][filter_mask],
-                        np.radians(data["Phase"].values[0][filter_mask]),
-                        data["cfid"].values[0][filter_mask],
-                        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],
+                        data["cmred"].values[0],
+                        data["csigmapsf"].values[0],
+                        np.radians(data["Phase"].values[0]),
+                        data["cfid"].values[0],
+                        ra=np.radians(data["ra"].values[0]),
+                        dec=np.radians(data["dec"].values[0]),
+                        jd=data["cjd"].values[0],
                         model="SSHG1G2",
                         p0=p0,
                         terminator=terminator,
-                        ra_s=np.radians(data["ra_s"].values[0][filter_mask]),
-                        dec_s=np.radians(data["dec_s"].values[0][filter_mask]),
+                        ra_s=np.radians(data["ra_s"].values[0]),
+                        dec_s=np.radians(data["dec_s"].values[0]),
                     )
                 else:
                     Afit = estimate_sso_params(
-                        data["cmred"].values[0][filter_mask],
-                        data["csigmapsf"].values[0][filter_mask],
-                        np.radians(data["Phase"].values[0][filter_mask]),
-                        data["cfid"].values[0][filter_mask],
-                        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],
+                        data["cmred"].values[0],
+                        data["csigmapsf"].values[0],
+                        np.radians(data["Phase"].values[0]),
+                        data["cfid"].values[0],
+                        ra=np.radians(data["ra"].values[0]),
+                        dec=np.radians(data["dec"].values[0]),
+                        jd=data["cjd"].values[0],
                         model="SSHG1G2",
                         p0=p0,
                         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/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.dist-info → asteroid_spinprops-1.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: asteroid_spinprops
-Version: 1.0.1
+Version: 1.1.2
 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.dist-info → asteroid_spinprops-1.1.2.dist-info}/RECORD

@@ -1,10 +1,10 @@
 asteroid_spinprops/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 asteroid_spinprops/ssolib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 asteroid_spinprops/ssolib/dataprep.py,sha256=7PfkVNpLjPERkhr8dZQfN8haFCFmoeXB3fWuTSBLVuc,7848
-asteroid_spinprops/ssolib/modelfit.py,sha256=Kg5Qn0yU4wbfat9ZCvT9pYqSIo9toUm5kwhCiSvhalw,15898
-asteroid_spinprops/ssolib/periodest.py,sha256=XCBqsgPFcLFk-vreVmpYPjghJDyUyHSEeCULayqPRHg,13216
+asteroid_spinprops/ssolib/modelfit.py,sha256=CM2fc_OKPrajK3Dadiny4JEkY1KuwCXqoarTx8SnYpM,16473
+asteroid_spinprops/ssolib/periodest.py,sha256=kDWEB0fPRd5paqxNjJmigsocrAd4rydYLwxNh5sMV2U,13216
 asteroid_spinprops/ssolib/ssptools.py,sha256=DlSgYtXenztRAtEV9d4itzp5OZMjkbXkW2yZ_Qumu4U,4490
 asteroid_spinprops/ssolib/utils.py,sha256=BUeIP0DZ45tg5qAQML8LBM8Gbj1vn2d3PGzvgQvfq_I,11094
-asteroid_spinprops-1.0.1.dist-info/METADATA,sha256=4aQ7NoSNXRB2HbMHw1AIjhNE3UZFLUL5CYV_QeQywnA,5635
-asteroid_spinprops-1.0.1.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-asteroid_spinprops-1.0.1.dist-info/RECORD,,
+asteroid_spinprops-1.1.2.dist-info/METADATA,sha256=Ea_ijdxK1WerLh0BSULWUQp3sn054ghbk35Chg_Ggz4,5635
+asteroid_spinprops-1.1.2.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+asteroid_spinprops-1.1.2.dist-info/RECORD,,