LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.algorithms.starSelector.BaseStarSelectorTask Class Reference
Inheritance diagram for lsst.meas.algorithms.starSelector.BaseStarSelectorTask:

Public Member Functions

def __init__ (self, schema, **kwds)
 
def run (self, exposure, sourceCat, matches=None, isStarField=None)
 
def selectStars (self, exposure, sourceCat, matches=None)
 

Static Public Attributes

bool usesMatches = False
 
 ConfigClass = BaseStarSelectorConfig
 

Detailed Description

Base class for star selectors

Register all star selectors with the starSelectorRegistry using:
    starSelectorRegistry.register(name, class)

Definition at line 47 of file starSelector.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.algorithms.starSelector.BaseStarSelectorTask.__init__ (   self,
  schema,
**  kwds 
)

Definition at line 58 of file starSelector.py.

58  def __init__(self, schema, **kwds):
59  # catch code that passed config positionally before schema argument was added
60  assert isinstance(schema, Schema)
61  pipeBase.Task.__init__(self, **kwds)
62 

Member Function Documentation

◆ run()

def lsst.meas.algorithms.starSelector.BaseStarSelectorTask.run (   self,
  exposure,
  sourceCat,
  matches = None,
  isStarField = None 
)
Select stars and set a flag field True for stars in the input catalog.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    the exposure containing the sources
sourceCat : `lsst.afw.table.SourceCatalog`
    catalog of sources that may be stars
matches : `lsst.afw.table.ReferenceMatchVector` or None
    astrometric matches; ignored by this star selector. Some star selectors
    will ignore this argument, others may require it. See the
    usesMatches class variable.
isStarField : `str`
    name of flag field to set True for stars, or None to not set a field;
    the field is left unchanged for non-stars

Returns
-------
struct : `lsst.pipe.base.Struct`
Result struct containing:

    - starCat  catalog of stars that were selected as stars and successfuly made into PSF candidates
                (a subset of sourceCat whose records are shallow copies)

Definition at line 63 of file starSelector.py.

63  def run(self, exposure, sourceCat, matches=None, isStarField=None):
64  """Select stars and set a flag field True for stars in the input catalog.
65 
66  Parameters
67  ----------
68  exposure : `lsst.afw.image.Exposure`
69  the exposure containing the sources
70  sourceCat : `lsst.afw.table.SourceCatalog`
71  catalog of sources that may be stars
72  matches : `lsst.afw.table.ReferenceMatchVector` or None
73  astrometric matches; ignored by this star selector. Some star selectors
74  will ignore this argument, others may require it. See the
75  usesMatches class variable.
76  isStarField : `str`
77  name of flag field to set True for stars, or None to not set a field;
78  the field is left unchanged for non-stars
79 
80  Returns
81  -------
82  struct : `lsst.pipe.base.Struct`
83  Result struct containing:
84 
85  - starCat catalog of stars that were selected as stars and successfuly made into PSF candidates
86  (a subset of sourceCat whose records are shallow copies)
87  """
88  result = self.selectStars(exposure=exposure, sourceCat=sourceCat, matches=matches)
89 
90  if isStarField is not None:
91  isStarKey = sourceCat.schema[isStarField].asKey()
92  for star in result.starCat:
93  star.set(isStarKey, True)
94 
95  return pipeBase.Struct(starCat=result.starCat)
96 
def run(self, coaddExposures, bbox, wcs)
Definition: getTemplate.py:603

◆ selectStars()

def lsst.meas.algorithms.starSelector.BaseStarSelectorTask.selectStars (   self,
  exposure,
  sourceCat,
  matches = None 
)
Return a catalog of stars: a subset of sourceCat whose records are shallow copies

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    The exposure containing the sources.
sourceCat : `lsst.afw.table.SourceCatalog`
    Catalog of sources that may be stars.
matches : `lsst.afw.table.ReferenceMatchVector` or None
    astrometric matches; ignored by this star selector. Some star selectors
    will ignore this argument, others may require it. See the usesMatches class variable.

Paramters
---------
struct : `lsst.pipe.base.Struct`
Result struct containing:

    - starCat  catalog of stars that were selected as stars and successfuly made into PSF candidates
                (a subset of sourceCat whose records are shallow copies)

Notes
-----
Warning: The returned catalog must have records that are shallow copies
(fortunately this is the default behavior when you add a record from one catalog to another);
otherwise the run method cannot set the isStarField flag in the original source catalog.

Definition at line 98 of file starSelector.py.

98  def selectStars(self, exposure, sourceCat, matches=None):
99  """Return a catalog of stars: a subset of sourceCat whose records are shallow copies
100 
101  Parameters
102  ----------
103  exposure : `lsst.afw.image.Exposure`
104  The exposure containing the sources.
105  sourceCat : `lsst.afw.table.SourceCatalog`
106  Catalog of sources that may be stars.
107  matches : `lsst.afw.table.ReferenceMatchVector` or None
108  astrometric matches; ignored by this star selector. Some star selectors
109  will ignore this argument, others may require it. See the usesMatches class variable.
110 
111  Paramters
112  ---------
113  struct : `lsst.pipe.base.Struct`
114  Result struct containing:
115 
116  - starCat catalog of stars that were selected as stars and successfuly made into PSF candidates
117  (a subset of sourceCat whose records are shallow copies)
118 
119  Notes
120  -----
121  Warning: The returned catalog must have records that are shallow copies
122  (fortunately this is the default behavior when you add a record from one catalog to another);
123  otherwise the run method cannot set the isStarField flag in the original source catalog.
124  """
125  raise NotImplementedError("BaseStarSelectorTask is abstract, subclasses must override this method")
126 
127 

Member Data Documentation

◆ ConfigClass

lsst.meas.algorithms.starSelector.BaseStarSelectorTask.ConfigClass = BaseStarSelectorConfig
static

Definition at line 55 of file starSelector.py.

◆ usesMatches

bool lsst.meas.algorithms.starSelector.BaseStarSelectorTask.usesMatches = False
static

Definition at line 54 of file starSelector.py.


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