Inheritance diagram for lsst.meas.extensions.psfex.psfexStarSelector.PsfexStarSelectorTask:

Public Member Functions
def	selectSources (self, sourceCat, matches=None, exposure=None)

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 202 of file psfexStarSelector.py.

Member Function Documentation

◆ selectSources()

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

Return a selection of psf-like objects.

Parameters
----------
sourceCat : `lsst.afw.table.SourceCatalog`
    Catalog of sources to select from.
    This catalog must be contiguous in memory.
matches : `list` of `lsst.afw.table.ReferenceMatch` or None
    Ignored by this source selector.
exposure : `lsst.afw.image.Exposure` or None
    The exposure the catalog was built from; used for debug display.

Return
------
struct : `lsst.pipe.base.Struct`
    The struct contains the following data:

    - selected : `numpy.ndarray` of `bool``
        Boolean array of sources that were selected, same length as
        sourceCat.

Definition at line 266 of file psfexStarSelector.py.

Member Data Documentation

◆ ConfigClass

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

static

Definition at line 263 of file psfexStarSelector.py.

◆ usesMatches

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

static

Definition at line 264 of file psfexStarSelector.py.

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

python/lsst/meas/extensions/psfex/psfexStarSelector.py