lsst.ip.diffim ge197c71c49+7b74940fe4
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
lsst.ip.diffim.kernelCandidateQa.KernelCandidateQa Class Reference
Inheritance diagram for lsst.ip.diffim.kernelCandidateQa.KernelCandidateQa:

Public Member Functions

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

Static Public Member Functions

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

Public Attributes

 fields
 

Detailed Description

Quality Assessment class for Kernel Candidates

Definition at line 36 of file kernelCandidateQa.py.

Constructor & Destructor Documentation

◆ __init__()

def 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

◆ addToSchema()

def 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()

def 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()

def 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()

def 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: