lsst.ip.diffim  13.0-22-g3839dbb
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Public Member Functions | Static Public Attributes | List of all members
lsst.ip.diffim.diaCatalogSourceSelector.DiaCatalogSourceSelectorTask Class Reference

Select sources for Kernel candidates. More...

Inheritance diagram for lsst.ip.diffim.diaCatalogSourceSelector.DiaCatalogSourceSelectorTask:

Public Member Functions

def selectStars
 

Static Public Attributes

 ConfigClass = DiaCatalogSourceSelectorConfig
 
 usesMatches = True
 

Detailed Description

Select sources for Kernel candidates.

Contents

Description

A naive star selector based on second moments. Use with caution.

Task initialisation

Invoking the Task

Like all star selectors, the main method is run.

Configuration parameters

See DiaCatalogSourceSelectorConfig

Debug variables

DiaCatalogSourceSelectorTask has a debug dictionary with the following keys:

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

For example, put something like:

1 import lsstDebug
2 def DebugInfo(name):
3  di = lsstDebug.getInfo(name) # N.b. lsstDebug.Info(name) would call us recursively
4  if name.endswith("catalogStarSelector"):
5  di.display = True
6 
7  return di
8 
9 lsstDebug.Info = DebugInfo

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

Definition at line 114 of file diaCatalogSourceSelector.py.

Member Function Documentation

def lsst.ip.diffim.diaCatalogSourceSelector.DiaCatalogSourceSelectorTask.selectStars (   self,
  exposure,
  sourceCat,
  matches = None 
)
Select sources for Kernel candidates

@param[in] exposure  the exposure containing the sources
@param[in] sourceCat  catalog of sources that may be stars (an lsst.afw.table.SourceCatalog)
@param[in] matches  a match vector as produced by meas_astrom; required
            (defaults to None to match the StarSelector API and improve error handling)

@return an lsst.pipe.base.Struct containing:
- starCat  a list of sources to be used as kernel candidates

Definition at line 172 of file diaCatalogSourceSelector.py.

Member Data Documentation

lsst.ip.diffim.diaCatalogSourceSelector.DiaCatalogSourceSelectorTask.ConfigClass = DiaCatalogSourceSelectorConfig
static

Definition at line 169 of file diaCatalogSourceSelector.py.

lsst.ip.diffim.diaCatalogSourceSelector.DiaCatalogSourceSelectorTask.usesMatches = True
static

Definition at line 170 of file diaCatalogSourceSelector.py.


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