lsst.meas.base gdd7ff8183c+1c36868fb5
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)
 

Public Attributes

 varValue
 
 emptyFootprintFlag
 

Static Public Attributes

 ConfigClass = VarianceConfig
 
int FAILURE_BAD_CENTROID = 1
 
int FAILURE_EMPTY_FOOTPRINT = 2
 

Detailed Description

Compute the median variance corresponding to a footprint.

The aim here is to measure the background variance, rather than that of
the object itself. In order to achieve this, the variance is calculated
over an area scaled up from the shape of the input footprint.

Parameters
----------
config : `VarianceConfig`
    Plugin configuraion.
name : `str`
    Plugin name.
schema : `lsst.afw.table.Schema`
    The schema for the measurement output catalog. New fields will be
    added to hold measurements produced by this plugin.
metadata : `lsst.daf.base.PropertySet`
    Plugin metadata that will be attached to the output catalog

Definition at line 229 of file plugins.py.

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented from lsst.meas.base.wrappers.GenericPlugin.

Definition at line 263 of file plugins.py.

Member Function Documentation

◆ fail()

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

This default implementation simply records the failure in the source
record.

Parameters
----------
measRecord : `lsst.afw.table.SourceRecord`
    Catalog record for the source being measured.
error : `Exception`
    Error causing failure, or `None`.

Reimplemented from lsst.meas.base.wrappers.GenericPlugin.

Definition at line 302 of file plugins.py.

◆ getExecutionOrder()

def lsst.meas.base.plugins.VariancePlugin.getExecutionOrder (   cls)
Get the relative execution order of this plugin.

Must be reimplemented as a class method by concrete derived classes.

Reimplemented from lsst.meas.base.wrappers.GenericPlugin.

Definition at line 260 of file plugins.py.

◆ measure()

def lsst.meas.base.plugins.VariancePlugin.measure (   self,
  measRecord,
  exposure,
  center 
)
Measure a single source.

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

Parameters
----------
measRecord : `lsst.afw.table.SourceRecord`
    Catalog record for the source being measured.
exposure : `lsst.afw.image.Exposure`
    Exposure on which the source is being measured.
center : `lsst.geom.Point2D`
    Pixel coordinates of the object.

Raises
------
MeasurementError
    Raised if the measurement fails for a known/justifiable reason.

Reimplemented from lsst.meas.base.wrappers.GenericPlugin.

Definition at line 274 of file plugins.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.base.plugins.VariancePlugin.ConfigClass = VarianceConfig
static

Definition at line 249 of file plugins.py.

◆ emptyFootprintFlag

lsst.meas.base.plugins.VariancePlugin.emptyFootprintFlag

Definition at line 266 of file plugins.py.

◆ FAILURE_BAD_CENTROID

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

Definition at line 251 of file plugins.py.

◆ FAILURE_EMPTY_FOOTPRINT

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

Definition at line 255 of file plugins.py.

◆ varValue

lsst.meas.base.plugins.VariancePlugin.varValue

Definition at line 265 of file plugins.py.


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