lsst.ip.diffim  15.0-9-g15da764
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 selectSources (self, sourceCat, matches=None, exposure=None)
 

Static Public Attributes

 ConfigClass = DiaCatalogSourceSelectorConfig
 
bool 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:

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 111 of file diaCatalogSourceSelector.py.

Member Function Documentation

◆ selectSources()

def lsst.ip.diffim.diaCatalogSourceSelector.DiaCatalogSourceSelectorTask.selectSources (   self,
  sourceCat,
  matches = None,
  exposure = None 
)
Return a selection of sources for Kernel candidates.

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.
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 : `array` of `bool``
Boolean array of sources that were selected, same length as
sourceCat.

Definition at line 169 of file diaCatalogSourceSelector.py.

Member Data Documentation

◆ ConfigClass

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

Definition at line 166 of file diaCatalogSourceSelector.py.

◆ usesMatches

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

Definition at line 167 of file diaCatalogSourceSelector.py.


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