MagDiff#

class lsst.analysis.tools.actions.vector.MagDiff(*args, **kw)#

Bases: VectorAction

Calculate the difference between two magnitudes; each magnitude is derived from a flux column.

Notes#

The flux columns need to be in units (specifiable in the fluxUnits1 and 2 config options) that can be converted to janskies. This action doesn’t have any calibration information and assumes that the fluxes are already calibrated.

Attributes Summary

`col1`	Column to subtract from (`str`)
`col2`	Column to subtract (`str`)
`fluxUnits1`	Units for col1 (`str`, default `'nanojansky'`)
`fluxUnits2`	Units for col2 (`str`, default `'nanojansky'`)
`returnMillimags`	Use millimags or not? (`bool`, default `True`)

Methods Summary

`__call__`(data, **kwargs)	Call self as a function.
`getInputSchema`()	Return the schema an `AnalysisAction` expects to be present in the arguments supplied to the __call__ method.

Attributes Documentation

col1#: Column to subtract from (str)

col2#: Column to subtract (str)

fluxUnits1#: Units for col1 (str, default 'nanojansky')

fluxUnits2#: Units for col2 (str, default 'nanojansky')

returnMillimags#: Use millimags or not? (bool, default True)

Methods Documentation

__call__(data: MutableMapping[str, ndarray[tuple[Any, ...], dtype[_ScalarT]] | Scalar | HealSparseMap | Tensor | Mapping], **kwargs) → ndarray[tuple[Any, ...], dtype[_ScalarT]]#: Call self as a function.

getInputSchema() → Iterable[tuple[str, type[ndarray[tuple[Any, ...], dtype[_ScalarT]]] | type[Scalar] | type[HealSparseMap] | type[Tensor] | type[Mapping]]]#

Return the schema an AnalysisAction expects to be present in the arguments supplied to the __call__ method.

Returns#

resultKeyedDataSchema: The schema this action requires to be present when calling this action, keys are unformatted.