lsst.meas.algorithms.sourceSelector Namespace Reference

Classes
class	BaseLimit
class	BaseSourceSelectorConfig
class	BaseSourceSelectorTask
class	ColorLimit
class	FluxLimit
class	MagnitudeErrorLimit
class	MagnitudeLimit
class	NullSourceSelectorTask
class	ReferenceSourceSelectorConfig
class	ReferenceSourceSelectorTask
class	RequireFiniteRaDec
class	RequireFlags
class	RequireIsolated
class	RequirePrimary
class	RequireUnresolved
class	ScienceSourceSelectorConfig
class	ScienceSourceSelectorTask
class	SignalToNoiseLimit

Functions
	_getFieldFromCatalog (catalog, field, isFlag=False)

Variables
	sourceSelectorRegistry

Function Documentation

_getFieldFromCatalog()

lsst.meas.algorithms.sourceSelector._getFieldFromCatalog ( catalog, field, isFlag = False )

protected

Get a field from a catalog, for `lsst.afw.table` catalogs or
`pandas.DataFrame` or `astropy.table.Table` catalogs.

Parameters
----------
catalog : `lsst.afw.table.SourceCatalog` or `pandas.DataFrame`
          or `astropy.table.Table`
    Catalog of sources to extract field array
field : `str`
    Name of field
isFlag : `bool`, optional
    Is this a flag column?  If it does not exist, return array
    of False.

Returns
-------
array : `np.ndarray`
    Array of field values from the catalog.

Definition at line 740 of file sourceSelector.py.

def _getFieldFromCatalog(catalog, field, isFlag=False):
    """
    Get a field from a catalog, for `lsst.afw.table` catalogs or
    `pandas.DataFrame` or `astropy.table.Table` catalogs.
 
    Parameters
    ----------
    catalog : `lsst.afw.table.SourceCatalog` or `pandas.DataFrame`
              or `astropy.table.Table`
        Catalog of sources to extract field array
    field : `str`
        Name of field
    isFlag : `bool`, optional
        Is this a flag column?  If it does not exist, return array
        of False.
 
    Returns
    -------
    array : `np.ndarray`
        Array of field values from the catalog.
    """
    found = False
    if isinstance(catalog, (pandas.DataFrame, astropy.table.Table)):
        if field in catalog.columns:
            found = True
            # Sequences must be converted to numpy arrays
            arr = np.array(catalog[field])
    else:
        if field in catalog.schema:
            found = True
            arr = catalog[field]
 
    if isFlag and not found:
        arr = np.zeros(len(catalog), dtype=bool)
    elif not found:
        raise KeyError(f"Could not find field {field} in catalog.")
 
    return arr

Variable Documentation

sourceSelectorRegistry

lsst.meas.algorithms.sourceSelector.sourceSelectorRegistry

Initial value:

=  pexConfig.makeRegistry(
    doc="A registry of source selectors (subclasses of "
        "BaseSourceSelectorTask)",
)

Definition at line 156 of file sourceSelector.py.