DipoleFitTask

class lsst.ip.diffim.DipoleFitTask(schema, algMetadata=None, **kwargs)

Bases: SingleFrameMeasurementTask

A task that fits a dipole to a difference image, with an optional separate detection image.

Because it subclasses SingleFrameMeasurementTask, and calls SingleFrameMeasurementTask.run() from its run() method, it still can be used identically to a standard SingleFrameMeasurementTask.

Attributes Summary

NOISE_EXPOSURE_ID

Name by which the noise exposire ID is recorded in metadata ('str').

NOISE_OFFSET

Name by which the noise offset is recorded in metadata ('str').

NOISE_SEED_MULTIPLIER

Name by which the noise seed multiplier is recorded in metadata ('str').

NOISE_SOURCE

Name by which the noise source is recorded in metadata ('str').

algMetadata

Metadata about active plugins (lsst.daf.base.PropertyList).

plugins

Plugins to be invoked (PluginMap).

Methods Summary

callMeasure(measRecord, *args, **kwds)

Call measure on all plugins and consistently handle exceptions.

callMeasureN(measCat, *args, **kwds)

Call measureN on all plugins and consistently handle exceptions.

doMeasurement(plugin, measRecord, *args, **kwds)

Call measure on the specified plugin.

doMeasurementN(plugin, measCat, *args, **kwds)

Call measureN on the specified plugin.

emptyMetadata()

Empty (clear) the metadata for this Task and all sub-Tasks.

getFullMetadata()

Get metadata for all tasks.

getFullName()

Get the task name as a hierarchical name including parent task names.

getName()

Get the name of the task.

getTaskDict()

Get a dictionary of all tasks as a shallow copy.

initializePlugins(**kwds)

Initialize plugins (and slots) according to configuration.

makeField(doc)

Make a lsst.pex.config.ConfigurableField for this task.

makeSubtask(name, **keyArgs)

Create a subtask as a new instance as the name attribute of this task.

measure(measCat, exposure)

Backwards-compatibility alias for run.

run(sources, exposure[, posExp, negExp])

Run dipole measurement and classification

runPlugins(noiseReplacer, measCat, exposure)

Call the configured measument plugins on an image.

timer(name[, logLevel])

Context manager to log performance data for an arbitrary block of code.

Attributes Documentation

NOISE_EXPOSURE_ID = 'NOISE_EXPOSURE_ID'

Name by which the noise exposire ID is recorded in metadata (‘str’).

NOISE_OFFSET = 'NOISE_OFFSET'

Name by which the noise offset is recorded in metadata (‘str’).

NOISE_SEED_MULTIPLIER = 'NOISE_SEED_MULTIPLIER'

Name by which the noise seed multiplier is recorded in metadata (‘str’).

NOISE_SOURCE = 'NOISE_SOURCE'

Name by which the noise source is recorded in metadata (‘str’).

algMetadata = None

Metadata about active plugins (lsst.daf.base.PropertyList).

Contains additional information about active plugins to be saved with the output catalog. Will be filled by subclasses.

plugins = None

Plugins to be invoked (PluginMap).

Initially empty, this will be populated as plugins are initialized. It should be considered read-only.

Methods Documentation

callMeasure(measRecord, *args, **kwds)

Call measure on all plugins and consistently handle exceptions.

Parameters:
measRecordlsst.afw.table.SourceRecord

The record corresponding to the object being measured. Will be updated in-place with the results of measurement.

*args

Positional arguments forwarded to plugin.measure

**kwds

Keyword arguments. Two are handled locally:

beginOrderint

Beginning execution order (inclusive). Measurements with executionOrder < beginOrder are not executed. None for no limit.

endOrderint

Ending execution order (exclusive). Measurements with executionOrder >= endOrder are not executed. None for no limit.

Others are forwarded to plugin.measure().

Notes

This method can be used with plugins that have different signatures; the only requirement is that measRecord be the first argument. Subsequent positional arguments and keyword arguments are forwarded directly to the plugin.

This method should be considered “protected”: it is intended for use by derived classes, not users.

callMeasureN(measCat, *args, **kwds)

Call measureN on all plugins and consistently handle exceptions.

Parameters:
measCatlsst.afw.table.SourceCatalog

Catalog containing only the records for the source family to be measured, and where outputs should be written.

*args

Positional arguments forwarded to plugin.measure()

**kwds

Keyword arguments. Two are handled locally:

beginOrder:

Beginning execution order (inclusive): Measurements with executionOrder < beginOrder are not executed. None for no limit.

endOrder:

Ending execution order (exclusive): measurements with executionOrder >= endOrder are not executed. None for no limit.

Others are are forwarded to plugin.measure().

Notes

This method can be used with plugins that have different signatures; the only requirement is that measRecord be the first argument. Subsequent positional arguments and keyword arguments are forwarded directly to the plugin.

This method should be considered “protected”: it is intended for use by derived classes, not users.

doMeasurement(plugin, measRecord, *args, **kwds)

Call measure on the specified plugin.

Exceptions are handled in a consistent way.

Parameters:
pluginsubclass of BasePlugin

Plugin that will be executed.

measRecordlsst.afw.table.SourceRecord

The record corresponding to the object being measured. Will be updated in-place with the results of measurement.

*args

Positional arguments forwarded to plugin.measure().

**kwds

Keyword arguments forwarded to plugin.measure().

Notes

This method can be used with plugins that have different signatures; the only requirement is that plugin and measRecord be the first two arguments. Subsequent positional arguments and keyword arguments are forwarded directly to the plugin.

This method should be considered “protected”: it is intended for use by derived classes, not users.

doMeasurementN(plugin, measCat, *args, **kwds)

Call measureN on the specified plugin.

Exceptions are handled in a consistent way.

Parameters:
pluginsubclass of BasePlugin

Plugin that will be executed.

measCatlsst.afw.table.SourceCatalog

Catalog containing only the records for the source family to be measured, and where outputs should be written.

*args

Positional arguments forwarded to plugin.measureN().

**kwds

Keyword arguments forwarded to plugin.measureN().

Notes

This method can be used with plugins that have different signatures; the only requirement is that the plugin and measCat be the first two arguments. Subsequent positional arguments and keyword arguments are forwarded directly to the plugin.

This method should be considered “protected”: it is intended for use by derived classes, not users.

emptyMetadata() None

Empty (clear) the metadata for this Task and all sub-Tasks.

getFullMetadata() TaskMetadata

Get metadata for all tasks.

Returns:
metadataTaskMetadata

The keys are the full task name. Values are metadata for the top-level task and all subtasks, sub-subtasks, etc.

Notes

The returned metadata includes timing information (if @timer.timeMethod is used) and any metadata set by the task. The name of each item consists of the full task name with . replaced by :, followed by . and the name of the item, e.g.:

topLevelTaskName:subtaskName:subsubtaskName.itemName

using : in the full task name disambiguates the rare situation that a task has a subtask and a metadata item with the same name.

getFullName() str

Get the task name as a hierarchical name including parent task names.

Returns:
fullNamestr

The full name consists of the name of the parent task and each subtask separated by periods. For example:

  • The full name of top-level task “top” is simply “top”.

  • The full name of subtask “sub” of top-level task “top” is “top.sub”.

  • The full name of subtask “sub2” of subtask “sub” of top-level task “top” is “top.sub.sub2”.

getName() str

Get the name of the task.

Returns:
taskNamestr

Name of the task.

See also

getFullName

Get the full name of the task.

getTaskDict() dict[str, weakref.ReferenceType[lsst.pipe.base.task.Task]]

Get a dictionary of all tasks as a shallow copy.

Returns:
taskDictdict

Dictionary containing full task name: task object for the top-level task and all subtasks, sub-subtasks, etc.

initializePlugins(**kwds)

Initialize plugins (and slots) according to configuration.

Parameters:
**kwds

Keyword arguments forwarded directly to plugin constructors.

Notes

Derived class constructors should call this method to fill the plugins attribute and add corresponding output fields and slot aliases to the output schema.

In addition to the attributes added by BaseMeasurementTask.__init__, a schema` attribute holding the output schema must be present before this method is called.

Keyword arguments are forwarded directly to plugin constructors, allowing derived classes to use plugins with different signatures.

classmethod makeField(doc: str) ConfigurableField

Make a lsst.pex.config.ConfigurableField for this task.

Parameters:
docstr

Help text for the field.

Returns:
configurableFieldlsst.pex.config.ConfigurableField

A ConfigurableField for this task.

Examples

Provides a convenient way to specify this task is a subtask of another task.

Here is an example of use:

class OtherTaskConfig(lsst.pex.config.Config):
    aSubtask = ATaskClass.makeField("brief description of task")
makeSubtask(name: str, **keyArgs: Any) None

Create a subtask as a new instance as the name attribute of this task.

Parameters:
namestr

Brief name of the subtask.

**keyArgs

Extra keyword arguments used to construct the task. The following arguments are automatically provided and cannot be overridden:

  • config.

  • parentTask.

Notes

The subtask must be defined by Task.config.name, an instance of ConfigurableField or RegistryField.

measure(measCat, exposure)

Backwards-compatibility alias for run.

run(sources, exposure, posExp=None, negExp=None, **kwargs)

Run dipole measurement and classification

Parameters:
sourceslsst.afw.table.SourceCatalog

diaSources that will be measured using dipole measurement

exposurelsst.afw.image.Exposure

The difference exposure on which the diaSources of the sources parameter were detected. If neither posExp nor negExp are set, then the dipole is also fitted directly to this difference image.

posExplsst.afw.image.Exposure, optional

“Positive” exposure, typically a science exposure, or None if unavailable When posExp is None, will compute posImage = exposure + negExp.

negExplsst.afw.image.Exposure, optional

“Negative” exposure, typically a template exposure, or None if unavailable When negExp is None, will compute negImage = posExp - exposure.

**kwargs

Additional keyword arguments for lsst.meas.base.sfm.SingleFrameMeasurementTask.

runPlugins(noiseReplacer, measCat, exposure, beginOrder=None, endOrder=None)

Call the configured measument plugins on an image.

Parameters:
noiseReplacerNoiseReplacer

Used to fill sources not being measured with noise.

measCatlsst.afw.table.SourceCatalog

Catalog to be filled with the results of measurement. Must contain all the lsst.afw.table.SourceRecords to be measured (with lsst.afw.detection.Footprints attached), and have a schema that is a superset of self.schema.

exposurelsst.afw.image.ExposureF

Image containing the pixel data to be measured together with associated PSF, WCS, etc.

beginOrderfloat, optional

Start execution order (inclusive): measurements with executionOrder < beginOrder are not executed. None for no limit.

endOrderfloat, optional

Final execution order (exclusive): measurements with executionOrder >= endOrder are not executed. None for no limit.

timer(name: str, logLevel: int = 10) Iterator[None]

Context manager to log performance data for an arbitrary block of code.

Parameters:
namestr

Name of code being timed; data will be logged using item name: Start and End.

logLevelint

A logging level constant.

See also

lsst.utils.timer.logInfo

Implementation function.

Examples

Creating a timer context:

with self.timer("someCodeToTime"):
    pass  # code to time