lsst.meas.extensions.psfex  16.0-11-g9bb73b2
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.extensions.psfex.psfexStarSelector.PsfexStarSelectorTask Class Reference
Inheritance diagram for lsst.meas.extensions.psfex.psfexStarSelector.PsfexStarSelectorTask:

Public Member Functions

def selectStars (self, exposure, sourceCat, matches=None)
 Select stars from source catalog. More...
 

Static Public Attributes

 ConfigClass = PsfexStarSelectorConfig
 
bool usesMatches = False
 

Detailed Description

A star selector whose algorithm is not yet documented.

@anchor PsfexStarSelectorTask_

@section meas_extensions_psfex_psfexStarSelectorStarSelector_Contents  Contents

 - @ref meas_extensions_psfex_psfexStarSelectorStarSelector_Purpose
 - @ref meas_extensions_psfex_psfexStarSelectorStarSelector_Initialize
 - @ref meas_extensions_psfex_psfexStarSelectorStarSelector_IO
 - @ref meas_extensions_psfex_psfexStarSelectorStarSelector_Config
 - @ref meas_extensions_psfex_psfexStarSelectorStarSelector_Debug

@section meas_extensions_psfex_psfexStarSelectorStarSelector_Purpose  Description

A star selector whose algorithm is not yet documented

@section meas_extensions_psfex_psfexStarSelectorStarSelector_Initialize  Task initialisation

@copydoc \_\_init\_\_

@section meas_extensions_psfex_psfexStarSelectorStarSelector_IO  Invoking the Task

Like all star selectors, the main method is `run`.

@section meas_extensions_psfex_psfexStarSelectorStarSelector_Config  Configuration parameters

See @ref PsfexStarSelectorConfig

@section meas_extensions_psfex_psfexStarSelectorStarSelector_Debug  Debug variables

PsfexStarSelectorTask has a debug dictionary with the following keys:
<dl>
<dt>display
<dd>bool; if True display debug information
<dt>displayExposure
<dd>bool; if True display the exposure and spatial cells
<dt>plotFwhmHistogram
<dd>bool; if True plot histogram of FWHM
<dt>plotFlags
<dd>bool: if True plot the sources coloured by their flags
<dt>plotRejection
<dd>bool; if True plot why sources are rejected
</dl>

For example, put something like:
@code{.py}
    import lsstDebug
    def DebugInfo(name):
        di = lsstDebug.getInfo(name)  # N.b. lsstDebug.Info(name) would call us recursively
        if name.endswith("objectSizeStarSelector"):
            di.display = True
            di.displayExposure = True
            di.plotFwhmHistogram = True

        return di

    lsstDebug.Info = DebugInfo
@endcode
into your `debug.py` file and run your task with the `--debug` flag.

Definition at line 200 of file psfexStarSelector.py.

Member Function Documentation

◆ selectStars()

def lsst.meas.extensions.psfex.psfexStarSelector.PsfexStarSelectorTask.selectStars (   self,
  exposure,
  sourceCat,
  matches = None 
)

Select stars from source catalog.

Parameters
[in]exposurethe exposure containing the sources
[in]sourceCatcatalog of sources that may be stars (an lsst.afw.table.SourceCatalog)
[in]matchesastrometric matches; ignored by this star selector
Returns
a Struct containing:
  • starCat a subset of sourceCat containing the selected stars

Definition at line 264 of file psfexStarSelector.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.extensions.psfex.psfexStarSelector.PsfexStarSelectorTask.ConfigClass = PsfexStarSelectorConfig
static

Definition at line 261 of file psfexStarSelector.py.

◆ usesMatches

bool lsst.meas.extensions.psfex.psfexStarSelector.PsfexStarSelectorTask.usesMatches = False
static

Definition at line 262 of file psfexStarSelector.py.


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