lsst.pipe.tasks  v22.0.x-gc9c83ed91b+4fb2b8f86e
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)
 

Public Attributes

 schema
 
 isSingleFrame
 
 includeDeblend
 
 isPatchInnerKey
 
 isTractInnerKey
 
 isPrimaryKey
 
 isDeblendedSourceKey
 
 fromBlendKey
 
 isIsolatedKey
 
 isDeblendedModelKey
 

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.
includeDeblend : `bool`
    Include deblend information in isPrimary and
    add isDeblendedSource field?
kwargs :
    Keyword arguments passed to the task.

Definition at line 198 of file setPrimaryFlags.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 216 of file setPrimaryFlags.py.

Member Function Documentation

◆ run()

def lsst.pipe.tasks.setPrimaryFlags.SetPrimaryFlagsTask.run (   self,
  sources,
  skyMap = None,
  tractInfo = None,
  patchInfo = None 
)
Set isPrimary and related flags on sources.

For coadded imaging, the `isPrimary` 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 isPrimary 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

Definition at line 261 of file setPrimaryFlags.py.

Member Data Documentation

◆ ConfigClass

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

Definition at line 214 of file setPrimaryFlags.py.

◆ fromBlendKey

lsst.pipe.tasks.setPrimaryFlags.SetPrimaryFlagsTask.fromBlendKey

Definition at line 246 of file setPrimaryFlags.py.

◆ includeDeblend

lsst.pipe.tasks.setPrimaryFlags.SetPrimaryFlagsTask.includeDeblend

Definition at line 220 of file setPrimaryFlags.py.

◆ isDeblendedModelKey

lsst.pipe.tasks.setPrimaryFlags.SetPrimaryFlagsTask.isDeblendedModelKey

Definition at line 255 of file setPrimaryFlags.py.

◆ isDeblendedSourceKey

lsst.pipe.tasks.setPrimaryFlags.SetPrimaryFlagsTask.isDeblendedSourceKey

Definition at line 242 of file setPrimaryFlags.py.

◆ isIsolatedKey

lsst.pipe.tasks.setPrimaryFlags.SetPrimaryFlagsTask.isIsolatedKey

Definition at line 250 of file setPrimaryFlags.py.

◆ isPatchInnerKey

lsst.pipe.tasks.setPrimaryFlags.SetPrimaryFlagsTask.isPatchInnerKey

Definition at line 225 of file setPrimaryFlags.py.

◆ isPrimaryKey

lsst.pipe.tasks.setPrimaryFlags.SetPrimaryFlagsTask.isPrimaryKey

Definition at line 235 of file setPrimaryFlags.py.

◆ isSingleFrame

lsst.pipe.tasks.setPrimaryFlags.SetPrimaryFlagsTask.isSingleFrame

Definition at line 219 of file setPrimaryFlags.py.

◆ isTractInnerKey

lsst.pipe.tasks.setPrimaryFlags.SetPrimaryFlagsTask.isTractInnerKey

Definition at line 229 of file setPrimaryFlags.py.

◆ schema

lsst.pipe.tasks.setPrimaryFlags.SetPrimaryFlagsTask.schema

Definition at line 218 of file setPrimaryFlags.py.


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