lsst.pipe.tasks.functors.Color Class Reference

Inheritance diagram for lsst.pipe.tasks.functors.Color:

Public Member Functions
	__init__ (self, col, filt2, filt1, **kwargs)
	filt (self)
	filt (self, filt)
	columns (self)
	multilevelColumns (self, parq, **kwargs)
	name (self)
	shortname (self)
	noDup (self)
	__call__ (self, data, dropna=False)
	difference (self, data1, data2, **kwargs)
	fail (self, df)

Public Attributes
	col = fluxName(col)
	filt2 = filt2
	filt1 = filt1
	mag2 = Mag(col, filt=filt2, **kwargs)
	mag1 = Mag(col, filt=filt1, **kwargs)
str	dataset = dataset if dataset is not None else self._defaultDataset
	log = logging.getLogger(type(self).__name__)

Protected Member Functions
	_func (self, df)
	_get_data_columnLevels (self, data, columnIndex=None)
	_get_data_columnLevelNames (self, data, columnIndex=None)
	_colsFromDict (self, colDict, columnIndex=None)
	_get_columnIndex (self, data)
	_get_data (self, data)
	_setLevels (self, df)
	_dropna (self, vals)

Protected Attributes
	_noDup = noDup

Static Protected Attributes
str	_defaultDataset = 'ref'
tuple	_dfLevels = ('column',)
bool	_defaultNoDup = False

Detailed Description

Compute the color between two filters.

Computes color by initializing two different `Mag` functors based on the
``col`` and filters provided, and then returning the difference.

This is enabled by the `_func` method expecting a DataFrame with a
multilevel column index, with both ``'band'`` and ``'column'``, instead of
just ``'column'``, which is the `Functor` default.
This is controlled by the `_dfLevels` attribute.

Also of note, the default dataset for `Color` is ``forced_src'``, whereas
for `Mag` it is ``'meas'``.

Parameters
----------
col : str
    Name of the flux column from which to compute; same as would be passed
    to `~lsst.pipe.tasks.functors.Mag`.

filt2, filt1 : str
    Filters from which to compute magnitude difference.
    Color computed is ``Mag(filt2) - Mag(filt1)``.

Definition at line 930 of file functors.py.

Constructor & Destructor Documentation

__init__()

lsst.pipe.tasks.functors.Color.__init__	(		self,
			col,
			filt2,
			filt1,
		**	kwargs )

Definition at line 958 of file functors.py.

    def __init__(self, col, filt2, filt1, **kwargs):
        self.col = fluxName(col)
        if filt2 == filt1:
            raise RuntimeError("Cannot compute Color for %s: %s - %s " % (col, filt2, filt1))
        self.filt2 = filt2
        self.filt1 = filt1
 
        self.mag2 = Mag(col, filt=filt2, **kwargs)
        self.mag1 = Mag(col, filt=filt1, **kwargs)
 
        super().__init__(**kwargs)
 

Member Function Documentation

__call__()

lsst.pipe.tasks.functors.Functor.__call__ ( self, data, dropna = False )

inherited

Definition at line 348 of file functors.py.

    def __call__(self, data, dropna=False):
        df = self._get_data(data)
        try:
            vals = self._func(df)
        except Exception as e:
            self.log.error("Exception in %s call: %s: %s", self.name, type(e).__name__, e)
            vals = self.fail(df)
        if dropna:
            vals = self._dropna(vals)
 
        return vals
 

_colsFromDict()

lsst.pipe.tasks.functors.Functor._colsFromDict ( self, colDict, columnIndex = None )

protectedinherited

Converts dictionary column specficiation to a list of columns.

Definition at line 218 of file functors.py.

    def _colsFromDict(self, colDict, columnIndex=None):
        """Converts dictionary column specficiation to a list of columns."""
        new_colDict = {}
        columnLevels = self._get_data_columnLevels(None, columnIndex=columnIndex)
 
        for i, lev in enumerate(columnLevels):
            if lev in colDict:
                if isinstance(colDict[lev], str):
                    new_colDict[lev] = [colDict[lev]]
                else:
                    new_colDict[lev] = colDict[lev]
            else:
                new_colDict[lev] = columnIndex.levels[i]
 
        levelCols = [new_colDict[lev] for lev in columnLevels]
        cols = list(product(*levelCols))
        colsAvailable = [col for col in cols if col in columnIndex]
        return colsAvailable
 

_dropna()

lsst.pipe.tasks.functors.Functor._dropna ( self, vals )

protectedinherited

Definition at line 345 of file functors.py.

    def _dropna(self, vals):
        return vals.dropna()
 

_func()

lsst.pipe.tasks.functors.Color._func ( self, df )

protected

Reimplemented from lsst.pipe.tasks.functors.Functor.

Definition at line 978 of file functors.py.

    def _func(self, df):
        mag2 = self.mag2._func(df[self.filt2])
        mag1 = self.mag1._func(df[self.filt1])
        return mag2 - mag1
 

_get_columnIndex()

lsst.pipe.tasks.functors.Functor._get_columnIndex ( self, data )

protectedinherited

Return columnIndex.

Definition at line 294 of file functors.py.

    def _get_columnIndex(self, data):
        """Return columnIndex."""
 
        if isinstance(data, (DeferredDatasetHandle, InMemoryDatasetHandle)):
            return data.get(component="columns")
        else:
            return None
 

_get_data()

lsst.pipe.tasks.functors.Functor._get_data ( self, data )

protectedinherited

Retrieve DataFrame necessary for calculation.

The data argument can be a `~pandas.DataFrame`, a
`~lsst.daf.butler.DeferredDatasetHandle`, or
an `~lsst.pipe.base.InMemoryDatasetHandle`.

Returns a DataFrame upon which `self._func` can act.

Definition at line 302 of file functors.py.

    def _get_data(self, data):
        """Retrieve DataFrame necessary for calculation.
 
        The data argument can be a `~pandas.DataFrame`, a
        `~lsst.daf.butler.DeferredDatasetHandle`, or
        an `~lsst.pipe.base.InMemoryDatasetHandle`.
 
        Returns a DataFrame upon which `self._func` can act.
        """
        # We wrap a DataFrame in a handle here to take advantage of the
        # DataFrame delegate DataFrame column wrangling abilities.
        if isinstance(data, pd.DataFrame):
            _data = InMemoryDatasetHandle(data, storageClass="DataFrame")
        elif isinstance(data, (DeferredDatasetHandle, InMemoryDatasetHandle)):
            _data = data
        else:
            raise RuntimeError(f"Unexpected type provided for data. Got {get_full_type_name(data)}.")
 
        # First thing to do: check to see if the data source has a multilevel
        # column index or not.
        columnIndex = self._get_columnIndex(_data)
        is_multiLevel = isinstance(columnIndex, pd.MultiIndex)
 
        # Get proper columns specification for this functor.
        if is_multiLevel:
            columns = self.multilevelColumns(_data, columnIndex=columnIndex)
        else:
            columns = self.columns
 
        # Load in-memory DataFrame with appropriate columns the gen3 way.
        df = _data.get(parameters={"columns": columns})
 
        # Drop unnecessary column levels.
        if is_multiLevel:
            df = self._setLevels(df)
 
        return df
 

_get_data_columnLevelNames()

lsst.pipe.tasks.functors.Functor._get_data_columnLevelNames ( self, data, columnIndex = None )

protectedinherited

Gets the content of each of the column levels for a multilevel
table.

Definition at line 204 of file functors.py.

    def _get_data_columnLevelNames(self, data, columnIndex=None):
        """Gets the content of each of the column levels for a multilevel
        table.
        """
        if columnIndex is None:
            columnIndex = data.get(component="columns")
 
        columnLevels = columnIndex.names
        columnLevelNames = {
            level: list(np.unique(np.array([c for c in columnIndex])[:, i]))
            for i, level in enumerate(columnLevels)
        }
        return columnLevelNames
 

_get_data_columnLevels()

lsst.pipe.tasks.functors.Functor._get_data_columnLevels ( self, data, columnIndex = None )

protectedinherited

Gets the names of the column index levels.

This should only be called in the context of a multilevel table.

Parameters
----------
data : various
    The data to be read, can be a
    `~lsst.daf.butler.DeferredDatasetHandle` or
    `~lsst.pipe.base.InMemoryDatasetHandle`.
columnIndex (optional): pandas `~pandas.Index` object
    If not passed, then it is read from the
    `~lsst.daf.butler.DeferredDatasetHandle`
    for `~lsst.pipe.base.InMemoryDatasetHandle`.

Definition at line 184 of file functors.py.

    def _get_data_columnLevels(self, data, columnIndex=None):
        """Gets the names of the column index levels.
 
        This should only be called in the context of a multilevel table.
 
        Parameters
        ----------
        data : various
            The data to be read, can be a
            `~lsst.daf.butler.DeferredDatasetHandle` or
            `~lsst.pipe.base.InMemoryDatasetHandle`.
        columnIndex (optional): pandas `~pandas.Index` object
            If not passed, then it is read from the
            `~lsst.daf.butler.DeferredDatasetHandle`
            for `~lsst.pipe.base.InMemoryDatasetHandle`.
        """
        if columnIndex is None:
            columnIndex = data.get(component="columns")
        return columnIndex.names
 

_setLevels()

lsst.pipe.tasks.functors.Functor._setLevels ( self, df )

protectedinherited

Definition at line 340 of file functors.py.

    def _setLevels(self, df):
        levelsToDrop = [n for n in df.columns.names if n not in self._dfLevels]
        df.columns = df.columns.droplevel(levelsToDrop)
        return df
 

columns()

lsst.pipe.tasks.functors.Color.columns

(

self

)

Columns required to perform calculation.

Reimplemented from lsst.pipe.tasks.functors.Functor.

Definition at line 984 of file functors.py.

    def columns(self):
        return [self.mag1.col, self.mag2.col]
 

difference()

lsst.pipe.tasks.functors.Functor.difference ( self, data1, data2, ** kwargs )

inherited

Computes difference between functor called on two different
DataFrame/Handle objects.

Definition at line 360 of file functors.py.

    def difference(self, data1, data2, **kwargs):
        """Computes difference between functor called on two different
        DataFrame/Handle objects.
        """
        return self(data1, **kwargs) - self(data2, **kwargs)
 

fail()

lsst.pipe.tasks.functors.Functor.fail ( self, df )

inherited

Definition at line 366 of file functors.py.

    def fail(self, df):
        return pd.Series(np.full(len(df), np.nan), index=df.index)
 

filt() [1/2]

lsst.pipe.tasks.functors.Color.filt

(

self

)

Reimplemented from lsst.pipe.tasks.functors.Functor.

Definition at line 971 of file functors.py.

    def filt(self):
        return None
 

filt() [2/2]

lsst.pipe.tasks.functors.Color.filt	(		self,
			filt )

Reimplemented from lsst.pipe.tasks.functors.Functor.

Definition at line 975 of file functors.py.

    def filt(self, filt):
        pass
 

multilevelColumns()

lsst.pipe.tasks.functors.Color.multilevelColumns	(		self,
			data,
		**	columnIndex )

Returns columns needed by functor from multilevel dataset.

To access tables with multilevel column structure, the
`~lsst.daf.butler.DeferredDatasetHandle` or
`~lsst.pipe.base.InMemoryDatasetHandle` needs to be passed
either a list of tuples or a dictionary.

Parameters
----------
data : various
    The data as either `~lsst.daf.butler.DeferredDatasetHandle`, or
    `~lsst.pipe.base.InMemoryDatasetHandle`.
columnIndex (optional): pandas `~pandas.Index` object
    Either passed or read in from
    `~lsst.daf.butler.DeferredDatasetHandle`.
`returnTuple` : `bool`
    If true, then return a list of tuples rather than the column
    dictionary specification.
    This is set to `True` by `CompositeFunctor` in order to be able to
    combine columns from the various component functors.

Reimplemented from lsst.pipe.tasks.functors.Functor.

Definition at line 987 of file functors.py.

    def multilevelColumns(self, parq, **kwargs):
        return [(self.dataset, self.filt1, self.col), (self.dataset, self.filt2, self.col)]
 

name()

lsst.pipe.tasks.functors.Color.name

(

self

)

Reimplemented from lsst.pipe.tasks.functors.Functor.

Definition at line 991 of file functors.py.

    def name(self):
        return f'{self.filt2} - {self.filt1} ({self.col})'
 

noDup()

lsst.pipe.tasks.functors.Functor.noDup ( self )

inherited

Do not explode by band if used on object table.

Definition at line 170 of file functors.py.

    def noDup(self):
        """Do not explode by band if used on object table."""
        if self._noDup is not None:
            return self._noDup
        else:
            return self._defaultNoDup
 

shortname()

lsst.pipe.tasks.functors.Color.shortname

(

self

)

Short name of functor (suitable for column name/dict key).

Reimplemented from lsst.pipe.tasks.functors.Functor.

Definition at line 995 of file functors.py.

    def shortname(self):
        return f"{self.col}_{self.filt2.replace('-', '')}m{self.filt1.replace('-', '')}"
 
 

Member Data Documentation

_defaultDataset

str lsst.pipe.tasks.functors.Functor._defaultDataset = 'ref'

staticprotectedinherited

Definition at line 159 of file functors.py.

_defaultNoDup

bool lsst.pipe.tasks.functors.Functor._defaultNoDup = False

staticprotectedinherited

Definition at line 161 of file functors.py.

_dfLevels

tuple lsst.pipe.tasks.functors.Functor._dfLevels = ('column',)

staticprotectedinherited

Definition at line 160 of file functors.py.

_noDup

lsst.pipe.tasks.functors.Functor._noDup = noDup

protectedinherited

Definition at line 166 of file functors.py.

col

lsst.pipe.tasks.functors.Color.col = fluxName(col)

Definition at line 959 of file functors.py.

dataset

str lsst.pipe.tasks.functors.Functor.dataset = dataset if dataset is not None else self._defaultDataset

inherited

Definition at line 165 of file functors.py.

filt1

lsst.pipe.tasks.functors.Color.filt1 = filt1

Definition at line 963 of file functors.py.

filt2

lsst.pipe.tasks.functors.Color.filt2 = filt2

Definition at line 962 of file functors.py.

log

lsst.pipe.tasks.functors.Functor.log = logging.getLogger(type(self).__name__)

inherited

Definition at line 167 of file functors.py.

mag1

lsst.pipe.tasks.functors.Color.mag1 = Mag(col, filt=filt1, **kwargs)

Definition at line 966 of file functors.py.

mag2

lsst.pipe.tasks.functors.Color.mag2 = Mag(col, filt=filt2, **kwargs)

Definition at line 965 of file functors.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/pipe_tasks/g99af87f6a8+b0f4ad7b8d/python/lsst/pipe/tasks/functors.py