lsst.meas.algorithms  14.0-7-g23fdbe95+14
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:

Public Member Functions

def apply (self, catalog)
 

Static Public Attributes

 fluxField
 
 minimum = pexConfig.Field(dtype=float, optional=True, doc="Select objects fainter than this flux")
 
 maximum = pexConfig.Field(dtype=float, optional=True, doc="Select objects brighter than this flux")
 

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 150 of file sourceSelector.py.

Member Function Documentation

◆ apply()

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

Parameters
----------
catalog : `lsst.afw.table.SourceCatalog`
    Source to which to apply limits.

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

Definition at line 162 of file sourceSelector.py.

Member Data Documentation

◆ fluxField

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

Definition at line 157 of file sourceSelector.py.

◆ maximum

lsst.meas.algorithms.sourceSelector.FluxLimit.maximum = pexConfig.Field(dtype=float, optional=True, doc="Select objects brighter than this flux")
static

Definition at line 160 of file sourceSelector.py.

◆ minimum

lsst.meas.algorithms.sourceSelector.FluxLimit.minimum = pexConfig.Field(dtype=float, optional=True, doc="Select objects fainter than this flux")
static

Definition at line 159 of file sourceSelector.py.


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