Add star mag to set new magnitude for stars in default sky sim mode.

lsst-ts · Nov 14, 2023 · 3ea00e9 · 3ea00e9
1 parent ede8c6a
commit 3ea00e9
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 1 deletion.
diff --git a/bin.src/img_closed_loop.py b/bin.src/img_closed_loop.py
@@ -47,6 +47,7 @@
         args.rot_cam,
         args.boresight_deg,
         args.mjd,
+        args.star_mag,
         args.output,
         args.sky_file,
         args.clobber,

diff --git a/doc/versionHistory.rst b/doc/versionHistory.rst
@@ -6,6 +6,12 @@
 Version History
 ##################
 
+-------------
+0.8.0
+-------------
+
+* Add star_mag to img_closed_loop to specify default star magnitude.
+
 -------------
 0.7.0
 -------------

diff --git a/python/lsst/ts/imsim/closed_loop_task.py b/python/lsst/ts/imsim/closed_loop_task.py
@@ -1019,6 +1019,7 @@ def run_img(
         rot_cam_in_deg: float,
         boresight: list[float],
         mjd: float,
+        star_mag: float,
         base_output_dir: str,
         path_sky_file: str,
         do_erase_dir_content: bool,
@@ -1047,6 +1048,8 @@ def run_img(
             Boresight [ra, dec] in degree.
         mjd : float
             MJD of the observation.
+        star_mag : float
+            Magnitude of stars if using default sky file.
         base_output_dir : str
             Base output directory.
         path_sky_file : str
@@ -1104,7 +1107,7 @@ def run_img(
 
         # Configure the components
         self.config_sky_sim(
-            inst_name, obs_metadata, path_sky_file=path_sky_file, star_mag=15
+            inst_name, obs_metadata, path_sky_file=path_sky_file, star_mag=star_mag
         )
         self.config_ofc_calc(inst_name)
         self.imsim_cmpt = ImsimCmpt()
@@ -1392,6 +1395,13 @@ def set_img_parser(parser: ArgumentParser) -> ArgumentParser:
             "--mjd", type=float, default=59580, help="Starting MJD of observation."
         )
 
+        parser.add_argument(
+            "--star_mag",
+            type=float,
+            default=15.0,
+            help="Magnitude of stars if using default sky_file. The default is 15.",
+        )
+
         parser.add_argument(
             "--turn_off_sky_background",
             action="store_true",

diff --git a/tests/test_closed_loop_task.py b/tests/test_closed_loop_task.py
@@ -191,6 +191,7 @@ def test_set_img_parser(self):
         self.assertEqual(args.raw_seeing, 0.5)
         self.assertFalse(args.turn_off_sky_background)
         self.assertFalse(args.turn_off_atmosphere)
+        self.assertEqual(args.star_mag, 15.0)
 
     def test_get_sensor_name_list_of_field_lsst_wfs(self):
         sensor_name_list = self.closed_loop_task.get_sensor_name_list_of_fields("lsst")