A star selector that looks for a cluster of small objects in a size-magnitude plot. More...

Inheritance diagram for lsst.meas.algorithms.objectSizeStarSelector.ObjectSizeStarSelectorTask:

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

def	run (self, sourceCat, sourceSelectedField=None, matches=None, exposure=None)

Static Public Attributes
	ConfigClass = ObjectSizeStarSelectorConfig

bool	usesMatches = False

Detailed Description

A star selector that looks for a cluster of small objects in a size-magnitude plot.

Description

A star selector that looks for a cluster of small objects in a size-magnitude plot.

Task initialisation

Invoking the Task

Like all star selectors, the main method is run.

Configuration parameters

See ObjectSizeStarSelectorConfig

Debug variables

ObjectSizeStarSelectorTask has a debug dictionary with the following keys:

display: bool; if True display debug information
displayExposure: bool; if True display the exposure and spatial cells
plotMagSize: bool: if True display the magnitude-size relation using matplotlib
dumpData: bool; if True dump data to a pickle file

For example, put something like:

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.plotMagSize = True
    return di
lsstDebug.Info = DebugInfo

into your debug.py file and run your task with the --debug flag.

Definition at line 319 of file objectSizeStarSelector.py.

Member Function Documentation

◆ run()

def lsst.meas.algorithms.sourceSelector.BaseSourceSelectorTask.run	(	self,
		sourceCat,
		sourceSelectedField = `None`,
		matches = `None`,
		exposure = `None`
	)

inherited

Select sources and return them.

The input catalog must be contiguous in memory.

Parameters:
-----------
sourceCat : `lsst.afw.table.SourceCatalog`
    Catalog of sources to select from.
sourceSelectedField : `str` or None
    Name of flag field in sourceCat to set for selected sources.
    If set, will modify sourceCat in-place.
matches : `list` of `lsst.afw.table.ReferenceMatch` or None
    List of matches to use for source selection.
    If usesMatches is set in source selector this field is required.
    If not, it is ignored.
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:

    - sourceCat : `lsst.afw.table.SourceCatalog`
The catalog of sources that were selected.
(may not be memory-contiguous)
    - selected : `numpy.ndarray` of `bool``
Boolean array of sources that were selected, same length as
sourceCat.

Raises
------
RuntimeError
    Raised if ``sourceCat`` is not contiguous.

Definition at line 69 of file sourceSelector.py.

◆ selectSources()

def lsst.meas.algorithms.objectSizeStarSelector.ObjectSizeStarSelectorTask.selectSources	(	self,
		sourceCat,
		matches = `None`,
		exposure = `None`
	)

Return a selection of PSF candidates that represent likely stars.

A list of PSF candidates may be used by a PSF fitter to construct a PSF.

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 in this SourceSelector.
exposure : `lsst.afw.image.Exposure` or None
    The exposure the catalog was built from; used to get the detector
    to transform to TanPix, and for debug display.

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

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

Definition at line 381 of file objectSizeStarSelector.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.algorithms.objectSizeStarSelector.ObjectSizeStarSelectorTask.ConfigClass = ObjectSizeStarSelectorConfig

static

Definition at line 378 of file objectSizeStarSelector.py.

◆ usesMatches

bool lsst.meas.algorithms.objectSizeStarSelector.ObjectSizeStarSelectorTask.usesMatches = False