mapping:prep sampling fft

Version: 0.0.0

Description

Prepare time sampling optimum for FFT computation and expected frequencies in output.

Inputs

This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. Some inputs are required, while others are optional and provide additional configuration. Each parameter is detailed in the sections that follow the table.

time_freq_support (Pin 0)

• Required: Yes
• Expected type(s): time_freq_support

Initial time domain TimeFreqSupport.

cutoff_frequency (Pin 1)

• Required: No
• Expected type(s): double

Cutoff Frequency. In this case, number of points is calculated computing (time_range * cutoff_freq * 2) and taking the next power of 2 (optimum for fft calculation).

number_sampling_point (Pin 2)

• Required: No
• Expected type(s): int32

For number of sampling point (calculation with cutoff_frequency is ignored).

Outputs

This table lists the output pins for this operator. Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. Each output is detailed in the sections that follow the table.

time_tfs_sampled (Pin 0)

• Expected type(s): time_freq_support

Optimum sampled time domain TimeFreqSupport.

freq_tfs_fft (Pin 1)

• Expected type(s): time_freq_support

Frequency domain TimeFreqSupport expected in output of FFT.

Configurations

This operator supports configuration options that modify its behavior.

mutex

• Expected type(s): bool
• Default value: false

If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads.

Scripting

This operator can be accessed through scripting interfaces using these identifiers.

Category: mapping

Plugin: core

Scripting name: prep_sampling_fft

Full name: mapping.prep_sampling_fft

Internal name: prepare_sampling_fft

License: None

Examples

These examples demonstrate how to use this operator in different programming environments. Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output.

#include "dpf_api.h"

ansys::dpf::Operator op("prepare_sampling_fft"); // operator instantiation
op.connect(0, my_time_freq_support);
op.connect(1, my_cutoff_frequency);
op.connect(2, my_number_sampling_point);
ansys::dpf::TimeFreqSupport my_time_tfs_sampled = op.getOutput<ansys::dpf::TimeFreqSupport>(0);
ansys::dpf::TimeFreqSupport my_freq_tfs_fft = op.getOutput<ansys::dpf::TimeFreqSupport>(1);

import ansys.dpf.core as dpf

op = dpf.operators.mapping.prep_sampling_fft() # operator instantiation
op.inputs.time_freq_support.connect(my_time_freq_support)
op.inputs.cutoff_frequency.connect(my_cutoff_frequency)
op.inputs.number_sampling_point.connect(my_number_sampling_point)
my_time_tfs_sampled = op.outputs.time_tfs_sampled()
my_freq_tfs_fft = op.outputs.freq_tfs_fft()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.mapping.prep_sampling_fft() # operator instantiation
op.inputs.time_freq_support.Connect(my_time_freq_support)
op.inputs.cutoff_frequency.Connect(my_cutoff_frequency)
op.inputs.number_sampling_point.Connect(my_number_sampling_point)
my_time_tfs_sampled = op.outputs.time_tfs_sampled.GetData()
my_freq_tfs_fft = op.outputs.freq_tfs_fft.GetData()

Changelog

• Version 0.0.0: Initial release.