lsst.pipe.tasks gc750389ca5+705f4fb1b5
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.measurePsf.MeasurePsfTask Class Reference
Inheritance diagram for lsst.pipe.tasks.measurePsf.MeasurePsfTask:

Public Member Functions

def __init__ (self, schema=None, **kwargs)
 
def run (self, exposure, sources, expId=0, matches=None)
 
def usesMatches (self)
 

Public Attributes

 candidateKey
 
 usedKey
 

Static Public Attributes

 ConfigClass = MeasurePsfConfig
 

Detailed Description

A task that selects stars from a catalog of sources and uses those to measure the PSF.

Parameters
----------
schema : `lsst.sfw.table.Schema`
    An `lsst.afw.table.Schema` used to create the output `lsst.afw.table.SourceCatalog`.
**kwargs :
    Keyword arguments passed to lsst.pipe.base.task.Task.__init__.

Notes
-----
If schema is not None, 'calib_psf_candidate' and 'calib_psf_used' fields will be added to
identify which stars were employed in the PSF estimation.

This task can add fields to the schema, so any code calling this task must ensure that
these fields are indeed present in the input table.

The star selector is a subclass of
``lsst.meas.algorithms.starSelector.BaseStarSelectorTask`` "lsst.meas.algorithms.BaseStarSelectorTask"
and the PSF determiner is a sublcass of
``lsst.meas.algorithms.psfDeterminer.BasePsfDeterminerTask`` "lsst.meas.algorithms.BasePsfDeterminerTask"

There is no establised set of configuration parameters for these algorithms, so once you start modifying
parameters (as we do in @ref pipe_tasks_measurePsf_Example) your code is no longer portable.

Debugging:

.. code-block:: none

display
    If True, display debugging plots
displayExposure
    display the Exposure + spatialCells
displayPsfCandidates
    show mosaic of candidates
showBadCandidates
    Include bad candidates
displayPsfMosaic
    show mosaic of reconstructed PSF(xy)
displayResiduals
    show residuals
normalizeResiduals
    Normalise residuals by object amplitude

Additionally you can enable any debug outputs that your chosen star selector and psf determiner support.

Definition at line 61 of file measurePsf.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.measurePsf.MeasurePsfTask.__init__ (   self,
  schema = None,
**  kwargs 
)

Definition at line 111 of file measurePsf.py.

Member Function Documentation

◆ run()

def lsst.pipe.tasks.measurePsf.MeasurePsfTask.run (   self,
  exposure,
  sources,
  expId = 0,
  matches = None 
)
Measure the PSF.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure to process; measured PSF will be added.
sources : `Unknown`
    Measured sources on exposure; flag fields will be set marking
    stars chosen by the star selector and the PSF determiner if a schema
    was passed to the task constructor.
expId : `int`, optional
    Exposure id used for generating random seed.
matches : `list`, optional
    A list of ``lsst.afw.table.ReferenceMatch`` objects
    (i.e. of ``lsst.afw.table.Match`` with @c first being
    of type ``lsst.afw.table.SimpleRecord`` and @c second
    type lsst.afw.table.SourceRecord --- the reference object and detected
    object respectively) as returned by @em e.g. the AstrometryTask.
    Used by star selectors that choose to refer to an external catalog.

Returns
-------
measurement : `lsst.pipe.base.Struct`
     PSF measurement as a struct with attributes:

    ``psf``
        The measured PSF (also set in the input exposure).
    ``cellSet``
        An `lsst.afw.math.SpatialCellSet` containing the PSF candidates
        as returned by the psf determiner.

Definition at line 134 of file measurePsf.py.

◆ usesMatches()

def lsst.pipe.tasks.measurePsf.MeasurePsfTask.usesMatches (   self)
Return True if this task makes use of the "matches" argument to the run method

Definition at line 239 of file measurePsf.py.

Member Data Documentation

◆ candidateKey

lsst.pipe.tasks.measurePsf.MeasurePsfTask.candidateKey

Definition at line 114 of file measurePsf.py.

◆ ConfigClass

lsst.pipe.tasks.measurePsf.MeasurePsfTask.ConfigClass = MeasurePsfConfig
static

Definition at line 108 of file measurePsf.py.

◆ usedKey

lsst.pipe.tasks.measurePsf.MeasurePsfTask.usedKey

Definition at line 119 of file measurePsf.py.


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