dkist-processing-dlnirsp 0.32.8__py3-none-any.whl → 0.33.0__py3-none-any.whl

{dkist_processing_dlnirsp-0.32.8.dist-info → dkist_processing_dlnirsp-0.33.0.dist-info}/RECORD

@@ -4,21 +4,20 @@ dkist_processing_dlnirsp/config.py,sha256=3jM7P00T-Xlzfnvc3jwRiFtinW5GoTczQ6qNLL
 dkist_processing_dlnirsp/dev_scripts/__init__.py,sha256=tITkbcFg1a-24sdFaWK8OyLrQSQk7AI6Ycs8PHHfHEM,83
 dkist_processing_dlnirsp/dev_scripts/test_slitbeam_group_assignment.py,sha256=ac-8G-P2L_xW6m3tOooFlHs1N5_C6F_7k2VAU2a9_1A,4171
 dkist_processing_dlnirsp/models/__init__.py,sha256=ItaZgbjndT5uwEv2YDQZCVAHGbiB_sjzkX8MMbIgcSo,45
-dkist_processing_dlnirsp/models/constants.py,sha256=0TV_K6WbvUlDQdNRxx_qblQ_dwN7RGU7ng2iDOBQedo,6386
+dkist_processing_dlnirsp/models/constants.py,sha256=y4c8boq1Rp4mqtkNJi3aj1EkhUnU7fiq013aqiFOonM,6602
 dkist_processing_dlnirsp/models/fits_access.py,sha256=5HH8NM2tAh63Aauy6oCXKJGJ2AbQPBP5L1DitVfFEs0,895
-dkist_processing_dlnirsp/models/parameters.py,sha256=PsaZSNE4Uyov1xGMqRqh6kb5F8NnDDm3QRHkoiDAsYY,15812
+dkist_processing_dlnirsp/models/parameters.py,sha256=YD2BdQRO0Yk1sz3DJP-wNehBUJvDQ7cHqEnQP6UYo6w,17210
 dkist_processing_dlnirsp/models/tags.py,sha256=xD_XaCjMXmd70P0FoHy92XSdlabIk07RGVEyFpXpGfM,5791
 dkist_processing_dlnirsp/models/task_name.py,sha256=LmEoI_h4UecvIMGcO5U8mGTqfToPjABuFbsYkC_rZyw,506
 dkist_processing_dlnirsp/parsers/__init__.py,sha256=O6KcssCD39an60pqLISt1aHQ4u5ADg0TMNw1dB694Ug,81
 dkist_processing_dlnirsp/parsers/dlnirsp_l0_fits_access.py,sha256=ziUeSWPOiFV0HdkCCfFZGPOZB-PB1OhK2qjYbVdsAb4,4314
 dkist_processing_dlnirsp/parsers/dlnirsp_l1_fits_acess.py,sha256=K-9HRVZ02IUl0wRnhlTMnwSikTt7vYi_zSWYs0V_6-Y,878
 dkist_processing_dlnirsp/parsers/mosaic.py,sha256=0z0sTbDQFhg2hyCp6hSKFpuaS-rOSUBvuBOT6mSSadA,31061
-dkist_processing_dlnirsp/parsers/task.py,sha256=9_JzhqfU9os-6uUpn1FlNd2d1yWfD0dB4u0H0OruTbs,1619
-dkist_processing_dlnirsp/parsers/time.py,sha256=DsnGxT4coH6FjiHsLr5gimW8lGExE5y_E6zzUH89HMM,2072
+dkist_processing_dlnirsp/parsers/task.py,sha256=wtg8kNuxqGHaK34dJAZ92-f29-3V1QrnLGUGRAebUUk,990
+dkist_processing_dlnirsp/parsers/time.py,sha256=bdsNRXGpiKe7nBt3rOvk5gKYtqo10nFkTR9EMwbDcsg,2093
 dkist_processing_dlnirsp/parsers/wavelength.py,sha256=CHZDFqOpzErhaR0MSbzQ6NiagdmkVkZ-6HWRERH5TNY,972
 dkist_processing_dlnirsp/parsers/wcs_corrections.py,sha256=yeTLowmtAIs5sjNStIKmBTZUxttOtldJSeW_adsXFYQ,1786
-dkist_processing_dlnirsp/tasks/__init__.py,sha256=6N5xdCM3FeTpzmBUgUnJ5mKF2N3vBfcj-SNqVQ9ZHiw,996
-dkist_processing_dlnirsp/tasks/assemble_movie.py,sha256=BxUO7_Zj_QGLXqNpp87bLawyLo4G0I0DTLZPMXpi5Mo,5539
+dkist_processing_dlnirsp/tasks/__init__.py,sha256=zGSL-fIB0el6PCjf4VEIHU_pOTv945D95I2G4vxHtHA,924
 dkist_processing_dlnirsp/tasks/bad_pixel_map.py,sha256=ZzG86mXped2k2PjX7okKAi3JCQGJHalBhBgFU-T8K_8,8194
 dkist_processing_dlnirsp/tasks/dark.py,sha256=rFnVULAunChEdxEXcosxNJM_iqRGslia9cUnV1FAOQQ,3580
 dkist_processing_dlnirsp/tasks/dlnirsp_base.py,sha256=dIpQGE0COLAXPAUbKn6dpLJj5VDCxfAVYFfX8fR6OSo,1519
@@ -28,25 +27,24 @@ dkist_processing_dlnirsp/tasks/instrument_polarization.py,sha256=G79qXg1080zsd8Z
 dkist_processing_dlnirsp/tasks/l1_output_data.py,sha256=Psta0476jih-cfmpdnzmquys030sW4f4VX6ksAb-g1o,465
 dkist_processing_dlnirsp/tasks/lamp.py,sha256=twoMHMnE2jm2OYxkeHFcjqcyQYVtEjSU2_z2mmn3Ybs,5390
 dkist_processing_dlnirsp/tasks/linearity_correction.py,sha256=z3MpWHp0lZYB2zrfHfH7HlcKoro6TPxwEN8rpqVv08c,22716
-dkist_processing_dlnirsp/tasks/make_movie_frames.py,sha256=zxyAWNnPFbG7jpUEe3ekRyJGjk706T9a-yiA3eoWi5M,6290
-dkist_processing_dlnirsp/tasks/parse.py,sha256=ZtqM6dyxxnnbVTAun040EuxfQZEQcnkXzZffXSBTYkk,10919
+dkist_processing_dlnirsp/tasks/movie.py,sha256=IaZCRg2KIETEXDyyOe3FLoY5cd7eJOhMtjkiSYjElEU,44291
+dkist_processing_dlnirsp/tasks/parse.py,sha256=WGFIssavbQg1BAbW0_jS56SoEya-X-bHkLTbxTooUFI,11218
 dkist_processing_dlnirsp/tasks/quality_metrics.py,sha256=1ScLAinv3WG-0M7u_26gnogbJ_D84K9CP7eRvEuwb9E,7346
 dkist_processing_dlnirsp/tasks/science.py,sha256=sNI4AYO10qe3JL62KWXR87MnfX9m85Jo4_PkQ0qd5TQ,35737
-dkist_processing_dlnirsp/tasks/solar.py,sha256=NyLYkRophfXaVtvnGuNEvkcE8JNcmCJVuobNYAZ7KjQ,11135
+dkist_processing_dlnirsp/tasks/solar.py,sha256=hVOVwQkzO4kioPDgJz3GqSNcisfpEMbDPESJN-INh10,15494
 dkist_processing_dlnirsp/tasks/wavelength_calibration.py,sha256=QhFlbX8h9UqkK2vx779nK6LBksp2P2yPqhAxrwcuJ4o,16851
 dkist_processing_dlnirsp/tasks/write_l1.py,sha256=Smd9Fzp3Kx4F3nHYJJRAXqNy9n71TsYovuvFjLcUYs4,9732
 dkist_processing_dlnirsp/tasks/mixin/__init__.py,sha256=5PMbkD6K0zTfhCxv8vg2lvJCNP81qItJ_R_7Yy3Mpwc,26
 dkist_processing_dlnirsp/tasks/mixin/corrections.py,sha256=MRZXCEc0KBE-9cQUpRP-K3ioDYRH8_ORFlJcH2SsmWA,6803
 dkist_processing_dlnirsp/tasks/mixin/group_id.py,sha256=u28XLVtvZ_lmzzaSX2SuA2MOiY69GC8AJsic2Vi2OSQ,11137
 dkist_processing_dlnirsp/tests/__init__.py,sha256=UHIAs0SglAXeB7UeDgVwo1EE9QPRq3rG3BZkiCpBq7M,42
-dkist_processing_dlnirsp/tests/conftest.py,sha256=Xp02ZyHi6X3FzyY_IQOjLsH3gOA9zK7KGo9gpeeO6jw,68768
-dkist_processing_dlnirsp/tests/test_assemble_movie.py,sha256=hKAIHCRQu8fZwCuWsX_4WHFrDpC0bDQ9CCI9A5bRkqg,5665
+dkist_processing_dlnirsp/tests/conftest.py,sha256=cmYQ9PnOiEXeTpAsRmRm64MVEVYwgOyHWafQTHl932E,70413
 dkist_processing_dlnirsp/tests/test_assemble_quality.py,sha256=djZsVSuRGl3akH3LmYjWvYuNSUFFQfS5y0S3Op7lQIE,1327
 dkist_processing_dlnirsp/tests/test_bad_pixel_map.py,sha256=g5jWhVGSHMOtkcdiZ27G51ciud4ySjoDAjvMGLlgTIM,6093
 dkist_processing_dlnirsp/tests/test_corrections.py,sha256=hefVNm3bgwfGQ7Wn0hi077LU_fKlDXJ0eeMl6HCRogA,7569
 dkist_processing_dlnirsp/tests/test_dark.py,sha256=qv7SvUNgafzfdyIW11I6eSFeaXjw34-9X1ipnqKE1cY,3726
 dkist_processing_dlnirsp/tests/test_dlnirsp_base.py,sha256=PCFklqGEqrgIhTYcatu7RfOxr_b_XjHotc36MRbUvnk,1853
-dkist_processing_dlnirsp/tests/test_dlnirsp_constants.py,sha256=RFNf-Hj835NlE45vygxh01kJm8YdCJJ3UUwzJRYJHE8,6411
+dkist_processing_dlnirsp/tests/test_dlnirsp_constants.py,sha256=0E7Z4LHBDTAJ8G6TqGL7EU-MGN60Iqze4uZgZJwxqRc,6487
 dkist_processing_dlnirsp/tests/test_dlnirsp_fits_access.py,sha256=5C5NPOkNigoNhIFNUKyrJvyt_mRjke1tkfXQcv1cnPI,5639
 dkist_processing_dlnirsp/tests/test_geometric.py,sha256=94RDg1mGEMTibD2oPOoCKil5yUQMp_0vO4cDWzG3644,7742
 dkist_processing_dlnirsp/tests/test_group_id.py,sha256=TpNllN6OZuYF8almsayk7pRTc4J8TcLGp1SHCBG6QAU,6279
@@ -54,32 +52,32 @@ dkist_processing_dlnirsp/tests/test_ifu_drift.py,sha256=K6ushbVQVE6AATjiP3hEgF6o
 dkist_processing_dlnirsp/tests/test_instrument_polarization_calibration.py,sha256=pPXjfzi3EcaawNqvXsz3OcCF1XITEJeCzQ8-iOjlm7U,23430
 dkist_processing_dlnirsp/tests/test_lamp.py,sha256=umy4ydYR5M3dqXTQP14qbamOleutyD1jSj3325aitl0,3940
 dkist_processing_dlnirsp/tests/test_linearity_correction.py,sha256=JkPNtsRad2JQQ2QiJjQar9tJuCi9-ksOdEYHW_-kl58,31793
-dkist_processing_dlnirsp/tests/test_make_movie_frames.py,sha256=fR1xJEFJMK0xUu8-EyOS_6mIX_ZO2J_nM0k3ud8xtYM,3648
-dkist_processing_dlnirsp/tests/test_parameters.py,sha256=KpBeisM4BIF5Kl6ZxZqk3yCozndmLMlzNgo0ij0hmYw,10328
-dkist_processing_dlnirsp/tests/test_parse.py,sha256=UIII4R6JruUEFIlYDRwTwiBqyf4ldYxAhCWHM-jcd6E,38005
+dkist_processing_dlnirsp/tests/test_movie.py,sha256=j1ocVuy7PZCJrL-MrTczI-mFEsnECyCQ6P8uiK3mokw,4284
+dkist_processing_dlnirsp/tests/test_parameters.py,sha256=bL30vGwFMwY2vP6-mQ-KPsr7I213PaXP7S1wKVPqq8g,10705
+dkist_processing_dlnirsp/tests/test_parse.py,sha256=prx8K0vFGkW-YZm0YB13FBobbiMf0u1k8TuCyNF4_qE,38418
 dkist_processing_dlnirsp/tests/test_quality.py,sha256=OBWva_E6T5RfDuo73LiTdTr7uh2FO04VpBAsSOLfjVQ,6122
-dkist_processing_dlnirsp/tests/test_science.py,sha256=1DKqKNAEZEsVCffYz_TiEc2REG7cBIfGeig1kJK4ZtE,20902
-dkist_processing_dlnirsp/tests/test_solar.py,sha256=jTNnxs5fE8R_hLvmdAU9x4RXJaSpJWGQajL7kzXTxPQ,12111
+dkist_processing_dlnirsp/tests/test_science.py,sha256=2dpNW8-QaFqYeTbTeXqKRSWSns1b9l1iRgfhj8UBAUw,20632
+dkist_processing_dlnirsp/tests/test_solar.py,sha256=0_QpdZFUczXCalhFrXQcMf3SWErbalnVTqV9r0558Pc,15411
 dkist_processing_dlnirsp/tests/test_trial_create_quality_report.py,sha256=5wgj4PhiB-JRl7Sm7EUIvk5DDcFYpytpVLPmMbPuN_Y,2807
-dkist_processing_dlnirsp/tests/test_wavelength_calibration.py,sha256=GFGXtl0KdClolknAwfR0aG5t-Ux5N5mynol4dKp0cn8,14830
+dkist_processing_dlnirsp/tests/test_wavelength_calibration.py,sha256=Yp5A2I8WHrnKha56W_8o5BxVH21jervGsS0thN7ptn0,15028
 dkist_processing_dlnirsp/tests/test_workflows.py,sha256=cRw_c90B-ZXGaw0vVWymYCE-_Ll6mBeM7aHsu-uXewo,290
 dkist_processing_dlnirsp/tests/test_write_l1.py,sha256=J9D1QqCDe0IzYsphA4s_ciDEL0tUUSV1KLm8yo9mxyM,13335
 dkist_processing_dlnirsp/tests/local_trial_workflows/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dkist_processing_dlnirsp/tests/local_trial_workflows/l0_linearize_only.py,sha256=WpO2T2PRDiglwBB3zQDV_3Cq1RSw-ufu_iFjT5aLFJk,6750
-dkist_processing_dlnirsp/tests/local_trial_workflows/l0_polcals_as_science.py,sha256=ZDefUSKggIH2ebzUziQWU_A2yWeX68vjqzC11MNkzJU,19338
-dkist_processing_dlnirsp/tests/local_trial_workflows/l0_solar_gain_as_science.py,sha256=Nv8qi-U2mUpWRn8rfx0ckn6v9OUGbfSND-fX9WVRaU0,20102
-dkist_processing_dlnirsp/tests/local_trial_workflows/l0_to_l1.py,sha256=MfCqHOO9RC24FRqGUKfPiTGUZh7rft9NklYKej-oM00,17757
-dkist_processing_dlnirsp/tests/local_trial_workflows/local_trial_dev_mockers.py,sha256=zEnx_mOTwF8QRM8BZ2Nn0MntfFIkrMVQZDUbmqCmDJk,12191
+dkist_processing_dlnirsp/tests/local_trial_workflows/l0_polcals_as_science.py,sha256=Ms0a_P-d-6dmz_j1hXXQYpF7hfgJljdGjRgAnMampCw,19399
+dkist_processing_dlnirsp/tests/local_trial_workflows/l0_solar_gain_as_science.py,sha256=J_Iijqxy9pYc0olA38QOGV5_pCeoKMojqWtyKAnhL1g,20163
+dkist_processing_dlnirsp/tests/local_trial_workflows/l0_to_l1.py,sha256=jt8oeLKENlSUbOek6hDQAhYeq2zY3FuphmkiP44lnDk,17791
+dkist_processing_dlnirsp/tests/local_trial_workflows/local_trial_dev_mockers.py,sha256=dQ5hYJUXQDx6O7x9eQn3GbKsfcjpB_ylAmQ2N2MPsDI,12198
 dkist_processing_dlnirsp/tests/local_trial_workflows/local_trial_helpers.py,sha256=5abEDqLyJ1mH6RYlV6ReHOqUkUste0vC6raENFQeDNY,21375
 dkist_processing_dlnirsp/tests/local_trial_workflows/translate_files.py,sha256=bsOqBtGE9SdOZL2ROJ-murJHjymYrE_nEPNHJgy7pDc,1882
 dkist_processing_dlnirsp/workflows/__init__.py,sha256=bDRNGCIayR8Z-dcOClvk5nTmHgKORTrZUVX9e3UpCc8,165
-dkist_processing_dlnirsp/workflows/l0_processing.py,sha256=m7zNXo9XoBwXzfiDQTmf4mPgJrTXY15DvqrAXwsx7Mg,4117
-dkist_processing_dlnirsp/workflows/trial_workflow.py,sha256=eqfRtWSuusM-5yvDjlabeCKolAswvw7rOqFEohFjOhI,4732
+dkist_processing_dlnirsp/workflows/l0_processing.py,sha256=walF4jr4qNCZv_YIh2pnmyQ0BEakGtXrS8k1lkzlBNY,3976
+dkist_processing_dlnirsp/workflows/trial_workflow.py,sha256=PCncn1-tDHrcqPziV3LzrCCtgk6dwJpHa4Cx3ff8lQ0,4598
 docs/Makefile,sha256=qnlVz6PuBqE39NfHWuUnHhNEA-EFgT2-WJNNNy9ttfk,4598
 docs/bad_pixel_calibration.rst,sha256=UPBJCG1XWIFMwaR8BnvvbfdEN68s1SJ2nlxsXe1viHU,3403
 docs/changelog.rst,sha256=ZpZPJIyl4nI0Eicku6uSrLdiinNOF2GcZwrvTEsb-Zs,346
 docs/conf.py,sha256=wCcGpP5TUXfMTPgumKu0ZInLxYSuKILyCGi8__Omnmo,2081
-docs/gain.rst,sha256=ytH5AhcCkLlXCKg4enL60p1mBquOv2Bc_T6gvq2-L3Q,4568
+docs/gain.rst,sha256=XyktESmH9kVyp1wtwRdvNshYC1CqA-XBWqsMG2TyhHg,5060
 docs/geometric.rst,sha256=1iI26WJkFbFR0yG_zNbDwiZxU4i0KPtqVkUQL-aKI70,3522
 docs/ifu_drift.rst,sha256=8Hd1XmW9ay2ig__kZJ03ut1_6M6F_NnMqrbSLrIl9tQ,1997
 docs/index.rst,sha256=c2KAA_icOw7Ao3rWVv7lRBTEZ-9JWidL615Xrt6fSq4,378
@@ -94,8 +92,8 @@ docs/science_calibration.rst,sha256=JUMeS7KyIsL9cUuy-IdV2tQ-wQ2lBx6j8u_51ThJzVg,
 docs/scientific_changelog.rst,sha256=01AWBSHg8zElnodCgAq-hMxhk9CkX5rtEENx4iz0sjI,300
 docs/wavelength_calibration.rst,sha256=QGUd5Xmv5f7WQ1EKvw2CcgiMJQULjzdCW1hSQ8h8jj0,4123
 licenses/LICENSE.rst,sha256=piZaQplkzOMmH1NXg6QIdo9wwo9pPCoHkvm2-DmH76E,1462
-dkist_processing_dlnirsp-0.32.8.dist-info/METADATA,sha256=ORbWeb4x6DYDu3wN0vVwL00qSayzvXv-2CEQYqyR-0s,30061
-dkist_processing_dlnirsp-0.32.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-dkist_processing_dlnirsp-0.32.8.dist-info/entry_points.txt,sha256=p4-7cpIfxmQGFUDIP5n5noE5KADHN2-JvV03e0gOx9s,140
-dkist_processing_dlnirsp-0.32.8.dist-info/top_level.txt,sha256=4WmLV9LQM78KTFnkHmtaOJvVHAPpz0m9ruzDS-B_cUo,49
-dkist_processing_dlnirsp-0.32.8.dist-info/RECORD,,
+dkist_processing_dlnirsp-0.33.0.dist-info/METADATA,sha256=4xNQA-3ecQwtXglEbvb5BBaBYSwkSLEC3mpMe7XMUIQ,30900
+dkist_processing_dlnirsp-0.33.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+dkist_processing_dlnirsp-0.33.0.dist-info/entry_points.txt,sha256=p4-7cpIfxmQGFUDIP5n5noE5KADHN2-JvV03e0gOx9s,140
+dkist_processing_dlnirsp-0.33.0.dist-info/top_level.txt,sha256=4WmLV9LQM78KTFnkHmtaOJvVHAPpz0m9ruzDS-B_cUo,49
+dkist_processing_dlnirsp-0.33.0.dist-info/RECORD,,

docs/gain.rst

@@ -14,7 +14,8 @@ polarized beams. We call a single beam from a single slit a "slitbeam"; there ar
 DLNIRSP gain calibration is performed by the `~dkist_processing_dlnirsp.tasks.solar` task using the following procedure.
 The important steps are described in more detail below.
 
-#. Apply dark, lamp, and geometric corrections to all solar gain frames and average them together.
+#. Apply dark, lamp, and geometric corrections to all solar gain frames and average them together. For polarimetric data
+   the average is computed for each modstate and the result is demodulated. The Stokes I frame is then used for subsequent steps.
 
 #. Compute a single characteristic solar spectrum across all slitbeams and place it into the full array.
 
@@ -37,7 +38,9 @@ Algorithm Detail
 Apply Dark, Lamp, and Geometric Corrections
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-This step is mostly how it sounds. Importantly, all solar gain images are divided by the average lamp gain image, which
+This step is mostly how it sounds. For polarimetric data, each modstate is averaged separately and the final "average"
+gain array is taken as the demodulated Stokes I signal. For intensity-mode data, a straight average over all modstates is
+computed. The result (either Stokes I or full average) is then divided by the average lamp gain image, which
 ensures that system illumination differences are not misidentified as true solar signal in the following steps. After
 applying the :doc:`geometric correction </geometric>` all spectra will be on the reference wavelength grid.
 
@@ -59,7 +62,8 @@ geometric corrections. The result is a "raw" array that contains only the solar
 Remove Characteristic Solar Spectra from Raw Solar Gain Frames
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-The re-distorted solar spectra are divided from the dark-corrected solar gain frames. Because we don't use solar gains
+The re-distorted solar spectra are divided from the dark-corrected solar gain frames. For polarimetric data the solar
+spectra are removed from the demodulated Stokes I dark-corrected gain signal. Because we don't use solar gains
 with a lamp correction applied, the resulting gain image includes the full optical response of the system and can be
 applied directly to the science data.
 

dkist_processing_dlnirsp/tasks/assemble_movie.py

@@ -1,150 +0,0 @@
-"""Task for constructing a browse movie."""
-
-from typing import Type
-
-import numpy as np
-from dkist_processing_common.codecs.fits import fits_array_decoder
-from dkist_processing_common.tasks import AssembleMovie
-from dkist_service_configuration.logging import logger
-from PIL import ImageDraw
-from PIL.ImageFont import FreeTypeFont
-
-from dkist_processing_dlnirsp.models.constants import DlnirspConstants
-from dkist_processing_dlnirsp.models.tags import DlnirspTag
-from dkist_processing_dlnirsp.parsers.dlnirsp_l1_fits_acess import DlnirspL1FitsAccess
-
-__all__ = ["AssembleDlnirspMovie"]
-
-
-class AssembleDlnirspMovie(AssembleMovie):
-    """
-    Assemble all DLNIRSP movie frames (tagged with DlnirspTag.movie_frame()) into an mp4 movie file.
-
-    Subclassed from the `AssembleMovie` task in `dkist_processing_common` as required to add DLNIRSP specific
-    text overlays.
-    """
-
-    constants: DlnirspConstants
-
-    MPL_COLOR_MAP = "afmhot"
-
-    @property
-    def constants_model_class(self) -> Type[DlnirspConstants]:
-        """Get DLNIRSP constants."""
-        return DlnirspConstants
-
-    @property
-    def fits_parsing_class(self):
-        """Parse frames as DlnirspL1FitsAccess objects."""
-        return DlnirspL1FitsAccess
-
-    def compute_frame_shape(self) -> tuple[int, int]:
-        """Dynamically set the dimensions of the movie based on L1 file shape."""
-        movie_frame_arrays = self.read(tags=[DlnirspTag.movie_frame()], decoder=fits_array_decoder)
-        random_frame = next(movie_frame_arrays)
-        raw_L1_shape = random_frame.shape
-        flipped_shape = raw_L1_shape[::-1]
-
-        standard_HD_num_pix = 1920 * 1080
-        frame_num_pix = np.prod(flipped_shape)
-        scale_factor = np.sqrt(standard_HD_num_pix / frame_num_pix)
-        scaled_shape = tuple(int(i * scale_factor) for i in flipped_shape)
-
-        return scaled_shape
-
-    def pre_run(self) -> None:
-        """Set the movie frame shape prior to running."""
-        super().pre_run()
-        frame_shape = self.compute_frame_shape()
-        logger.info(f"Setting movie shape to {frame_shape}")
-        self.MOVIE_FRAME_SHAPE = frame_shape
-
-    @property
-    def num_images(self) -> int:
-        """
-        Total number of images in final movie.
-
-        Overloaded from `dkist-processing-common` so we can handle all the levels of instrument looping.
-        """
-        return (
-            self.constants.num_mosaic_repeats
-            * self.constants.num_dither_steps
-            * self.constants.num_mosaic_tiles
-        )
-
-    def tags_for_image_n(self, n: int) -> list[str]:
-        """Return tags that grab the n'th movie image.
-
-        Overloaded from `dkist-processing-common` so we can handle all the levels of instrument looping.
-        """
-        mosaic_num = n // (self.constants.num_dither_steps * self.constants.num_mosaic_tiles)
-        dither_step = (n // self.constants.num_mosaic_tiles) % self.constants.num_dither_steps
-        tile_num = n % self.constants.num_mosaic_tiles
-        X_tile, Y_tile = np.unravel_index(
-            tile_num, (self.constants.num_mosaic_tiles_x, self.constants.num_mosaic_tiles_y)
-        )
-        # mosaic tile nums are 1-indexed
-        X_tile += 1
-        Y_tile += 1
-
-        tags = [
-            DlnirspTag.mosaic_num(mosaic_num),
-            DlnirspTag.dither_step(dither_step),
-            DlnirspTag.mosaic_tile_x(X_tile),
-            DlnirspTag.mosaic_tile_y(Y_tile),
-        ]
-        logger.info(f"AssembleMovie.tags_for_image_n: {tags = }")
-        return tags
-
-    def write_overlay(self, draw: ImageDraw, fits_obj: DlnirspL1FitsAccess) -> None:
-        """
-        Mark each movie frame the instrument, wavelength, and observe time.
-
-        Additionally, add labels for the 4 Stokes sub-frames if the data are polarimetric.
-        """
-        self.write_line(
-            draw=draw,
-            text=f"INSTRUMENT: {self.constants.instrument}",
-            line=3,
-            column="right",
-            font=self.font_36,
-        )
-        self.write_line(
-            draw=draw,
-            text=f"WAVELENGTH: {fits_obj.wavelength} nm",
-            line=2,
-            column="right",
-            font=self.font_36,
-        )
-        self.write_line(
-            draw=draw,
-            text=f"OBS TIME: {fits_obj.time_obs}",
-            line=1,
-            column="right",
-            font=self.font_36,
-        )
-
-        if self.constants.correct_for_polarization:
-            # The `line` on which an item is drawn is a multiple of the height of that line.
-            IQ_line = self.get_middle_line(draw=draw, text="I  Q", font=self.font_36)
-
-            # Subtract 1 from the UV line so that it's below IQ_line
-            UV_line = IQ_line - 1
-
-            self.write_line(
-                draw=draw, text="I   Q", line=IQ_line, column="middle", font=self.font_36
-            )
-            self.write_line(
-                draw=draw, text="U   V", line=UV_line, column="middle", font=self.font_36
-            )
-
-    def get_middle_line(self, draw: ImageDraw, text: str, font: FreeTypeFont) -> int:
-        """
-        Get the line number for the middle of the frame.
-
-        We need to compute this in real time because the frame size is dynamically based on the L1 file shape.
-        """
-        _, _, _, text_height = draw.textbbox(xy=(0, 0), text=text, font=font)
-        # See `write_line` in `dkist-processing-common` for why this is the expression.
-        line = (self.MOVIE_FRAME_SHAPE[1] // 2) / (self.TEXT_MARGIN_PX + text_height)
-        return line

dkist_processing_dlnirsp/tasks/make_movie_frames.py

@@ -1,156 +0,0 @@
-"""Task for turning output science frames into movie frames."""
-
-import numpy as np
-from astropy.io import fits
-from astropy.visualization import ZScaleInterval
-from dkist_processing_common.codecs.fits import fits_array_encoder
-from dkist_processing_common.codecs.fits import fits_hdu_decoder
-from dkist_service_configuration.logging import logger
-
-from dkist_processing_dlnirsp.models.tags import DlnirspTag
-from dkist_processing_dlnirsp.tasks.dlnirsp_base import DlnirspTaskBase
-
-__all__ = ["MakeDlnirspMovieFrames"]
-
-
-class MakeDlnirspMovieFrames(DlnirspTaskBase):
-    """Task class for making individual movie frames that will be used for the browse movie."""
-
-    def run(self) -> None:
-        """
-        Construct movie frames from the set of output science frames.
-
-        For now just make a single movie frame for every output frame. If the data are polarimetric then all 4
-        Stokes images will be put together in a grid.
-        """
-        if self.constants.correct_for_polarization:
-            logger.info("Making polarimetric movie frames")
-        else:
-            logger.info("Making spectrographic movie frames")
-
-        self.make_movie_frames()
-
-    def make_movie_frames(self):
-        """Make a movie frame for every output frame."""
-        for mosaic_num in range(self.constants.num_mosaic_repeats):
-            for dither_step in range(self.constants.num_dither_steps):
-                for X_tile in range(1, self.constants.num_mosaic_tiles_x + 1):
-                    for Y_tile in range(1, self.constants.num_mosaic_tiles_y + 1):
-                        if self.constants.correct_for_polarization:
-                            data, header = self.make_single_polarimetric_frame(
-                                mosaic_num=mosaic_num,
-                                dither_step=dither_step,
-                                X_tile_num=X_tile,
-                                Y_tile_num=Y_tile,
-                            )
-                        else:
-                            data, header = self.make_single_spectrographic_frame(
-                                mosaic_num=mosaic_num,
-                                dither_step=dither_step,
-                                X_tile_num=X_tile,
-                                Y_tile_num=Y_tile,
-                            )
-
-                        self.write(
-                            data=data,
-                            header=header,
-                            tags=[
-                                DlnirspTag.movie_frame(),
-                                DlnirspTag.mosaic_num(mosaic_num),
-                                DlnirspTag.dither_step(dither_step),
-                                DlnirspTag.mosaic_tile_x(X_tile),
-                                DlnirspTag.mosaic_tile_y(Y_tile),
-                            ],
-                            encoder=fits_array_encoder,
-                        )
-
-    def make_single_polarimetric_frame(
-        self, mosaic_num: int, dither_step: int, X_tile_num: int, Y_tile_num: int
-    ) -> tuple[np.ndarray, fits.Header]:
-        """
-        Extract and grid together all 4 Stokes frames for a given instrument loop tuple.
-
-        The data are also scaled for visual appeal.
-        """
-        stokes_dict = dict()
-        for stokes in self.constants.stokes_params:
-            tags = [
-                DlnirspTag.frame(),
-                DlnirspTag.calibrated(),
-                DlnirspTag.mosaic_num(mosaic_num),
-                DlnirspTag.dither_step(dither_step),
-                DlnirspTag.mosaic_tile_x(X_tile_num),
-                DlnirspTag.mosaic_tile_y(Y_tile_num),
-            ]
-            hdu = next(self.read(tags=tags, decoder=fits_hdu_decoder))
-            data_2D = self.grab_wavelength_slice(hdu.data)
-            stokes_dict[stokes] = self.scale_for_rendering(data_2D)
-
-        # Don't care which hdu we get
-        header = hdu.header
-        movie_array = self.grid_movie_frame(
-            top_left=stokes_dict["I"],
-            top_right=stokes_dict["Q"],
-            bottom_left=stokes_dict["U"],
-            bottom_right=stokes_dict["V"],
-        )
-        return movie_array, header
-
-    def make_single_spectrographic_frame(
-        self, mosaic_num: int, dither_step: int, X_tile_num: int, Y_tile_num: int
-    ) -> tuple[np.ndarray, fits.Header]:
-        """Load a output spectrographic frame, extract a single wavelength, and scale for visual appeal."""
-        tags = [
-            DlnirspTag.frame(),
-            DlnirspTag.calibrated(),
-            DlnirspTag.mosaic_num(mosaic_num),
-            DlnirspTag.dither_step(dither_step),
-            DlnirspTag.mosaic_tile_x(X_tile_num),
-            DlnirspTag.mosaic_tile_y(Y_tile_num),
-        ]
-        hdu = next(self.read(tags=tags, decoder=fits_hdu_decoder))
-
-        data_2D = self.grab_wavelength_slice(hdu.data)
-        scaled_data = self.scale_for_rendering(data_2D)
-
-        movie_array = self.scale_for_rendering(scaled_data)
-
-        return movie_array, hdu.header
-
-    @staticmethod
-    def grab_wavelength_slice(data: np.ndarray):
-        """Convert a 3D IFU image into a 2D movie frame by extracting a certain wavelength region."""
-        wavelength_dim_size = data.shape[0]
-        middle_index = int(np.mean(range(wavelength_dim_size)))
-        return data[middle_index, :, :]
-
-    @staticmethod
-    def scale_for_rendering(data: np.ndarray):
-        """
-        Scale the output frame data using a normalization function to facilitate display as a movie frame.
-
-        Non-number pixels (nan, inf, -inf) are set to black.
-        """
-        bad_idx = ~np.isfinite(data)
-        data[bad_idx] = np.nanmedian(data)
-        zscale = ZScaleInterval()
-        scaled_data = zscale(data)
-        scaled_data[bad_idx] = 0.0
-        return scaled_data
-
-    @staticmethod
-    def grid_movie_frame(
-        top_left: np.ndarray,
-        top_right: np.ndarray,
-        bottom_left: np.ndarray,
-        bottom_right: np.ndarray,
-    ) -> np.ndarray:
-        """Combine multiple arrays into a 2x2 grid."""
-        result = np.concatenate(
-            (
-                np.concatenate((top_left, top_right), axis=1),
-                np.concatenate((bottom_left, bottom_right), axis=1),
-            ),
-            axis=0,
-        )
-        return result

dkist_processing_dlnirsp/tests/test_assemble_movie.py

@@ -1,169 +0,0 @@
-import numpy as np
-import pytest
-from dkist_processing_common._util.scratch import WorkflowFileSystem
-from moviepy.video.io.VideoFileClip import VideoFileClip
-
-from dkist_processing_dlnirsp.models.tags import DlnirspTag
-from dkist_processing_dlnirsp.tasks.assemble_movie import AssembleDlnirspMovie
-from dkist_processing_dlnirsp.tests.conftest import DlnirspTestingConstants
-from dkist_processing_dlnirsp.tests.conftest import MovieFrameHeaders
-from dkist_processing_dlnirsp.tests.conftest import tag_on_mosaic_dither_loops
-from dkist_processing_dlnirsp.tests.conftest import write_frames_to_task
-
-
-def write_movie_frames_to_task(
-    task,
-    dither_mode_on: bool,
-    num_mosaics: int,
-    num_X_tiles: int,
-    num_Y_tiles: int,
-    array_shape: tuple[int, int],
-) -> int:
-    dataset = MovieFrameHeaders(
-        dither_mode_on=dither_mode_on,
-        num_mosaics=num_mosaics,
-        num_X_tiles=num_X_tiles,
-        num_Y_tiles=num_Y_tiles,
-        array_shape=array_shape,
-    )
-
-    num_written_frames = write_frames_to_task(
-        task=task,
-        frame_generator=dataset,
-        extra_tags=[
-            DlnirspTag.movie_frame(),
-        ],
-        tag_func=tag_on_mosaic_dither_loops,
-        data_func=make_movie_frame_data,
-    )
-    return num_written_frames
-
-
-def make_movie_frame_data(frame: MovieFrameHeaders) -> np.ndarray:
-    shape = frame.array_shape[1:]
-    data = np.zeros(shape)
-    total_frames = frame.dataset_shape[0]
-    current_index = frame.index + 1
-    horizontal_frac = int((current_index / total_frames) * shape[0])
-    data[:horizontal_frac, :] = 1.0
-
-    return data
-
-
-@pytest.fixture
-def assemble_movie_task(recipe_run_id, dither_mode_on, tmp_path, link_constants_db):
-    num_mosaics = 4
-    num_X_tiles = 3
-    num_Y_tiles = 2
-
-    constants = DlnirspTestingConstants(
-        NUM_MOSAIC_REPEATS=num_mosaics,
-        NUM_MOSAIC_TILES_X=num_X_tiles,
-        NUM_MOSAIC_TILES_Y=num_Y_tiles,
-        NUM_DITHER_STEPS=int(dither_mode_on) + 1,
-    )
-    link_constants_db(recipe_run_id, constants)
-
-    with AssembleDlnirspMovie(
-        recipe_run_id=recipe_run_id,
-        workflow_name="workflow_name",
-        workflow_version="workflow_version",
-    ) as task:
-        task.scratch = WorkflowFileSystem(scratch_base_path=tmp_path, recipe_run_id=recipe_run_id)
-
-        yield task, num_mosaics, num_X_tiles, num_Y_tiles
-        task._purge()
-
-
-@pytest.mark.parametrize("dither_mode_on", [pytest.param(True, id="dither_mode_on")])
-@pytest.mark.parametrize(
-    "is_polarimetric, requires_shrinking",
-    [
-        pytest.param(True, True, id="polarimetric_shrink"),
-        pytest.param(False, False, id="spectrographic_noshrink"),
-        pytest.param(True, False, id="polarimetric_noshrink"),
-    ],
-)
-def test_assemble_movie(
-    assemble_movie_task,
-    dither_mode_on,
-    is_polarimetric,
-    requires_shrinking,
-    mocker,
-    fake_gql_client,
-):
-    """
-    Given: An AssembleDlnirspMovie task and associated MOVIE_FRAME files
-    When: Running the task
-    Then: A movie is generated with the correct size
-    """
-    mocker.patch(
-        "dkist_processing_common.tasks.mixin.metadata_store.GraphQLClient", new=fake_gql_client
-    )
-    task, num_mosaics, num_X_tiles, num_Y_tiles = assemble_movie_task
-
-    if requires_shrinking:
-        movie_shape = (1080 * 2, 1920 * 2)  # Intentionally "backward" from normal
-        expected_shape = (1080, 1920)[::-1]
-    else:
-        movie_shape = (1920 // 2 - 1, 1080 // 2 - 1)  # Weird aspect ratio
-        expected_shape = (1920, 1080)[::-1]  # Because AssembleMovie will force even dimensions
-    write_movie_frames_to_task(
-        task,
-        dither_mode_on=dither_mode_on,
-        num_mosaics=num_mosaics,
-        num_X_tiles=num_X_tiles,
-        num_Y_tiles=num_Y_tiles,
-        array_shape=movie_shape,
-    )
-
-    task()
-
-    movie_file = list(task.read(tags=[DlnirspTag.movie()]))
-    assert len(movie_file) == 1
-    assert movie_file[0].exists()
-    clip = VideoFileClip(str(movie_file[0]))
-    assert tuple(clip.size) == expected_shape
-
-    # import os
-    # os.system(f"cp {movie_file[0]} foo.mp4")
-
-
-@pytest.mark.parametrize(
-    "dither_mode_on",
-    [pytest.param(True, id="dither_mode_on"), pytest.param(False, id="dither_mode_off")],
-)
-def test_tags_for_images(assemble_movie_task, dither_mode_on):
-    """
-    Given: A `AssembleDlnirspMovie` task with constants describing the number of L1 frames
-    When: Computing the tags for a certain movie image
-    Then: The correct tags are returned
-    """
-    task, num_mosaics, num_X_tiles, num_Y_tiles = assemble_movie_task
-    num_dither = int(dither_mode_on) + 1
-
-    assert task.num_images == num_mosaics * num_dither * num_X_tiles * num_Y_tiles
-
-    expected_mosaic_values = sum(
-        [[i for _ in range(num_X_tiles * num_Y_tiles * num_dither)] for i in range(num_mosaics)], []
-    )
-    expected_dither_values = (
-        sum([[d] * num_X_tiles * num_Y_tiles for d in range(num_dither)], []) * num_mosaics
-    )
-    expected_X_tile_values = (
-        sum([[i for _ in range(num_Y_tiles)] for i in range(1, num_X_tiles + 1)] * num_mosaics, [])
-        * num_dither
-    )
-    expected_Y_tile_values = (
-        list(range(1, num_Y_tiles + 1)) * num_X_tiles * num_mosaics * num_dither
-    )
-
-    for n in range(task.num_images):
-        assert sorted(task.tags_for_image_n(n)) == sorted(
-            [
-                DlnirspTag.mosaic_num(expected_mosaic_values[n]),
-                DlnirspTag.dither_step(expected_dither_values[n]),
-                DlnirspTag.mosaic_tile_x(expected_X_tile_values[n]),
-                DlnirspTag.mosaic_tile_y(expected_Y_tile_values[n]),
-            ]
-        )