lsst.pipe.tasks.functors Namespace Reference

Classes
class	Color
class	Column
class	CompositeFunctor
class	ComputePixelScale
class	ConvertDetectorAngleToPositionAngle
class	ConvertPixelSqToArcsecondsSq
class	ConvertPixelToArcseconds
class	CoordColumn
class	CustomFunctor
class	DecColumn
class	DecErrColumn
class	DeconvolvedMoments
class	E1
class	E2
class	Ebv
class	Functor
class	HsmFwhm
class	HsmTraceSize
class	HtmIndex20
class	Index
class	LocalDipoleDiffFlux
class	LocalDipoleDiffFluxErr
class	LocalDipoleMeanFlux
class	LocalDipoleMeanFluxErr
class	LocalNanojansky
class	LocalNanojanskyErr
class	LocalPhotometry
class	LocalWcs
class	Mag
class	MagDiff
class	MagErr
class	MomentsBase
class	MomentsIuuSky
class	MomentsIuvSky
class	MomentsIvvSky
class	MultibandColumn
class	MultibandSinglePrecisionFloatColumn
class	NanoJansky
class	NanoJanskyErr
class	Photometry
class	PositionAngleFromMoments
class	PsfHsmTraceSizeDiff
class	PsfSdssTraceSizeDiff
class	RAColumn
class	RADecCovColumn
class	RadiusFromQuadrupole
class	RAErrColumn
class	ReferenceBand
class	SdssTraceSize
class	SemimajorAxisFromMoments
class	SemiminorAxisFromMoments
class	SinglePrecisionFloatColumn

Functions
	init_fromDict (initDict, basePath='lsst.pipe.tasks.functors', typeKey='functor', name=None)
	mag_aware_eval (df, expr, log)
	fluxName (col)
	fluxErrName (col)

Function Documentation

fluxErrName()

lsst.pipe.tasks.functors.fluxErrName

(

col

)

Append _instFluxErr to the column name if it doesn't have it already.

Definition at line 816 of file functors.py.

def fluxErrName(col):
    """Append _instFluxErr to the column name if it doesn't have it already."""
    if not col.endswith('_instFluxErr'):
        col += '_instFluxErr'
    return col
 
 

fluxName()

lsst.pipe.tasks.functors.fluxName

(

col

)

Append _instFlux to the column name if it doesn't have it already.

Definition at line 809 of file functors.py.

def fluxName(col):
    """Append _instFlux to the column name if it doesn't have it already."""
    if not col.endswith('_instFlux'):
        col += '_instFlux'
    return col
 
 

init_fromDict()

lsst.pipe.tasks.functors.init_fromDict	(		initDict,
			basePath = 'lsst.pipe.tasks.functors',
			typeKey = 'functor',
			name = None )

Initialize an object defined in a dictionary.

The object needs to be importable as f'{basePath}.{initDict[typeKey]}'.
The positional and keyword arguments (if any) are contained in "args" and
"kwargs" entries in the dictionary, respectively.
This is used in `~lsst.pipe.tasks.functors.CompositeFunctor.from_yaml` to
initialize a composite functor from a specification in a YAML file.

Parameters
----------
initDict : dictionary
    Dictionary describing object's initialization.
    Must contain an entry keyed by ``typeKey`` that is the name of the
    object, relative to ``basePath``.
basePath : str
    Path relative to module in which ``initDict[typeKey]`` is defined.
typeKey : str
    Key of ``initDict`` that is the name of the object (relative to
    ``basePath``).

Definition at line 59 of file functors.py.

                  typeKey='functor', name=None):
    """Initialize an object defined in a dictionary.
 
    The object needs to be importable as f'{basePath}.{initDict[typeKey]}'.
    The positional and keyword arguments (if any) are contained in "args" and
    "kwargs" entries in the dictionary, respectively.
    This is used in `~lsst.pipe.tasks.functors.CompositeFunctor.from_yaml` to
    initialize a composite functor from a specification in a YAML file.
 
    Parameters
    ----------
    initDict : dictionary
        Dictionary describing object's initialization.
        Must contain an entry keyed by ``typeKey`` that is the name of the
        object, relative to ``basePath``.
    basePath : str
        Path relative to module in which ``initDict[typeKey]`` is defined.
    typeKey : str
        Key of ``initDict`` that is the name of the object (relative to
        ``basePath``).
    """
    initDict = initDict.copy()
    # TO DO: DM-21956 We should be able to define functors outside this module
    pythonType = doImport(f'{basePath}.{initDict.pop(typeKey)}')
    args = []
    if 'args' in initDict:
        args = initDict.pop('args')
        if isinstance(args, str):
            args = [args]
    try:
        element = pythonType(*args, **initDict)
    except Exception as e:
        message = f'Error in constructing functor "{name}" of type {pythonType.__name__} with args: {args}'
        raise type(e)(message, e.args)
    return element
 
 

mag_aware_eval()

lsst.pipe.tasks.functors.mag_aware_eval	(		df,
			expr,
			log )

Evaluate an expression on a DataFrame, knowing what the 'mag' function
means.

Builds on `pandas.DataFrame.eval`, which parses and executes math on
DataFrames.

Parameters
----------
df : ~pandas.DataFrame
    DataFrame on which to evaluate expression.

expr : str
    Expression.

Definition at line 580 of file functors.py.

def mag_aware_eval(df, expr, log):
    """Evaluate an expression on a DataFrame, knowing what the 'mag' function
    means.
 
    Builds on `pandas.DataFrame.eval`, which parses and executes math on
    DataFrames.
 
    Parameters
    ----------
    df : ~pandas.DataFrame
        DataFrame on which to evaluate expression.
 
    expr : str
        Expression.
    """
    try:
        expr_new = re.sub(r'mag\‍((\w+)\‍)', r'-2.5*log(\g<1>)/log(10)', expr)
        val = df.eval(expr_new)
    except Exception as e:  # Should check what actually gets raised
        log.error("Exception in mag_aware_eval: %s: %s", type(e).__name__, e)
        expr_new = re.sub(r'mag\‍((\w+)\‍)', r'-2.5*log(\g<1>_instFlux)/log(10)', expr)
        val = df.eval(expr_new)
    return val