Noise

BufferedAlphaNoise

Create a buffer of alpha noise generator. Alpha can be in [0, 2].

Source code in cmtj/noise/__init__.pyi

class BufferedAlphaNoise:
    """Create a buffer of alpha noise generator. Alpha can be in [0, 2]."""

    def __init__(self, bufferSize: int, alpha: float, std: float, scale: float) -> None: ...
    def fillBuffer(self) -> None:
        """Fill the buffer with the noise. This method is called only once."""
        ...

    def tick(self) -> float:
        """Produce the next sample of the noise."""
        ...

fillBuffer()

Fill the buffer with the noise. This method is called only once.

Source code in cmtj/noise/__init__.pyi

def fillBuffer(self) -> None:
    """Fill the buffer with the noise. This method is called only once."""
    ...

tick()

Produce the next sample of the noise.

Source code in cmtj/noise/__init__.pyi

def tick(self) -> float:
    """Produce the next sample of the noise."""
    ...

VectorAlphaNoise

Create a vector alpha noise generator. Alpha can be in [0, 2].

Source code in cmtj/noise/__init__.pyi

class VectorAlphaNoise:
    """Create a vector alpha noise generator. Alpha can be in [0, 2]."""

    def __init__(
        self,
        bufferSize: int,
        alpha: float,
        std: float,
        scale: float,
        axis: cmtj.Axis = cmtj.Axis.all,
    ) -> None:
        """Kasdin algorithm for vector alpha noise generation.

        :param bufferSize: Buffer size
        :param alpha: Alpha parameter
        :param std: Standard deviation
        :param scale: Scale
        :param axis: Axis, by default all axes are used
        """
        ...

    def getPrevSample(self) -> cmtj.CVector:
        """Get the previous sample of the noise in a vector form."""
        ...

    def getScale(self) -> float:
        """Get the scale of the noise."""
        ...

    def tick(self) -> float: ...
    def tickVector(self) -> cmtj.CVector:
        """Get the next sample of the noise in a vector form."""
        ...

__init__(bufferSize, alpha, std, scale, axis=cmtj.Axis.all)

Kasdin algorithm for vector alpha noise generation.

Parameters:

Name	Type	Description	Default
bufferSize	int	Buffer size	required
alpha	float	Alpha parameter	required
std	float	Standard deviation	required
scale	float	Scale	required
axis	cmtj.Axis	Axis, by default all axes are used	cmtj.Axis.all

Source code in cmtj/noise/__init__.pyi

def __init__(
    self,
    bufferSize: int,
    alpha: float,
    std: float,
    scale: float,
    axis: cmtj.Axis = cmtj.Axis.all,
) -> None:
    """Kasdin algorithm for vector alpha noise generation.

    :param bufferSize: Buffer size
    :param alpha: Alpha parameter
    :param std: Standard deviation
    :param scale: Scale
    :param axis: Axis, by default all axes are used
    """
    ...

getPrevSample()

Get the previous sample of the noise in a vector form.

Source code in cmtj/noise/__init__.pyi

def getPrevSample(self) -> cmtj.CVector:
    """Get the previous sample of the noise in a vector form."""
    ...

getScale()

Get the scale of the noise.

Source code in cmtj/noise/__init__.pyi

def getScale(self) -> float:
    """Get the scale of the noise."""
    ...

tickVector()

Get the next sample of the noise in a vector form.

Source code in cmtj/noise/__init__.pyi

def tickVector(self) -> cmtj.CVector:
    """Get the next sample of the noise in a vector form."""
    ...