Inheritance diagram for lsst.jointcal.utils.JointcalStatistics:
Public Member Functions | |
| def | __init__ (self, match_radius=0.1 *arcseconds, flux_limit=100.0, do_photometry=True, do_astrometry=True, verbose=False) |
| def | compute_rms (self, data_refs, reference) |
| def | make_plots (self, data_refs, old_wcs_list, name='', interactive=False, per_ccd_plot=False, outdir='.plots') |
Detailed Description
Compute statistics on jointcal-processed data, and optionally generate plots. Notes ----- Instantiate JointcalStatistics and call compute_rms() to get the relevant statistics for e.g. unittests, and call make_plots() to generate a suite of diagnostic plots.
Constructor & Destructor Documentation
◆ __init__()
| def lsst.jointcal.utils.JointcalStatistics.__init__ | ( | self, | |
match_radius = 0.1*arcseconds, |
|||
flux_limit = 100.0, |
|||
do_photometry = True, |
|||
do_astrometry = True, |
|||
verbose = False |
|||
| ) |
Parameters
----------
match_radius : lsst.afw.geom.Angle
match sources within this radius for RMS statistics
flux_limit : float
Signal/Noise (flux/fluxSigma) for sources to be included in the RMS cross-match.
100 is a balance between good centroids and enough sources.
do_photometry : bool, optional
Perform calculations/make plots for photometric metrics.
do_astrometry : bool, optional
Perform calculations/make plots for astrometric metrics.
verbose : bool, optional
Print extra things
Member Function Documentation
◆ compute_rms()
| def lsst.jointcal.utils.JointcalStatistics.compute_rms | ( | self, | |
| data_refs, | |||
| reference | |||
| ) |
Match all data_refs to compute the RMS, for all detections above self.flux_limit.
Parameters
----------
data_refs : list of lsst.daf.persistence.butlerSubset.ButlerDataRef
A list of data refs to do the calculations between.
reference : lsst reference catalog
reference catalog to do absolute matching against.
Returns
-------
namedtuple:
astropy.Quantity
Post-jointcal relative RMS of the matched sources.
astropy.Quantity
Post-jointcal absolute RMS of matched sources.
float
Post-jointcal photometric repeatability (PA1 from the SRD).
◆ make_plots()
| def lsst.jointcal.utils.JointcalStatistics.make_plots | ( | self, | |
| data_refs, | |||
| old_wcs_list, | |||
name = '', |
|||
interactive = False, |
|||
per_ccd_plot = False, |
|||
outdir = '.plots' |
|||
| ) |
Make plots of various quantites to help with debugging.
Requires that `compute_rms()` was run first.
Parameters
----------
data_refs : list of lsst.daf.persistence.butlerSubset.ButlerDataRef
A list of data refs to do the calculations between.
old_wcs_list : list of lsst.afw.image.wcs.Wcs
A list of the old (pre-jointcal) WCSs, one-to-one corresponding to data_refs.
name : str
Name to include in plot titles and save files.
interactive : bool
Turn on matplotlib interactive mode and drop into a debugger when
plotting is finished. Otherwise, use a non-interactive backend.
per_ccd_plot : bool
Plot the WCS per CCD (takes longer and generates many plots for a large camera)
outdir : str
directory to save plots to.
Member Data Documentation
◆ bright
◆ do_astrometry
◆ do_photometry
◆ faint
◆ filters
◆ flux_limit
◆ log
◆ match_radius
◆ new_dist_total
◆ new_mag
◆ new_PA1
◆ new_ref
◆ new_rms
◆ new_source
◆ new_weighted_rms
◆ old_dist_total
◆ old_mag
◆ old_PA1
◆ old_ref
◆ old_rms
◆ old_source
◆ old_weighted_rms
◆ verbose
◆ visits_per_dataRef
The documentation for this class was generated from the following file:
- python/lsst/jointcal/utils.py
