lsst.meas.base gc76e4e2a6e+d465fdd76a
Loading...
Searching...
No Matches
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)
 

Public Attributes

 numberKey
 
 noInputsFlag
 

Static Public Attributes

 ConfigClass = InputCountConfig
 
int FAILURE_BAD_CENTROID = 1
 
int FAILURE_NO_INPUTS = 2
 

Detailed Description

Count the number of input images which contributed to a a source.

Parameters
----------
config : `InputCountConfig`
    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

Notes
-----
Information is derived from the image's `~lsst.afw.image.CoaddInputs`.
Note these limitation:

- This records the number of images which contributed to the pixel in the
  center of the source footprint, rather than to any or all pixels in the
  source.
- Clipping in the coadd is not taken into account.

Definition at line 330 of file plugins.py.

Constructor & Destructor Documentation

◆ __init__()

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

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

Definition at line 370 of file plugins.py.

Member Function Documentation

◆ fail()

def lsst.meas.base.plugins.InputCountPlugin.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 390 of file plugins.py.

◆ getExecutionOrder()

def lsst.meas.base.plugins.InputCountPlugin.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 367 of file plugins.py.

◆ measure()

def lsst.meas.base.plugins.InputCountPlugin.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 381 of file plugins.py.

Member Data Documentation

◆ ConfigClass

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

Definition at line 356 of file plugins.py.

◆ FAILURE_BAD_CENTROID

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

Definition at line 358 of file plugins.py.

◆ FAILURE_NO_INPUTS

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

Definition at line 362 of file plugins.py.

◆ noInputsFlag

lsst.meas.base.plugins.InputCountPlugin.noInputsFlag

Definition at line 375 of file plugins.py.

◆ numberKey

lsst.meas.base.plugins.InputCountPlugin.numberKey

Definition at line 372 of file plugins.py.


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