lsst.meas.astrom  16.0-16-gd8e3590+1
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.astrom.catalogStarSelector.CatalogStarSelectorTask Class Reference

Select stars based on a reference catalog. More...

Public Member Functions

def selectSources (self, sourceCat, matches=None, exposure=None)
 

Static Public Attributes

 ConfigClass = CatalogStarSelectorConfig
 
bool usesMatches = True
 

Detailed Description

Select stars based on a reference catalog.

Contents

Description

Select stars using a match list: select sources where the matching reference object is unresolved, plus the source passes the following tests:

Task initialisation

Invoking the Task

Like all star selectors, the main method is run. Unlike most star selectors, this one requires the matches argument (the usesMatches property is true).

Configuration parameters

See CatalogStarSelectorConfig

Debug variables

CatalogStarSelectorTask has a debug dictionary with the following keys:

display
bool; if True display debug information
pauseAtEnd
bool; if True wait after displaying everything and wait for user input

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("catalogStarSelector"):
di.display = True
return di
lsstDebug.Info = DebugInfo

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

Definition at line 85 of file catalogStarSelector.py.

Member Function Documentation

◆ selectSources()

def lsst.meas.astrom.catalogStarSelector.CatalogStarSelectorTask.selectSources (   self,
  sourceCat,
  matches = None,
  exposure = None 
)
Return a selection of sources based on reference catalog matches.

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`
    A match vector as produced by meas_astrom; required.
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 146 of file catalogStarSelector.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.astrom.catalogStarSelector.CatalogStarSelectorTask.ConfigClass = CatalogStarSelectorConfig
static

Definition at line 143 of file catalogStarSelector.py.

◆ usesMatches

bool lsst.meas.astrom.catalogStarSelector.CatalogStarSelectorTask.usesMatches = True
static

Definition at line 144 of file catalogStarSelector.py.


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