lsst.meas.base.compensatedGaussian._compensatedGaussian.SingleFrameCompensatedGaussianFluxPlugin Class Reference

Inheritance diagram for lsst.meas.base.compensatedGaussian._compensatedGaussian.SingleFrameCompensatedGaussianFluxPlugin:

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

Public Attributes
	width_keys
	flagHandler

Static Public Attributes
	ConfigClass = SingleFrameCompensatedGaussianFluxConfig

Protected Attributes
	_rads
	_flux_corrections
	_variance_corrections
	_t
	_max_rad

Detailed Description

Definition at line 58 of file _compensatedGaussian.py.

Constructor & Destructor Documentation

__init__()

lsst.meas.base.compensatedGaussian._compensatedGaussian.SingleFrameCompensatedGaussianFluxPlugin.__init__	(		self,
		SingleFrameCompensatedGaussianFluxConfig	config,
		str	name,
			schema,
			metadata,
			logName = None,
		**	kwds )

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

Definition at line 65 of file _compensatedGaussian.py.

    ):
        super().__init__(config, name, schema, metadata, logName, **kwds)
 
        flagDefs = FlagDefinitionList()
 
        self.width_keys = {}
        self._rads = {}
        self._flux_corrections = {}
        self._variance_corrections = {}
        self._t = config.t
        for width in config.kernel_widths:
            base_key = f"{name}_{width}"
 
            # flux
            flux_str = f"{base_key}_instFlux"
            flux_key = schema.addField(
                flux_str,
                type="D",
                doc="Compensated Gaussian flux measurement.",
                units="count",
            )
 
            # flux error
            err_str = f"{base_key}_instFluxErr"
            err_key = schema.addField(
                err_str,
                type="D",
                doc="Compensated Gaussian flux error.",
                units="count",
            )
 
            # mask bits
            mask_str = f"{base_key}_mask_bits"
            mask_key = schema.addField(mask_str, type=np.int32, doc="Mask bits set within aperture.")
 
            # failure flags
            failure_flag = flagDefs.add(f"{width}_flag", "Compensated Gaussian measurement failed")
            oob_flag = flagDefs.add(f"{width}_flag_bounds", "Compensated Gaussian out-of-bounds")
 
            self.width_keys[width] = (flux_key, err_key, mask_key, failure_flag, oob_flag)
            self._rads[width] = math.ceil(sps.norm.ppf((0.995,), scale=width * config.t)[0])
 
        self.flagHandler = FlagHandler.addFields(schema, name, flagDefs)
        self._max_rad = max(self._rads)
 

Member Function Documentation

fail()

lsst.meas.base.compensatedGaussian._compensatedGaussian.SingleFrameCompensatedGaussianFluxPlugin.fail	(		self,
			measRecord,
			error = None )

Record failure

See also
--------
lsst.meas.base.SingleFramePlugin.fail

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

Definition at line 118 of file _compensatedGaussian.py.

    def fail(self, measRecord, error=None):
        """Record failure
 
        See also
        --------
        lsst.meas.base.SingleFramePlugin.fail
        """
        if error is None:
            self.flagHandler.handleFailure(measRecord)
        else:
            self.flagHandler.handleFailure(measRecord, error.cpp)
 

getExecutionOrder()

lsst.meas.base.compensatedGaussian._compensatedGaussian.SingleFrameCompensatedGaussianFluxPlugin.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 62 of file _compensatedGaussian.py.

    def getExecutionOrder(cls):
        return cls.FLUX_ORDER
 

measure()

lsst.meas.base.compensatedGaussian._compensatedGaussian.SingleFrameCompensatedGaussianFluxPlugin.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 130 of file _compensatedGaussian.py.

    def measure(self, measRecord, exposure):
        center = measRecord.getCentroid()
        bbox = exposure.getBBox()
 
        y = center.getY() - bbox.beginY
        x = center.getX() - bbox.beginX
 
        y_floor = math.floor(y)
        x_floor = math.floor(x)
 
        for width, (flux_key, err_key, mask_key, failure_flag, oob_flag) in self.width_keys.items():
            rad = self._rads[width]
 
            if Point2I(center) not in exposure.getBBox().erodedBy(rad):
                self.flagHandler.setValue(measRecord, failure_flag.number, True)
                self.flagHandler.setValue(measRecord, oob_flag.number, True)
                continue
 
            y_slice = slice(y_floor - rad, y_floor + rad + 1, 1)
            x_slice = slice(x_floor - rad, x_floor + rad + 1, 1)
            y_mean = y - y_floor + rad
            x_mean = x - x_floor + rad
 
            sub_im = exposure.image.array[y_slice, x_slice]
            sub_var = exposure.variance.array[y_slice, x_slice]
 
            if sub_im.size == 0 or sub_im.shape[0] != sub_im.shape[1] or (sub_im.shape[0] % 2) == 0:
                self.flagHandler.setValue(measRecord, failure_flag.number, True)
                self.flagHandler.setValue(measRecord, oob_flag.number, True)
                continue
 
            flux, var = _compensatedGaussianFiltInnerProduct(
                sub_im,
                sub_var,
                x_mean,
                y_mean,
                width,
                self._t,
            )
 
            measRecord.set(flux_key, flux)
            measRecord.set(err_key, np.sqrt(var))
            measRecord.set(mask_key, np.bitwise_or.reduce(exposure.mask.array[y_slice, x_slice], axis=None))

Member Data Documentation

_flux_corrections

lsst.meas.base.compensatedGaussian._compensatedGaussian.SingleFrameCompensatedGaussianFluxPlugin._flux_corrections

protected

Definition at line 80 of file _compensatedGaussian.py.

_max_rad

lsst.meas.base.compensatedGaussian._compensatedGaussian.SingleFrameCompensatedGaussianFluxPlugin._max_rad

protected

Definition at line 116 of file _compensatedGaussian.py.

_rads

lsst.meas.base.compensatedGaussian._compensatedGaussian.SingleFrameCompensatedGaussianFluxPlugin._rads

protected

Definition at line 79 of file _compensatedGaussian.py.

_t

lsst.meas.base.compensatedGaussian._compensatedGaussian.SingleFrameCompensatedGaussianFluxPlugin._t

protected

Definition at line 82 of file _compensatedGaussian.py.

_variance_corrections

lsst.meas.base.compensatedGaussian._compensatedGaussian.SingleFrameCompensatedGaussianFluxPlugin._variance_corrections

protected

Definition at line 81 of file _compensatedGaussian.py.

ConfigClass

lsst.meas.base.compensatedGaussian._compensatedGaussian.SingleFrameCompensatedGaussianFluxPlugin.ConfigClass = SingleFrameCompensatedGaussianFluxConfig

static

Definition at line 59 of file _compensatedGaussian.py.

flagHandler

lsst.meas.base.compensatedGaussian._compensatedGaussian.SingleFrameCompensatedGaussianFluxPlugin.flagHandler

Definition at line 115 of file _compensatedGaussian.py.

width_keys

lsst.meas.base.compensatedGaussian._compensatedGaussian.SingleFrameCompensatedGaussianFluxPlugin.width_keys

Definition at line 78 of file _compensatedGaussian.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/ge5f7162a3a+bb2241c923/python/lsst/meas/base/compensatedGaussian/_compensatedGaussian.py