# {py:mod}`simvx.core.noise`

```{py:module} simvx.core.noise
```

```{autodoc2-docstring} simvx.core.noise
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`NoiseType <simvx.core.noise.NoiseType>`
  - ```{autodoc2-docstring} simvx.core.noise.NoiseType
    :summary:
    ```
* - {py:obj}`FractalType <simvx.core.noise.FractalType>`
  - ```{autodoc2-docstring} simvx.core.noise.FractalType
    :summary:
    ```
* - {py:obj}`FastNoiseLite <simvx.core.noise.FastNoiseLite>`
  - ```{autodoc2-docstring} simvx.core.noise.FastNoiseLite
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`__all__ <simvx.core.noise.__all__>`
  - ```{autodoc2-docstring} simvx.core.noise.__all__
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: simvx.core.noise.__all__
:value: >
   ['FastNoiseLite', 'NoiseType', 'FractalType']

```{autodoc2-docstring} simvx.core.noise.__all__
```

````

`````{py:class} NoiseType()
:canonical: simvx.core.noise.NoiseType

Bases: {py:obj}`enum.IntEnum`

```{autodoc2-docstring} simvx.core.noise.NoiseType
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.noise.NoiseType.__init__
```

````{py:attribute} PERLIN
:canonical: simvx.core.noise.NoiseType.PERLIN
:value: >
   0

```{autodoc2-docstring} simvx.core.noise.NoiseType.PERLIN
```

````

````{py:attribute} SIMPLEX
:canonical: simvx.core.noise.NoiseType.SIMPLEX
:value: >
   1

```{autodoc2-docstring} simvx.core.noise.NoiseType.SIMPLEX
```

````

````{py:attribute} VALUE
:canonical: simvx.core.noise.NoiseType.VALUE
:value: >
   2

```{autodoc2-docstring} simvx.core.noise.NoiseType.VALUE
```

````

````{py:attribute} CELLULAR
:canonical: simvx.core.noise.NoiseType.CELLULAR
:value: >
   3

```{autodoc2-docstring} simvx.core.noise.NoiseType.CELLULAR
```

````

````{py:method} __abs__()
:canonical: simvx.core.noise.NoiseType.__abs__

````

````{py:method} __add__()
:canonical: simvx.core.noise.NoiseType.__add__

````

````{py:method} __and__()
:canonical: simvx.core.noise.NoiseType.__and__

````

````{py:method} __bool__()
:canonical: simvx.core.noise.NoiseType.__bool__

````

````{py:method} __ceil__()
:canonical: simvx.core.noise.NoiseType.__ceil__

````

````{py:method} __delattr__()
:canonical: simvx.core.noise.NoiseType.__delattr__

````

````{py:method} __dir__()
:canonical: simvx.core.noise.NoiseType.__dir__

````

````{py:method} __divmod__()
:canonical: simvx.core.noise.NoiseType.__divmod__

````

````{py:method} __eq__()
:canonical: simvx.core.noise.NoiseType.__eq__

````

````{py:method} __float__()
:canonical: simvx.core.noise.NoiseType.__float__

````

````{py:method} __floor__()
:canonical: simvx.core.noise.NoiseType.__floor__

````

````{py:method} __floordiv__()
:canonical: simvx.core.noise.NoiseType.__floordiv__

````

````{py:method} __format__()
:canonical: simvx.core.noise.NoiseType.__format__

````

````{py:method} __ge__()
:canonical: simvx.core.noise.NoiseType.__ge__

````

````{py:method} __getattribute__()
:canonical: simvx.core.noise.NoiseType.__getattribute__

````

````{py:method} __getnewargs__()
:canonical: simvx.core.noise.NoiseType.__getnewargs__

````

````{py:method} __getstate__()
:canonical: simvx.core.noise.NoiseType.__getstate__

````

````{py:method} __gt__()
:canonical: simvx.core.noise.NoiseType.__gt__

````

````{py:method} __hash__()
:canonical: simvx.core.noise.NoiseType.__hash__

````

````{py:method} __index__()
:canonical: simvx.core.noise.NoiseType.__index__

````

````{py:method} __int__()
:canonical: simvx.core.noise.NoiseType.__int__

````

````{py:method} __invert__()
:canonical: simvx.core.noise.NoiseType.__invert__

````

````{py:method} __le__()
:canonical: simvx.core.noise.NoiseType.__le__

````

````{py:method} __lshift__()
:canonical: simvx.core.noise.NoiseType.__lshift__

````

````{py:method} __lt__()
:canonical: simvx.core.noise.NoiseType.__lt__

````

````{py:method} __mod__()
:canonical: simvx.core.noise.NoiseType.__mod__

````

````{py:method} __mul__()
:canonical: simvx.core.noise.NoiseType.__mul__

````

````{py:method} __ne__()
:canonical: simvx.core.noise.NoiseType.__ne__

````

````{py:method} __neg__()
:canonical: simvx.core.noise.NoiseType.__neg__

````

````{py:method} __new__()
:canonical: simvx.core.noise.NoiseType.__new__

````

````{py:method} __or__()
:canonical: simvx.core.noise.NoiseType.__or__

````

````{py:method} __pos__()
:canonical: simvx.core.noise.NoiseType.__pos__

````

````{py:method} __pow__()
:canonical: simvx.core.noise.NoiseType.__pow__

````

````{py:method} __radd__()
:canonical: simvx.core.noise.NoiseType.__radd__

````

````{py:method} __rand__()
:canonical: simvx.core.noise.NoiseType.__rand__

````

````{py:method} __rdivmod__()
:canonical: simvx.core.noise.NoiseType.__rdivmod__

````

````{py:method} __reduce__()
:canonical: simvx.core.noise.NoiseType.__reduce__

````

````{py:method} __reduce_ex__()
:canonical: simvx.core.noise.NoiseType.__reduce_ex__

````

````{py:method} __repr__()
:canonical: simvx.core.noise.NoiseType.__repr__

````

````{py:method} __rfloordiv__()
:canonical: simvx.core.noise.NoiseType.__rfloordiv__

````

````{py:method} __rlshift__()
:canonical: simvx.core.noise.NoiseType.__rlshift__

````

````{py:method} __rmod__()
:canonical: simvx.core.noise.NoiseType.__rmod__

````

````{py:method} __rmul__()
:canonical: simvx.core.noise.NoiseType.__rmul__

````

````{py:method} __ror__()
:canonical: simvx.core.noise.NoiseType.__ror__

````

````{py:method} __round__()
:canonical: simvx.core.noise.NoiseType.__round__

````

````{py:method} __rpow__()
:canonical: simvx.core.noise.NoiseType.__rpow__

````

````{py:method} __rrshift__()
:canonical: simvx.core.noise.NoiseType.__rrshift__

````

````{py:method} __rshift__()
:canonical: simvx.core.noise.NoiseType.__rshift__

````

````{py:method} __rsub__()
:canonical: simvx.core.noise.NoiseType.__rsub__

````

````{py:method} __rtruediv__()
:canonical: simvx.core.noise.NoiseType.__rtruediv__

````

````{py:method} __rxor__()
:canonical: simvx.core.noise.NoiseType.__rxor__

````

````{py:method} __setattr__()
:canonical: simvx.core.noise.NoiseType.__setattr__

````

````{py:method} __sizeof__()
:canonical: simvx.core.noise.NoiseType.__sizeof__

````

````{py:method} __str__()
:canonical: simvx.core.noise.NoiseType.__str__

````

````{py:method} __sub__()
:canonical: simvx.core.noise.NoiseType.__sub__

````

````{py:method} __subclasshook__()
:canonical: simvx.core.noise.NoiseType.__subclasshook__

````

````{py:method} __truediv__()
:canonical: simvx.core.noise.NoiseType.__truediv__

````

````{py:method} __trunc__()
:canonical: simvx.core.noise.NoiseType.__trunc__

````

````{py:method} __xor__()
:canonical: simvx.core.noise.NoiseType.__xor__

````

````{py:method} as_integer_ratio()
:canonical: simvx.core.noise.NoiseType.as_integer_ratio

````

````{py:method} bit_count()
:canonical: simvx.core.noise.NoiseType.bit_count

````

````{py:method} bit_length()
:canonical: simvx.core.noise.NoiseType.bit_length

````

````{py:method} conjugate()
:canonical: simvx.core.noise.NoiseType.conjugate

````

```{py:class} denominator
:canonical: simvx.core.noise.NoiseType.denominator

```

```{py:class} imag
:canonical: simvx.core.noise.NoiseType.imag

```

````{py:method} is_integer()
:canonical: simvx.core.noise.NoiseType.is_integer

````

```{py:class} numerator
:canonical: simvx.core.noise.NoiseType.numerator

```

```{py:class} real
:canonical: simvx.core.noise.NoiseType.real

```

````{py:method} to_bytes()
:canonical: simvx.core.noise.NoiseType.to_bytes

````

````{py:method} __deepcopy__(memo)
:canonical: simvx.core.noise.NoiseType.__deepcopy__

````

````{py:method} __copy__()
:canonical: simvx.core.noise.NoiseType.__copy__

````

````{py:method} name()
:canonical: simvx.core.noise.NoiseType.name

````

````{py:method} value()
:canonical: simvx.core.noise.NoiseType.value

````

`````

`````{py:class} FractalType()
:canonical: simvx.core.noise.FractalType

Bases: {py:obj}`enum.IntEnum`

```{autodoc2-docstring} simvx.core.noise.FractalType
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.noise.FractalType.__init__
```

````{py:attribute} NONE
:canonical: simvx.core.noise.FractalType.NONE
:value: >
   0

```{autodoc2-docstring} simvx.core.noise.FractalType.NONE
```

````

````{py:attribute} FBM
:canonical: simvx.core.noise.FractalType.FBM
:value: >
   1

```{autodoc2-docstring} simvx.core.noise.FractalType.FBM
```

````

````{py:attribute} RIDGED
:canonical: simvx.core.noise.FractalType.RIDGED
:value: >
   2

```{autodoc2-docstring} simvx.core.noise.FractalType.RIDGED
```

````

````{py:attribute} PING_PONG
:canonical: simvx.core.noise.FractalType.PING_PONG
:value: >
   3

```{autodoc2-docstring} simvx.core.noise.FractalType.PING_PONG
```

````

````{py:method} __abs__()
:canonical: simvx.core.noise.FractalType.__abs__

````

````{py:method} __add__()
:canonical: simvx.core.noise.FractalType.__add__

````

````{py:method} __and__()
:canonical: simvx.core.noise.FractalType.__and__

````

````{py:method} __bool__()
:canonical: simvx.core.noise.FractalType.__bool__

````

````{py:method} __ceil__()
:canonical: simvx.core.noise.FractalType.__ceil__

````

````{py:method} __delattr__()
:canonical: simvx.core.noise.FractalType.__delattr__

````

````{py:method} __dir__()
:canonical: simvx.core.noise.FractalType.__dir__

````

````{py:method} __divmod__()
:canonical: simvx.core.noise.FractalType.__divmod__

````

````{py:method} __eq__()
:canonical: simvx.core.noise.FractalType.__eq__

````

````{py:method} __float__()
:canonical: simvx.core.noise.FractalType.__float__

````

````{py:method} __floor__()
:canonical: simvx.core.noise.FractalType.__floor__

````

````{py:method} __floordiv__()
:canonical: simvx.core.noise.FractalType.__floordiv__

````

````{py:method} __format__()
:canonical: simvx.core.noise.FractalType.__format__

````

````{py:method} __ge__()
:canonical: simvx.core.noise.FractalType.__ge__

````

````{py:method} __getattribute__()
:canonical: simvx.core.noise.FractalType.__getattribute__

````

````{py:method} __getnewargs__()
:canonical: simvx.core.noise.FractalType.__getnewargs__

````

````{py:method} __getstate__()
:canonical: simvx.core.noise.FractalType.__getstate__

````

````{py:method} __gt__()
:canonical: simvx.core.noise.FractalType.__gt__

````

````{py:method} __hash__()
:canonical: simvx.core.noise.FractalType.__hash__

````

````{py:method} __index__()
:canonical: simvx.core.noise.FractalType.__index__

````

````{py:method} __int__()
:canonical: simvx.core.noise.FractalType.__int__

````

````{py:method} __invert__()
:canonical: simvx.core.noise.FractalType.__invert__

````

````{py:method} __le__()
:canonical: simvx.core.noise.FractalType.__le__

````

````{py:method} __lshift__()
:canonical: simvx.core.noise.FractalType.__lshift__

````

````{py:method} __lt__()
:canonical: simvx.core.noise.FractalType.__lt__

````

````{py:method} __mod__()
:canonical: simvx.core.noise.FractalType.__mod__

````

````{py:method} __mul__()
:canonical: simvx.core.noise.FractalType.__mul__

````

````{py:method} __ne__()
:canonical: simvx.core.noise.FractalType.__ne__

````

````{py:method} __neg__()
:canonical: simvx.core.noise.FractalType.__neg__

````

````{py:method} __new__()
:canonical: simvx.core.noise.FractalType.__new__

````

````{py:method} __or__()
:canonical: simvx.core.noise.FractalType.__or__

````

````{py:method} __pos__()
:canonical: simvx.core.noise.FractalType.__pos__

````

````{py:method} __pow__()
:canonical: simvx.core.noise.FractalType.__pow__

````

````{py:method} __radd__()
:canonical: simvx.core.noise.FractalType.__radd__

````

````{py:method} __rand__()
:canonical: simvx.core.noise.FractalType.__rand__

````

````{py:method} __rdivmod__()
:canonical: simvx.core.noise.FractalType.__rdivmod__

````

````{py:method} __reduce__()
:canonical: simvx.core.noise.FractalType.__reduce__

````

````{py:method} __reduce_ex__()
:canonical: simvx.core.noise.FractalType.__reduce_ex__

````

````{py:method} __repr__()
:canonical: simvx.core.noise.FractalType.__repr__

````

````{py:method} __rfloordiv__()
:canonical: simvx.core.noise.FractalType.__rfloordiv__

````

````{py:method} __rlshift__()
:canonical: simvx.core.noise.FractalType.__rlshift__

````

````{py:method} __rmod__()
:canonical: simvx.core.noise.FractalType.__rmod__

````

````{py:method} __rmul__()
:canonical: simvx.core.noise.FractalType.__rmul__

````

````{py:method} __ror__()
:canonical: simvx.core.noise.FractalType.__ror__

````

````{py:method} __round__()
:canonical: simvx.core.noise.FractalType.__round__

````

````{py:method} __rpow__()
:canonical: simvx.core.noise.FractalType.__rpow__

````

````{py:method} __rrshift__()
:canonical: simvx.core.noise.FractalType.__rrshift__

````

````{py:method} __rshift__()
:canonical: simvx.core.noise.FractalType.__rshift__

````

````{py:method} __rsub__()
:canonical: simvx.core.noise.FractalType.__rsub__

````

````{py:method} __rtruediv__()
:canonical: simvx.core.noise.FractalType.__rtruediv__

````

````{py:method} __rxor__()
:canonical: simvx.core.noise.FractalType.__rxor__

````

````{py:method} __setattr__()
:canonical: simvx.core.noise.FractalType.__setattr__

````

````{py:method} __sizeof__()
:canonical: simvx.core.noise.FractalType.__sizeof__

````

````{py:method} __str__()
:canonical: simvx.core.noise.FractalType.__str__

````

````{py:method} __sub__()
:canonical: simvx.core.noise.FractalType.__sub__

````

````{py:method} __subclasshook__()
:canonical: simvx.core.noise.FractalType.__subclasshook__

````

````{py:method} __truediv__()
:canonical: simvx.core.noise.FractalType.__truediv__

````

````{py:method} __trunc__()
:canonical: simvx.core.noise.FractalType.__trunc__

````

````{py:method} __xor__()
:canonical: simvx.core.noise.FractalType.__xor__

````

````{py:method} as_integer_ratio()
:canonical: simvx.core.noise.FractalType.as_integer_ratio

````

````{py:method} bit_count()
:canonical: simvx.core.noise.FractalType.bit_count

````

````{py:method} bit_length()
:canonical: simvx.core.noise.FractalType.bit_length

````

````{py:method} conjugate()
:canonical: simvx.core.noise.FractalType.conjugate

````

```{py:class} denominator
:canonical: simvx.core.noise.FractalType.denominator

```

```{py:class} imag
:canonical: simvx.core.noise.FractalType.imag

```

````{py:method} is_integer()
:canonical: simvx.core.noise.FractalType.is_integer

````

```{py:class} numerator
:canonical: simvx.core.noise.FractalType.numerator

```

```{py:class} real
:canonical: simvx.core.noise.FractalType.real

```

````{py:method} to_bytes()
:canonical: simvx.core.noise.FractalType.to_bytes

````

````{py:method} __deepcopy__(memo)
:canonical: simvx.core.noise.FractalType.__deepcopy__

````

````{py:method} __copy__()
:canonical: simvx.core.noise.FractalType.__copy__

````

````{py:method} name()
:canonical: simvx.core.noise.FractalType.name

````

````{py:method} value()
:canonical: simvx.core.noise.FractalType.value

````

`````

`````{py:class} FastNoiseLite(seed: int = 0, noise_type: simvx.core.noise.NoiseType = NoiseType.PERLIN, frequency: float = 0.01)
:canonical: simvx.core.noise.FastNoiseLite

```{autodoc2-docstring} simvx.core.noise.FastNoiseLite
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.noise.FastNoiseLite.__init__
```

````{py:property} seed
:canonical: simvx.core.noise.FastNoiseLite.seed
:type: int

```{autodoc2-docstring} simvx.core.noise.FastNoiseLite.seed
```

````

````{py:method} get_noise_2d(x: float, y: float) -> float
:canonical: simvx.core.noise.FastNoiseLite.get_noise_2d

```{autodoc2-docstring} simvx.core.noise.FastNoiseLite.get_noise_2d
```

````

````{py:method} get_noise_3d(x: float, y: float, z: float) -> float
:canonical: simvx.core.noise.FastNoiseLite.get_noise_3d

```{autodoc2-docstring} simvx.core.noise.FastNoiseLite.get_noise_3d
```

````

````{py:method} get_noise_2d_array(xs: numpy.ndarray, ys: numpy.ndarray) -> numpy.ndarray
:canonical: simvx.core.noise.FastNoiseLite.get_noise_2d_array

```{autodoc2-docstring} simvx.core.noise.FastNoiseLite.get_noise_2d_array
```

````

````{py:method} get_noise_3d_array(xs: numpy.ndarray, ys: numpy.ndarray, zs: numpy.ndarray) -> numpy.ndarray
:canonical: simvx.core.noise.FastNoiseLite.get_noise_3d_array

```{autodoc2-docstring} simvx.core.noise.FastNoiseLite.get_noise_3d_array
```

````

````{py:method} get_image(width: int, height: int, scale: float = 1.0) -> numpy.ndarray
:canonical: simvx.core.noise.FastNoiseLite.get_image

```{autodoc2-docstring} simvx.core.noise.FastNoiseLite.get_image
```

````

`````