lsst.meas.base.compensatedGaussian._compensatedTophat.SingleFrameCompensatedTophatFluxPlugin Class Reference

Inheritance diagram for lsst.meas.base.compensatedGaussian._compensatedTophat.SingleFrameCompensatedTophatFluxPlugin:

Public Member Functions
	getExecutionOrder (cls)
	__init__ (self, SingleFrameCompensatedTophatFluxConfig config, str name, schema, metadata, logName=None, **kwds)
	fail (self, measRecord, error=None)
	measure (self, measRecord, exposure)
	getLogName (self)

Static Public Member Functions
	getTransformClass ()

Public Attributes
dict	aperture_keys = {}
	flagHandler = FlagHandler.addFields(schema, name, flagDefs)
	config = config
	name = name
	logName = logName

Static Public Attributes
	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
	ConfigClass = BasePluginConfig

Protected Attributes
dict	_rads = {}
	_inner_scale = config.inner_scale
	_outer_scale = config.outer_scale
	_max_rad = max(self._rads)

Detailed Description

Definition at line 70 of file _compensatedTophat.py.

Constructor & Destructor Documentation

__init__()

lsst.meas.base.compensatedGaussian._compensatedTophat.SingleFrameCompensatedTophatFluxPlugin.__init__	(		self,
		SingleFrameCompensatedTophatFluxConfig	config,
		str	name,
			schema,
			metadata,
			logName = None,
		**	kwds )

Definition at line 77 of file _compensatedTophat.py.

Member Function Documentation

fail()

lsst.meas.base.compensatedGaussian._compensatedTophat.SingleFrameCompensatedTophatFluxPlugin.fail	(		self,
			measRecord,
			error = None )

Record a failure of the `measure` or `measureN` method.

Parameters
----------
measRecord : `lsst.afw.table.SourceRecord`
    Table record describing the source being measured.
error : `MeasurementError`, optional
    Only provided if the measurement failed due to a
    `MeasurementError` being raised; otherwise, will be `None`.

Notes
-----
When the plugin raises an exception, framework will call
`BasePlugin.fail` to allow the plugin to set its failure flag
field(s).  When `BasePlugin.measureN` raises an exception,
`BasePlugin.fail` will be called repeatedly with all the records that
were being measured.

If the exception is an `MeasurementError`, it will be passed as the
error argument; in all other cases the error argument will be `None`,
and the failure will be logged by the measurement framework as a
warning.

Reimplemented from lsst.meas.base.pluginsBase.BasePlugin.

Definition at line 129 of file _compensatedTophat.py.

getExecutionOrder()

lsst.meas.base.compensatedGaussian._compensatedTophat.SingleFrameCompensatedTophatFluxPlugin.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.pluginsBase.BasePlugin.

Definition at line 74 of file _compensatedTophat.py.

getLogName()

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

inherited

Definition at line 134 of file pluginsBase.py.

getTransformClass()

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.

measure()

lsst.meas.base.compensatedGaussian._compensatedTophat.SingleFrameCompensatedTophatFluxPlugin.measure	(		self,
			measRecord,
			exposure )

Measure the properties of a source on a single image.

The image may be from a single epoch, or it may be a coadd.

Parameters
----------
measRecord : `lsst.afw.table.SourceRecord`
    Record describing the object being measured. Previously-measured
    quantities may be retrieved from here, and it will be updated
    in-place tih the outputs of this plugin.
exposure : `lsst.afw.image.ExposureF`
    The pixel data to be measured, together with the associated PSF,
    WCS, etc. All other sources in the image should have been replaced
    by noise according to deblender outputs.

Reimplemented from lsst.meas.base.sfm.SingleFramePlugin.

Definition at line 135 of file _compensatedTophat.py.

Member Data Documentation

_inner_scale

lsst.meas.base.compensatedGaussian._compensatedTophat.SingleFrameCompensatedTophatFluxPlugin._inner_scale = config.inner_scale

protected

Definition at line 92 of file _compensatedTophat.py.

_max_rad

lsst.meas.base.compensatedGaussian._compensatedTophat.SingleFrameCompensatedTophatFluxPlugin._max_rad = max(self._rads)

protected

Definition at line 127 of file _compensatedTophat.py.

_outer_scale

lsst.meas.base.compensatedGaussian._compensatedTophat.SingleFrameCompensatedTophatFluxPlugin._outer_scale = config.outer_scale

protected

Definition at line 93 of file _compensatedTophat.py.

_rads

dict lsst.meas.base.compensatedGaussian._compensatedTophat.SingleFrameCompensatedTophatFluxPlugin._rads = {}

protected

Definition at line 91 of file _compensatedTophat.py.

APCORR_ORDER

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

staticinherited

Definition at line 98 of file pluginsBase.py.

aperture_keys

dict lsst.meas.base.compensatedGaussian._compensatedTophat.SingleFrameCompensatedTophatFluxPlugin.aperture_keys = {}

Definition at line 90 of file _compensatedTophat.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 = config

inherited

Definition at line 130 of file pluginsBase.py.

ConfigClass

lsst.meas.base.pluginsBase.BasePlugin.ConfigClass = BasePluginConfig

staticinherited

Definition at line 116 of file pluginsBase.py.

DEFAULT_CATALOGCALCULATION

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

staticinherited

Definition at line 108 of file pluginsBase.py.

flagHandler

lsst.meas.base.compensatedGaussian._compensatedTophat.SingleFrameCompensatedTophatFluxPlugin.flagHandler = FlagHandler.addFields(schema, name, flagDefs)

Definition at line 126 of file _compensatedTophat.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 = logName

inherited

Definition at line 132 of file pluginsBase.py.

name

lsst.meas.base.pluginsBase.BasePlugin.name = name

inherited

Definition at line 131 of file pluginsBase.py.

registry

lsst.meas.base.sfm.SingleFramePlugin.registry = PluginRegistry(SingleFramePluginConfig)

staticinherited

Definition at line 76 of file sfm.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:

• python/lsst/meas/base/compensatedGaussian/_compensatedTophat.py