MatchVariableFakesTask¶
- class lsst.pipe.tasks.matchFakes.MatchVariableFakesTask(*, config: PipelineTaskConfig | None = None, log: logging.Logger | LsstLogAdapter | None = None, initInputs: dict[str, Any] | None = None, **kwargs: Any)¶
Bases:
MatchFakesTask
Match injected fakes to their detected sources in the catalog and compute their expected brightness in a difference image assuming perfect subtraction.
This task is generally for injected sources that cannot be easily identified by their footprints such as in the case of detector sources post image differencing.
Attributes Summary
Methods Summary
composeFakeCat
(fakeCats, skyMap)Concatenate the fakeCats from tracts that may cover the exposure.
computeExpectedDiffMag
(fakeCat, ...)Compute the magnitude expected in the difference image for this detector/visit.
Empty (clear) the metadata for this Task and all sub-Tasks.
Get metadata for all tasks.
Get the task name as a hierarchical name including parent task names.
getName
()Get the name of the task.
Get a dictionary of all tasks as a shallow copy.
getVisitMatchedFakeCat
(fakeCat, exposure)Trim the fakeCat to select particular visit
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.run
(fakeCats, ccdVisitFakeMagnitudes, ...)Match fakes to detected diaSources within a difference image bound.
runQuantum
(butlerQC, inputRefs, outputRefs)Do butler IO and transform 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
- composeFakeCat(fakeCats, skyMap)¶
Concatenate the fakeCats from tracts that may cover the exposure.
- Parameters:
- fakeCats
list
oflsst.daf.butler.DeferredDatasetHandle
Set of fake cats to concatenate.
- skyMap
lsst.skymap.SkyMap
SkyMap defining the geometry of the tracts and patches.
- fakeCats
- Returns:
- combinedFakeCat
pandas.DataFrame
All fakes that cover the inner polygon of the tracts in this quantum.
- combinedFakeCat
- computeExpectedDiffMag(fakeCat, ccdVisitFakeMagnitudes, band)¶
Compute the magnitude expected in the difference image for this detector/visit. Modify fakeCat in place.
Negative magnitudes indicate that the source should be detected as a negative source.
- Parameters:
- fakeCat
pandas.DataFrame
Catalog of fake sources.
- ccdVisitFakeMagnitudes
pandas.DataFrame
Magnitudes for variable sources in this specific ccdVisit.
- band
str
Band that this ccdVisit was observed in.
- fakeCat
- 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
- getName() str ¶
Get the name of the task.
- Returns:
- taskName
str
Name of the task.
- taskName
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:
- taskDict
dict
Dictionary containing full task name: task object for the top-level task and all subtasks, sub-subtasks, etc.
- taskDict
- getVisitMatchedFakeCat(fakeCat, exposure)¶
Trim the fakeCat to select particular visit
- Parameters:
- fakeCat
pandas.core.frame.DataFrame
The catalog of fake sources to add to the exposure
- exposure
lsst.afw.image.exposure.exposure.ExposureF
The exposure to add the fake sources to
- fakeCat
- Returns:
- movingFakeCat
pandas.DataFrame
All fakes that belong to the visit
- movingFakeCat
- 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")
- 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
.
- run(fakeCats, ccdVisitFakeMagnitudes, skyMap, diffIm, associatedDiaSources, band)¶
Match fakes to detected diaSources within a difference image bound.
- Parameters:
- fakeCat
pandas.DataFrame
Catalog of fakes to match to detected diaSources.
- diffIm
lsst.afw.image.Exposure
Difference image where
associatedDiaSources
were detected in.- associatedDiaSources
pandas.DataFrame
Catalog of difference image sources detected in
diffIm
.
- fakeCat
- Returns:
- result
lsst.pipe.base.Struct
Results struct with components.
matchedDiaSources
: Fakes matched to input diaSources. Has length offakeCat
. (pandas.DataFrame
)
- result
- runQuantum(butlerQC, inputRefs, outputRefs)¶
Do butler IO and transform to provide in memory objects for tasks
run
method.- Parameters:
- butlerQC
QuantumContext
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