SnSelector

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

Bases: SelectorBase

Selects points that have S/N > threshold in the given flux type.

Attributes Summary

bands	The bands to apply the signal to noise cut in.Takes precedence if bands passed to call (List, default [])
fluxType	Flux type to calculate the S/N in.
maxSN	Maximum S/N to include in the sample (to allow S/N ranges).
plotLabelKey	Key to use when populating plot info, ignored if empty string (str, default '')
threshold	The S/N threshold to remove sources with.
uncertaintySuffix	Suffix to add to fluxType to specify uncertainty column (str, default 'Err')

Methods Summary

__call__(data, **kwargs)	Makes a mask of objects that have S/N greater than self.threshold in self.fluxType
getInputSchema()	Return the schema an AnalysisAction expects to be present in the arguments supplied to the __call__ method.

Attributes Documentation

bands

The bands to apply the signal to noise cut in.Takes precedence if bands passed to call (List, default [])

fluxType

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

maxSN

Maximum S/N to include in the sample (to allow S/N ranges). (float, default 1000000.0)

plotLabelKey

Key to use when populating plot info, ignored if empty string (str, default '')

threshold

The S/N threshold to remove sources with. (float, default 500.0)

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 | Tensor], **kwargs) → ndarray[Any, dtype[ScalarType]]

Makes a mask of objects that have S/N greater than self.threshold in self.fluxType

Parameters:

dataKeyedData

The data to perform the selection on.

Returns:

resultVector

A mask of the objects that satisfy the given S/N cut.

getInputSchema() → Tensor]]]

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.