filter:abc weightings

Version: 0.0.0

Description

Computes ABC-weightings for the amplitude spectrum in dB units.

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

data to be weighted in dB units equipped with cumulative ids in the scoping.

weighting_type (Pin 1)

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

if this pin is set to 0, the A-weighting is computed, 1 the B-weigting is computed and 2 the C-weightings is computed.

shape_by_tf_scoping (Pin 2)

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

if this pin is set to true, each field of the input fields container is defined by time freq scoping and not by ids. Default is false

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.

weightings (Pin 0)

• Expected type(s): fields_container

weighted data in dB units.

Configurations

This operator supports configuration options that modify its behavior.

inplace

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

The output is written over the input to save memory if this config is set to true.

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

Plugin: core

Scripting name: abc_weightings

Full name: filter.abc_weightings

Internal name: abc_weightings

License: any_dpf_supported_increments

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("abc_weightings"); // operator instantiation
op.connect(0, my_fields_container);
op.connect(1, my_weighting_type);
op.connect(2, my_shape_by_tf_scoping);
ansys::dpf::FieldsContainer my_weightings = op.getOutput<ansys::dpf::FieldsContainer>(0);

import ansys.dpf.core as dpf

op = dpf.operators.filter.abc_weightings() # operator instantiation
op.inputs.fields_container.connect(my_fields_container)
op.inputs.weighting_type.connect(my_weighting_type)
op.inputs.shape_by_tf_scoping.connect(my_shape_by_tf_scoping)
my_weightings = op.outputs.weightings()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.filter.abc_weightings() # operator instantiation
op.inputs.fields_container.Connect(my_fields_container)
op.inputs.weighting_type.Connect(my_weighting_type)
op.inputs.shape_by_tf_scoping.Connect(my_shape_by_tf_scoping)
my_weightings = op.outputs.weightings.GetData()

Changelog

• Version 0.0.0: Initial release.