lsst.pipe.tasks  13.0-56-g21e2fbf+3
 All Classes Namespaces Files Functions Variables Groups Pages
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__
 Create the detection task. More...
 
def run
 Measure the PSF. More...
 
def usesMatches
 

Public Attributes

 candidateKey
 
 usedKey
 
 reservedKey
 

Static Public Attributes

 ConfigClass = MeasurePsfConfig
 

Detailed Description

Definition at line 56 of file measurePsf.py.

Constructor & Destructor Documentation

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

Create the detection task.

Most arguments are simply passed onto pipe.base.Task.

Parameters
schemaAn lsst::afw::table::Schema used to create the output lsst.afw.table.SourceCatalog
**kwargsKeyword arguments passed to lsst.pipe.base.task.Task.__init__.

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.

Note
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.

Definition at line 205 of file measurePsf.py.

Member Function Documentation

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

Measure the PSF.

Parameters
[in,out]exposureExposure to process; measured PSF will be added.
[in,out]sourcesMeasured 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.
[in]expIdExposure id used for generating random seed.
[in]matchesA list of lsst.afw.table.ReferenceMatch objects (i.e. of lsst.afw.table.Match with first being of type lsst.afw.table.SimpleRecord and second type lsst.afw.table.SourceRecord — the reference object and detected object respectively) as returned by e.g. the AstrometryTask. Used by star selectors that choose to refer to an external catalog.
Returns
a pipe.base.Struct with fields:
  • 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 241 of file measurePsf.py.

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 344 of file measurePsf.py.

Member Data Documentation

lsst.pipe.tasks.measurePsf.MeasurePsfTask.candidateKey

Definition at line 220 of file measurePsf.py.

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

Definition at line 202 of file measurePsf.py.

lsst.pipe.tasks.measurePsf.MeasurePsfTask.reservedKey

Definition at line 230 of file measurePsf.py.

lsst.pipe.tasks.measurePsf.MeasurePsfTask.usedKey

Definition at line 225 of file measurePsf.py.


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