lsst.meas.base  13.0-33-gb1a1d47+14
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.base.plugins.SingleFrameVariancePlugin Class Reference
Inheritance diagram for lsst.meas.base.plugins.SingleFrameVariancePlugin:
lsst.meas.base.sfm.SingleFramePlugin lsst.meas.base.baseMeasurement.BaseMeasurementPlugin lsst.meas.base.pluginsBase.BasePlugin

Public Member Functions

def getExecutionOrder (cls)
 
def __init__ (self, config, name, schema, metadata)
 
def measure (self, measRecord, exposure)
 
def fail (self, measRecord, error=None)
 
def measureN (self, measCat, exposure)
 Measure the properties of a group of blended sources on a single image (single-epoch image or coadd). More...
 
def getLogName (self)
 

Static Public Member Functions

def getTransformClass ()
 Get the measurement transformation appropriate to this plugin. More...
 

Public Attributes

 varValue
 
 varFlag
 
 emptyFootprintFlag
 
 config
 
 name
 
 logName
 

Static Public Attributes

 ConfigClass = SingleFrameVarianceConfig
 
int FAILURE_BAD_CENTROID = 1
 
int FAILURE_EMPTY_FOOTPRINT = 2
 
 registry = PluginRegistry(SingleFramePluginConfig)
 
float CENTROID_ORDER = 0.0
 
float SHAPE_ORDER = 1.0
 
float FLUX_ORDER = 2.0
 
float APCORR_ORDER = 3.0
 
float DEFAULT_CATALOGCALCULATION = 4.0
 

Detailed Description

Calculate the median variance within a Footprint scaled from the object shape so
the value is not terribly influenced by the object and instead represents the
variance in the background near the object.

Definition at line 194 of file plugins.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.base.plugins.SingleFrameVariancePlugin.__init__ (   self,
  config,
  name,
  schema,
  metadata 
)

Definition at line 208 of file plugins.py.

Member Function Documentation

◆ fail()

def lsst.meas.base.plugins.SingleFrameVariancePlugin.fail (   self,
  measRecord,
  error = None 
)

Definition at line 245 of file plugins.py.

◆ getExecutionOrder()

def lsst.meas.base.plugins.SingleFrameVariancePlugin.getExecutionOrder (   cls)

Definition at line 205 of file plugins.py.

◆ getLogName()

def lsst.meas.base.pluginsBase.BasePlugin.getLogName (   self)
inherited

Definition at line 92 of file pluginsBase.py.

◆ getTransformClass()

def lsst.meas.base.pluginsBase.BasePlugin.getTransformClass ( )
staticinherited

Get the measurement transformation appropriate to this plugin.

This returns a subclass of MeasurementTransform, which may be instantiated with details of the algorithm configuration and then called with information about calibration and WCS to convert from raw measurement quantities to calibrated units. Calibrated data is then provided in a separate output table.

By default, we copy everything from the input to the output without transformation.

Definition at line 117 of file pluginsBase.py.

◆ measure()

def lsst.meas.base.plugins.SingleFrameVariancePlugin.measure (   self,
  measRecord,
  exposure 
)

Definition at line 219 of file plugins.py.

◆ measureN()

def lsst.meas.base.sfm.SingleFramePlugin.measureN (   self,
  measCat,
  exposure 
)
inherited

Measure the properties of a group of blended sources on a single image (single-epoch image or coadd).

Parameters
[in,out]measCatlsst.afw.table.SourceCatalog to be filled with outputs, and from which previously-measured quantities can be retrieved, containing only the sources that should be measured together in this call.
[in]exposurelsst.afw.image.ExposureF, containing the pixel data to be measured and the associated Psf, Wcs, etc. Sources not in the blended hierarchy to be measured will have been replaced with noise using deblender outputs.

Derived classes that do not implement measureN() should just inherit this disabled version. Derived classes that do implement measureN() should additionally add a bool doMeasureN config field to their config class to signal that measureN-mode is available.

Definition at line 93 of file sfm.py.

Member Data Documentation

◆ APCORR_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.APCORR_ORDER = 3.0
staticinherited

Definition at line 53 of file pluginsBase.py.

◆ CENTROID_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.CENTROID_ORDER = 0.0
staticinherited

Definition at line 50 of file pluginsBase.py.

◆ config

lsst.meas.base.pluginsBase.BasePlugin.config
inherited

Definition at line 88 of file pluginsBase.py.

◆ ConfigClass

lsst.meas.base.plugins.SingleFrameVariancePlugin.ConfigClass = SingleFrameVarianceConfig
static

Definition at line 200 of file plugins.py.

◆ DEFAULT_CATALOGCALCULATION

float lsst.meas.base.pluginsBase.BasePlugin.DEFAULT_CATALOGCALCULATION = 4.0
staticinherited

Definition at line 54 of file pluginsBase.py.

◆ emptyFootprintFlag

lsst.meas.base.plugins.SingleFrameVariancePlugin.emptyFootprintFlag

Definition at line 212 of file plugins.py.

◆ FAILURE_BAD_CENTROID

int lsst.meas.base.plugins.SingleFrameVariancePlugin.FAILURE_BAD_CENTROID = 1
static

Definition at line 201 of file plugins.py.

◆ FAILURE_EMPTY_FOOTPRINT

int lsst.meas.base.plugins.SingleFrameVariancePlugin.FAILURE_EMPTY_FOOTPRINT = 2
static

Definition at line 202 of file plugins.py.

◆ FLUX_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.FLUX_ORDER = 2.0
staticinherited

Definition at line 52 of file pluginsBase.py.

◆ logName

lsst.meas.base.pluginsBase.BasePlugin.logName
inherited

Definition at line 90 of file pluginsBase.py.

◆ name

lsst.meas.base.pluginsBase.BasePlugin.name
inherited

Definition at line 89 of file pluginsBase.py.

◆ registry

lsst.meas.base.sfm.SingleFramePlugin.registry = PluginRegistry(SingleFramePluginConfig)
staticinherited

Definition at line 61 of file sfm.py.

◆ SHAPE_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.SHAPE_ORDER = 1.0
staticinherited

Definition at line 51 of file pluginsBase.py.

◆ varFlag

lsst.meas.base.plugins.SingleFrameVariancePlugin.varFlag

Definition at line 211 of file plugins.py.

◆ varValue

lsst.meas.base.plugins.SingleFrameVariancePlugin.varValue

Definition at line 210 of file plugins.py.


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