Skip to content
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.

Sign up for GitHub

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

update monthly trending plot to allow shifted date ranges #943

Merged
merged 1 commit into from
Dec 4, 2024
Merged

update monthly trending plot to allow shifted date ranges #943

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 23 additions & 8 deletions webbpsf/trending.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1106,12 +1106,16 @@ def filter_opdtable_for_daterange(start_date, end_date, opdtable):
return opdtable


def filter_opdtable_for_month(year, mon, opdtable):
def filter_opdtable_for_month(year, mon, opdtable, shift_dates_offset=None):
"""Filter existing opdtable for a given month
This includes the last measurement in the prior month too (if applicable), so we can compute a delta
to the first one
"""
start_date, end_date = get_month_start_end(year, mon)
if shift_dates_offset:
start_date += shift_dates_offset * u.day
end_date += shift_dates_offset * u.day

return filter_opdtable_for_daterange(start_date, end_date, opdtable)


Expand All @@ -1129,15 +1133,15 @@ def get_opdtable_for_daterange(start_date, end_date):
return opdtable


def get_opdtable_for_month(year, mon):
def get_opdtable_for_month(year, mon, **kwargs):
"""Return table of OPD measurements for a given month.
retrieve the opd table and filter according to month/year designation
"""
# Retrieve full OPD table, then trim to the selected time period
opdtable0 = webbpsf.mast_wss.retrieve_mast_opd_table()
opdtable0 = webbpsf.mast_wss.deduplicate_opd_table(opdtable0)

opdtable = filter_opdtable_for_month(year, mon, opdtable0)
opdtable = filter_opdtable_for_month(year, mon, opdtable0, **kwargs)
return opdtable


Expand Down Expand Up @@ -1196,7 +1200,8 @@ def get_dates_for_pid(pid, project='jwst'):
return


def monthly_trending_plot(year, month, verbose=True, instrument='NIRCam', filter='F200W', vmax=200, pid=None, opdtable=None):
def monthly_trending_plot(year, month, verbose=True, instrument='NIRCam', filter='F200W', vmax=200, pid=None, opdtable=None,
shift_dates_offset=None):
"""Make monthly trending plot showing OPDs, mirror moves, RMS WFE, and the resulting PSF EEs

year, month : integers
Expand All @@ -1209,6 +1214,8 @@ def monthly_trending_plot(year, month, verbose=True, instrument='NIRCam', filter
Image display vmax for OPDs, given here in units of nanometers.
opdtable : astropy.table.Table
Table of available OPDs, Default None: as returned by retrieve_mast_opd_table()
shift_dates_offset: int
number of dates to shift later the time period, for showing trends around the month divisions
"""

def vprint(*text):
Expand All @@ -1217,6 +1224,10 @@ def vprint(*text):

start_date, end_date = get_month_start_end(year, month)

if shift_dates_offset:
start_date += shift_dates_offset * u.day
end_date += shift_dates_offset * u.day

# Look up wavefront sensing and mirror move corrections for that month
if pid:
pid_dates = get_dates_for_pid(pid)
Expand All @@ -1228,11 +1239,11 @@ def vprint(*text):
try:
if opdtable is None:
vprint('obtaining opdtable for month')
opdtable = get_opdtable_for_month(year, month)
opdtable = get_opdtable_for_month(year, month, shift_dates_offset=shift_dates_offset)
else:
vprint('filtering opdtable for month')
opdtable = check_colnames(opdtable)
opdtable = filter_opdtable_for_month(year, month, opdtable)
opdtable = filter_opdtable_for_month(year, month, opdtable, shift_dates_offset=shift_dates_offset)
except ValueError as e:
print(e)
raise
Expand Down Expand Up @@ -1342,7 +1353,8 @@ def basic_show_image(image, ax, vmax=0.3, nanmask=1):

fs = 14 # Font size for axes labels

fig.suptitle(f'WF Trending for {year}-{month:02d}', fontsize=fs * 1.5, fontweight='bold')
title_extra = f", plus {shift_dates_offset} days" if shift_dates_offset else ""
fig.suptitle(f'WF Trending for {year}-{month:02d}{title_extra}', fontsize=fs * 1.5, fontweight='bold')

# Plot 1: Wavefront Error

Expand Down Expand Up @@ -1518,7 +1530,10 @@ def basic_show_image(image, ax, vmax=0.3, nanmask=1):
for i in range(3):
im_axes[i, j].set_visible(False)

outname = f'wf_trending_{year}-{month:02d}.pdf'
if shift_dates_offset:
outname = f'wf_trending_{year}-{month:02d}+{shift_dates_offset}days.pdf'
else:
outname = f'wf_trending_{year}-{month:02d}.pdf'
plt.savefig(outname, dpi=200, bbox_inches='tight')
vprint(f'Saved to {outname}')

Expand Down
Loading