lsst.pipe.tasks  21.0.0-33-g5ddf1805+ec8417d5dd
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.setPrimaryFlags.SetPrimaryFlagsTask Class Reference
Inheritance diagram for lsst.pipe.tasks.setPrimaryFlags.SetPrimaryFlagsTask:

Public Member Functions

def __init__ (self, schema, isSingleFrame=False, **kwargs)
 
def run (self, sources, skyMap=None, tractInfo=None, patchInfo=None, includeDeblend=True)
 

Public Attributes

 schema
 
 isSingleFrame
 
 isPatchInnerKey
 
 isTractInnerKey
 
 isPrimaryKey
 

Static Public Attributes

 ConfigClass = SetPrimaryFlagsConfig
 

Detailed Description

Add isPrimaryKey to a given schema.

Parameters
----------
schema : `lsst.afw.table.Schema`
    The input schema.
isSingleFrame : `bool`
    Flag specifying if task is operating with single frame imaging.
kwargs :
    Keyword arguments passed to the task.

Definition at line 36 of file setPrimaryFlags.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.setPrimaryFlags.SetPrimaryFlagsTask.__init__ (   self,
  schema,
  isSingleFrame = False,
**  kwargs 
)

Definition at line 51 of file setPrimaryFlags.py.

Member Function Documentation

◆ run()

def lsst.pipe.tasks.setPrimaryFlags.SetPrimaryFlagsTask.run (   self,
  sources,
  skyMap = None,
  tractInfo = None,
  patchInfo = None,
  includeDeblend = True 
)
Set is-patch-inner, is-tract-inner and is-primary flags on sources.
For coadded imaging, the is-primary flag returns True when an object
has no children, is in the inner region of a coadd patch, is in the
inner region of a coadd trach, and is not detected in a pseudo-filter
(e.g., a sky_object).
For single frame imaging, the is-primary flag returns True when a
source has no children and is not a sky source.

Parameters
----------
sources : `lsst.afw.table.SourceCatalog`
    A sourceTable. Reads in centroid fields and an nChild field.
    Writes is-patch-inner, is-tract-inner, and is-primary flags.
skyMap : `lsst.skymap.BaseSkyMap`
    Sky tessellation object
tractInfo : `lsst.skymap.TractInfo`
    Tract object
patchInfo : `lsst.skymap.PatchInfo`
    Patch object
includeDeblend : `bool`
    Include deblend information in isPrimary?

Definition at line 74 of file setPrimaryFlags.py.

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.setPrimaryFlags.SetPrimaryFlagsTask.ConfigClass = SetPrimaryFlagsConfig
static

Definition at line 49 of file setPrimaryFlags.py.

◆ isPatchInnerKey

lsst.pipe.tasks.setPrimaryFlags.SetPrimaryFlagsTask.isPatchInnerKey

Definition at line 59 of file setPrimaryFlags.py.

◆ isPrimaryKey

lsst.pipe.tasks.setPrimaryFlags.SetPrimaryFlagsTask.isPrimaryKey

Definition at line 69 of file setPrimaryFlags.py.

◆ isSingleFrame

lsst.pipe.tasks.setPrimaryFlags.SetPrimaryFlagsTask.isSingleFrame

Definition at line 54 of file setPrimaryFlags.py.

◆ isTractInnerKey

lsst.pipe.tasks.setPrimaryFlags.SetPrimaryFlagsTask.isTractInnerKey

Definition at line 63 of file setPrimaryFlags.py.

◆ schema

lsst.pipe.tasks.setPrimaryFlags.SetPrimaryFlagsTask.schema

Definition at line 53 of file setPrimaryFlags.py.


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