lsst.meas.base  14.0-22-gcfb0d17+2
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.base.plugins.VariancePlugin Class Reference
Inheritance diagram for lsst.meas.base.plugins.VariancePlugin:
lsst.meas.base.wrappers.GenericPlugin lsst.meas.base.pluginsBase.BasePlugin

Public Member Functions

def getExecutionOrder (cls)
 
def __init__ (self, config, name, schema, metadata)
 
def measure (self, measRecord, exposure, center)
 
def fail (self, measRecord, error=None)
 
def measureN (self, measCat, exposure, refCat, refWcs)
 
def makeSingleFramePlugin (cls, name)
 
def makeForcedPlugin (cls, name)
 
def getLogName (self)
 

Static Public Member Functions

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

Public Attributes

 varValue
 
 emptyFootprintFlag
 
 config
 
 name
 
 logName
 

Static Public Attributes

 ConfigClass = VarianceConfig
 
int FAILURE_BAD_CENTROID = 1
 
int FAILURE_EMPTY_FOOTPRINT = 2
 
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 197 of file plugins.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 211 of file plugins.py.

Member Function Documentation

◆ fail()

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

Definition at line 247 of file plugins.py.

◆ getExecutionOrder()

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

Definition at line 208 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.

◆ makeForcedPlugin()

def lsst.meas.base.wrappers.GenericPlugin.makeForcedPlugin (   cls,
  name 
)
inherited
Produce a ForcedPlugin sub-class from this GenericPlugin class

The class is also registered.

Parameters
----------
name : `str`
    Name of plugin to register.

Definition at line 601 of file wrappers.py.

◆ makeSingleFramePlugin()

def lsst.meas.base.wrappers.GenericPlugin.makeSingleFramePlugin (   cls,
  name 
)
inherited
Produce a SingleFramePlugin sub-class from this GenericPlugin class

The class is also registered.

Parameters
----------
name : `str`
    Name of plugin to register.

Definition at line 560 of file wrappers.py.

◆ measure()

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

Definition at line 221 of file plugins.py.

◆ measureN()

def lsst.meas.base.wrappers.GenericPlugin.measureN (   self,
  measCat,
  exposure,
  refCat,
  refWcs 
)
inherited
Measure multiple sources

It is the responsibility of this method to perform the desired
measurement and record the result in the `measCat`.

Parameters
----------
measCat : `lsst.afw.table.SourceCatalog`
    Catalog for the sources being measured.
exposure : `lsst.afw.image.Exposure`
    Exposure on which the source is being measured.
refCat : `lsst.afw.table.SourceCatalog`
    Reference catalog.
refWcs : `lsst.afw.image.Wcs`
    Astrometric solution for the reference image.

Raises
------
`MeasurementError`
    If the measurement fails for a known/justifiable reason.

Definition at line 520 of file wrappers.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.VariancePlugin.ConfigClass = VarianceConfig
static

Definition at line 203 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.VariancePlugin.emptyFootprintFlag

Definition at line 214 of file plugins.py.

◆ FAILURE_BAD_CENTROID

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

Definition at line 204 of file plugins.py.

◆ FAILURE_EMPTY_FOOTPRINT

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

Definition at line 205 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.

◆ SHAPE_ORDER

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

Definition at line 51 of file pluginsBase.py.

◆ varValue

lsst.meas.base.plugins.VariancePlugin.varValue

Definition at line 213 of file plugins.py.


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