polarcbo.noise.noise_model

class polarcbo.noise.noise_model

Bases: ABC

Abstract noise model class

abstract __call__(m_diff)

Call method for classes that inherit from noise_model

Parameters:

m_diff (array_like, shape (J, d)) – For a system of \(J\) particles, the i-th row of this array m_diff[i,:] represents the vector \(x_i - \mathsf{m}(x_i)\) where \(x\in\R^d\) denotes the position of the i-th particle and \(\mathsf{m}(x_i)\) its weighted mean.

Returns:

n – The random vector that is computed by the repspective noise model.

Return type:

array_like, shape (J,d)