Sn

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

Bases: VectorAction

Compute signal-to-noise in the given flux type

Attributes Summary

band	Band to calculate the S/N in.
fluxType	Flux type to calculate the S/N in.
uncertaintySuffix	Suffix to add to fluxType to specify uncertainty column (str, default 'Err')

Methods Summary

__call__(data, **kwargs)	Computes S/N in self.fluxType
getInputSchema()	Return the schema an AnalysisAction expects to be present in the arguments supplied to the __call__ method.

Attributes Documentation

band

Band to calculate the S/N in. (str, default 'i')

fluxType

Flux type to calculate the S/N in. (str, default '{band}_psfFlux')

uncertaintySuffix

Suffix to add to fluxType to specify uncertainty column (str, default 'Err')

Methods Documentation

__call__(data: MutableMapping[str, ndarray[Any, dtype[ScalarType]] | Scalar | HealSparseMap], **kwargs) → ndarray[Any, dtype[ScalarType]]

Computes S/N in self.fluxType

Parameters:

dfTabular

Returns:

resultVector

Computed signal-to-noise ratio.

getInputSchema() → HealSparseMap]]]

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.