DPF Framework 2026 R1

utility:remove unnecessary labels

Last update: 31.07.2026

Version: 0.0.0

Description

Removes the selected label from a 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)
-1 permissive bool
0 fields_container Required fields_container
1 label_to_remove Required string

permissive (Pin -1)

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

If true, the operator does not throw an error if the label to be removed has more than one entry.

fields_container (Pin 0)

Fields Container with the label to be removed.

label_to_remove (Pin 1)

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

Label to be removed from the fields container.

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)

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.

read_inputs_in_parallel

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

If this option is set to true, the operator's inputs will be evaluated in parallel.

Scripting

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

Category: utility

Plugin: core

Scripting name: remove_unnecessary_labels

Full name: utility.remove_unnecessary_labels

Internal name: remove_unnecessary_label

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("remove_unnecessary_label"); // operator instantiation
op.connect(-1, my_permissive);
op.connect(0, my_fields_container);
op.connect(1, my_label_to_remove);
ansys::dpf::FieldsContainer my_fields_container = op.getOutput<ansys::dpf::FieldsContainer>(0);
CPython 
import ansys.dpf.core as dpf

op = dpf.operators.utility.remove_unnecessary_labels() # operator instantiation
op.inputs.permissive.connect(my_permissive)
op.inputs.fields_container.connect(my_fields_container)
op.inputs.label_to_remove.connect(my_label_to_remove)
my_fields_container = op.outputs.fields_container()
IPython 
import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.utility.remove_unnecessary_labels() # operator instantiation
op.inputs.permissive.Connect(my_permissive)
op.inputs.fields_container.Connect(my_fields_container)
op.inputs.label_to_remove.Connect(my_label_to_remove)
my_fields_container = op.outputs.fields_container.GetData()

Changelog

  • Version 0.0.0: Initial release.

Connect with Ansys