Gaussian.wrap.md

Gaussian.wrap (function)

def wrap(self, value, wrap_at=None)

Wrap values via modulo:

value % wrap_at

See also:

• Gaussian.wrap_at
• Gaussian.get_wrap_at

Arguments

• value (float or array): values to wrap
• wrap_at (float, optional, default=None): value to use for the upper-limit. If not provided or None, will use Gaussian.wrap_at. If False, will return value unwrapped.

Returns

• (float or array): same shape/type as input value.