lsst.pipe.tasks.functors.LocalMagnitudeErr Class Reference

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

Public Member Functions
def	columns (self)
def	name (self)
def	instFluxToNanojansky (self, instFlux, localCalib)
def	instFluxErrToNanojanskyErr (self, instFlux, instFluxErr, localCalib, localCalibErr)
def	instFluxToMagnitude (self, instFlux, localCalib)
def	instFluxErrToMagnitudeErr (self, instFlux, instFluxErr, localCalib, localCalibErr)
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)
def	shortname (self)

Public Attributes
	instFluxCol
	instFluxErrCol
	photoCalibCol
	photoCalibErrCol
	filt
	dataset

Static Public Attributes
tuple	logNJanskyToAB = (1 * u.nJy).to_value(u.ABmag)

Detailed Description

Compute calibrated AB magnitude errors using the local calibration value.

See also
--------
LocalNanojansky
LocalNanojanskyErr
LocalMagnitude
LocalMagnitudeErr

Definition at line 1673 of file functors.py.

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.LocalMagnitudeErr.columns

(

self

)

Columns required to perform calculation

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

Definition at line 1685 of file functors.py.

    def columns(self):
        return [self.instFluxCol, self.instFluxErrCol,
                self.photoCalibCol, self.photoCalibErrCol]
 

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)
 

instFluxErrToMagnitudeErr()

def lsst.pipe.tasks.functors.LocalPhotometry.instFluxErrToMagnitudeErr (   self,   instFlux,   instFluxErr,   localCalib,   localCalibErr  )

inherited

Convert instrument flux err to nanojanskys.

Parameters
----------
instFlux : `numpy.ndarray` or `pandas.Series`
    Array of instrument flux measurements
instFluxErr : `numpy.ndarray` or `pandas.Series`
    Errors on associated ``instFlux`` values
localCalib : `numpy.ndarray` or `pandas.Series`
    Array of local photometric calibration estimates.
localCalibErr : `numpy.ndarray` or `pandas.Series`
   Errors on associated ``localCalib`` values

Returns
-------
calibMagErr: `numpy.ndarray` or `pandas.Series`
    Error on calibrated AB magnitudes.

Definition at line 1578 of file functors.py.

    def instFluxErrToMagnitudeErr(self, instFlux, instFluxErr, localCalib, localCalibErr):
        """Convert instrument flux err to nanojanskys.
 
        Parameters
        ----------
        instFlux : `numpy.ndarray` or `pandas.Series`
            Array of instrument flux measurements
        instFluxErr : `numpy.ndarray` or `pandas.Series`
            Errors on associated ``instFlux`` values
        localCalib : `numpy.ndarray` or `pandas.Series`
            Array of local photometric calibration estimates.
        localCalibErr : `numpy.ndarray` or `pandas.Series`
           Errors on associated ``localCalib`` values
 
        Returns
        -------
        calibMagErr: `numpy.ndarray` or `pandas.Series`
            Error on calibrated AB magnitudes.
        """
        err = self.instFluxErrToNanojanskyErr(instFlux, instFluxErr, localCalib, localCalibErr)
        return 2.5 / np.log(10) * err / self.instFluxToNanojansky(instFlux, instFluxErr)
 
 

instFluxErrToNanojanskyErr()

def lsst.pipe.tasks.functors.LocalPhotometry.instFluxErrToNanojanskyErr (   self,   instFlux,   instFluxErr,   localCalib,   localCalibErr  )

inherited

Convert instrument flux to nanojanskys.

Parameters
----------
instFlux : `numpy.ndarray` or `pandas.Series`
    Array of instrument flux measurements
instFluxErr : `numpy.ndarray` or `pandas.Series`
    Errors on associated ``instFlux`` values
localCalib : `numpy.ndarray` or `pandas.Series`
    Array of local photometric calibration estimates.
localCalibErr : `numpy.ndarray` or `pandas.Series`
   Errors on associated ``localCalib`` values

Returns
-------
calibFluxErr : `numpy.ndarray` or `pandas.Series`
    Errors on calibrated flux measurements.

Definition at line 1540 of file functors.py.

    def instFluxErrToNanojanskyErr(self, instFlux, instFluxErr, localCalib, localCalibErr):
        """Convert instrument flux to nanojanskys.
 
        Parameters
        ----------
        instFlux : `numpy.ndarray` or `pandas.Series`
            Array of instrument flux measurements
        instFluxErr : `numpy.ndarray` or `pandas.Series`
            Errors on associated ``instFlux`` values
        localCalib : `numpy.ndarray` or `pandas.Series`
            Array of local photometric calibration estimates.
        localCalibErr : `numpy.ndarray` or `pandas.Series`
           Errors on associated ``localCalib`` values
 
        Returns
        -------
        calibFluxErr : `numpy.ndarray` or `pandas.Series`
            Errors on calibrated flux measurements.
        """
        return np.hypot(instFluxErr * localCalib, instFlux * localCalibErr)
 

instFluxToMagnitude()

def lsst.pipe.tasks.functors.LocalPhotometry.instFluxToMagnitude (   self,   instFlux,   localCalib  )

inherited

Convert instrument flux to nanojanskys.

Parameters
----------
instFlux : `numpy.ndarray` or `pandas.Series`
    Array of instrument flux measurements
localCalib : `numpy.ndarray` or `pandas.Series`
    Array of local photometric calibration estimates.

Returns
-------
calibMag : `numpy.ndarray` or `pandas.Series`
    Array of calibrated AB magnitudes.

Definition at line 1561 of file functors.py.

    def instFluxToMagnitude(self, instFlux, localCalib):
        """Convert instrument flux to nanojanskys.
 
        Parameters
        ----------
        instFlux : `numpy.ndarray` or `pandas.Series`
            Array of instrument flux measurements
        localCalib : `numpy.ndarray` or `pandas.Series`
            Array of local photometric calibration estimates.
 
        Returns
        -------
        calibMag : `numpy.ndarray` or `pandas.Series`
            Array of calibrated AB magnitudes.
        """
        return -2.5 * np.log10(self.instFluxToNanojansky(instFlux, localCalib)) + self.logNJanskyToAB
 

instFluxToNanojansky()

def lsst.pipe.tasks.functors.LocalPhotometry.instFluxToNanojansky (   self,   instFlux,   localCalib  )

inherited

Convert instrument flux to nanojanskys.

Parameters
----------
instFlux : `numpy.ndarray` or `pandas.Series`
    Array of instrument flux measurements
localCalib : `numpy.ndarray` or `pandas.Series`
    Array of local photometric calibration estimates.

Returns
-------
calibFlux : `numpy.ndarray` or `pandas.Series`
    Array of calibrated flux measurements.

Definition at line 1523 of file functors.py.

    def instFluxToNanojansky(self, instFlux, localCalib):
        """Convert instrument flux to nanojanskys.
 
        Parameters
        ----------
        instFlux : `numpy.ndarray` or `pandas.Series`
            Array of instrument flux measurements
        localCalib : `numpy.ndarray` or `pandas.Series`
            Array of local photometric calibration estimates.
 
        Returns
        -------
        calibFlux : `numpy.ndarray` or `pandas.Series`
            Array of calibrated flux measurements.
        """
        return instFlux * localCalib
 

multilevelColumns()

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
 

name()

def lsst.pipe.tasks.functors.LocalMagnitudeErr.name

(

self

)

Full name of functor (suitable for figure labels)

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

Definition at line 1690 of file functors.py.

    def name(self):
        return f'magErr_{self.instFluxCol}'
 

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.Functor.shortname (   self )

inherited

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

Reimplemented in lsst.pipe.tasks.functors.Color, and lsst.pipe.tasks.functors.MagDiff.

Definition at line 366 of file functors.py.

    def shortname(self):
        """Short name of functor (suitable for column name/dict key)
        """
        return self.name
 
 

Member Data Documentation

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.

instFluxCol

lsst.pipe.tasks.functors.LocalPhotometry.instFluxCol

inherited

Definition at line 1517 of file functors.py.

instFluxErrCol

lsst.pipe.tasks.functors.LocalPhotometry.instFluxErrCol

inherited

Definition at line 1518 of file functors.py.

logNJanskyToAB

tuple lsst.pipe.tasks.functors.LocalPhotometry.logNJanskyToAB = (1 * u.nJy).to_value(u.ABmag)

staticinherited

Definition at line 1509 of file functors.py.

photoCalibCol

lsst.pipe.tasks.functors.LocalPhotometry.photoCalibCol

inherited

Definition at line 1519 of file functors.py.

photoCalibErrCol

lsst.pipe.tasks.functors.LocalPhotometry.photoCalibErrCol

inherited

Definition at line 1520 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-147-g0e635eb1+1acddb5be5/python/lsst/pipe/tasks/functors.py