ForcedPhotCcdFromDataFrameTask

class lsst.meas.base.ForcedPhotCcdFromDataFrameTask(refSchema=None, initInputs=None, **kwargs)

Bases: ForcedPhotCcdTask

Force Photometry on a per-detector exposure with coords from a DataFrame

Uses input from a DataFrame instead of SourceCatalog like the base class ForcedPhotCcd does. Writes out a SourceCatalog so that the downstream WriteForcedSourceTableTask can be reused with output from this Task.

Attributes Summary

canMultiprocess
dataPrefix

Methods Summary

attachFootprints(sources, refCat, exposure, ...)	Attach footprints to blank sources prior to measurements.
emptyMetadata()	Empty (clear) the metadata for this Task and all sub-Tasks.
generateMeasCat(dataId, exposure, refCat, refWcs)	Generate a measurement catalog.
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.
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.
prepareCalibratedExposure(exposure[, ...])	Prepare a calibrated exposure and apply external calibrations and sky corrections if so configured.
run(measCat, exposure, refCat, refWcs[, ...])	Perform forced measurement on a single exposure.
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

canMultiprocess: ClassVar[bool] = True

dataPrefix = ''

Methods Documentation

attachFootprints(sources, refCat, exposure, refWcs)

Attach footprints to blank sources prior to measurements.

Notes

Footprint objects for forced photometry must be in the pixel coordinate system of the image being measured, while the actual detections may start out in a different coordinate system.

Subclasses of this class may implement this method to define how those Footprint objects should be generated.

This default implementation transforms depends on the footprintSource configuration parameter.

emptyMetadata() → None

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

generateMeasCat(dataId, exposure, refCat, refWcs)

Generate a measurement catalog.

Parameters:

dataIdlsst.daf.butler.DataCoordinate

Butler data ID for this image, with {visit, detector} keys.

exposurelsst.afw.image.exposure.Exposure

Exposure to generate the catalog for.

refCatlsst.afw.table.SourceCatalog

Catalog of shapes and positions at which to force photometry.

refWcslsst.afw.image.SkyWcs

Reference world coordinate system. This parameter is not currently used.

Returns:

measCatlsst.afw.table.SourceCatalog

Catalog of forced sources to measure.

expIdint

Unique binary id associated with the input exposure

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.

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.

prepareCalibratedExposure(exposure, skyCorr=None, visitSummary=None)

Prepare a calibrated exposure and apply external calibrations and sky corrections if so configured.

Parameters:

exposurelsst.afw.image.exposure.Exposure

Input exposure to adjust calibrations.

skyCorrlsst.afw.math.backgroundList, optional

Sky correction frame to apply if doApplySkyCorr=True.

visitSummarylsst.afw.table.ExposureCatalog, optional

Exposure catalog with update calibrations; any not-None calibration objects attached will be used. These are applied first and may be overridden by other arguments.

Returns:

exposurelsst.afw.image.exposure.Exposure

Exposure with adjusted calibrations.

run(measCat, exposure, refCat, refWcs, exposureId=None)

Perform forced measurement on a single exposure.

Parameters:

measCatlsst.afw.table.SourceCatalog

The measurement catalog, based on the sources listed in the reference catalog.

exposurelsst.afw.image.Exposure

The measurement image upon which to perform forced detection.

refCatlsst.afw.table.SourceCatalog

The reference catalog of sources to measure.

refWcslsst.afw.image.SkyWcs

The WCS for the references.

exposureIdint

Optional unique exposureId used for random seed in measurement task.

Returns:

resultlsst.pipe.base.Struct

Structure with fields:

measCat

Catalog of forced measurement results (lsst.afw.table.SourceCatalog).

runQuantum(butlerQC, inputRefs, outputRefs)

Do butler IO and transform to provide in memory objects for tasks run method.

Parameters:

butlerQCQuantumContext

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.

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