math:time freq interpolation
Last update: 31.07.2026Version: 0.0.0
Description
Interpolates between all the matching fields of a fields container at given times or frequencies, using ramped: fieldOut = field1*(1.-fact)+field2*(fact), or stepped: fieldOut=field2. If the time freq is higher than the max available, the field at the max time freq is taken. Computes the output time freq support to support the fields container
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.
| Pin number | Name | Status | Expected type(s) |
|---|---|---|---|
| 0 | fields_container | Required | fields_container |
| 1 | time_freq_values | Required | double, vector<double>, field |
| 2 | step | int32 |
|
| 3 | interpolation_type | int32 |
|
| 4 | force_new_time_freq_support | bool |
|
| 8 | time_freq_support | time_freq_support |
fields_container (Pin 0)
- Required: Yes
- Expected type(s):
fields_container
time_freq_values (Pin 1)
- Required: Yes
- Expected type(s):
double,vector<double>,field
list of frequencies or times needed. To specify load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps".
step (Pin 2)
- Required: No
- Expected type(s):
int32
if a Field is set as input, the step ids should be its scoping.
interpolation_type (Pin 3)
- Required: No
- Expected type(s):
int32
1 is ramped, 2 is stepped, default is 1.
force_new_time_freq_support (Pin 4)
- Required: No
- Expected type(s):
bool
If set to true, the output fields container will always have a new time freq support rescoped to the output time_freq_values (default is false). If set to false, the time freq support is only recreated when time or frequency values are between existing ones.
time_freq_support (Pin 8)
- Required: No
- Expected type(s):
time_freq_support
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.
| Pin number | Name | Expected type(s) |
|---|---|---|
| 0 | fields_container | fields_container |
fields_container (Pin 0)
- Expected type(s):
fields_container
FieldsContainer with interpolated fields at specified time/frequency values
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.
permissive
- Expected type(s):
bool - Default value: false
If this option is set to true, warning checks (like unit or data sizes) won't be done.
Scripting
This operator can be accessed through scripting interfaces using these identifiers.
Category: math
Plugin: core
Scripting name: None
Full name: None
Internal name: time_freq_interpolation
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.
C++
#include "dpf_api.h"
ansys::dpf::Operator op("time_freq_interpolation"); // operator instantiation
op.connect(0, my_fields_container);
op.connect(1, my_time_freq_values);
op.connect(2, my_step);
op.connect(3, my_interpolation_type);
op.connect(4, my_force_new_time_freq_support);
op.connect(8, my_time_freq_support);
ansys::dpf::FieldsContainer my_fields_container = op.getOutput<ansys::dpf::FieldsContainer>(0);
CPython
import ansys.dpf.core as dpf
op = dpf.operators.math.None() # operator instantiation
op.inputs.fields_container.connect(my_fields_container)
op.inputs.time_freq_values.connect(my_time_freq_values)
op.inputs.step.connect(my_step)
op.inputs.interpolation_type.connect(my_interpolation_type)
op.inputs.force_new_time_freq_support.connect(my_force_new_time_freq_support)
op.inputs.time_freq_support.connect(my_time_freq_support)
my_fields_container = op.outputs.fields_container()
IPython
import mech_dpf
import Ans.DataProcessing as dpf
op = dpf.operators.math.None() # operator instantiation
op.inputs.fields_container.Connect(my_fields_container)
op.inputs.time_freq_values.Connect(my_time_freq_values)
op.inputs.step.Connect(my_step)
op.inputs.interpolation_type.Connect(my_interpolation_type)
op.inputs.force_new_time_freq_support.Connect(my_force_new_time_freq_support)
op.inputs.time_freq_support.Connect(my_time_freq_support)
my_fields_container = op.outputs.fields_container.GetData()
Changelog
- Version 0.0.0: Initial release.