lsst.meas.base.plugins.InputCountPlugin Class Reference

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

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 ()

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

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

Constructor & Destructor Documentation

__init__()

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

Definition at line 369 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()

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 389 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()

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

    def getExecutionOrder(cls):
        return BasePlugin.SHAPE_ORDER
 

getLogName()

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

inherited

Definition at line 134 of file pluginsBase.py.

    def getLogName(self):
        return self.logName
 

getTransformClass()

def lsst.meas.base.pluginsBase.BasePlugin.getTransformClass ( )

staticinherited

Get the measurement transformation appropriate to this plugin.

This returns a subclass of `transforms.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.

Notes
-----
By default, we copy everything from the input to the output without
transformation.

Reimplemented in lsst.meas.base.plugins.ForcedPeakCentroidPlugin, and lsst.meas.base.plugins.SingleFramePeakCentroidPlugin.

Definition at line 169 of file pluginsBase.py.

    def getTransformClass():
        """Get the measurement transformation appropriate to this plugin.
 
        This returns a subclass of `transforms.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.
 
        Notes
        -----
        By default, we copy everything from the input to the output without
        transformation.
        """
        return PassThroughTransform

makeForcedPlugin()

def lsst.meas.base.wrappers.GenericPlugin.makeForcedPlugin (   cls,   name  )

inherited

Produce a ForcedPlugin subclass from this GenericPlugin class.

The class is also registered.

Parameters
----------
name : `str`
    Name of plugin to register.

Definition at line 623 of file wrappers.py.

    def makeForcedPlugin(cls, name):
        """Produce a ForcedPlugin subclass from this GenericPlugin class.
 
        The class is also registered.
 
        Parameters
        ----------
        name : `str`
            Name of plugin to register.
        """
        class ForcedFromGenericConfig(cls.ConfigClass, ForcedPluginConfig):
            pass
 
        @register(name)
        class ForcedFromGenericPlugin(ForcedPlugin):
            ConfigClass = ForcedFromGenericConfig
 
            def __init__(self, config, name, schemaMapper, metadata, logName=None):
                ForcedPlugin.__init__(self, config, name, schemaMapper, metadata, logName=logName)
                schema = schemaMapper.editOutputSchema()
                self._generic = cls(config, name, schema, metadata)
 
            def measure(self, measRecord, exposure, refRecord, refWcs):
                # Forced photometry tasks should almost be configured with a
                # centroider (populating measRecord.getCentroid()) that
                # transforms the reference centroid, but we respect their
                # decision if they decided to re-centroid (or do something more
                # unusual) on the image being measured.
                center = measRecord.getCentroid()
                return self._generic.measure(measRecord, exposure, center)
 
            def measureN(self, measCat, exposure, refCat, refWcs):
                return self._generic.measureN(measCat, exposure, refCat, refWcs)
 
            def fail(self, measRecord, error=None):
                self._generic.fail(measRecord, error if error is not None else None)
 
            @staticmethod
            def getExecutionOrder():
                return cls.getExecutionOrder()
 
            def getTransformClass(self):
                return self._generic.getTransformClass()
 
        return ForcedFromGenericPlugin

makeSingleFramePlugin()

def lsst.meas.base.wrappers.GenericPlugin.makeSingleFramePlugin (   cls,   name  )

inherited

Produce a SingleFramePlugin subclass from this GenericPlugin class.

The class is also registered.

Parameters
----------
name : `str`
    Name of plugin to register.

Definition at line 582 of file wrappers.py.

    def makeSingleFramePlugin(cls, name):
        """Produce a SingleFramePlugin subclass from this GenericPlugin class.
 
        The class is also registered.
 
        Parameters
        ----------
        name : `str`
            Name of plugin to register.
        """
        class SingleFrameFromGenericConfig(cls.ConfigClass, SingleFramePluginConfig):
            pass
 
        @register(name)
        class SingleFrameFromGenericPlugin(SingleFramePlugin):
            ConfigClass = SingleFrameFromGenericConfig
 
            def __init__(self, config, name, schema, metadata, logName=None):
                SingleFramePlugin.__init__(self, config, name, schema, metadata, logName=logName)
                self._generic = cls(config, name, schema, metadata)
 
            def measure(self, measRecord, exposure):
                center = measRecord.getCentroid()
                return self._generic.measure(measRecord, exposure, center)
 
            def measureN(self, measCat, exposure, refCat, refWcs):
                return self._generic.measureN(measCat, exposure, refCat, refWcs)
 
            def fail(self, measRecord, error=None):
                self._generic.fail(measRecord, error if error is not None else None)
 
            @staticmethod
            def getExecutionOrder():
                return cls.getExecutionOrder()
 
            def getTransformClass(self):
                return self._generic.getTransformClass()
 
        return SingleFrameFromGenericPlugin
 

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 380 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())))
 

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
    Raised if the measurement fails for a known/justifiable reason.

Definition at line 542 of file wrappers.py.

    def measureN(self, measCat, exposure, refCat, refWcs):
        """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
            Raised if the measurement fails for a known/justifiable reason.
        """
        raise NotImplementedError()
 

Member Data Documentation

APCORR_ORDER

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

staticinherited

Definition at line 98 of file pluginsBase.py.

CENTROID_ORDER

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

staticinherited

Definition at line 72 of file pluginsBase.py.

config

lsst.meas.base.pluginsBase.BasePlugin.config

inherited

Definition at line 130 of file pluginsBase.py.

ConfigClass

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

static

Definition at line 355 of file plugins.py.

DEFAULT_CATALOGCALCULATION

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

staticinherited

Definition at line 108 of file pluginsBase.py.

FAILURE_BAD_CENTROID

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

static

Definition at line 357 of file plugins.py.

FAILURE_NO_INPUTS

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

static

Definition at line 361 of file plugins.py.

FLUX_ORDER

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

staticinherited

Definition at line 89 of file pluginsBase.py.

logName

lsst.meas.base.pluginsBase.BasePlugin.logName

inherited

Definition at line 132 of file pluginsBase.py.

name

lsst.meas.base.pluginsBase.BasePlugin.name

inherited

Definition at line 131 of file pluginsBase.py.

noInputsFlag

lsst.meas.base.plugins.InputCountPlugin.noInputsFlag

Definition at line 374 of file plugins.py.

numberKey

lsst.meas.base.plugins.InputCountPlugin.numberKey

Definition at line 371 of file plugins.py.

SHAPE_ORDER

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

staticinherited

Definition at line 80 of file pluginsBase.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_base/22.0.1-25-gb120d7b+8b5510f75f/python/lsst/meas/base/plugins.py