lsst.ip.diffim g88964a4962+8a1a53efdf
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | Static Protected Member Functions | List of all members
lsst.ip.diffim.kernelCandidateQa.KernelCandidateQa Class Reference
Inheritance diagram for lsst.ip.diffim.kernelCandidateQa.KernelCandidateQa:

Public Member Functions

 __init__ (self, nKernelSpatial)
 
 makeMetricMap (self)
 
 addToSchema (self, inSourceCatalog)
 
 apply (cls, candidateList, spatialKernel, spatialBackground, dof=0)
 

Static Public Member Functions

 aggregate (sourceCatalog, metadata, wcsresids, diaSources=None)
 

Public Attributes

 fields
 

Static Protected Member Functions

 _calculateStats (di, dof=0.)
 

Detailed Description

Quality Assessment class for Kernel Candidates

Definition at line 36 of file kernelCandidateQa.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.ip.diffim.kernelCandidateQa.KernelCandidateQa.__init__ ( self,
nKernelSpatial )
Class to undertake QA of KernelCandidates after modeling of
the Psf-matching kernel.  Both directly--fitted diffim (LOCAL)
and spatially--interpolated kernel diffim (SPATIAL) metrics
are calculated, based on the distribution of residuals in the
KernelCandidates stamp.

Parameters
----------
nKernelSpatial : `int`
    Number of terms in the spatial model; needed to initialize per-basis QA arrays

Definition at line 39 of file kernelCandidateQa.py.

Member Function Documentation

◆ _calculateStats()

lsst.ip.diffim.kernelCandidateQa.KernelCandidateQa._calculateStats ( di,
dof = 0. )
staticprotected
Calculate the core QA statistics on a difference image

Definition at line 141 of file kernelCandidateQa.py.

◆ addToSchema()

lsst.ip.diffim.kernelCandidateQa.KernelCandidateQa.addToSchema ( self,
inSourceCatalog )
Add the to-be-generated QA keys to the Source schema

Definition at line 113 of file kernelCandidateQa.py.

◆ aggregate()

lsst.ip.diffim.kernelCandidateQa.KernelCandidateQa.aggregate ( sourceCatalog,
metadata,
wcsresids,
diaSources = None )
static
Generate aggregate metrics (e.g. total numbers of false
positives) from all the Sources in the sourceCatalog

Definition at line 296 of file kernelCandidateQa.py.

◆ apply()

lsst.ip.diffim.kernelCandidateQa.KernelCandidateQa.apply ( cls,
candidateList,
spatialKernel,
spatialBackground,
dof = 0 )
Evaluate the QA metrics for all KernelCandidates in the
candidateList; set the values of the metrics in their
associated Sources

Definition at line 200 of file kernelCandidateQa.py.

◆ makeMetricMap()

lsst.ip.diffim.kernelCandidateQa.KernelCandidateQa.makeMetricMap ( self)

Definition at line 81 of file kernelCandidateQa.py.

Member Data Documentation

◆ fields

lsst.ip.diffim.kernelCandidateQa.KernelCandidateQa.fields

Definition at line 51 of file kernelCandidateQa.py.


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