mapping:fft
Version: 0.0.0
Description
Computes the Fast Fourier Transform on each component of input Field or each field of input Fields Container (you can use transpose_fields_container to have relevant scoping). Fields are assumed with the same scoping, number of components and representing equally spaced data, ideally resampled to have a 2^n points (prepare_sampling_fft with time_freq_interpolation can help creating these fields). If Complex label is present, Complex to Complex FFT performed otherwise Real to Complex is performed (only half of the coefficient will be returned).
Inputs
| Input | Name | Expected type(s) | Description |
|---|---|---|---|
| Pin 0 Required | field | field, fields_container | Field or Fields Container. |
| Pin 3 | scale_forward_transform | double | Scale for Forward Transform, default is 2/field_num_elementary_data. |
| Pin 4 | inplace | bool | True if inplace, default is false. |
| Pin 5 | force_fft_points | int32 | Explicitely define number of fft points to either rescope or perform zero padding. |
| Pin 6 | cutoff_frequency | double | Restrict output frequency up to this cutoff frequency |
| Pin 7 | scale_right_amplitude | bool | If set to true (default is false), 2/field_num_entities scaling will be applied, to have right amplitude values. |
Outputs
| Output | Name | Expected type(s) | Description |
|---|---|---|---|
| Pin 0 | fields_container | fields_container | Output Complex Fields Container with labels matching input Fields Container. No supports binded, but prepare_sampling_fft provides it. |
Configurations
| Name | Expected type(s) | Default value | Description |
|---|---|---|---|
| mutex | bool | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. |
Scripting
Category: mapping
Plugin: core
Scripting name: fft
Full name: mapping.fft
Internal name: fft
License: None
Changelog
- Version 0.0.0: Initial release.