IqrHistAction¶
- class lsst.analysis.tools.actions.scalar.IqrHistAction(*args, **kw)¶
Bases:
ScalarAction
Calculates the interquartile range of the given histogram data.
Attributes Summary
Key of frequency Vector (
str
)Key of bin midpoints Vector (
str
)Methods Summary
__call__
(data, **kwargs)Compute a scalar value from keyed data.
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
Methods Documentation
- __call__(data: MutableMapping[str, ndarray[Any, dtype[ScalarType]] | Scalar | HealSparseMap | Tensor], **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() Tensor]]] ¶
Return the schema an
AnalysisAction
expects to be present in the arguments supplied to the __call__ method.- Returns:
- result
KeyedDataSchema
The schema this action requires to be present when calling this action, keys are unformatted.
- result
- histIqr(hist, bin_mid)¶
Calculates the interquartile range of a histogram with binned values
- Parameters:
- hist
numpy.ndarray
Frequency array
- bin_mid
numpy.ndarray
Bin midpoints array
- hist
- Returns:
- iqr
float
Inter-quartile range of histogram with binned values
- iqr