Merge pull request #700 from dirac-institute/t_p_cometary

Update simulation_parsing.py

demo/sspp_testset_orbits.des

@@ -1,4 +1,4 @@
-ObjID epochMJD_TDB t_p argPeri node inc e q FORMAT
+ObjID epochMJD_TDB t_p_MJD_TDB argPeri node inc e q FORMAT
 6 54800.0 6340.99721 16.4209 45.79141 21.20084 0.67411 5.65043 COM
 632 54800.0 23466.22367 284.5519 217.91073 5.37133 0.4966 6.88417 COM
 6624 54800.0 26018.29348 107.05559 285.0348 22.55248 0.31532 8.0147 COM

docs/inputs.rst

@@ -56,7 +56,7 @@ Cometary Orbit Format
 ~~~~~~~~~~~~~~~~~~~~~~~
 An example of an orbit file in Cometary format::
 
-   objID FORMAT q e inc node argPeri t_p epochMJD_TDB
+   objID FORMAT q e inc node argPeri t_p_MJD_TDB epochMJD_TDB
    S1000000a COM 3.01822 0.05208 22.56035 211.00286 335.42134 51575.94061 54800.00000
    S1000001a COM 2.10974 0.07518 4.91571 209.40298 322.66447 54205.77161 54800.00000
    S1000002a COM 2.80523 0.07777 1.24945 112.52284 139.86858 54468.71747 54800.00000
@@ -80,7 +80,7 @@ An example of an orbit file in Cometary format::
 +-------------+----------------------------------------------------------------------------------+
 | argPeri     | Argument of perihelion (degrees)                                                 |
 +-------------+----------------------------------------------------------------------------------+
-| t_p         | Time of periapsis (degrees)                                                      |
+| t_p_MJD_TDB         | Time of periapsis (years, MJD)                                                      |
 +-------------+----------------------------------------------------------------------------------+
 | epochMJD_TDB| Epoch (MJD)                                                                      |
 +-------------+----------------------------------------------------------------------------------+

src/sorcha/ephemeris/simulation_parsing.py

@@ -21,31 +21,33 @@ def mjd_tai_to_epoch(mjd_tai):
     return epoch
 
 
-def parse_orbit_row(row, epochMJD_TDB, ephem, sun_dict, gm_sun, gm_total):
+def parse_orbit_row(row, epochJD_TDB, ephem, sun_dict, gm_sun, gm_total):
     orbit_format = row["FORMAT"]
 
     if orbit_format not in ["CART", "BCART"]:
         if orbit_format == "COM":
+            t_p_JD_TDB = row["t_p_MJD_TDB"] + 2400000.5
             ecx, ecy, ecz, dx, dy, dz = universal_cartesian(
                 gm_sun,
                 row["q"],
                 row["e"],
                 row["inc"] * np.pi / 180.0,
                 row["node"] * np.pi / 180.0,
                 row["argPeri"] * np.pi / 180.0,
-                row["t_p"],
-                epochMJD_TDB,
+                t_p_JD_TDB,
+                epochJD_TDB,
             )
         elif orbit_format == "BCOM":
+            t_p_JD_TDB = row["t_p_MJD_TDB"] + 2400000.5
             ecx, ecy, ecz, dx, dy, dz = universal_cartesian(
                 gm_total,
                 row["q"],
                 row["e"],
                 row["inc"] * np.pi / 180.0,
                 row["node"] * np.pi / 180.0,
                 row["argPeri"] * np.pi / 180.0,
-                row["t_p"],
-                epochMJD_TDB,
+                t_p_JD_TDB,
+                epochJD_TDB,
             )
         elif orbit_format == "KEP":
             ecx, ecy, ecz, dx, dy, dz = universal_cartesian(
@@ -55,8 +57,8 @@ def parse_orbit_row(row, epochMJD_TDB, ephem, sun_dict, gm_sun, gm_total):
                 row["inc"] * np.pi / 180.0,
                 row["node"] * np.pi / 180.0,
                 row["argPeri"] * np.pi / 180.0,
-                epochMJD_TDB - (row["ma"] * np.pi / 180.0) * np.sqrt(row["a"] ** 3 / gm_sun),
-                epochMJD_TDB,
+                epochJD_TDB - (row["ma"] * np.pi / 180.0) * np.sqrt(row["a"] ** 3 / gm_sun),
+                epochJD_TDB,
             )
         elif orbit_format == "BKEP":
             ecx, ecy, ecz, dx, dy, dz = universal_cartesian(
@@ -66,19 +68,19 @@ def parse_orbit_row(row, epochMJD_TDB, ephem, sun_dict, gm_sun, gm_total):
                 row["inc"] * np.pi / 180.0,
                 row["node"] * np.pi / 180.0,
                 row["argPeri"] * np.pi / 180.0,
-                epochMJD_TDB - (row["ma"] * np.pi / 180.0) * np.sqrt(row["a"] ** 3 / gm_total),
-                epochMJD_TDB,
+                epochJD_TDB - (row["ma"] * np.pi / 180.0) * np.sqrt(row["a"] ** 3 / gm_total),
+                epochJD_TDB,
             )
         else:
             raise ValueError("Provided orbit format not supported.")
     else:
         ecx, ecy, ecz = row["x"], row["y"], row["z"]
         dx, dy, dz = row["xdot"], row["ydot"], row["zdot"]
 
-    if epochMJD_TDB not in sun_dict:
-        sun_dict[epochMJD_TDB] = ephem.get_particle("Sun", epochMJD_TDB - ephem.jd_ref)
+    if epochJD_TDB not in sun_dict:
+        sun_dict[epochJD_TDB] = ephem.get_particle("Sun", epochJD_TDB - ephem.jd_ref)
 
-    sun = sun_dict[epochMJD_TDB]
+    sun = sun_dict[epochJD_TDB]
 
     equatorial_coords = np.array(ecliptic_to_equatorial([ecx, ecy, ecz]))
     equatorial_velocities = np.array(ecliptic_to_equatorial([dx, dy, dz]))

src/sorcha/readers/OrbitAuxReader.py

@@ -71,7 +71,7 @@ def _process_and_validate_input_table(self, input_table, **kwargs):
             sys.exit("ERROR: Orbit file must have a consistent FORMAT (COM, KEP, or CART).")
 
         keplerian_elements = ["ObjID", "a", "e", "inc", "node", "argPeri", "ma", "epochMJD_TDB"]
-        cometary_elements = ["ObjID", "q", "e", "inc", "node", "argPeri", "t_p", "epochMJD_TDB"]
+        cometary_elements = ["ObjID", "q", "e", "inc", "node", "argPeri", "t_p_MJD_TDB", "epochMJD_TDB"]
         cartesian_elements = ["ObjID", "x", "y", "z", "xdot", "ydot", "zdot", "epochMJD_TDB"]
 
         if orb_format in ["KEP", "BKEP"]:
@@ -82,6 +82,10 @@ def _process_and_validate_input_table(self, input_table, **kwargs):
             if not all(column in input_table.columns for column in cometary_elements):
                 pplogger.error("ERROR: PPReadOrbitFile: Must provide all cometary orbital elements.")
                 sys.exit("ERROR: PPReadOrbitFile: Must provide all cometary orbital elements.")
+            if np.any(input_table["t_p_MJD_TDB"] > 2400000.5):
+                pplogger.warning(
+                    "WARNING: At least one t_p_MJD_TDB is above 2400000.5 - make sure your t_p are MJD and not in JD"
+                )
         elif orb_format in ["CART", "BCART"]:
             if not all(column in input_table.columns for column in cartesian_elements):
                 pplogger.error("ERROR: PPReadOrbitFile: Must provide all cartesian coordinate values.")

tests/data/PPReadAllInput_orbits.des

@@ -1,4 +1,4 @@
-ObjID epochMJD_TDB t_p argPeri node inc e q FORMAT
+ObjID epochMJD_TDB t_p_MJD_TDB argPeri node inc e q FORMAT
 6 54800.0 6340.99721 16.4209 45.79141 21.20084 0.67411 5.65043 COM
 632 54800.0 23466.22367 284.5519 217.91073 5.37133 0.4966 6.88417 COM
 6624 54800.0 26018.29348 107.05559 285.0348 22.55248 0.31532 8.0147 COM

tests/data/PPReadOrbitFile_bad_format.csv

@@ -1,4 +1,4 @@
-ObjID,FORMAT,q,e,inc,node,argPeri,t_p,epochMJD_TDB
+ObjID,FORMAT,q,e,inc,node,argPeri,t_p_MJD_TDB,epochMJD_TDB
 S00000t,COM,0.952105479028,0.504888475701,4.899098347472,148.881068605772,39.949789586436,54486.32292808,54466.0
 S000015,COM,0.154159694141,0.938877338769,48.223407545506,105.219186748093,38.658234184755,54736.8815041081,54466.0
 S000021,COM,0.281032037287,0.878997705355,24.078642319571,135.007398381801,58.797679973638,54022.4542604236,54466.0

tests/data/orbit_test_files/orbit_bcom.csv

@@ -1,4 +1,4 @@
-ObjID,FORMAT,q,e,inc,node,argPeri,t_p,epochMJD_TDB
+ObjID,FORMAT,q,e,inc,node,argPeri,t_p_MJD_TDB,epochMJD_TDB
 S00000t,BCOM,0.952105479028,0.504888475701,4.899098347472,148.881068605772,39.949789586436,54486.32292808,54466.0
 S000015,BCOM,0.154159694141,0.938877338769,48.223407545506,105.219186748093,38.658234184755,54736.8815041081,54466.0
 S000021,BCOM,0.281032037287,0.878997705355,24.078642319571,135.007398381801,58.797679973638,54022.4542604236,54466.0

tests/data/orbit_test_files/orbit_cart_wrong_cols.csv

@@ -1,4 +1,4 @@
-ObjID,FORMAT,q,e,inc,node,argPeri,t_p,epochMJD_TDB
+ObjID,FORMAT,q,e,inc,node,argPeri,t_p_MJD_TDB,epochMJD_TDB
 S00000t,CART,0.952105479028,0.504888475701,4.899098347472,148.881068605772,39.949789586436,54486.32292808,54466.0
 S000015,CART,0.154159694141,0.938877338769,48.223407545506,105.219186748093,38.658234184755,54736.8815041081,54466.0
 S000021,CART,0.281032037287,0.878997705355,24.078642319571,135.007398381801,58.797679973638,54022.4542604236,54466.0

tests/data/orbit_test_files/orbit_com.csv

@@ -1,4 +1,4 @@
-ObjID,FORMAT,q,e,inc,node,argPeri,t_p,epochMJD_TDB
+ObjID,FORMAT,q,e,inc,node,argPeri,t_p_MJD_TDB,epochMJD_TDB
 S00000t,COM,0.952105479028,0.504888475701,4.899098347472,148.881068605772,39.949789586436,54486.32292808,54466.0
 S000015,COM,0.154159694141,0.938877338769,48.223407545506,105.219186748093,38.658234184755,54736.8815041081,54466.0
 S000021,COM,0.281032037287,0.878997705355,24.078642319571,135.007398381801,58.797679973638,54022.4542604236,54466.0

tests/data/orbit_test_files/orbit_kep_wrong_cols.csv

@@ -1,4 +1,4 @@
-ObjID,FORMAT,q,e,inc,node,argPeri,t_p,epochMJD_TDB
+ObjID,FORMAT,q,e,inc,node,argPeri,t_p_MJD_TDB,epochMJD_TDB
 S00000t,KEP,0.952105479028,0.504888475701,4.899098347472,148.881068605772,39.949789586436,54486.32292808,54466.0
 S000015,KEP,0.154159694141,0.938877338769,48.223407545506,105.219186748093,38.658234184755,54736.8815041081,54466.0
 S000021,KEP,0.281032037287,0.878997705355,24.078642319571,135.007398381801,58.797679973638,54022.4542604236,54466.0

tests/data/orbits_test1.txt

@@ -1,4 +1,4 @@
-ObjID FORMAT q e inc node argPeri t_p epochMJD_TDB
+ObjID FORMAT q e inc node argPeri t_p_MJD_TDB epochMJD_TDB
 S00000t COM  0.952105479028000E+00  0.504888475701000E+00  0.489909834747200E+01  0.148881068605772E+03  0.399497895864360E+02  0.544863229280800E+05  0.544660000000000E+05
 S000015 COM  0.154159694141000E+00  0.938877338769000E+00  0.482234075455060E+02  0.105219186748093E+03  0.386582341847550E+02  0.547368815041081E+05  0.544660000000000E+05
 S000021 COM  0.281032037287000E+00  0.878997705355000E+00  0.240786423195710E+02  0.135007398381801E+03  0.587976799736380E+02  0.540224542604236E+05  0.544660000000000E+05

tests/data/orbits_test2.txt

@@ -1,3 +1,3 @@
-ObjID FORMAT q e inc node argPeri t_p epochMJD_TDB
+ObjID FORMAT q e inc node argPeri t_p_MJD_TDB epochMJD_TDB
 S00002b COM  0.108676548629200E+01  0.624200488727000E+00  0.216866761445080E+02  0.157115012852228E+03  0.325254912423030E+03  0.545901488726900E+05  0.544660000000000E+05
 S000044 COM  0.836323486528000E+00  0.406845980820000E+00  0.239981351289780E+02  0.172289084710415E+03  0.357925128655503E+03  0.545545563720268E+05  0.544660000000000E+05

tests/data/test_input_fullobs.csv

@@ -1,4 +1,4 @@
-ObjID,FieldID,FieldMJD_TAI,AstRange(km),AstRangeRate(km/s),AstRA(deg),AstRARate(deg/day),AstDec(deg),AstDecRate(deg/day),Ast-Sun(J2000x)(km),Ast-Sun(J2000y)(km),Ast-Sun(J2000z)(km),Ast-Sun(J2000vx)(km/s),Ast-Sun(J2000vy)(km/s),Ast-Sun(J2000vz)(km/s),Obs-Sun(J2000x)(km),Obs-Sun(J2000y)(km),Obs-Sun(J2000z)(km),Obs-Sun(J2000vx)(km/s),Obs-Sun(J2000vy)(km/s),Obs-Sun(J2000vz)(km/s),Sun-Ast-Obs(deg),V(H=0,u-r,g-r,i-r,z-r,y-r,GS,FORMAT,q,e,incl,node,argperi,t_p,H,t_0,optFilter,seeingFwhmGeom,seeingFwhmEff,fiveSigmaDepth,fieldRA,fieldDec,rotSkyPos,TrailedSourceMag,PSFMag,fiveSigmaDepthAtSource,AstrometricSigma(deg),PhotometricSigmaTrailedSource(mag),SNR,PhotometricSigmaPSF(mag),observedTrailedSourceMag,observedPSFMag,AstRATrue(deg),AstDecTrue(deg),detectorID,counter
+ObjID,FieldID,FieldMJD_TAI,AstRange(km),AstRangeRate(km/s),AstRA(deg),AstRARate(deg/day),AstDec(deg),AstDecRate(deg/day),Ast-Sun(J2000x)(km),Ast-Sun(J2000y)(km),Ast-Sun(J2000z)(km),Ast-Sun(J2000vx)(km/s),Ast-Sun(J2000vy)(km/s),Ast-Sun(J2000vz)(km/s),Obs-Sun(J2000x)(km),Obs-Sun(J2000y)(km),Obs-Sun(J2000z)(km),Obs-Sun(J2000vx)(km/s),Obs-Sun(J2000vy)(km/s),Obs-Sun(J2000vz)(km/s),Sun-Ast-Obs(deg),V(H=0,u-r,g-r,i-r,z-r,y-r,GS,FORMAT,q,e,incl,node,argperi,t_p_MJD_TDB,H,t_0,optFilter,seeingFwhmGeom,seeingFwhmEff,fiveSigmaDepth,fieldRA,fieldDec,rotSkyPos,TrailedSourceMag,PSFMag,fiveSigmaDepthAtSource,AstrometricSigma(deg),PhotometricSigmaTrailedSource(mag),SNR,PhotometricSigmaPSF(mag),observedTrailedSourceMag,observedPSFMag,AstRATrue(deg),AstDecTrue(deg),detectorID,counter
 S1000000a,894816,61769.320619,393817194.335,-22.515,164.0377129999997,0.059181,-17.582575000001285,-0.103034,-381360770.152,236918119.898,-61023282.708,-8.456,-15.118,-2.703,-20416770.015,133676144.369,57941007.918,-30.238,-4.221,-1.691,18.341701,5.454,0.0,0.0,0.0,0.0,0.0,0.15,COM,3.01822,0.05208,22.56035,211.00286,335.42134,51575.94061,14.2,54800.0,r,1.0585375509059165,1.2244982371118207,23.86356436464961,163.87542090842982,-18.84327137012991,115.45370443821976,19.6553455147994,19.65971332007237,23.839403736057715,2.9880927198448093e-06,0.0067559265881139,159.7413150392024,0.0067756541324796,19.64807294986914,19.647048752490328,164.037713,-17.582575,66.0,19
 S1000000a,894838,61769.332335,393794417.661,-22.487,164.0384050000008,0.058995,-17.58378199999977,-0.102901,-381369329.791,236902814.698,-61026019.437,-8.455,-15.119,-2.703,-20447365.99,133671859.702,57939294.809,-30.213,-4.244,-1.694,18.340845,5.454,0.0,0.0,0.0,0.0,0.0,0.15,COM,3.01822,0.05208,22.56035,211.00286,335.42134,51575.94061,14.2,54800.0,i,0.963171758792392,1.108481458384905,23.50948086026021,163.87542090842982,-18.84327137012991,120.71163574339585,19.65519024392603,19.66044317371636,23.48540836773025,3.058098344879201e-06,0.0086164409529643,125.04277045119268,0.0086483828701725,19.658459587542698,19.673310426207006,164.038405,-17.583782,59.0,19
 S1000000a,897478,61773.283672,386228488.529,-22.131,164.25272700000187,0.039576,-17.97083300000036,-0.094141,-384224280.492,231721359.793,-61943876.273,-8.269,-15.233,-2.673,-30627123.481,132014807.04,57220279.418,-29.914,-6.079,-2.515,18.034121,5.401,0.0,0.0,0.0,0.0,0.0,0.15,COM,3.01822,0.05208,22.56035,211.00286,335.42134,51575.94061,14.2,54800.0,g,0.9868254867575018,1.137257283159978,24.412081324532743,163.33185289781585,-17.478349047859123,162.97581185764338,19.602460273919007,19.606206520430625,24.40274105573913,2.8628267283501646e-06,0.0045626763406293,236.9204689068152,0.0045730589905698,19.59169233587751,19.6032266133104,164.252727,-17.970833,87.0,20

tests/data/testorb.csv

@@ -1,4 +1,4 @@
-ObjID,FORMAT,q,e,inc,node,argPeri,t_p,epochMJD_TDB
+ObjID,FORMAT,q,e,inc,node,argPeri,t_p_MJD_TDB,epochMJD_TDB
 S00000t,COM,0.952105479028,0.504888475701,4.899098347472,148.881068605772,39.949789586436,54486.32292808,54466.0
 S000015,COM,0.154159694141,0.938877338769,48.223407545506,105.219186748093,38.658234184755,54736.8815041081,54466.0
 S000021,COM,0.281032037287,0.878997705355,24.078642319571,135.007398381801,58.797679973638,54022.4542604236,54466.0

tests/data/testorb.des

@@ -1,4 +1,4 @@
-ObjID FORMAT q e inc node argPeri t_p epochMJD_TDB
+ObjID FORMAT q e inc node argPeri t_p_MJD_TDB epochMJD_TDB
 S00000t COM  0.952105479028000E+00  0.504888475701000E+00  0.489909834747200E+01  0.148881068605772E+03  0.399497895864360E+02  0.544863229280800E+05  0.544660000000000E+05
 S000015 COM  0.154159694141000E+00  0.938877338769000E+00  0.482234075455060E+02  0.105219186748093E+03  0.386582341847550E+02  0.547368815041081E+05  0.544660000000000E+05
 S000021 COM  0.281032037287000E+00  0.878997705355000E+00  0.240786423195710E+02  0.135007398381801E+03  0.587976799736380E+02  0.540224542604236E+05  0.544660000000000E+05

tests/readers/test_CSVReader.py

@@ -288,7 +288,7 @@ def test_CSVDataReader_orbits():
             "inc",
             "node",
             "argPeri",
-            "t_p",
+            "t_p_MJD_TDB",
             "epochMJD_TDB",
         ],
         dtype=object,

tests/readers/test_CombinedDataReader.py

@@ -45,7 +45,7 @@ def test_CombinedDataReader():
         "Obs-Sun(J2000vz)(km/s)": 4.677,
         "Sun-Ast-Obs(deg)": 8.010336,
         "epochMJD_TDB": 54800.0,
-        "t_p": 23466.22367,
+        "t_p_MJD_TDB": 23466.22367,
         "argPeri": 284.5519,
         "node": 217.91073,
         "inc": 5.37133,
@@ -116,7 +116,7 @@ def test_CombinedDataReader_ephem():
         "Obs-Sun(J2000vz)(km/s)": 4.677,
         "Sun-Ast-Obs(deg)": 8.010336,
         "epochMJD_TDB": 54800.0,
-        "t_p": 23466.22367,
+        "t_p_MJD_TDB": 23466.22367,
         "argPeri": 284.5519,
         "node": 217.91073,
         "inc": 5.37133,

tests/readers/test_OrbitAuxReader.py

@@ -22,7 +22,7 @@ def test_OrbitAuxReader():
 
     # Check that we modify the columns (i -> incl, etc.)
     expected_columns = np.array(
-        ["ObjID", "FORMAT", "q", "e", "inc", "node", "argPeri", "t_p", "epochMJD_TDB"], dtype=object
+        ["ObjID", "FORMAT", "q", "e", "inc", "node", "argPeri", "t_p_MJD_TDB", "epochMJD_TDB"], dtype=object
     )
     assert_equal(expected_columns, orbit_txt.columns.values)
 
@@ -73,7 +73,7 @@ def test_orbit_reader_com():
 
     # Check that we modify the columns (i -> incl, etc.)
     expected_columns = np.array(
-        ["ObjID", "FORMAT", "q", "e", "inc", "node", "argPeri", "t_p", "epochMJD_TDB"], dtype=object
+        ["ObjID", "FORMAT", "q", "e", "inc", "node", "argPeri", "t_p_MJD_TDB", "epochMJD_TDB"], dtype=object
     )
     assert_equal(expected_columns, orbit_csv.columns.values)
 
@@ -114,7 +114,7 @@ def test_orbit_reader_bcom():
 
     # Check that we modify the columns (i -> incl, etc.)
     expected_columns = np.array(
-        ["ObjID", "FORMAT", "q", "e", "inc", "node", "argPeri", "t_p", "epochMJD_TDB"], dtype=object
+        ["ObjID", "FORMAT", "q", "e", "inc", "node", "argPeri", "t_p_MJD_TDB", "epochMJD_TDB"], dtype=object
     )
     assert_equal(expected_columns, orbit_csv.columns.values)
 

tests/sorcha/test_PPMatchPointingToObservations.py

@@ -47,7 +47,7 @@ def test_PPMatchPointingToObservations():
         {
             "ObjID": ["356450"],
             "t_0": [54466.0],
-            "t_p": [90480.35745],
+            "t_p_MJD_TDB": [90480.35745],
             "argperi": [7.89],
             "node": [144.25849],
             "incl": [8.98718],
@@ -116,7 +116,7 @@ def test_PPMatchPointingToObservations():
             "y-r": [-0.7, -0.7],
             "GS": [0.15, 0.15],
             "t_0": [54466.0, 54466.0],
-            "t_p": [90480.35745, 90480.35745],
+            "t_p_MJD_TDB": [90480.35745, 90480.35745],
             "argperi": [7.89, 7.89],
             "node": [144.25849, 144.25849],
             "incl": [8.98718, 8.98718],

tests/sorcha/test_combined_data_reading.py

@@ -126,7 +126,7 @@ def test_PPReadAllInput():
             "y-r",
             "GS",
             "epochMJD_TDB",
-            "t_p",
+            "t_p_MJD_TDB",
             "argPeri",
             "node",
             "inc",