lsst.pipe.tasks g253578fa50+c1a9b1f270
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
lsst.pipe.tasks.functors.LocalNanojansky Class Reference
Inheritance diagram for lsst.pipe.tasks.functors.LocalNanojansky:
lsst.pipe.tasks.functors.LocalPhotometry lsst.pipe.tasks.functors.Functor

Public Member Functions

 columns (self)
 
 name (self)
 
 instFluxToNanojansky (self, instFlux, localCalib)
 
 instFluxErrToNanojanskyErr (self, instFlux, instFluxErr, localCalib, localCalibErr=None)
 
 instFluxToMagnitude (self, instFlux, localCalib)
 
 instFluxErrToMagnitudeErr (self, instFlux, instFluxErr, localCalib, localCalibErr=None)
 
 noDup (self)
 
 multilevelColumns (self, data, columnIndex=None, returnTuple=False)
 
 __call__ (self, data, dropna=False)
 
 difference (self, data1, data2, **kwargs)
 
 fail (self, df)
 
 shortname (self)
 

Public Attributes

 instFluxCol = instFluxCol
 
 instFluxErrCol = instFluxErrCol
 
 photoCalibCol = photoCalibCol
 
 filt = filt
 
str dataset = dataset if dataset is not None else self._defaultDataset
 
 log = logging.getLogger(type(self).__name__)
 

Static Public Attributes

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

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 calibrated fluxes using the local calibration value.

This returns units of nanojanskys.

Definition at line 1803 of file functors.py.

Member Function Documentation

◆ __call__()

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

Definition at line 353 of file functors.py.

◆ _colsFromDict()

lsst.pipe.tasks.functors.Functor._colsFromDict ( self,
colDict,
columnIndex = None )
protectedinherited 
Converts dictionary column specficiation to a list of columns.

Definition at line 223 of file functors.py.

◆ _dropna()

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

Definition at line 350 of file functors.py.

◆ _func()

lsst.pipe.tasks.functors.LocalNanojansky._func ( self,
df )
protected

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

Definition at line 1817 of file functors.py.

◆ _get_columnIndex()

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

Definition at line 299 of file functors.py.

◆ _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 307 of file functors.py.

◆ _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 209 of file functors.py.

◆ _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 189 of file functors.py.

◆ _setLevels()

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

Definition at line 345 of file functors.py.

◆ columns()

lsst.pipe.tasks.functors.LocalNanojansky.columns ( self) 
Columns required to perform calculation.

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

Definition at line 1810 of file functors.py.

◆ 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 365 of file functors.py.

◆ fail()

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

Definition at line 371 of file functors.py.

◆ instFluxErrToMagnitudeErr()

lsst.pipe.tasks.functors.LocalPhotometry.instFluxErrToMagnitudeErr ( self,
instFlux,
instFluxErr,
localCalib,
localCalibErr = None )
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`, optional
    Errors on associated ``localCalib`` values.  Ignored and deprecated;
    will be removed after v29.

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

Definition at line 1775 of file functors.py.

◆ instFluxErrToNanojanskyErr()

lsst.pipe.tasks.functors.LocalPhotometry.instFluxErrToNanojanskyErr ( self,
instFlux,
instFluxErr,
localCalib,
localCalibErr = None )
inherited 
Convert instrument flux to nanojanskys.

Parameters
----------
instFlux : `~numpy.ndarray` or `~pandas.Series`
    Array of instrument flux measurements.  Ignored (accepted for
    backwards compatibility and consistency with magnitude-error
    calculation methods).
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`, optional
    Errors on associated ``localCalib`` values.  Ignored and deprecated;
    will be removed after v29.

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

Definition at line 1730 of file functors.py.

◆ instFluxToMagnitude()

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

◆ instFluxToNanojansky()

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

◆ multilevelColumns()

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
`~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 in lsst.pipe.tasks.functors.Color, and lsst.pipe.tasks.functors.CompositeFunctor.

Definition at line 242 of file functors.py.

◆ name()

lsst.pipe.tasks.functors.LocalNanojansky.name ( self)

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

Definition at line 1814 of file functors.py.

◆ noDup()

lsst.pipe.tasks.functors.Functor.noDup ( self)
inherited 
Do not explode by band if used on object table.

Definition at line 175 of file functors.py.

◆ shortname()

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

Member Data Documentation

◆ _defaultDataset

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

Definition at line 164 of file functors.py.

◆ _defaultNoDup

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

Definition at line 166 of file functors.py.

◆ _dfLevels

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

Definition at line 165 of file functors.py.

◆ _noDup

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

Definition at line 171 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 170 of file functors.py.

◆ filt

lsst.pipe.tasks.functors.Functor.filt = filt
inherited

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

Definition at line 169 of file functors.py.

◆ instFluxCol

lsst.pipe.tasks.functors.LocalPhotometry.instFluxCol = instFluxCol
inherited

Definition at line 1704 of file functors.py.

◆ instFluxErrCol

lsst.pipe.tasks.functors.LocalPhotometry.instFluxErrCol = instFluxErrCol
inherited

Definition at line 1705 of file functors.py.

◆ log

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

Definition at line 172 of file functors.py.

◆ logNJanskyToAB

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

Definition at line 1696 of file functors.py.

◆ photoCalibCol

lsst.pipe.tasks.functors.LocalPhotometry.photoCalibCol = photoCalibCol
inherited

Definition at line 1706 of file functors.py.

The documentation for this class was generated from the following file:
Generated on Tue Apr 21 2026 10:40:03 for lsst.pipe.tasks by doxygen 1.13.2