lsst.jointcal  22.0.1-14-gc97e25b+d548b459a8
Public Member Functions | Public Attributes | List of all members
lsst.jointcal.utils.JointcalStatistics Class Reference

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')
 

Public Attributes

 match_radius
 
 flux_limit
 
 do_photometry
 
 do_astrometry
 
 verbose
 
 log
 
 filters
 
 visits_per_dataRef
 
 old_source
 
 new_source
 
 new_PA1
 
 old_dist_total
 
 new_dist_total
 
 old_rms
 
 new_rms
 
 old_ref
 
 new_ref
 
 old_mag
 
 new_mag
 
 faint
 
 bright
 
 old_weighted_rms
 
 new_weighted_rms
 
 old_PA1
 

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.

Definition at line 49 of file utils.py.

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.geom.Angle
    match sources within this radius for RMS statistics
flux_limit : float
    Signal/Noise (flux/fluxErr) 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

Definition at line 60 of file utils.py.

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).

Definition at line 85 of file utils.py.

◆ 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.

Definition at line 198 of file utils.py.

Member Data Documentation

◆ bright

lsst.jointcal.utils.JointcalStatistics.bright

Definition at line 303 of file utils.py.

◆ do_astrometry

lsst.jointcal.utils.JointcalStatistics.do_astrometry

Definition at line 81 of file utils.py.

◆ do_photometry

lsst.jointcal.utils.JointcalStatistics.do_photometry

Definition at line 80 of file utils.py.

◆ faint

lsst.jointcal.utils.JointcalStatistics.faint

Definition at line 302 of file utils.py.

◆ filters

lsst.jointcal.utils.JointcalStatistics.filters

Definition at line 108 of file utils.py.

◆ flux_limit

lsst.jointcal.utils.JointcalStatistics.flux_limit

Definition at line 79 of file utils.py.

◆ log

lsst.jointcal.utils.JointcalStatistics.log

Definition at line 83 of file utils.py.

◆ match_radius

lsst.jointcal.utils.JointcalStatistics.match_radius

Definition at line 78 of file utils.py.

◆ new_dist_total

lsst.jointcal.utils.JointcalStatistics.new_dist_total

Definition at line 183 of file utils.py.

◆ new_mag

lsst.jointcal.utils.JointcalStatistics.new_mag

Definition at line 291 of file utils.py.

◆ new_PA1

lsst.jointcal.utils.JointcalStatistics.new_PA1

Definition at line 173 of file utils.py.

◆ new_ref

lsst.jointcal.utils.JointcalStatistics.new_ref

Definition at line 289 of file utils.py.

◆ new_rms

lsst.jointcal.utils.JointcalStatistics.new_rms

Definition at line 285 of file utils.py.

◆ new_source

lsst.jointcal.utils.JointcalStatistics.new_source

Definition at line 158 of file utils.py.

◆ new_weighted_rms

lsst.jointcal.utils.JointcalStatistics.new_weighted_rms

Definition at line 309 of file utils.py.

◆ old_dist_total

lsst.jointcal.utils.JointcalStatistics.old_dist_total

Definition at line 182 of file utils.py.

◆ old_mag

lsst.jointcal.utils.JointcalStatistics.old_mag

Definition at line 290 of file utils.py.

◆ old_PA1

lsst.jointcal.utils.JointcalStatistics.old_PA1

Definition at line 310 of file utils.py.

◆ old_ref

lsst.jointcal.utils.JointcalStatistics.old_ref

Definition at line 288 of file utils.py.

◆ old_rms

lsst.jointcal.utils.JointcalStatistics.old_rms

Definition at line 284 of file utils.py.

◆ old_source

lsst.jointcal.utils.JointcalStatistics.old_source

Definition at line 143 of file utils.py.

◆ old_weighted_rms

lsst.jointcal.utils.JointcalStatistics.old_weighted_rms

Definition at line 308 of file utils.py.

◆ verbose

lsst.jointcal.utils.JointcalStatistics.verbose

Definition at line 82 of file utils.py.

◆ visits_per_dataRef

lsst.jointcal.utils.JointcalStatistics.visits_per_dataRef

Definition at line 109 of file utils.py.


The documentation for this class was generated from the following file: