LocalDipoleDiffFlux¶

class lsst.pipe.tasks.functors.LocalDipoleDiffFlux(instFluxPosCol, instFluxNegCol, instFluxPosErrCol, instFluxNegErrCol, photoCalibCol, photoCalibErrCol, **kwargs)¶

Bases: LocalDipoleMeanFlux

Compute the absolute difference of dipole fluxes.

Calculated value is (abs(pos) - abs(neg)).

See also

LocalNanojansky
LocalNanojanskyErr
LocalDipoleMeanFlux
LocalDipoleMeanFluxErr
LocalDipoleDiffFluxErr

Attributes Summary

`columns`	Columns required to perform calculation.
`logNJanskyToAB`
`name`	Full name of functor (suitable for figure labels).
`noDup`	Do not explode by band if used on object table.
`shortname`	Short name of functor (suitable for column name/dict key).

Methods Summary

`__call__`(data[, dropna])	Call self as a function.
`difference`(data1, data2, **kwargs)	Computes difference between functor called on two different DataFrame/Handle objects.
`fail`(df)
`instFluxErrToMagnitudeErr`(instFlux, ...)	Convert instrument flux err to nanojanskys.
`instFluxErrToNanojanskyErr`(instFlux, ...)	Convert instrument flux to nanojanskys.
`instFluxToMagnitude`(instFlux, localCalib)	Convert instrument flux to nanojanskys.
`instFluxToNanojansky`(instFlux, localCalib)	Convert instrument flux to nanojanskys.
`multilevelColumns`(data[, columnIndex, ...])	Returns columns needed by functor from multilevel dataset.

Attributes Documentation

columns¶

logNJanskyToAB = 31.4¶

name¶

noDup¶: Do not explode by band if used on object table.

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

Methods Documentation

__call__(data, dropna=False)¶: Call self as a function.

difference(data1, data2, **kwargs)¶: Computes difference between functor called on two different DataFrame/Handle objects.

fail(df)¶

instFluxErrToMagnitudeErr(instFlux, instFluxErr, localCalib, localCalibErr)¶

Convert instrument flux err to nanojanskys.

Parameters:

instFluxndarray or Series: Array of instrument flux measurements.
instFluxErrndarray or Series: Errors on associated instFlux values.
localCalibndarray or Series: Array of local photometric calibration estimates.
localCalibErrndarray or Series: Errors on associated localCalib values.

Returns:

calibMagErr: ndarray or Series: Error on calibrated AB magnitudes.

instFluxErrToNanojanskyErr(instFlux, instFluxErr, localCalib, localCalibErr)¶

Convert instrument flux to nanojanskys.

Parameters:

instFluxndarray or Series: Array of instrument flux measurements.
instFluxErrndarray or Series: Errors on associated instFlux values.
localCalibndarray or Series: Array of local photometric calibration estimates.
localCalibErrndarray or Series: Errors on associated localCalib values.

Returns:

calibFluxErrndarray or Series: Errors on calibrated flux measurements.

instFluxToMagnitude(instFlux, localCalib)¶

Convert instrument flux to nanojanskys.

Parameters:

instFluxndarray or Series: Array of instrument flux measurements.
localCalibndarray or Series: Array of local photometric calibration estimates.

Returns:

calibMagndarray or Series: Array of calibrated AB magnitudes.

instFluxToNanojansky(instFlux, localCalib)¶

Convert instrument flux to nanojanskys.

Parameters:

instFluxndarray or Series: Array of instrument flux measurements.
localCalibndarray or Series: Array of local photometric calibration estimates.

Returns:

calibFluxndarray or Series: Array of calibrated flux measurements.

multilevelColumns(data, columnIndex=None, returnTuple=False)¶

Returns columns needed by functor from multilevel dataset.

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

Parameters:

datavarious: The data as either DeferredDatasetHandle, or InMemoryDatasetHandle.
columnIndex (optional): pandas `~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.

Navigation

LocalDipoleDiffFlux¶