8000 JP-2299: Change residual fringe step reference models to FringeFreqModel by jemorrison · Pull Request #6385 · spacetelescope/jwst · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

JP-2299: Change residual fringe step reference models to FringeFreqModel #6385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Oct 8, 2021

Conversation

jemorrison
Copy link
Collaborator
@jemorrison jemorrison commented Oct 6, 2021

Closes #6381
Resolves JP-2299

Description

To be consistent with reference type the ResidualFringeModel was changed to FringeFreqModel. In addition, the argument 'transmission_level' was removed from options. This should not be something the user can change.

Checklist

  • Tests
  • Documentation
  • Change log
  • Milestone
  • Label(s)

@jemorrison jemorrison added this to the Build 7.9 milestone Oct 6, 2021
@jemorrison jemorrison self-assigned this Oct 6, 2021
@codecov
Copy link
codecov bot commented Oct 6, 2021

Codecov Repo 8000 rt

Merging #6385 (6625367) into master (bae21b6) will decrease coverage by 0.34%.
The diff coverage is 66.66%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #6385      +/-   ##
==========================================
- Coverage   77.59%   77.25%   -0.35%     
==========================================
  Files         408      409       +1     
  Lines       34895    35070     +175     
==========================================
+ Hits        27077    27092      +15     
- Misses       7818     7978     +160     
Flag Coverage Δ *Carryforward flag
nightly 77.60% <50.00%> (ø) Carriedforward from 598d019
unit 56.39% <80.00%> (-0.01%) ⬇️

*This pull request uses carry forward flags. Click here to find out more.

Impacted Files Coverage Δ
jwst/residual_fringe/residual_fringe_step.py 12.08% <0.00%> (-1.76%) ⬇️
jwst/datamodels/__init__.py 100.00% <100.00%> (ø)
jwst/datamodels/fringefreq.py 100.00% <100.00%> (ø)
jwst/extract_1d/extract.py 70.96% <0.00%> (-6.51%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bae21b6...6625367. Read the comment docs.

Copy link
Collaborator
@stscieisenhamer stscieisenhamer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple of minor comments, but otherwise LGTM.

Any documentation changes needed? Or is that another PR?

CHANGES.rst Outdated
@@ -2020,6 +2020,8 @@ residual_fringe
- Fixed an error when a filename was give as the input to apply the residual fringe correction [#6349]

- Updated residual fringe reference data model to support new delivery of reference files [#6357]

- Changed the model for reference file from ResidualFringeModel to FringeFreq [#6385]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy: extra space between "for" and "reference", possible word missing?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about "Changed reference file model name from ResidualFringeModel to FringeFreqModel"

@@ -29,6 +28,9 @@ class ResidualFringeStep(Step):

def process(self, input):

self.transmission_level = 80 # sets the transmission level to use in the regions file
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Slightly cleaner code would be to set this as a class-level attribute. Easier to override, if necessary, by subclasses, etc. Example:

class ResidualFringeStep:

    transmission_level = 80 # sets the transmission level to use in the regions file

    ...

@hbushouse hbushouse changed the title Change residual fringe step reference models to FringeFreqModel - JP-2299 JP-2299: Change residual fringe step reference models to FringeFreqModel Oct 8, 2021
CHANGES.rst Outdated
@@ -2020,6 +2020,8 @@ residual_fringe
- Fixed an error when a filename was give as the input to apply the residual fringe correction [#6349]

- Updated residual fringe reference data model to support new delivery of reference files [#6357]

- Changed reference file model name from ResidualFringeModel to FringeFreq [#6385]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This new entry is waaaay down in the change log, in the section for Cal 0.15.0. We're way beyond that. This should be up at the top in the section for 1.4.0.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, and the new model name is FringeFreqModel, not FringeFreq

@jemorrison
Copy link
Collaborator Author

I moved the change entry to datamodels and the correct version version of the pipeline. It was more a data models issue rather than residual_fringe change. At least I think it should go data models changes ?

@@ -75,6 +75,8 @@ datamodels
and regions files. Fix an incorrect comment on
FilteroffsetModel. [#6362]

- Changed reference file model name from ResidualFringeModel to FringeFreq [#6385]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree it's appropriate for this to go in the datamodels section. But the new name shown here is still incorrect: should be FringeFreqModel

@jemorrison jemorrison merged commit e37c4ac into spacetelescope:master Oct 8, 2021
@jemorrison jemorrison deleted the Update_FringeModel branch November 4, 2021 22:00
loicalbert pushed a commit to talensgj/jwst that referenced this pull request Nov 5, 2021
…del (spacetelescope#6385)

* Change residual fringe step reference models to FringeFreqModel

* Update change log

* fix import of FringeFreq

* flake8 fix

* update change log

* moved change log entry to correct version
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename ResidualFringeModel to better match reftype name fringefreq
3 participants
0