ExtinctionCorrectedMagDiff

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

Bases: VectorAction

Compute the difference between two magnitudes and correct for extinction By default bands are derived from the <band>_ prefix on flux columns, per the naming convention in the Object Table: e.g. the band of ‘g_psfFlux’ is ‘g’. If column names follow another convention, bands can alternatively be supplied via the band1 or band2 config parameters. If band1 and band2 are supplied, the flux column names are ignored.

Attributes Summary

band1	Optional band for magDiff.col1.
band2	Optional band for magDiff.col2.
ebvCol	E(B-V) Column Name (str, default 'ebv')
extinctionCoeffs	Dictionary of extinction coefficients for conversion from E(B-V) to extinction, A_band.Key must be the band (Dict, default None)
magDiff	Action that returns a difference in magnitudes (VectorAction, default <class 'lsst.analysis.tools.actions.vector.vectorActions.MagDiff'>)

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

band1

Optional band for magDiff.col1. Supercedes column name prefix (str, default None)

band2

Optional band for magDiff.col2. Supercedes column name prefix (str, default None)

ebvCol

E(B-V) Column Name (str, default 'ebv')

extinctionCoeffs

Dictionary of extinction coefficients for conversion from E(B-V) to extinction, A_band.Key must be the band (Dict, default None)

magDiff

Action that returns a difference in magnitudes (VectorAction, default <class 'lsst.analysis.tools.actions.vector.vectorActions.MagDiff'>)

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.