lsst.meas.base  16.0-13-gd9b1b71+8
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.base.plugins.InputCountPlugin Class Reference
Inheritance diagram for lsst.meas.base.plugins.InputCountPlugin:
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

 numberKey
 
 noInputsFlag
 
 config
 
 name
 
 logName
 

Static Public Attributes

 ConfigClass = InputCountConfig
 
int FAILURE_BAD_CENTROID = 1
 
int FAILURE_NO_INPUTS = 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

Plugin to count how many input images contributed to each source. This information
is in the exposure's coaddInputs. Some limitations:
* This is only for the pixel containing the center, not for all the pixels in the
  Footprint
* This does not account for any clipping in the coadd

Definition at line 265 of file plugins.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 282 of file plugins.py.

Member Function Documentation

◆ fail()

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

Definition at line 302 of file plugins.py.

◆ getExecutionOrder()

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

Definition at line 279 of file plugins.py.

◆ getLogName()

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

Definition at line 90 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 115 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 600 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 559 of file wrappers.py.

◆ measure()

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

Definition at line 293 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 519 of file wrappers.py.

Member Data Documentation

◆ APCORR_ORDER

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

Definition at line 51 of file pluginsBase.py.

◆ CENTROID_ORDER

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

Definition at line 48 of file pluginsBase.py.

◆ config

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

Definition at line 86 of file pluginsBase.py.

◆ ConfigClass

lsst.meas.base.plugins.InputCountPlugin.ConfigClass = InputCountConfig
static

Definition at line 274 of file plugins.py.

◆ DEFAULT_CATALOGCALCULATION

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

Definition at line 52 of file pluginsBase.py.

◆ FAILURE_BAD_CENTROID

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

Definition at line 275 of file plugins.py.

◆ FAILURE_NO_INPUTS

int lsst.meas.base.plugins.InputCountPlugin.FAILURE_NO_INPUTS = 2
static

Definition at line 276 of file plugins.py.

◆ FLUX_ORDER

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

Definition at line 50 of file pluginsBase.py.

◆ logName

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

Definition at line 88 of file pluginsBase.py.

◆ name

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

Definition at line 87 of file pluginsBase.py.

◆ noInputsFlag

lsst.meas.base.plugins.InputCountPlugin.noInputsFlag

Definition at line 287 of file plugins.py.

◆ numberKey

lsst.meas.base.plugins.InputCountPlugin.numberKey

Definition at line 284 of file plugins.py.

◆ SHAPE_ORDER

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

Definition at line 49 of file pluginsBase.py.


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