TransformForcedSourceTableTask

class lsst.pipe.tasks.postprocess.TransformForcedSourceTableTask(*args, **kwargs)

Bases: TransformCatalogBaseTask

Transform/standardize a ForcedSource catalog

Transforms each wide, per-detector forcedSource DataFrame per the specification file (per-camera defaults found in ForcedSource.yaml). All epochs that overlap the patch are aggregated into one per-patch narrow-DataFrame file.

No de-duplication of rows is performed. Duplicate resolutions flags are pulled in from the referenceCatalog: detect_isPrimary, detect_isTractInner,`detect_isPatchInner`, so that user may de-duplicate for analysis or compare duplicates for QA.

The resulting table includes multiple bands. Epochs (MJDs) and other useful per-visit rows can be retreived by joining with the CcdVisitTable on ccdVisitId.

Attributes Summary

canMultiprocess
inputDataset
outputDataset

Methods Summary

emptyMetadata()	Empty (clear) the metadata for this Task and all sub-Tasks.
getAnalysis(handles[, funcs, band])
getFullMetadata()	Get metadata for all tasks.
getFullName()	Get the task name as a hierarchical name including parent task names.
getFunctors()
getName()	Get the name of the task.
getTaskDict()	Get a dictionary of all tasks as a shallow copy.
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(inputCatalogs, referenceCatalog[, ...])	Do postprocessing calculations
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.
transform(band, handles, funcs, dataId)

Attributes Documentation

canMultiprocess: ClassVar[bool] = True

inputDataset

outputDataset

Methods Documentation

emptyMetadata() → None

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

getAnalysis(handles, funcs=None, band=None)

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”.

getFunctors()

getName() → str

Get the name of the task.

Returns:

taskNamestr

Name of the task.

See also

getFullName

getTaskDict() → Dict[str, ReferenceType[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.

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.

run(inputCatalogs, referenceCatalog, funcs=None, dataId=None, band=None)

Do postprocessing calculations

Takes a DeferredDatasetHandle or InMemoryDatasetHandle or DataFrame object and dataId, returns a dataframe with results of postprocessing calculations.

Parameters:

handleslsst.daf.butler.DeferredDatasetHandle or

lsst.pipe.base.InMemoryDatasetHandle or pandas.DataFrame, or list of these.

DataFrames from which calculations are done.

funcslsst.pipe.tasks.functors.Functors

Functors to apply to the table’s columns

dataIddict, optional

Used to add a patchId column to the output dataframe.

bandstr, optional

Filter band that is being processed.

Returns

——

dfpandas.DataFrame

runQuantum(butlerQC, inputRefs, outputRefs)

Method to do butler IO and or transforms to provide in memory objects for tasks run method

Parameters:

butlerQCButlerQuantumContext

A butler which is specialized to operate in the context of a lsst.daf.butler.Quantum.

inputRefsInputQuantizedConnection

Datastructure whose attribute names are the names that identify connections defined in corresponding PipelineTaskConnections class. The values of these attributes are the lsst.daf.butler.DatasetRef objects associated with the defined input/prerequisite connections.

outputRefsOutputQuantizedConnection

Datastructure whose attribute names are the names that identify connections defined in corresponding PipelineTaskConnections class. The values of these attributes are the lsst.daf.butler.DatasetRef objects associated with the defined output connections.

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.

logLevel

A logging level constant.

See also

timer.logInfo

Examples

Creating a timer context:

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

transform(band, handles, funcs, dataId)