lsst.meas.algorithms  22.0.1-21-g532228a4+ed99709a9c
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.algorithms.sourceSelector.FluxLimit Class Reference
Inheritance diagram for lsst.meas.algorithms.sourceSelector.FluxLimit:
lsst.meas.algorithms.sourceSelector.BaseLimit

Public Member Functions

def apply (self, catalog)
 

Static Public Attributes

 fluxField
 
 minimum = pexConfig.Field(dtype=float, optional=True, doc="Select objects with value greater than this")
 
 maximum = pexConfig.Field(dtype=float, optional=True, doc="Select objects with value less than this")
 

Detailed Description

Select sources using a flux limit

This object can be used as a `lsst.pex.config.Config` for configuring
the limit, and then the `apply` method can be used to identify sources
in the catalog that match the configured limit.

Definition at line 242 of file sourceSelector.py.

Member Function Documentation

◆ apply()

def lsst.meas.algorithms.sourceSelector.FluxLimit.apply (   self,
  catalog 
)
Apply the flux limits to a catalog

Parameters
----------
catalog : `lsst.afw.table.SourceCatalog`
    Catalog of sources to which the limit will be applied.

Returns
-------
selected : `numpy.ndarray`
    Boolean array indicating for each source whether it is selected
    (True means selected).

Reimplemented from lsst.meas.algorithms.sourceSelector.BaseLimit.

Definition at line 252 of file sourceSelector.py.

Member Data Documentation

◆ fluxField

lsst.meas.algorithms.sourceSelector.FluxLimit.fluxField
static
Initial value:
= pexConfig.Field(dtype=str, default="slot_CalibFlux_instFlux",
doc="Name of the source flux field to use.")

Definition at line 249 of file sourceSelector.py.

◆ maximum

lsst.meas.algorithms.sourceSelector.BaseLimit.maximum = pexConfig.Field(dtype=float, optional=True, doc="Select objects with value less than this")
staticinherited

Definition at line 175 of file sourceSelector.py.

◆ minimum

lsst.meas.algorithms.sourceSelector.BaseLimit.minimum = pexConfig.Field(dtype=float, optional=True, doc="Select objects with value greater than this")
staticinherited

Definition at line 174 of file sourceSelector.py.


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