calix.common.boundary_check.BoundaryCheckResult

class calix.common.boundary_check.BoundaryCheckResult(parameters: numpy.ndarray, error_mask: numpy.ndarray, messages: List[str])

Bases: object

Result object for boundary checks. Contains:

• Parameters clipped to a desired parameter range.

• Boolean mask of parameters which initially exceeded the desired

parameter range. Values of True indicate reaching the boundaries. * List of strings containing error messages. May be empty, as messages are only returned if errors are given.

__init__(parameters: numpy.ndarray, error_mask: numpy.ndarray, messages: List[str]) → None

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(parameters, error_mask, messages)

Initialize self.

error_mask: numpy.ndarray

messages: List[str]

parameters: numpy.ndarray