lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorTask Class Reference

Inheritance diagram for lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorTask:

Public Member Functions
	__init__ (self, initInputs=None, **kwargs)
	runQuantum (self, butlerQC, inputRefs, outputRefs)
pipeBase.Struct	run (self, lsst.afw.table.SourceCatalog refCat, np.ndarray objectIds, int visit, int detector, lsst.afw.geom.SkyWcs refWcs, lsst.afw.table.SourceCatalog|None directCat=None, lsst.afw.table.SourceCatalog|None diffCat=None, lsst.afw.image.Exposure|None exposure=None, lsst.afw.image.Exposure|None diaExposure=None, str|None band=None)

Static Public Attributes
	ConfigClass = ForcedPhotDetectorConfig

Protected Member Functions
None	_runForcedPhotometry (self, lsst.afw.table.SourceCatalog refCat, lsst.afw.table.SourceCatalog measCat, lsst.afw.image.Exposure exposure, lsst.afw.geom.SkyWcs refWcs)
	_makeMinimalSourceCatalogFromAstropy (self, table)
	_filterRefTable (self, refTableHandles, exposureBBox, exposureWcs)
lsst.afw.table.SourceCatalog	_generateMeasCat (self, lsst.afw.table.SourceCatalog refCat, lsst.afw.table.IdFactory|None idFactory=None)

Static Protected Attributes
str	_DefaultName = "forcedPhotDetector"

Detailed Description

A pipeline task for performing forced photometry on CCD images.

Definition at line 144 of file forcedPhotDetector.py.

Constructor & Destructor Documentation

__init__()

lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorTask.__init__	(		self,
			initInputs = None,
		**	kwargs )

Definition at line 149 of file forcedPhotDetector.py.

Member Function Documentation

_filterRefTable()

lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorTask._filterRefTable ( self, refTableHandles, exposureBBox, exposureWcs )

protected

Prepare a merged, filtered reference catalog from ArrowAstropy
inputs.

Parameters
----------
refTableHandles : sequence of `lsst.daf.butler.DeferredDatasetHandle`
    Handles for catalogs of shapes and positions at which to force
    photometry.
exposureBBox :   `lsst.geom.Box2I`
    Bounding box on which to select rows that overlap
exposureWcs : `lsst.afw.geom.SkyWcs`
    World coordinate system to convert sky coords in ref cat to
    pixel coords with which to compare with exposureBBox

Returns
-------
refTable : `astropy.table.Table`
    Astropy Table with only rows from the reference
    catalogs that overlap the exposure bounding box.

Definition at line 372 of file forcedPhotDetector.py.

_generateMeasCat()

lsst.afw.table.SourceCatalog lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorTask._generateMeasCat ( self, lsst.afw.table.SourceCatalog refCat, lsst.afw.table.IdFactory | None idFactory = None )

protected

Initialize an output catalog from the reference catalog.

Parameters
----------
refCat : `lsst.afw.table.SourceCatalog,`
    Catalog of reference sources.
idFactory : `lsst.afw.table.IdFactory`, optional
    Factory for creating IDs for sources.

Returns
-------
meascat : `lsst.afw.table.SourceCatalog`
    Source catalog ready for measurement.

Notes
-----
This generates a new blank `~lsst.afw.table.SourceRecord` for each
record in ``refCat``. Note that this method does not attach any
`~lsst.afw.detection.Footprint`\ s, which is done in
``config.measure``.

Definition at line 421 of file forcedPhotDetector.py.

_makeMinimalSourceCatalogFromAstropy()

lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorTask._makeMinimalSourceCatalogFromAstropy ( self, table )

protected

Create minimal schema SourceCatalog from an Astropy Table.

The forced measurement subtask expects this as input.

Parameters
----------
table : `astropy.table.Table`
    Table with locations and ids.

Returns
-------
outputCatalog : `lsst.afw.table.SourceTable`
    Output catalog with minimal schema.

Definition at line 349 of file forcedPhotDetector.py.

_runForcedPhotometry()

None lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorTask._runForcedPhotometry ( self, lsst.afw.table.SourceCatalog refCat, lsst.afw.table.SourceCatalog measCat, lsst.afw.image.Exposure exposure, lsst.afw.geom.SkyWcs refWcs )

protected

Perform forced measurement on a single exposure.

Parameters
----------
refCat : `lsst.afw.table.SourceCatalog`
    Catalog containing the reference catalog data, with columns
    for the object ID, right ascension, and declination.
measCat : `lsst.afw.table.SourceCatalog`
    Catalog containing the measurement data, with columns for the
    object ID and measured quantities.
    This catalog is updated in-place.
exposure : `lsst.afw.image.exposure.Exposure`
    Input exposure to adjust calibrations.
refWcs : `lsst.afw.geom.SkyWcs`
    Defines the X,Y coordinate system of ``refCat``.

Definition at line 310 of file forcedPhotDetector.py.

run()

pipeBase.Struct lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorTask.run	(		self,
		lsst.afw.table.SourceCatalog	refCat,
		np.ndarray	objectIds,
		int	visit,
		int	detector,
		lsst.afw.geom.SkyWcs	refWcs,
		lsst.afw.table.SourceCatalog | None	directCat = None,
		lsst.afw.table.SourceCatalog | None	diffCat = None,
		lsst.afw.image.Exposure | None	exposure = None,
		lsst.afw.image.Exposure | None	diaExposure = None,
		str | None	band = None )

Run forced photometry on a single detector.

There is a lot of prep work in the `runQuantum` method and it is
expected that this taks is usually run as a pipeline task, not
executed as a stand alone function.

Parameters
----------
refCat :
    Reference catalog for forced photometry.
objectIds :
    Array of object IDs corresponding to the reference catalog.
visit :
    Visit ID for the observation.
detector :
    Detector ID for the observation.
refWcs :
    Reference WCS for the observation.
directCat :
    Catalog for direct photometry.
    Only required when `config.doDirectPhotometry` is True.
diffCat :
    Catalog for difference photometry.
    Only required when `config.doDifferencePhotometry` is True.
exposure :
    Exposure for direct photometry.
    Only required when `config.doDirectPhotometry` is True.
diaExposure :
    Exposure for difference photometry.
    Only required when `config.doDifferencePhotometry` is True.
band :
    Band for the observation.

Definition at line 226 of file forcedPhotDetector.py.

runQuantum()

lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorTask.runQuantum	(		self,
			butlerQC,
			inputRefs,
			outputRefs )

Definition at line 158 of file forcedPhotDetector.py.

Member Data Documentation

_DefaultName

str lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorTask._DefaultName = "forcedPhotDetector"

staticprotected

Definition at line 147 of file forcedPhotDetector.py.

ConfigClass

lsst.pipe.tasks.forcedPhotDetector.ForcedPhotDetectorTask.ConfigClass = ForcedPhotDetectorConfig

static

Definition at line 146 of file forcedPhotDetector.py.

---

The documentation for this class was generated from the following file:

• python/lsst/pipe/tasks/forcedPhotDetector.py