|
def | makeIdFactory (self, dataRef) |
|
def | getExposureId (self, dataRef) |
|
def | fetchReferences (self, dataRef, exposure) |
|
def | getExposure (self, dataRef) |
|
def | runDataRef (self, dataRef, psfCache=None) |
|
def | run (self, measCat, exposure, refCat, refWcs, exposureId=None) |
|
def | attachFootprints (self, sources, refCat, exposure, refWcs, dataRef) |
|
def | writeOutput (self, dataRef, sources) |
|
def | getSchemaCatalogs (self) |
|
A command-line driver for performing forced measurement on CCD images.
Notes
-----
This task is a subclass of
:lsst-task:`lsst.meas.base.forcedPhotImage.ForcedPhotImageTask` which is
specifically for doing forced measurement on a single CCD exposure, using
as a reference catalog the detections which were made on overlapping
coadds.
The `run` method (inherited from `ForcedPhotImageTask`) takes a
`~lsst.daf.persistence.ButlerDataRef` argument that corresponds to a single
CCD. This should contain the data ID keys that correspond to the
``forced_src`` dataset (the output dataset for this task), which are
typically all those used to specify the ``calexp`` dataset (``visit``,
``raft``, ``sensor`` for LSST data) as well as a coadd tract. The tract is
used to look up the appropriate coadd measurement catalogs to use as
references (e.g. ``deepCoadd_src``; see
:lsst-task:`lsst.meas.base.references.CoaddSrcReferencesTask` for more
information). While the tract must be given as part of the dataRef, the
patches are determined automatically from the bounding box and WCS of the
calexp to be measured, and the filter used to fetch references is set via
the ``filter`` option in the configuration of
:lsst-task:`lsst.meas.base.references.BaseReferencesTask`).
In addition to the `run` method, `ForcedPhotCcdTask` overrides several
methods of `ForcedPhotImageTask` to specialize it for single-CCD
processing, including `~ForcedPhotImageTask.makeIdFactory`,
`~ForcedPhotImageTask.fetchReferences`, and
`~ForcedPhotImageTask.getExposure`. None of these should be called
directly by the user, though it may be useful to override them further in
subclasses.
Definition at line 149 of file forcedPhotCcd.py.
def lsst.meas.base.forcedPhotImage.ForcedPhotImageTask.attachFootprints |
( |
|
self, |
|
|
|
sources, |
|
|
|
refCat, |
|
|
|
exposure, |
|
|
|
refWcs, |
|
|
|
dataRef |
|
) |
| |
|
inherited |
Attach footprints to blank sources prior to measurements.
Notes
-----
`~lsst.afw.detection.Footprint`\ s 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 must implement this method to define how
those `~lsst.afw.detection.Footprint`\ s should be generated.
This default implementation transforms the
`~lsst.afw.detection.Footprint`\ s from the reference catalog from the
reference WCS to the exposure's WcS, which downgrades
`lsst.afw.detection.heavyFootprint.HeavyFootprint`\ s into regular
`~lsst.afw.detection.Footprint`\ s, destroying deblend information.
Definition at line 232 of file forcedPhotImage.py.
def lsst.meas.base.forcedPhotImage.ForcedPhotImageTask.runDataRef |
( |
|
self, |
|
|
|
dataRef, |
|
|
|
psfCache = None |
|
) |
| |
|
inherited |
Perform forced measurement on a single exposure.
Parameters
----------
dataRef : `lsst.daf.persistence.ButlerDataRef`
Passed to the ``references`` subtask to obtain the reference WCS,
the ``getExposure`` method (implemented by derived classes) to
read the measurment image, and the ``fetchReferences`` method to
get the exposure and load the reference catalog (see
:lsst-task`lsst.meas.base.references.CoaddSrcReferencesTask`).
Refer to derived class documentation for details of the datasets
and data ID keys which are used.
psfCache : `int`, optional
Size of PSF cache, or `None`. The size of the PSF cache can have
a significant effect upon the runtime for complicated PSF models.
Notes
-----
Sources are generated with ``generateMeasCat`` in the ``measurement``
subtask. These are passed to ``measurement``'s ``run`` method, which
fills the source catalog with the forced measurement results. The
sources are then passed to the ``writeOutputs`` method (implemented by
derived classes) which writes the outputs.
Definition at line 126 of file forcedPhotImage.py.