RAD-175: Add ePSF, ABVegaOffset, and ApCorr Schemas #452

PaulHuwe · 2024-09-27T19:33:21Z

Resolves RAD-175

Closes #

This PR adds schemas for PSF, AB Vega Offsets, and Aperture Corrections.

Tasks

Update or add relevant rad tests.
Update relevant docstrings and / or docs/ page.
Does this PR change any schema files?
- Schema changes were discussed at RAD Review Board meeting.
Does this PR change any API used downstream? (If not, label with no-changelog-entry-needed.)
- Write news fragment(s) in changes/: echo "changed something" > changes/<PR#>.<changetype>.rst (see below for change types).
- Start a romancal regression test (https://github.com/spacetelescope/RegressionTests/actions/workflows/romancal.yml) with this branch installed ("git+https://github.com/<fork>/rad@<branch>").
- Update relevant roman_datamodels utilities and tests.

News fragment change types:

changes/<PR#>.feature.rst: new feature
changes/<PR#>.bugfix.rst: fixes an issue
changes/<PR#>.doc.rst: documentation change
changes/<PR#>.removal.rst: deprecation or removal of public API
changes/<PR#>.misc.rst: infrastructure or miscellaneous change

codecov · 2024-09-27T19:35:38Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.81%. Comparing base (810c17f) to head (f256f30).
Report is 8 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #452   +/-   ##
=======================================
  Coverage   95.81%   95.81%           
=======================================
  Files           4        4           
  Lines         215      215           
=======================================
  Hits          206      206           
  Misses          9        9

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

…-175_PSFetalSchema

schlafly · 2024-09-30T20:27:42Z

src/rad/resources/schemas/reference_files/abvegaoffset-1.0.0.yaml

+      GRISM:
+        type: object
+        properties:
+          abvega_offset:
+            title: AB-Vega Magntiude Offset
+            description: Magnitude difference between the AB and Vega magnitude
+                systems. Found by calculating the AB magnitude of Vega within
+                the GRISM optical element bandpass.
+            type: number
+        required: [abvega_offset]
+      PRISM:
+        type: object
+        properties:
+          abvega_offset:
+            title: AB-Vega Magntiude Offset
+            description: Magnitude difference between the AB and Vega magnitude
+                systems. Found by calculating the AB magnitude of Vega within
+                the PRISM optical element bandpass.
+            type: number
+        required: [abvega_offset]


@tddesjardins , just for my edification, we do not currently ever plan to use these in the pipeline? These are the integrals over the full grism data, so that if that were a magnitude we ever computed, this would be the AB-Vega magnitude offset?

I am not aware of anything in the exposure or mosaic pipelines that would use this file. I was just chatting with Will, and I think in theory this could be used for L4 source catalogs or for user reference. (Frankly, I was questioning why this information just isn't in the photom file.)

I agree that the AB - Vega offsets could also go in the photom files. If we're duplicating Webb that's fine motivation for keeping it separate, but I agree that this is very parallel to the information in the photom files.

It is my understanding that this is what Webb did, but I would be in favor of combining the reference files instead of having 1 very basic file.

I would also prefer this in PHOTOM, but, it appears to be separate in JWST:
https://github.com/spacetelescope/jwst/blob/e5c73fa23d157f4aa65416b4070c2b838e978494/docs/jwst/references_general/abvegaoffset_reffile.inc

src/rad/resources/schemas/reference_files/apcorr-1.0.0.yaml

schlafly · 2024-09-30T20:35:29Z

src/rad/resources/schemas/reference_files/epsf-1.0.0.yaml

+          effective_temperature:
+            title: Effective Temperature
+            description: Effective temperature (K) of the simulated source(s)
+                used to generate the PSF model.
+            type: array
+            items:
+                type: integer


@tddesjardins , somewhere we should document things like what the metallicity & gravity of the source were---or maybe this is an ideal blackbody? I don't know where that documentation would go.

I don't know if there's a world where we would ever expect the temperature of Roman to vary enough to lead us to have different PSFs as a function of temperature, but if there were, we would probably rue calling this "effective_temperature."

The info on that is in the description or history of the file. I can't recall which I put it into. But it's thoroughly documented, believe me.

As for temperature, these are models for the moment, so we have effective temperatures. We spoke about how the on-orbit version of this will likely need a small schema change to represent observables, so it may be color, for instance. As for some kind of spacecraft temperature, we still won't know for a while, but my best guess is that it's likely to depend on something like ota_temperature, i.e., temperature measured somewhere in the primary/secondary mirror assembly. I just asked a GSFC person next to me, and they basically said this is unknowable at this point.

Right, I understand that these are stellar effective temperatures, I just wonder whether we're setting ourselves up for confusion if there ends up being another axis "ota_temperature" and then one starts wondering what the effective temperature is the effective temperature of. i.e., would we save confusion if we called these "stellar_effective_temperature" instead. If you expect we'll change the name of this down the road to color or something instead then there's no need to worry about this now, though.

I have concerns that if we enter this in as a "model only" keyword, we will have to make an entirely different schema & datamodel for release (which may have future downstream ramifications). If RTB wishes to keep the two separate, this is fine, but if we want to be able to use both interchangeably, I support renaming in a form similar to what @schlafly suggested. @tddesjardins - what say you?

tddesjardins · 2024-10-01T14:02:25Z

src/rad/resources/schemas/reference_files/abvegaoffset-1.0.0.yaml

+      GRISM:
+        type: object
+        properties:
+          abvega_offset:
+            title: AB-Vega Magntiude Offset
+            description: Magnitude difference between the AB and Vega magnitude
+                systems. Found by calculating the AB magnitude of Vega within
+                the GRISM optical element bandpass.
+            type: number
+        required: [abvega_offset]
+      PRISM:
+        type: object
+        properties:
+          abvega_offset:
+            title: AB-Vega Magntiude Offset
+            description: Magnitude difference between the AB and Vega magnitude
+                systems. Found by calculating the AB magnitude of Vega within
+                the PRISM optical element bandpass.
+            type: number
+        required: [abvega_offset]


I am not aware of anything in the exposure or mosaic pipelines that would use this file. I was just chatting with Will, and I think in theory this could be used for L4 source catalogs or for user reference. (Frankly, I was questioning why this information just isn't in the photom file.)

tddesjardins · 2024-10-01T15:58:43Z

src/rad/resources/schemas/reference_files/epsf-1.0.0.yaml

+          effective_temperature:
+            title: Effective Temperature
+            description: Effective temperature (K) of the simulated source(s)
+                used to generate the PSF model.
+            type: array
+            items:
+                type: integer


The info on that is in the description or history of the file. I can't recall which I put it into. But it's thoroughly documented, believe me.

As for temperature, these are models for the moment, so we have effective temperatures. We spoke about how the on-orbit version of this will likely need a small schema change to represent observables, so it may be color, for instance. As for some kind of spacecraft temperature, we still won't know for a while, but my best guess is that it's likely to depend on something like ota_temperature, i.e., temperature measured somewhere in the primary/secondary mirror assembly. I just asked a GSFC person next to me, and they basically said this is unknowable at this point.

tddesjardins · 2024-10-03T15:23:35Z

src/rad/resources/schemas/reference_files/epsf-1.0.0.yaml

+        required: [pixel_x, pixel_y]
+  psf:
+    title: ePSF Stamps
+    description: Postage stamps of ePSF models. The 3-dimensional array is


I just saw this typo in the description...the arrays are 4-dimensional, which is what ndim says, but the description says "The 3-dimensional array...". This should be changed to 4-dimensional.

src/rad/resources/schemas/reference_files/epsf-1.0.0.yaml

* Initial commit. * Added Changelog. * Simplified schemas. * Addressed PR comments. * Update src/rad/resources/schemas/reference_files/epsf-1.0.0.yaml

Initial commit.

4fd2116

PaulHuwe added 2 commits September 27, 2024 15:43

Added Changelog.

72fb9be

Merge branch 'main' of https://github.com/spacetelescope/rad into RAD…

e0c5de5

…-175_PSFetalSchema

PaulHuwe marked this pull request as ready for review September 27, 2024 19:48

PaulHuwe requested a review from a team as a code owner September 27, 2024 19:48

PaulHuwe requested review from schlafly, tddesjardins and wcschultz September 27, 2024 19:48

This was referenced Sep 27, 2024

APCORR, ABVEGAOFFSET, and EPSF Reference File Schema Creation spacetelescope/romancal#1403

Closed

APCORR, ABVEGAOFFSET, and EPSF Reference File Schema #450

Closed

schlafly reviewed Sep 30, 2024

View reviewed changes

tddesjardins approved these changes Oct 1, 2024

View reviewed changes

PaulHuwe and others added 3 commits October 2, 2024 19:22

Simplified schemas.

12576f9

Addressed PR comments.

0dd5c38

Merge branch 'main' into RAD-175_PSFetalSchema

4e79820

PaulHuwe requested a review from schlafly October 2, 2024 23:32

tddesjardins reviewed Oct 3, 2024

View reviewed changes

PaulHuwe commented Oct 3, 2024

View reviewed changes

src/rad/resources/schemas/reference_files/epsf-1.0.0.yaml Outdated Show resolved Hide resolved

PaulHuwe added 2 commits October 3, 2024 12:10

Update src/rad/resources/schemas/reference_files/epsf-1.0.0.yaml

4496f10

Merge branch 'main' into RAD-175_PSFetalSchema

3127e72

PaulHuwe requested a review from WilliamJamieson as a code owner October 11, 2024 02:23

Merge branch 'main' into RAD-175_PSFetalSchema

f256f30

PaulHuwe merged commit b61c261 into spacetelescope:main Oct 11, 2024
13 checks passed

PaulHuwe deleted the RAD-175_PSFetalSchema branch October 11, 2024 02:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RAD-175: Add ePSF, ABVegaOffset, and ApCorr Schemas #452

RAD-175: Add ePSF, ABVegaOffset, and ApCorr Schemas #452

PaulHuwe commented Sep 27, 2024

codecov bot commented Sep 27, 2024 •

edited

Loading

schlafly Sep 30, 2024

tddesjardins Oct 1, 2024

schlafly Oct 1, 2024

wcschultz Oct 1, 2024

PaulHuwe Oct 1, 2024

schlafly Sep 30, 2024

tddesjardins Oct 1, 2024

schlafly Oct 1, 2024

PaulHuwe Oct 2, 2024

tddesjardins Oct 1, 2024

tddesjardins Oct 1, 2024

tddesjardins Oct 3, 2024

RAD-175: Add ePSF, ABVegaOffset, and ApCorr Schemas #452

RAD-175: Add ePSF, ABVegaOffset, and ApCorr Schemas #452

Conversation

PaulHuwe commented Sep 27, 2024

Tasks

codecov bot commented Sep 27, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Sep 27, 2024 •

edited

Loading