Inheritance diagram for lsst.ip.diffim.dipoleMeasurement.ClassificationDipolePlugin:

Public Member Functions
	getExecutionOrder (cls)

	__init__ (self, config, name, schema, metadata)

	measure (self, measRecord, exposure)

	fail (self, measRecord, error=None)

Public Attributes
	dipoleAnalysis

	keyProbability

	keyFlag

Static Public Attributes
	ConfigClass = ClassificationDipoleConfig

Detailed Description

A plugin to classify whether a diaSource is a dipole.

Definition at line 51 of file dipoleMeasurement.py.

Constructor & Destructor Documentation

◆ init()

lsst.ip.diffim.dipoleMeasurement.ClassificationDipolePlugin.__init__	(	self,
		config,
		name,
		schema,
		metadata )

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

Definition at line 66 of file dipoleMeasurement.py.

    def __init__(self, config, name, schema, metadata):
        SingleFramePlugin.__init__(self, config, name, schema, metadata)
        self.dipoleAnalysis = DipoleAnalysis()
        self.keyProbability = schema.addField(name + "_value", type="D",
                                              doc="Set to 1 for dipoles, else 0.")
        self.keyFlag = schema.addField(name + "_flag", type="Flag", doc="Set to 1 for any fatal failure.")
 

Member Function Documentation

◆ fail()

lsst.ip.diffim.dipoleMeasurement.ClassificationDipolePlugin.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 96 of file dipoleMeasurement.py.

    def fail(self, measRecord, error=None):
        measRecord.set(self.keyFlag, True)

◆ getExecutionOrder()

lsst.ip.diffim.dipoleMeasurement.ClassificationDipolePlugin.getExecutionOrder ( cls )

Returns
-------
result : `callable`

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

Definition at line 58 of file dipoleMeasurement.py.

    def getExecutionOrder(cls):
        """
        Returns
        -------
        result : `callable`
        """
        return cls.APCORR_ORDER
 

◆ measure()

lsst.ip.diffim.dipoleMeasurement.ClassificationDipolePlugin.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 73 of file dipoleMeasurement.py.

    def measure(self, measRecord, exposure):
        passesSn = self.dipoleAnalysis.getSn(measRecord) > self.config.minSn
        negFlux = np.abs(measRecord.get("ip_diffim_PsfDipoleFlux_neg_instFlux"))
        negFluxFlag = measRecord.get("ip_diffim_PsfDipoleFlux_neg_flag")
        posFlux = np.abs(measRecord.get("ip_diffim_PsfDipoleFlux_pos_instFlux"))
        posFluxFlag = measRecord.get("ip_diffim_PsfDipoleFlux_pos_flag")
 
        if negFluxFlag or posFluxFlag:
            self.fail(measRecord)
            # continue on to classify
 
        totalFlux = negFlux + posFlux
 
        # If negFlux or posFlux are NaN, these evaluate to False
        passesFluxNeg = (negFlux / totalFlux) < self.config.maxFluxRatio
        passesFluxPos = (posFlux / totalFlux) < self.config.maxFluxRatio
        if (passesSn and passesFluxPos and passesFluxNeg):
            val = 1.0
        else:
            val = 0.0
 
        measRecord.set(self.keyProbability, val)
 

Member Data Documentation

◆ ConfigClass

lsst.ip.diffim.dipoleMeasurement.ClassificationDipolePlugin.ConfigClass = ClassificationDipoleConfig

static

Definition at line 55 of file dipoleMeasurement.py.

◆ dipoleAnalysis

lsst.ip.diffim.dipoleMeasurement.ClassificationDipolePlugin.dipoleAnalysis

Definition at line 68 of file dipoleMeasurement.py.

◆ keyFlag

lsst.ip.diffim.dipoleMeasurement.ClassificationDipolePlugin.keyFlag

Definition at line 71 of file dipoleMeasurement.py.

◆ keyProbability

lsst.ip.diffim.dipoleMeasurement.ClassificationDipolePlugin.keyProbability

Definition at line 69 of file dipoleMeasurement.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/ip_diffim/g1470d8bcf6+6be6c9203b/python/lsst/ip/diffim/dipoleMeasurement.py

Public Member Functions

Public Attributes

Static Public Attributes