DipoleFitTask¶

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

Bases: lsst.meas.base.sfm.SingleFrameMeasurementTask

!Subclass of SingleFrameMeasurementTask which accepts up to three input images in its run() method.

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`
`NOISE_OFFSET`
`NOISE_SEED_MULTIPLIER`
`NOISE_SOURCE`

Methods Summary

`callMeasure`(measRecord, args, *kwds)	!
`callMeasureN`(measCat, args, *kwds)	!
`doMeasurement`(plugin, measRecord, args, *kwds)	!
`doMeasurementN`(plugin, measCat, args, *kwds)	!
`emptyMetadata`()	Empty (clear) the metadata for this Task and all sub-Tasks.
`getAllSchemaCatalogs`()	Get schema catalogs for all tasks in the hierarchy, combining the results into a single dict.
`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.
`getPluginLogName`(pluginName)
`getSchemaCatalogs`()	Get the schemas generated by this task.
`getTaskDict`()	Get a dictionary of all tasks as a shallow copy.
`initializePlugins`(**kwds)	Initialize the plugins (and slots) according to the 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)	!
`run`(sources, exposure[, posExp, negExp])	!Run dipole measurement and classification
`runPlugins`(noiseReplacer, measCat, exposure)	Function which calls the defined measument plugins on an exposure
`timer`(name[, logLevel])	Context manager to log performance data for an arbitrary block of code.

Attributes Documentation

NOISE_EXPOSURE_ID = 'NOISE_EXPOSURE_ID'¶

NOISE_OFFSET = 'NOISE_OFFSET'¶

NOISE_SEED_MULTIPLIER = 'NOISE_SEED_MULTIPLIER'¶

NOISE_SOURCE = 'NOISE_SOURCE'¶

Methods Documentation

callMeasure(measRecord, *args, **kwds)¶

! Call the measure() method on all plugins, handling exceptions in a consistent way.

@param[in,out] measRecord lsst.afw.table.SourceRecord that corresponds to the object being: measured, and where outputs should be written.

@param[in] *args Positional arguments forwarded to Plugin.measure() @param[in] **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.

the rest are forwarded to Plugin.measure()

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 the measureN() method on all plugins, handling exceptions in a consistent way.

@param[in,out] measCat lsst.afw.table.SourceCatalog containing records for just: the source family to be measured, and where outputs should be written.
@param[in] beginOrder beginning execution order (inclusive): measurements with: executionOrder < beginOrder are not executed. None for no limit.
@param[in] endOrder ending execution order (exclusive): measurements with: executionOrder >= endOrder are not executed. None for no limit.

@param[in] *args Positional arguments forwarded to Plugin.measure() @param[in] **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.

the rest are forwarded to Plugin.measure()

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 the measure() method on the nominated plugin, handling exceptions in a consistent way.

@param[in] plugin Plugin that will measure @param[in,out] measRecord lsst.afw.table.SourceRecord that corresponds to the object being

measured, and where outputs should be written.

@param[in] *args Positional arguments forwarded to plugin.measure() @param[in] **kwds Keyword arguments forwarded to plugin.measure()

This method can be used with plugins that have different signatures; the only requirement is that the ‘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 the measureN() method on the nominated plugin, handling exceptions in a consistent way.

@param[in] plugin Plugin that will measure @param[in,out] measCat lsst.afw.table.SourceCatalog containing records for just

the source family to be measured, and where outputs should be written.

@param[in] *args Positional arguments forwarded to plugin.measureN() @param[in] **kwds Keyword arguments forwarded to plugin.measureN()

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()¶: Empty (clear) the metadata for this Task and all sub-Tasks.

getAllSchemaCatalogs()¶

Get schema catalogs for all tasks in the hierarchy, combining the results into a single dict.

Returns:	schemacatalogs : `dict` Keys are butler dataset type, values are a empty catalog (an instance of the appropriate lsst.afw.table Catalog type) for all tasks in the hierarchy, from the top-level task down through all subtasks.

Notes

This method may be called on any task in the hierarchy; it will return the same answer, regardless.

The default implementation should always suffice. If your subtask uses schemas the override Task.getSchemaCatalogs, not this method.

getFullMetadata()¶

Get metadata for all tasks.

Returns:	metadata : `lsst.daf.base.PropertySet` The `PropertySet` 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()¶

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

Returns:	fullName : `str` 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()¶

Get the name of the task.

Returns:	taskName : `str` Name of the task.

See also

Task.getAllSchemaCatalogs

Notes

Warning

Subclasses that use schemas must override this method. The default implemenation returns an empty dict.

This method may be called at any time after the Task is constructed, which means that all task schemas should be computed at construction time, not when data is actually processed. This reflects the philosophy that the schema should not depend on the data.

Returning catalogs rather than just schemas allows us to save e.g. slots for SourceCatalog as well.

getTaskDict()¶

Get a dictionary of all tasks as a shallow copy.

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

initializePlugins(**kwds)¶

Initialize the plugins (and slots) according to the configuration.

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

In addition to the attributes added by BaseMeasurementTask.__init__, a self.schema attribute holding the output schema must also 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)¶

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

Parameters:	doc : `str` Help text for the field.
Returns:	configurableField : `lsst.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("a brief description of what this task does")

makeSubtask(name, **keyArgs)¶

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

Parameters:	name : `str` 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 pex_config ConfigurableField or RegistryField.

measure(measCat, exposure)¶: ! Backwards-compatibility alias for run()

run(sources, exposure, posExp=None, negExp=None, **kwds)¶

!Run dipole measurement and classification

@param sources diaSources that will be measured using dipole measurement @param exposure Difference exposure on which the diaSources were detected; exposure = posExp - negExp @param posExp “Positive” exposure, typically a science exposure, or None if unavailable @param negExp “Negative” exposure, typically a template exposure, or None if unavailable @param **kwds Sent to SingleFrameMeasurementTask

@note When posExp is None, will compute posImage = exposure + negExp. Likewise, when negExp is None, will compute negImage = posExp - exposure. If both posExp and negExp are None, will attempt to fit the dipole to just the exposure with no constraint.

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

Function which calls the defined measument plugins on an exposure

Parameters:

noiseReplacer : lsst.meas.base.NoiseReplacer: noiseReplacer to fill sources not being measured with noise.
measCat : lsst.afw.table.SourceCatalog: SourceCatalog to be filled with outputs. Must contain all the SourceRecords to be measured (with Footprints attached), and have a schema that is a superset of self.schema.
exposure : lsst.afw.image.ExposureF: Exposure contaning the pixel data to be measured and the associated PSF, WCS, etc.
beginOrder : float: beginning execution order (inclusive): measurements with executionOrder < beginOrder are not executed. None for no limit.
endOrder : float: ending execution order (exclusive): measurements with executionOrder >= endOrder are not executed. None for no limit.

timer(name, logLevel=10000)¶

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

Parameters:	name : `str` Name of code being timed; data will be logged using item name: `Start` and `End`. logLevel A `lsst.log` level constant.

Navigation

DipoleFitTask¶