min_max:min max by entity over time

Version: 0.0.0

Description

For each entity and component, evaluates minimum and maximum over time/frequency.
Input pin 4 compute_amplitude is only effective when given fields_container contains the complex label.
if given input fields_container has a time_freq_support, output pins 2 and 3 fields_container contains time/freq indices of the minimum and maximum values.

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.

fields_container (Pin 0)

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

compute_absolute_value (Pin 3)

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

Calculate the absolute value of field entities before computing the min/max.

compute_amplitude (Pin 4)

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

Do calculate amplitude.

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.

min (Pin 0)

• Expected type(s): fields_container

max (Pin 1)

• Expected type(s): fields_container

time_freq_of_min (Pin 2)

• Expected type(s): fields_container

time_freq_of_max (Pin 3)

• Expected type(s): fields_container

Configurations

This operator supports configuration options that modify its behavior.

incremental

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

This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range.

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: min_max

Plugin: core

Scripting name: None

Full name: None

Internal name: min_max_over_time_by_entity

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("min_max_over_time_by_entity"); // operator instantiation
op.connect(0, my_fields_container);
op.connect(3, my_compute_absolute_value);
op.connect(4, my_compute_amplitude);
ansys::dpf::FieldsContainer my_min = op.getOutput<ansys::dpf::FieldsContainer>(0);
ansys::dpf::FieldsContainer my_max = op.getOutput<ansys::dpf::FieldsContainer>(1);
ansys::dpf::FieldsContainer my_time_freq_of_min = op.getOutput<ansys::dpf::FieldsContainer>(2);
ansys::dpf::FieldsContainer my_time_freq_of_max = op.getOutput<ansys::dpf::FieldsContainer>(3);

import ansys.dpf.core as dpf

op = dpf.operators.min_max.None() # operator instantiation
op.inputs.fields_container.connect(my_fields_container)
op.inputs.compute_absolute_value.connect(my_compute_absolute_value)
op.inputs.compute_amplitude.connect(my_compute_amplitude)
my_min = op.outputs.min()
my_max = op.outputs.max()
my_time_freq_of_min = op.outputs.time_freq_of_min()
my_time_freq_of_max = op.outputs.time_freq_of_max()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.min_max.None() # operator instantiation
op.inputs.fields_container.Connect(my_fields_container)
op.inputs.compute_absolute_value.Connect(my_compute_absolute_value)
op.inputs.compute_amplitude.Connect(my_compute_amplitude)
my_min = op.outputs.min.GetData()
my_max = op.outputs.max.GetData()
my_time_freq_of_min = op.outputs.time_freq_of_min.GetData()
my_time_freq_of_max = op.outputs.time_freq_of_max.GetData()

Changelog

• Version 0.0.0: Initial release.