CalcCompletenessHistogramAction¶

class lsst.analysis.tools.actions.keyedData.CalcCompletenessHistogramAction(*args, **kw)¶

Bases: KeyedDataAction

Action to calculate a histogram of completeness vs magnitude.

Attributes Summary

`action`	The action to compute completeness/purity (`CalcBinnedCompletenessAction`, default `<class 'lsst.analysis.tools.actions.keyedData.calcBinnedCompleteness.CalcBinnedCompletenessAction'>`)
`bins`	The magnitude bin configuration (`MagnitudeBinConfig`, default `<class 'lsst.analysis.tools.actions.config.binning.MagnitudeBinConfig'>`)
`config_metrics`	Metric definition configuration (`MagnitudeCompletenessConfig`, default `<class 'lsst.analysis.tools.actions.keyedData.calcCompletenessHistogram.MagnitudeCompletenessConfig'>`)

Methods Summary

`__call__`(data, **kwargs)	Call self as a function.
`getInputSchema`()	Return the schema an `AnalysisAction` expects to be present in the arguments supplied to the __call__ method.
`getOutputSchema`()	Return the schema an `AnalysisAction` will produce, if the `__call__` method returns `KeyedData`, otherwise this may return None.
`getPercentileName`(percentile)

Attributes Documentation

action¶: The action to compute completeness/purity (CalcBinnedCompletenessAction, default <class 'lsst.analysis.tools.actions.keyedData.calcBinnedCompleteness.CalcBinnedCompletenessAction'>)

bins¶: The magnitude bin configuration (MagnitudeBinConfig, default <class 'lsst.analysis.tools.actions.config.binning.MagnitudeBinConfig'>)

config_metrics¶: Metric definition configuration (MagnitudeCompletenessConfig, default <class 'lsst.analysis.tools.actions.keyedData.calcCompletenessHistogram.MagnitudeCompletenessConfig'>)

Methods Documentation

__call__(data: MutableMapping[str, ndarray[Any, dtype[_ScalarType_co]] | Scalar | HealSparseMap | Tensor | Mapping], **kwargs) → MutableMapping[str, ndarray[Any, dtype[_ScalarType_co]] | Scalar | HealSparseMap | Tensor | Mapping]¶: Call self as a function.

getInputSchema() → 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.

getOutputSchema() → Mapping]]]¶

Return the schema an AnalysisAction will produce, if the __call__ method returns KeyedData, otherwise this may return None.

Returns:

resultKeyedDataSchema or None: The schema this action will produce when returning from call. This will be unformatted if any templates are present. Should return None if action does not return KeyedData.