PhotoCalTask

Python API summary

from lsst.pipe.tasks.photoCal import PhotoCalTask
classPhotoCalTask(refObjLoader, schema=None, **kwds)

Calculate an Exposure’s zero-point given a set of flux measurements of stars matched to an input catalogue...

attributeconfig

Access configuration fields and retargetable subtasks.

methodrun(exposure, sourceCat, expId=0)

Do photometric calibration - select matches to use and (possibly iteratively) compute the zero point...

See also

See the PhotoCalTask API reference for complete details.

Retargetable subtasks

reserve

Default
lsst.meas.algorithms.reserveSourcesTask.ReserveSourcesTask
Field type
ConfigurableField
Reserve sources from fitting

Configuration fields

applyColorTerms

Default
None
Field type
bool Field (optional)

Apply photometric color terms to reference stars? One of: None: apply if colorterms and photoCatName are not None;

fail if color term data is not available for the specified ref catalog and filter.
True: always apply colorterms; fail if color term data is not available for the
specified reference catalog and filter.

False: do not apply.

colorterms

Data type
lsst.pipe.tasks.colorterms.ColortermLibrary
Field type
ConfigField
Library of photometric reference catalog name: color term dict

fluxField

Default
'slot_CalibFlux_instFlux'
Field type
str Field
Name of the source instFlux field to use. The associated flag field (‘<name>_flags’) will be implicitly included in badFlags.

magErrFloor

Default
0.0
Field type
float RangeField
Range
[0.0,inf)
Additional magnitude uncertainty to be added in quadrature with measurement errors.

match

Data type
lsst.meas.astrom.directMatch.DirectMatchConfigWithoutLoader
Field type
ConfigField
Match to reference catalog

nIter

Default
20
Field type
int Field
number of iterations

nSigma

Default
3.0
Field type
float Field
clip at nSigma

photoCatName

Default
None
Field type
str Field (optional)
Name of photometric reference catalog; used to select a color term dict in colorterms. see also applyColorTerms

sigmaMax

Default
0.25
Field type
float Field (optional)
maximum sigma to use when clipping

useMedian

Default
True
Field type
bool Field
use median instead of mean to compute zeropoint