filter:band pass (timescoping)

Version: 0.0.0

Description

The band pass filter returns all the values above (but not equal to) the minimum threshold value and below (but not equal to) the maximum threshold value in input.

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

min_threshold (Pin 1)

• Required: Yes
• Expected type(s): double, field

A minimum threshold scalar or a field containing one value is expected.

max_threshold (Pin 2)

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

A maximum threshold scalar or a field containing one value is expected.

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.

scoping (Pin 0)

• Expected type(s): scoping

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

Plugin: core

Scripting name: timescoping_band_pass

Full name: filter.timescoping_band_pass

Internal name: core::timescoping::band_pass

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("core::timescoping::band_pass"); // operator instantiation
op.connect(0, my_time_freq_support);
op.connect(1, my_min_threshold);
op.connect(2, my_max_threshold);
ansys::dpf::Scoping my_scoping = op.getOutput<ansys::dpf::Scoping>(0);

import ansys.dpf.core as dpf

op = dpf.operators.filter.timescoping_band_pass() # operator instantiation
op.inputs.time_freq_support.connect(my_time_freq_support)
op.inputs.min_threshold.connect(my_min_threshold)
op.inputs.max_threshold.connect(my_max_threshold)
my_scoping = op.outputs.scoping()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.filter.timescoping_band_pass() # operator instantiation
op.inputs.time_freq_support.Connect(my_time_freq_support)
op.inputs.min_threshold.Connect(my_min_threshold)
op.inputs.max_threshold.Connect(my_max_threshold)
my_scoping = op.outputs.scoping.GetData()

Changelog

• Version 0.0.0: Initial release.