lsst.meas.base.plugins.InputCountPlugin Class Reference

Inheritance diagram for lsst.meas.base.plugins.InputCountPlugin:

Public Member Functions
	getExecutionOrder (cls)
	__init__ (self, config, name, schema, metadata)
	measure (self, measRecord, exposure, center)
	fail (self, measRecord, error=None)

Public Attributes
	numberKey
	noInputsFlag
	FAILURE_NO_INPUTS
	FAILURE_BAD_CENTROID

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 source.

Parameters
----------
config : `InputCountConfig`
    Plugin configuration.
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 333 of file plugins.py.

Constructor & Destructor Documentation

__init__()

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

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

Definition at line 373 of file plugins.py.

    def __init__(self, config, name, schema, metadata):
        GenericPlugin.__init__(self, config, name, schema, metadata)
        self.numberKey = schema.addField(name + '_value', type="I",
                                         doc="Number of images contributing at center, not including any"
                                             "clipping")
        self.noInputsFlag = schema.addField(name + '_flag_noInputs', type="Flag",
                                            doc="No coadd inputs available")
        # Alias the badCentroid flag to that which is defined for the target of the centroid slot.
        # We do not simply rely on the alias because that could be changed post-measurement.
        schema.getAliasMap().set(name + '_flag_badCentroid', schema.getAliasMap().apply("slot_Centroid_flag"))
 

Member Function Documentation

fail()

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

    def fail(self, measRecord, error=None):
        if error is not None:
            assert error.getFlagBit() in (self.FAILURE_BAD_CENTROID, self.FAILURE_NO_INPUTS)
            # FAILURE_BAD_CENTROID handled by alias to centroid record.
            if error.getFlagBit() == self.FAILURE_NO_INPUTS:
                measRecord.set(self.noInputsFlag, True)
        GenericPlugin.fail(self, measRecord, error)
 
 

getExecutionOrder()

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

    def getExecutionOrder(cls):
        return BasePlugin.SHAPE_ORDER
 

measure()

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

    def measure(self, measRecord, exposure, center):
        if not exposure.getInfo().getCoaddInputs():
            raise MeasurementError("No coadd inputs defined.", self.FAILURE_NO_INPUTS)
        if not np.all(np.isfinite(center)):
            raise MeasurementError("Source has a bad centroid.", self.FAILURE_BAD_CENTROID)
 
        ccds = exposure.getInfo().getCoaddInputs().ccds
        measRecord.set(self.numberKey, len(ccds.subsetContaining(center, exposure.getWcs())))
 

Member Data Documentation

ConfigClass

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

static

Definition at line 359 of file plugins.py.

FAILURE_BAD_CENTROID [1/2]

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

static

Definition at line 361 of file plugins.py.

FAILURE_BAD_CENTROID [2/2]

lsst.meas.base.plugins.InputCountPlugin.FAILURE_BAD_CENTROID

Definition at line 388 of file plugins.py.

FAILURE_NO_INPUTS [1/2]

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

static

Definition at line 365 of file plugins.py.

FAILURE_NO_INPUTS [2/2]

lsst.meas.base.plugins.InputCountPlugin.FAILURE_NO_INPUTS

Definition at line 386 of file plugins.py.

noInputsFlag

lsst.meas.base.plugins.InputCountPlugin.noInputsFlag

Definition at line 378 of file plugins.py.

numberKey

lsst.meas.base.plugins.InputCountPlugin.numberKey

Definition at line 375 of file plugins.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_base/g212a7c68fe+04a9158687/python/lsst/meas/base/plugins.py