lsst.meas.algorithms.loadReferenceObjects Namespace Reference

Classes
class	LoadReferenceObjectsConfig
class	LoadReferenceObjectsTask
	Abstract base class to load objects from reference catalogs. More...

Functions
def	getRefFluxField
	Get name of flux field in schema. More...
def	getRefFluxKeys
	Return flux and flux error keys. More...

Variables
list	__all__ = ["getRefFluxField", "getRefFluxKeys", "LoadReferenceObjectsTask", "LoadReferenceObjectsConfig"]

Function Documentation

def lsst.meas.algorithms.loadReferenceObjects.getRefFluxField	(		schema,
			filterName = None
	)

Get name of flux field in schema.

if filterName is specified: return filterName_camFlux if present else return filterName_flux if present (camera filter name matches reference filter name) else throw RuntimeError else: return camFlux, if present, else throw RuntimeError

Parameters

[in]	schema	reference catalog schema
[in]	filterName	name of camera filter

Returns

flux field name

Exceptions

RuntimeError

if appropriate field is not found

Definition at line 14 of file loadReferenceObjects.py.

def getRefFluxField(schema, filterName=None):
    """!Get name of flux field in schema

    if filterName is specified:
        return *filterName*_camFlux if present
        else return *filterName*_flux if present (camera filter name matches reference filter name)
        else throw RuntimeError
    else:
        return camFlux, if present,
        else throw RuntimeError

    @param[in] schema  reference catalog schema
    @param[in] filterName  name of camera filter
    @return flux field name
    @throw RuntimeError if appropriate field is not found
    """
    if not isinstance(schema, afwTable.Schema):
        raise RuntimeError("schema=%s is not a schema" % (schema,))
    if filterName:
        fluxFieldList = [filterName + "_camFlux", filterName + "_flux"]
    else:
        fluxFieldList = ["camFlux"]
    for fluxField in fluxFieldList:
        if fluxField in schema:
            return fluxField

    raise RuntimeError("Could not find flux field(s) %s" % (", ".join(fluxFieldList)))