FracInRange

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

Bases: ScalarFromVectorAction

Compute the fraction of a distribution that is between specified minimum and maximum values, and is not NaN.

Attributes Summary

maximum

The maximum value (float, default 1.7976931348623157e+308)

minimum

The minimum value (float, default -1.7976931348623157e+308)

percent

Express result as percentage (bool, default False)

vectorKey

Key of Vector to compute statistic from.

Methods Summary

__call__(data, **kwargs)

Compute a scalar value from keyed data.

Attributes Documentation

maximum

The maximum value (float, default 1.7976931348623157e+308)

minimum

The minimum value (float, default -1.7976931348623157e+308)

percent

Express result as percentage (bool, default False)

vectorKey

Key of Vector to compute statistic from. (str)

Methods Documentation

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

Compute a scalar value from keyed data.

Parameters:
data

Keyed data to compute a value from.

kwargs

Additional keyword arguments.

Returns:
A scalar value.