lsst.meas.base  13.0-33-gb1a1d47+9
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.base.plugins.SingleFrameInputCountPlugin Class Reference
Inheritance diagram for lsst.meas.base.plugins.SingleFrameInputCountPlugin:
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

 numberKey
 
 numberFlag
 
 noInputsFlag
 
 config
 
 name
 
 logName
 

Static Public Attributes

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

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 261 of file plugins.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 278 of file plugins.py.

Member Function Documentation

◆ fail()

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

Definition at line 300 of file plugins.py.

◆ getExecutionOrder()

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

Definition at line 275 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.SingleFrameInputCountPlugin.measure (   self,
  measRecord,
  exposure 
)

Definition at line 290 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.SingleFrameInputCountPlugin.ConfigClass = SingleFrameInputCountConfig
static

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

◆ FAILURE_BAD_CENTROID

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

Definition at line 271 of file plugins.py.

◆ FAILURE_NO_INPUTS

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

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

◆ noInputsFlag

lsst.meas.base.plugins.SingleFrameInputCountPlugin.noInputsFlag

Definition at line 284 of file plugins.py.

◆ numberFlag

lsst.meas.base.plugins.SingleFrameInputCountPlugin.numberFlag

Definition at line 283 of file plugins.py.

◆ numberKey

lsst.meas.base.plugins.SingleFrameInputCountPlugin.numberKey

Definition at line 280 of file plugins.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.


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