WaveletBuffer
wavelet_buffer.WaveletBuffer
¶
Universal buffer for the wavelet decomposition
parameters: WaveletParameters
property
¶
Returns:
| Type | Description |
|---|---|
WaveletParameters
|
current wavelet parameters |
__init__(signal_shape, signal_number, decomposition_steps, wavelet_type, decompositions=None)
¶
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
signal_shape |
List[int]
|
for 1D signal with size N [N], for 2DN signal with size MXN, [M,N] |
required |
signal_number |
int
|
N for 2DN signal, e.g. RGB image would be 3 signals |
required |
decomposition_steps |
int
|
number of decomposition steps |
required |
wavelet_type |
WaveletType
|
type WaveletType.NONE, DB{1..5}, if it is NONE no wavelet composition |
required |
decompositions |
you can create a buffer with initialized subbands |
None
|
compose(scale_factor=0)
¶
Compose signal from subbands with given scale factor
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
scale_factor |
int
|
who many steps of wavelet decomposition should be re-compose |
0
|
Returns:
| Type | Description |
|---|---|
np.ndarray[np.float32]
|
restored signals |
decompose(data, denoiser)
¶
Decompose signal with wavelet decomposition The signal should have a shape which was set in the constructor of the buffer
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data |
np.ndarray[np.float32]
|
signal to decompose |
required |
denoiser |
BaseDenoiser
|
denoiser algorithm |
required |
Returns:
| Type | Description |
|---|---|
None
|
RuntimeError if input data isn't valid |
decomposition_size(signal_shape, decomposition_steps, **_kwargs)
staticmethod
¶
Estimate number of subbands for specific parameters
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
signal_shape |
List[int]
|
for 1D signal with size N [N], for 2DN signal with size MXN, [M,N] |
required |
decomposition_steps |
int
|
number of decomposition steps |
required |
Returns:
| Type | Description |
|---|---|
int
|
number of subbands for each signal |
parse(blob)
staticmethod
¶
Restore serialized buffer from string
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
blob |
bytes
|
serialized buffer |
required |
Returns:
| Type | Description |
|---|---|
WaveletBuffer
|
restored wavelet buffer |
serialize(compression_level=0)
¶
Serialize and compress buffer to binary string
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
compression_level |
int
|
0- no compression, 31 max compression (2-bits for each value) |
0
|
Returns:
| Type | Description |
|---|---|
bytes
|
serialized and compressed buffer |