IqrHistAction

class lsst.analysis.tools.actions.scalar.IqrHistAction(*args, **kw)

Bases: ScalarAction

Calculates the interquartile range of the given histogram data.

Attributes Summary

histKey	Key of frequency Vector (str)
midKey	Key of bin midpoints Vector (str)

Methods Summary

__call__(data, **kwargs)	Compute a scalar value from keyed data.
getInputSchema()	Return the schema an AnalysisAction expects to be present in the arguments supplied to the __call__ method.
histIqr(hist, bin_mid)	Calculates the interquartile range of a histogram with binned values

Attributes Documentation

histKey

Key of frequency Vector (str)

midKey

Key of bin midpoints Vector (str)

Methods Documentation

__call__(data: MutableMapping[str, ndarray[tuple[Any, ...], dtype[_ScalarT]] | Scalar | HealSparseMap | Tensor | Mapping], **kwargs)

Compute a scalar value from keyed data.

Parameters

data

Keyed data to compute a value from.

kwargs

Additional keyword arguments.

Returns

A scalar value.

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.

histIqr(hist, bin_mid)

Calculates the interquartile range of a histogram with binned values

Parameters

histnumpy.ndarray

Frequency array

bin_midnumpy.ndarray

Bin midpoints array

Returns

iqrfloat

Inter-quartile range of histogram with binned values