FracInRange

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

Bases: ScalarAction

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

Name of column (str)

Methods Summary

__call__(data, **kwargs)

Return the fraction of rows with values within the specified range.

getInputSchema()

Return the schema an AnalysisAction expects to be present in the arguments supplied to the __call__ method.

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

Name of column (str)

Methods Documentation

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

Return the fraction of rows with values within the specified range.

Parameters:
dataKeyedData
Returns:
resultScalar

The fraction (or percentage) of rows with values within the specified range.

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.