DipoleMeasurementTask

DipoleMeasurementTask measures sources on images to identify likely dipoles. This task is purely a configuration wrapper around SingleFrameMeasurementTask, with helpers to performe dipole-specific measurements.

Description

The plugins used by this task by default allow the user to test the hypothesis that the Source is a dipole. This includes a set of measurements derived from intermediate base classes DipoleCentroidAlgorithm and DipoleFluxAlgorithm. Their respective algorithm control classes are defined in DipoleCentroidControl and DipoleFluxControl. Each centroid and flux measurement will have _neg (negative) and _pos (positive lobe) fields.

The first set of measurements uses a “naive” algorithm for centroid and flux measurements, implemented in NaiveDipoleCentroidControl and NaiveDipoleFluxControl. The algorithm uses a naive 3x3 weighted moment around the nominal centroids of each peak in the Source Footprint. These algorithms fill the table fields ip_diffim_NaiveDipoleCentroid* and ip_diffim_NaiveDipoleFlux*

The second set of measurements undertakes a joint-Psf model on the negative and positive lobe simultaneously. This fit simultaneously solves for the negative and positive lobe centroids and fluxes using non-linear least squares minimization. The fields are stored in table elements ip_diffim_PsfDipoleFlux*.

Python API summary

from lsst.ip.diffim.dipoleMeasurement import DipoleMeasurementTask

classDipoleMeasurementTask(schema, algMetadata=None, **kwds)

Measurement of Sources, specifically ones from difference images, for characterization as dipoles...

attributeconfig

Access configuration fields and retargetable subtasks.

methodrun(measCat, exposure, noiseImage=None, exposureId=None, beginOrder=None, endOrder=None)

Run single frame measurement over an exposure and source catalog...

See also

See the DipoleMeasurementTask API reference for complete details.

Retargetable subtasks

plugins

Default

['base_PixelFlags', 'base_SdssCentroid', 'base_NaiveCentroid', 'base_SdssShape', 'base_GaussianFlux', 'base_PsfFlux', 'base_CircularApertureFlux', 'base_SkyCoord', 'base_Variance', 'base_Blendedness', 'base_LocalBackground', 'base_CompensatedGaussianFlux', 'base_ClassificationSizeExtendedness']

Field type

Multi-selection RegistryField

Choices

'base_PsfFlux'

lsst.meas.base.pluginRegistry.Configurable

'base_PeakLikelihoodFlux'

lsst.meas.base.pluginRegistry.Configurable

'base_GaussianFlux'

lsst.meas.base.pluginRegistry.Configurable

'base_NaiveCentroid'

lsst.meas.base.pluginRegistry.Configurable

'base_SdssCentroid'

lsst.meas.base.pluginRegistry.Configurable

'base_PixelFlags'

lsst.meas.base.pluginRegistry.Configurable

'base_SdssShape'

lsst.meas.base.pluginRegistry.Configurable

'base_ScaledApertureFlux'

lsst.meas.base.pluginRegistry.Configurable

'base_CircularApertureFlux'

lsst.meas.base.pluginRegistry.Configurable

'base_Blendedness'

lsst.meas.base.pluginRegistry.Configurable

'base_LocalBackground'

lsst.meas.base.pluginRegistry.Configurable

'base_FPPosition'

lsst.meas.base.pluginRegistry.Configurable

'base_Jacobian'

lsst.meas.base.pluginRegistry.Configurable

'base_Variance'

lsst.meas.base.pluginRegistry.Configurable

'base_InputCount'

lsst.meas.base.pluginRegistry.Configurable

'base_LocalPhotoCalib'

lsst.meas.base.pluginRegistry.Configurable

'base_LocalWcs'

lsst.meas.base.pluginRegistry.Configurable

'base_PeakCentroid'

lsst.meas.base.pluginRegistry.Configurable

'base_SkyCoord'

lsst.meas.base.pluginRegistry.Configurable

'base_ClassificationSizeExtendedness'

lsst.meas.base.pluginRegistry.Configurable

'base_CompensatedGaussianFlux'

lsst.meas.base.pluginRegistry.Configurable

'ip_diffim_DipoleFit'

lsst.meas.base.pluginRegistry.Configurable

'ip_diffim_ClassificationDipole'

lsst.meas.base.pluginRegistry.Configurable

'ext_trailedSources_Naive'

lsst.meas.base.pluginRegistry.Configurable

'ext_trailedSources_Veres'

lsst.meas.base.pluginRegistry.Configurable

'ext_shapeHSM_HigherOrderMomentsSource'

lsst.meas.base.pluginRegistry.Configurable

'ext_shapeHSM_HigherOrderMomentsPSF'

lsst.meas.base.pluginRegistry.Configurable

'ext_shapeHSM_HsmSourceMoments'

lsst.meas.base.pluginRegistry.Configurable

'ext_shapeHSM_HsmSourceMomentsRound'

lsst.meas.base.pluginRegistry.Configurable

'ext_shapeHSM_HsmPsfMoments'

lsst.meas.base.pluginRegistry.Configurable

'ext_shapeHSM_HsmPsfMomentsDebiased'

lsst.meas.base.pluginRegistry.Configurable

'ext_shapeHSM_HsmShapeBj'

lsst.meas.base.pluginRegistry.Configurable

'ext_shapeHSM_HsmShapeLinear'

lsst.meas.base.pluginRegistry.Configurable

'ext_shapeHSM_HsmShapeKsb'

lsst.meas.base.pluginRegistry.Configurable

'ext_shapeHSM_HsmShapeRegauss'

lsst.meas.base.pluginRegistry.Configurable

'ip_diffim_NaiveDipoleCentroid'

lsst.meas.base.pluginRegistry.Configurable

'ip_diffim_NaiveDipoleFlux'

lsst.meas.base.pluginRegistry.Configurable

'ip_diffim_PsfDipoleFlux'

lsst.meas.base.pluginRegistry.Configurable

'ext_gaap_GaapFlux'

lsst.meas.base.pluginRegistry.Configurable

Plugins to be run and their configuration

undeblended

Default

[]

Field type

Multi-selection RegistryField

Choices

'base_PsfFlux'

lsst.meas.base.pluginRegistry.Configurable

'base_PeakLikelihoodFlux'

lsst.meas.base.pluginRegistry.Configurable

'base_GaussianFlux'

lsst.meas.base.pluginRegistry.Configurable

'base_NaiveCentroid'

lsst.meas.base.pluginRegistry.Configurable

'base_SdssCentroid'

lsst.meas.base.pluginRegistry.Configurable

'base_PixelFlags'

lsst.meas.base.pluginRegistry.Configurable

'base_SdssShape'

lsst.meas.base.pluginRegistry.Configurable

'base_ScaledApertureFlux'

lsst.meas.base.pluginRegistry.Configurable

'base_CircularApertureFlux'

lsst.meas.base.pluginRegistry.Configurable

'base_Blendedness'

lsst.meas.base.pluginRegistry.Configurable

'base_LocalBackground'

lsst.meas.base.pluginRegistry.Configurable

'base_FPPosition'

lsst.meas.base.pluginRegistry.Configurable

'base_Jacobian'

lsst.meas.base.pluginRegistry.Configurable

'base_Variance'

lsst.meas.base.pluginRegistry.Configurable

'base_InputCount'

lsst.meas.base.pluginRegistry.Configurable

'base_LocalPhotoCalib'

lsst.meas.base.pluginRegistry.Configurable

'base_LocalWcs'

lsst.meas.base.pluginRegistry.Configurable

'base_PeakCentroid'

lsst.meas.base.pluginRegistry.Configurable

'base_SkyCoord'

lsst.meas.base.pluginRegistry.Configurable

'base_ClassificationSizeExtendedness'

lsst.meas.base.pluginRegistry.Configurable

'base_CompensatedGaussianFlux'

lsst.meas.base.pluginRegistry.Configurable

'ip_diffim_DipoleFit'

lsst.meas.base.pluginRegistry.Configurable

'ip_diffim_ClassificationDipole'

lsst.meas.base.pluginRegistry.Configurable

'ext_trailedSources_Naive'

lsst.meas.base.pluginRegistry.Configurable

'ext_trailedSources_Veres'

lsst.meas.base.pluginRegistry.Configurable

'ext_shapeHSM_HigherOrderMomentsSource'

lsst.meas.base.pluginRegistry.Configurable

'ext_shapeHSM_HigherOrderMomentsPSF'

lsst.meas.base.pluginRegistry.Configurable

'ext_shapeHSM_HsmSourceMoments'

lsst.meas.base.pluginRegistry.Configurable

'ext_shapeHSM_HsmSourceMomentsRound'

lsst.meas.base.pluginRegistry.Configurable

'ext_shapeHSM_HsmPsfMoments'

lsst.meas.base.pluginRegistry.Configurable

'ext_shapeHSM_HsmPsfMomentsDebiased'

lsst.meas.base.pluginRegistry.Configurable

'ext_shapeHSM_HsmShapeBj'

lsst.meas.base.pluginRegistry.Configurable

'ext_shapeHSM_HsmShapeLinear'

lsst.meas.base.pluginRegistry.Configurable

'ext_shapeHSM_HsmShapeKsb'

lsst.meas.base.pluginRegistry.Configurable

'ext_shapeHSM_HsmShapeRegauss'

lsst.meas.base.pluginRegistry.Configurable

'ip_diffim_NaiveDipoleCentroid'

lsst.meas.base.pluginRegistry.Configurable

'ip_diffim_NaiveDipoleFlux'

lsst.meas.base.pluginRegistry.Configurable

'ip_diffim_PsfDipoleFlux'

lsst.meas.base.pluginRegistry.Configurable

'ext_gaap_GaapFlux'

lsst.meas.base.pluginRegistry.Configurable

Plugins to run on undeblended image

Configuration fields

doReplaceWithNoise

Default

True

Field type

bool Field

When measuring, replace other detected footprints with noise?

noiseReplacer

Data type

lsst.meas.base.noiseReplacer.NoiseReplacerConfig

Field type

ConfigField

configuration that sets how to replace neighboring sources with noise

slots

Data type

lsst.meas.base.baseMeasurement.SourceSlotConfig

Field type

ConfigField

Mapping from algorithms to special aliases in Source.

undeblendedPrefix

Default

'undeblended_'

Field type

str Field

Prefix to give undeblended plugins

Debugging

The pipetask command line interface supports a --debug flag to import debug.py from your PYTHONPATH; see lsstDebug for more about debug.py files. The available variables in DipoleMeasurementTask include:

displaybool

Enable debug display output.

maskTransparencyfloat

Transparency of mask planes in the output display.

displayDiaSourcesbool

Show exposure with dipole fitting results.