check_max_components

menpofit.checks.check_max_components(max_components, n_scales, var_name)

Checks the maximum number of components per scale. It must be None or int or float or a list of those containing 1 or {n_scales} elements.

Parameters

• max_components (None or int or float or a list of those) – The value to check.

• n_scales (int) – The number of scales.

• var_name (str) – The name of the variable.

Returns

max_components (list of None or int or float) – The list of max components per scale.

Raises

ValueError – {var_name} must be None or an int > 0 or a 0 <= float <= 1 or a list of those containing 1 or {n_scales} elements