lsst.pipe.tasks.functors.Color Class Reference

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

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

Public Attributes
	col
	filt2
	filt1
	mag2
	mag1
	filt
	dataset

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` 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 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 897 of file functors.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 926 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__()

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

inherited

Definition at line 340 of file functors.py.

    def __call__(self, data, dropna=False):
        try:
            df = self._get_data(data)
            vals = self._func(df)
        except Exception:
            vals = self.fail(df)
        if dropna:
            vals = self._dropna(vals)
 
        return vals
 

columns()

def lsst.pipe.tasks.functors.Color.columns

(

self

)

Columns required to perform calculation

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

Definition at line 952 of file functors.py.

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

difference()

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

inherited

Computes difference between functor called on two different ParquetTable objects

Definition at line 351 of file functors.py.

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

fail()

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

inherited

Definition at line 356 of file functors.py.

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

filt() [1/2]

def lsst.pipe.tasks.functors.Color.filt

(

self

)

Definition at line 939 of file functors.py.

    def filt(self):
        return None
 

filt() [2/2]

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

Definition at line 943 of file functors.py.

    def filt(self, filt):
        pass
 

multilevelColumns() [1/2]

def lsst.pipe.tasks.functors.Functor.multilevelColumns (   self,   data,   columnIndex = None,   returnTuple = False  )

inherited

Returns columns needed by functor from multilevel dataset

To access tables with multilevel column structure, the `MultilevelParquetTable`
or `DeferredDatasetHandle` need to be passed either a list of tuples or a
dictionary.

Parameters
----------
data : `MultilevelParquetTable` or `DeferredDatasetHandle`

columnIndex (optional): pandas `Index` object
    either passed or read in from `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.

Definition at line 229 of file functors.py.

    def multilevelColumns(self, data, columnIndex=None, returnTuple=False):
        """Returns columns needed by functor from multilevel dataset
 
        To access tables with multilevel column structure, the `MultilevelParquetTable`
        or `DeferredDatasetHandle` need to be passed either a list of tuples or a
        dictionary.
 
        Parameters
        ----------
        data : `MultilevelParquetTable` or `DeferredDatasetHandle`
 
        columnIndex (optional): pandas `Index` object
            either passed or read in from `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.
 
        """
        if isinstance(data, DeferredDatasetHandle) and columnIndex is None:
            columnIndex = data.get(component="columns")
 
        # Confirm that the dataset has the column levels the functor is expecting it to have.
        columnLevels = self._get_data_columnLevels(data, columnIndex)
 
        columnDict = {'column': self.columns,
                      'dataset': self.dataset}
        if self.filt is None:
            columnLevelNames = self._get_data_columnLevelNames(data, columnIndex)
            if "band" in columnLevels:
                if self.dataset == "ref":
                    columnDict["band"] = columnLevelNames["band"][0]
                else:
                    raise ValueError(f"'filt' not set for functor {self.name}"
                                     f"(dataset {self.dataset}) "
                                     "and ParquetTable "
                                     "contains multiple filters in column index. "
                                     "Set 'filt' or set 'dataset' to 'ref'.")
        else:
            columnDict['band'] = self.filt
 
        if isinstance(data, MultilevelParquetTable):
            return data._colsFromDict(columnDict)
        elif isinstance(data, DeferredDatasetHandle):
            if returnTuple:
                return self._colsFromDict(columnDict, columnIndex=columnIndex)
            else:
                return columnDict
 

multilevelColumns() [2/2]

def lsst.pipe.tasks.functors.Color.multilevelColumns	(		self,
			parq,
		**	kwargs
	)

Definition at line 955 of file functors.py.

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

name()

def lsst.pipe.tasks.functors.Color.name

(

self

)

Full name of functor (suitable for figure labels)

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

Definition at line 959 of file functors.py.

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

noDup()

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

inherited

Definition at line 148 of file functors.py.

    def noDup(self):
        if self._noDup is not None:
            return self._noDup
        else:
            return self._defaultNoDup
 

shortname()

def 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 963 of file functors.py.

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

Member Data Documentation

col

lsst.pipe.tasks.functors.Color.col

Definition at line 927 of file functors.py.

dataset

lsst.pipe.tasks.functors.Functor.dataset

inherited

Definition at line 144 of file functors.py.

filt

lsst.pipe.tasks.functors.Functor.filt

inherited

Definition at line 143 of file functors.py.

filt1

lsst.pipe.tasks.functors.Color.filt1

Definition at line 931 of file functors.py.

filt2

lsst.pipe.tasks.functors.Color.filt2

Definition at line 930 of file functors.py.

mag1

lsst.pipe.tasks.functors.Color.mag1

Definition at line 934 of file functors.py.

mag2

lsst.pipe.tasks.functors.Color.mag2

Definition at line 933 of file functors.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/pipe_tasks/21.0.0-172-gfb10e10a+18fedfabac/python/lsst/pipe/tasks/functors.py