xlens.process_pipe.force_multiband

Classes

ForcedPhotCoaddConfig

ForcedPhotCoaddTask

A pipeline task for performing forced measurement on coadd images.

Module Contents

class ForcedPhotCoaddConfig[source]

Bases: lsst.pipe.base.PipelineTaskConfig

measurement[source]
coaddName[source]
doApCorr[source]
applyApCorr[source]
catalogCalculation[source]
footprintDatasetName[source]
doConserveFlux[source]
doStripFootprints[source]
hasFakes[source]
idGenerator[source]
setDefaults()[source]
class ForcedPhotCoaddTask(refSchema=None, initInputs=None, **kwds)[source]

Bases: lsst.pipe.base.PipelineTask

A pipeline task for performing forced measurement on coadd images.

Parameters:
  • refSchema (lsst.afw.table.Schema, optional) – The schema of the reference catalog, passed to the constructor of the references subtask. Optional, but must be specified if initInputs is not; if both are specified, initInputs takes precedence.

  • initInputs (dict) – Dictionary that can contain a key inputSchema containing the schema. If present will override the value of refSchema.

  • **kwds – Keyword arguments are passed to the supertask constructor.

ConfigClass[source]
_DefaultName = 'forcedPhotCoadd'[source]
dataPrefix = 'deepCoadd_'[source]
outputSchema[source]
runQuantum(butlerQC, inputRefs, outputRefs)[source]
generateMeasCat(dataId, exposure, refCat, refCatInBand, refWcs, footprintData)[source]

Generate a measurement catalog.

Parameters:
  • dataId (lsst.daf.butler.DataCoordinate) – Butler data ID for this image, with {tract, patch, band} keys.

  • exposure (lsst.afw.image.exposure.Exposure) – Exposure to generate the catalog for.

  • refCat (lsst.afw.table.SourceCatalog) – Catalog of shapes and positions at which to force photometry.

  • refCatInBand (lsst.afw.table.SourceCatalog) – Catalog of shapes and position in the band forced photometry is currently being performed

  • refWcs (lsst.afw.image.SkyWcs) – Reference world coordinate system.

  • footprintData (ScarletDataModel or lsst.afw.table.SourceCatalog) – Either the scarlet data models or the deblended catalog containing footprints. If footprintData is None then the footprints contained in refCatInBand are used.

Returns:

  • measCat (lsst.afw.table.SourceCatalog) – Catalog of forced sources to measure.

  • expId (int) – Unique binary id associated with the input exposure

Raises:

LookupError – Raised if a footprint with a given source id was in the reference catalog but not in the reference catalog in band (meaning there was some sort of mismatch in the two input catalogs)

run(measCat, exposure, refCat, refWcs, exposureId=None)[source]

Perform forced measurement on a single exposure.

Parameters:
  • measCat (lsst.afw.table.SourceCatalog) – The measurement catalog, based on the sources listed in the reference catalog.

  • exposure (lsst.afw.image.Exposure) – The measurement image upon which to perform forced detection.

  • refCat (lsst.afw.table.SourceCatalog) – The reference catalog of sources to measure.

  • refWcs (lsst.afw.image.SkyWcs) – The WCS for the references.

  • exposureId (int) – Optional unique exposureId used for random seed in measurement task.

Returns:

result – Structure with fields:

measCat

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

Return type:

Struct`

_attachScarletFootprints(catalog, modelData, exposure, band)[source]

Attach scarlet models as HeavyFootprints