DetectAndMeasureTask¶
- class lsst.ip.diffim.DetectAndMeasureTask(**kwargs)¶
Bases:
PipelineTask
Detect and measure sources on a difference image.
Attributes Summary
Methods Summary
addSkySources
(diaSources, mask, seed)Add sources in empty regions of the difference image for measuring the background.
Empty (clear) the metadata for this Task and all sub-Tasks.
Get schema catalogs for all tasks in the hierarchy, combining the results into a single dict.
Get metadata for all tasks.
Get the task name as a hierarchical name including parent task names.
getName
()Get the name of the task.
Return resource configuration for this task.
Get the schemas generated by this task.
Get a dictionary of all tasks as a shallow copy.
makeField
(doc)Make a
lsst.pex.config.ConfigurableField
for this task.makeIdFactory
(expId, expBits)Create IdFactory instance for unique 64 bit diaSource id-s.
makeSubtask
(name, **keyArgs)Create a subtask as a new instance as the
name
attribute of this task.measureDiaSources
(diaSources, science, ...)Use (matched) template and science image to constrain dipole fitting.
measureForcedSources
(diaSources, science, wcs)Perform forced measurement of the diaSources on the science image.
run
(science, template, difference, selectSources)Detect and measure sources on a difference image.
runQuantum
(butlerQC, inputRefs, outputRefs)Method to do butler IO and or transforms to provide in memory objects for tasks run method
timer
(name[, logLevel])Context manager to log performance data for an arbitrary block of code.
Attributes Documentation
Methods Documentation
- addSkySources(diaSources, mask, seed)¶
Add sources in empty regions of the difference image for measuring the background.
- Parameters:
- diaSources
lsst.afw.table.SourceCatalog
The catalog of detected sources.
- mask
lsst.afw.image.Mask
Mask plane for determining regions where Sky sources can be added.
- seed
int
Seed value to initialize the random number generator.
- diaSources
- getAllSchemaCatalogs() Dict[str, Any] ¶
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.
- schemacatalogs
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() TaskMetadata ¶
Get metadata for all tasks.
- Returns:
- metadata
TaskMetadata
The keys are the full task name. Values are metadata for the top-level task and all subtasks, sub-subtasks, etc.
- metadata
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:
- 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”.
- fullName
- getResourceConfig() ResourceConfig | None ¶
Return resource configuration for this task.
- Returns:
- Object of type
ResourceConfig
orNone
if resource - configuration is not defined for this task.
- Object of type
- getSchemaCatalogs() Dict[str, Any] ¶
Get the schemas generated by this task.
- Returns:
- schemaCatalogs
dict
Keys are butler dataset type, values are an empty catalog (an instance of the appropriate
lsst.afw.table
Catalog type) for this task.
- schemaCatalogs
See also
Task.getAllSchemaCatalogs
Notes
Warning
Subclasses that use schemas must override this method. The default implementation 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() Dict[str, ReferenceType[Task]] ¶
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.
- taskDict
- classmethod makeField(doc: str) ConfigurableField ¶
Make a
lsst.pex.config.ConfigurableField
for this task.- Parameters:
- doc
str
Help text for the field.
- doc
- Returns:
- configurableField
lsst.pex.config.ConfigurableField
A
ConfigurableField
for this task.
- configurableField
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")
- static makeIdFactory(expId, expBits)¶
Create IdFactory instance for unique 64 bit diaSource id-s.
- Parameters:
- expId
int
Exposure id.
- expBits: `int`
Number of used bits in
expId
.
- expId
- Returns:
- idFactory:
lsst.afw.table.IdFactory
- idFactory:
Notes
The diasource id-s consists of the
expId
stored fixed in the highest valueexpBits
of the 64-bit integer plus (bitwise or) a generated sequence number in the low value end of the integer.
- makeSubtask(name: str, **keyArgs: Any) None ¶
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”.
- name
Notes
The subtask must be defined by
Task.config.name
, an instance ofConfigurableField
orRegistryField
.
- measureDiaSources(diaSources, science, difference, matchedTemplate)¶
Use (matched) template and science image to constrain dipole fitting.
- Parameters:
- diaSources
lsst.afw.table.SourceCatalog
The catalog of detected sources.
- science
lsst.afw.image.ExposureF
Science exposure that the template was subtracted from.
- difference
lsst.afw.image.ExposureF
Result of subtracting template from the science image.
- matchedTemplate
lsst.afw.image.ExposureF
Warped and PSF-matched template that was used produce the difference image.
- diaSources
- measureForcedSources(diaSources, science, wcs)¶
Perform forced measurement of the diaSources on the science image.
- Parameters:
- diaSources
lsst.afw.table.SourceCatalog
The catalog of detected sources.
- science
lsst.afw.image.ExposureF
Science exposure that the template was subtracted from.
- wcs
lsst.afw.geom.SkyWcs
Coordinate system definition (wcs) for the exposure.
- diaSources
- run(science, template, difference, selectSources, idFactory=None)¶
Detect and measure sources on a difference image.
- Parameters:
- science
lsst.afw.image.ExposureF
Science exposure that the template was subtracted from.
- template
lsst.afw.image.ExposureF
Warped and PSF-matched template that was used produce the difference image.
- difference
lsst.afw.image.ExposureF
Result of subtracting template from the science image.
- selectSources
lsst.afw.table.SourceCatalog
, optional Identified sources on the science exposure.
- idFactory
lsst.afw.table.IdFactory
Generator object to assign ids to detected sources in the difference image.
- science
- Returns:
- results
lsst.pipe.base.Struct
subtractedMeasuredExposure
lsst.afw.image.ExposureF
Subtracted exposure with detection mask applied.
diaSources
lsst.afw.table.SourceCatalog
The catalog of detected sources.
- results
- runQuantum(butlerQC: ButlerQuantumContext, inputRefs: InputQuantizedConnection, outputRefs: OutputQuantizedConnection)¶
Method to do butler IO and or transforms to provide in memory objects for tasks run method
- Parameters:
- butlerQC
ButlerQuantumContext
A butler which is specialized to operate in the context of a
lsst.daf.butler.Quantum
.- inputRefs
InputQuantizedConnection
Datastructure whose attribute names are the names that identify connections defined in corresponding
PipelineTaskConnections
class. The values of these attributes are thelsst.daf.butler.DatasetRef
objects associated with the defined input/prerequisite connections.- outputRefs
OutputQuantizedConnection
Datastructure whose attribute names are the names that identify connections defined in corresponding
PipelineTaskConnections
class. The values of these attributes are thelsst.daf.butler.DatasetRef
objects associated with the defined output connections.
- butlerQC