lsst.meas.algorithms  14.0-7-g23fdbe95+7
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.algorithms.sourceSelector.MagnitudeLimit Class Reference
Inheritance diagram for lsst.meas.algorithms.sourceSelector.MagnitudeLimit:

Public Member Functions

def apply (self, catalog)
 

Static Public Attributes

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

Detailed Description

Select sources using a magnitude limit

Note that this assumes that a zero-point has already been applied and
the fluxes are in AB fluxes in Jansky. It is therefore principally
intended for reference catalogs rather than catalogs extracted from
science images.

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

Member Function Documentation

◆ apply()

def lsst.meas.algorithms.sourceSelector.MagnitudeLimit.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 207 of file sourceSelector.py.

Member Data Documentation

◆ fluxField

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

Definition at line 202 of file sourceSelector.py.

◆ maximum

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

Definition at line 205 of file sourceSelector.py.

◆ minimum

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

Definition at line 204 of file sourceSelector.py.


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