Ans.DataProcessing.operators.utility Namespace
Last update: 18.06.2026Classes
| Class | Description |
|---|---|
| assemble_scalars_to_matrices | Take nine scalar fields and assemble them as a 3x3 matrix field. If the 'symmetrical' input is set to true, only six scalar fields are required (xx, yy, zz, xy, xz and yz). ///available inputs: xx (Field) (optional), yy (Field) (optional), zz (Field) (optional), xy (Field) (optional), yz (Field) (optional), xz (Field) (optional), yx (Field) (optional), zy (Field) (optional), zx (Field) (optional), symmetrical (bool) (optional) |
| [assemble_scalars_to_matrices_ity_assemble_scalars_to_matrices_fc.md) | Take nine scalar fields container and assemble them as a 3x3 matrix fields. If the 'symmetrical' input is set to true, only six field containers are required (xx, yy, zz, xy, xz and yz). ///available inputs: xx (FieldsContainer) (optional), yy (FieldsContainer) (optional), zz (FieldsContainer) (optional), xy (FieldsContainer) (optional), yz (FieldsContainer) (optional), xz (FieldsContainer) (optional), yx (FieldsContainer) (optional), zy (FieldsContainer) (optional), zx (FieldsContainer) (optional), symmetrical (bool) (optional) |
| [assemble_scalarators_utility_assemble_scalars_to_vectors.md) | Takes three scalar fields and assembles them as a 3D vector field. ///available inputs: x (Field) (optional), y (Field) (optional), z (Field) (optional) |
| [assemble_scalars_rators_utility_assemble_scalars_to_vectors_fc.md) | Takes three scalar fields container and assembles them as a 3D vector fields container. ///available inputs: x (FieldsContainer) (optional), y (FieldsContainer) (optional), z (FieldsContainer) (optional) |
| bind_support | Ties a support to a field. ///available inputs: field (Field, FieldsContainer), support (MeshedRegion, AbstractFieldSupport) |
| bind_support_fc | Ties a support to a fields container. ///available inputs: fields_container (FieldsContainer), support (MeshedRegion, AbstractFieldSupport, TimeFreqSupport) |
| change_location | Changes the location property of a field without modifying the field data. ///available inputs: field (Field), new_location (string) |
| [change_shell_laility_change_shell_layers.md) | Extract the requested shell layers from the input fields. If the fields contain only one layer and the permissive configuration input is set to true then it returns the input fields. If permissive configuration input is set to false, any change which should not be permitted won't be achieved and the corresponding field in the output will be empty. If permissive configuration input is set to true (default), carefully check the result. ///available inputs: fields_container (FieldsContainer, Field), e_shell_layer (Int32), mesh (MeshedRegion, MeshesContainer) (optional), merge (bool) (optional) |
| [compute_time_scoility_compute_time_scoping.md) | compute_time_scoping() |
| [customtypefield_rators_utility_customtypefield_get_attribute.md) | Gets a property from an input field/field container. A CustomTypeFieldin pin 0, a property name (string) in pin 1 are expected as inputs ///available inputs: custom_type_field (CustomTypeField, CustomTypeFieldsContainer), property_name (string) |
| [cyclic_support_getors_utility_cyclic_support_get_attribute.md) | A CyclicSupport in pin 0 and a property name (string) in pin 1 are expected in input. ///available inputs: cyclic_support (CyclicSupport), property_name (string) |
| default_value | Returns the value from pin 0 if provided, otherwise returns the default value from pin 1. This operator acts as a fallback mechanism for optional inputs. ///available inputs: forced_value (object) (optional), default_value (object) |
| [delegate_to_o_utility_delegate_to_operator.md) | Delegate the run to an Operator instantiated by the name in input (forwards all the input of this Operator to the sub Operator). ///available inputs: operator_name (string) |
| [ds_get_attutility_ds_get_attribute.md) | A DataSources in pin 0 and a property name (string) in pin 1 are expected in input. An index refering to the property can also be provided. ///available inputs: data_sources (DataSources), property_name (string), property_index (Int32) (optional), property_key (string) (optional), property_result_key (string) (optional) |
| extract_field | Extracts the fields at the indices defined in the vector (in 1) from the fields container (in 0). If a single index is provided, returns a field; if multiple indices are provided, returns a fields container. ///available inputs: fields_container (Field, FieldsContainer), indices (IList int, System.Collections.IEnumerable) (optional) |
| extract_scoping | Takes a field type object, mesh or a collection of them and extracts its scoping or scopings container. ///available inputs: field_or_fields_container (Field, FieldsContainer, PropertyField, PropertyFieldsContainer, CustomTypeField, CustomTypeFieldsContainer, StringField, Scoping, ScopingsContainer, MeshedRegion, MeshesContainer) (optional), requested_location (Int32) (optional) |
| extract_sub_fc | Creates a new fields container with all the fields corresponding to the label space in input 1. If pin 1 is not defined, pin 0 input will be copied to the output. ///available inputs: fields_container (FieldsContainer), label_space (LabelSpace, Scoping) (optional), collapse_labels (bool) (optional) |
| extract_sub_mc | Creates a new meshes container with all the meshed regions corresponding to the label space in input 1. If pin 1 is not defined, pin 0 input will be copied to the output. ///available inputs: meshes (MeshesContainer), label_space (LabelSpace, Scoping) (optional), collapse_labels (bool) (optional) |
| extract_sub_sc | Creates a new scopings container with all the scopings corresponding to the label space in input 1. If pin 1 is not defined, pin 0 input will be copied to the output. ///available inputs: scopings_container (ScopingsContainer), label_space (LabelSpace, Scoping) (optional), collapse_labels (bool) (optional) |
| [extract_time_flity_extract_time_freq.md) | Extract timefreqs with sets scoping from a time freq support ///available inputs: time_freq_support (TimeFreqSupport), time_scoping (Scoping) (optional), real_or_complex (bool) (optional) |
| [fc_get_attrtility_fc_get_attribute.md) | Uses the FieldsContainer APIs to return a given attribute of the fields container in input. ///available inputs: fields_container (FieldsContainer), property_name (string), property_identifier (string, Int32) (optional) |
| [field](Ans_DataPr | Incrementaly merge the input. ///available inputs: input (Field) |
| [field_clone_to_shell_lality_field_clone_to_shell_layer.md) | Generates a Field from the Field in input 0 that has the same FieldDefinition with the exception of the shellLayers enum that is specified in input 1. The DataPointer is recomputed to the appropriate value. The Data of the output Field is 0.0 for all entities. Scoping can be shared or not based on the optional pin 2. ///available inputs: field (Field), shell_layer (Int32), duplicate_scoping (bool) (optional) |
| field_get_attribute | Gets a property from an input field/field container. A Fieldin pin 0, a property name (string) in pin 1 are expected as inputs ///available inputs: field (Field, FieldsContainer), property_name (string) |
| field_to_fc | Creates a fields container containing the field provided on pin 0. ///available inputs: field (Field, FieldsContainer), label (LabelSpace) |
| fields_container | Incrementaly merge the input. ///available inputs: input (FieldsContainer) |
| for_each | Allows to write a loop over a chunk of operators. ///available inputs: iterable (object), iterable_values (object) (optional), pin_index (Int32) (optional), forward1 (object), forward2 (object) |
| [forward](Ans_DataProc | Return all the inputs as outputs. ///available inputs: any (object) |
| forward_field | Returns the input field or fields container. ///available inputs: field (Field, FieldsContainer) |
| [forward_fields_containety_forward_fields_container.md) | Returns the input field or fields container. ///available inputs: fields (FieldsContainer, Field) |
| [forwarg_operators_utility_forward_meshes_container.md) | Returns the input mesh or meshes container into a meshes container. ///available inputs: meshes (MeshesContainer, MeshedRegion), default_label (string) (optional) |
| get_operators | Getter on operators inside a workflow. ///available inputs: workflow (Workflow) |
| [hdf5dpf_workgators_utility_hdf5dpf_workglow_provider.md) | Extract a custom result from an hdf5dpf file as an executable workflow. ///available inputs: time_scoping (Scoping) (optional), mesh_scoping (Scoping) (optional), streams (StreamsContainer) (optional), data_sources (DataSources) (optional), meta_data (DataTree) (optional), result_name (object) |
| [html_doc](Ans_DataProcessingate dpf's html documentation. Only on Windows. ///available inputs: output_path (string) (optional), exposure_level (Int32) (optional) | |
| [incremental_concatenate_as_fcy_incremental_concatenate_as_fc.md) | Assemble fields in a fields container. ///available inputs: field (Field), label (LabelSpace) (optional) |
| ints_to_scoping | Creates a scoping from integer data. Converts single integers, integer vectors, or existing scopings into a properly formatted DPF scoping. ///available inputs: ids (Int32, IList int, Scoping, System.Collections.IEnumerable), location (string) (optional), upper_bound (Int32, Scoping) (optional) |
| make_for_each_range | Generate a range that can be consumed by the for_each operator ///available inputs: try_generate_iterable (bool) (optional), iterable (object) (optional), operator_to_iterate (Operator), pin_index (Int32), valueA (object), valueB (object), valueC1 (object), valueC2 (object) |
| [make_label_splity_make_label_space.md) | Assemble strings and integers to make a label space. ///available inputs: base_label (LabelSpace, FieldsContainer, ScopingsContainer) (optional), label_name (string), label_value1 (Int32), label_value2 (Int32) |
| make_overall | Extracts a value from a field and makes a new field containing only this value, with the associated scoping's location set as 'overall'. ///available inputs: field (Field), id (Int32) |
| [make_producer_consusing_operators_utility_make_producer_consumer_for_each_iterator.md) | Generates an iterator that can be consumed by the for_each operator.The chain of Operators are split into a first part : the producers and a second part : the consumers.Asynchronous buffers are indeed to connect the producers and the consumers. ///available inputs: try_generate_iterable (bool) (optional), iterable (object) (optional), operator_to_iterate (Operator), pin_index (Int32), valueA (object), valueB (object), valueC1 (object), valueC2 (object), producer_op11 (Operator), producer_op12 (Operator), output_pin_of_producer_op12 (Int32), input_pin_of_consumer_op12 (Int32), consumer_op12 (Operator) |
| merge_any | Merges a list of objects having the same data types. Once the data type is found, the merge operation is forwarded to the correct merge Operator. ///available inputs: any1 (object), any2 (object) |
| merge_collections | Merges a set of collections into a unique one. ///available inputs: collections1 (AnyCollection), collections2 (AnyCollection) |
| merge_data_tree | Merges a list of data trees. Attributes names shouldn't be shared accross data tree instances. ///available inputs: data_tree1 (DataTree), data_tree2 (DataTree) |
| merge_fields | Assembles a set of fields into a unique one. ///available inputs: sum_merge (bool) (optional), merged_support (AbstractFieldSupport) (optional), fields1 (Field, FieldsContainer), fields2 (Field, FieldsContainer) |
| merge_fields_by_label | Merges the fields of a fields container that share the same label value. ///available inputs: fields_container (FieldsContainer), label (string), merged_field_support (AbstractFieldSupport) (optional), sum_merge (bool) (optional) |
| merge_fields_containers | Assembles a set of fields containers into a unique one. ///available inputs: should_merge_named_selections (bool) (optional), sum_merge (bool) (optional), merged_fields_support (AbstractFieldSupport) (optional), merged_fields_containers_support (AbstractFieldSupport) (optional), fields_containers1 (FieldsContainer), fields_containers2 (FieldsContainer) |
| merge_generic_data_container | Merges a list of generic data container. For each data entry, the merge operation is forwarded to the correct merge Operator. Primitive types cannot be merged, first instance found will be maintained in the result. ///available inputs: generic_data_container1 (GenericDataContainer), generic_data_container2 (GenericDataContainer) |
| merge_materials | Assembles a set of materials into a unique one. ///available inputs: materials1 (Materials), materials2 (Materials) |
| merge_meshes | Take a set of meshes and assemble them in a unique one ///available inputs: naive_merge_elements (bool) (optional), should_merge_named_selections (bool) (optional), meshes1 (MeshedRegion, MeshesContainer), meshes2 (MeshedRegion, MeshesContainer), merge_method (Int32) (optional), box_size (double) (optional), remove_duplicate_elements (Int32) (optional) |
| merge_meshes_containers | Assembles a set of meshes containers into a unique one. ///available inputs: meshes_containers1 (MeshesContainer), meshes_containers2 (MeshesContainer) |
| merge_property_fields | Assembles a set of property fields into a unique one. ///available inputs: naive_merge (bool), property_fields1 (PropertyField, PropertyFieldsContainer), property_fields2 (PropertyField, PropertyFieldsContainer) |
| merge_result_infos | Assembles a set of result information into a unique one. ///available inputs: result_infos1 (ResultInfo), result_infos2 (ResultInfo) |
| merge_scopings | Assembles a set of scopings into a unique one. ///available inputs: scopings1 (Scoping, ScopingsContainer), scopings2 (Scoping, ScopingsContainer) |
| merge_scopings_containers | Assembles a set of scopings containers into a unique one. ///available inputs: scopings_containers1 (ScopingsContainer), scopings_containers2 (ScopingsContainer) |
| merge_string_fields | Assembles a set of string fields into a unique one. ///available inputs: string_fields1 (StringField), string_fields2 (StringField) |
| merge_supports | Assembles a set of supports into a unique one. ///available inputs: should_merge_named_selections (bool) (optional), supports1 (AbstractFieldSupport), supports2 (AbstractFieldSupport) |
| merge_time_freq_supports | Assembles a set of time/frequency supports into a unique one. ///available inputs: time_freq_supports1 (TimeFreqSupport), time_freq_supports2 (TimeFreqSupport) |
| merge_to_field_matrix | Assembles a set of fields into a field matrix. ///available inputs: fields1 (Field, FieldsContainer), fields2 (Field, FieldsContainer) |
| merge_weighted_fields | Assembles a set of fields into a unique one, applying a weight on the sum of the fields. ///available inputs: sum_merge (bool) (optional), merged_support (AbstractFieldSupport) (optional), fields1 (Field, FieldsContainer), fields2 (Field, FieldsContainer), weights1 (PropertyField), weights2 (PropertyField) |
| merge_weighted_fields_containers | Assembles a set of fields containers into a unique one, applying a weight on the sum of the fields. ///available inputs: sum_merge (bool) (optional), merged_fields_support (AbstractFieldSupport) (optional), merged_fields_containers_support (AbstractFieldSupport) (optional), fields_containers1 (FieldsContainer), fields_containers2 (FieldsContainer), weights1 (), weights2 () |
| mesh | Incrementaly merge the input. ///available inputs: input (MeshedRegion) |
| mesh_to_mc | Creates a meshes container containing the mesh provided on pin 0. ///available inputs: mesh (MeshedRegion, MeshesContainer), label (LabelSpace) |
| meshes_container | Incrementaly merge the input. ///available inputs: input (MeshesContainer) |
| operator_changelog | Return a GenericDataContainer used to instantiate the Changelog of an operator based on its name. ///available inputs: operator_name (string) |
| operator_id | Return the id of an Operator. ///available inputs: op (Operator) |
| overlap_fields | Take two fields and superpose them, the overlapping field will override values of base_field. ///available inputs: base_field (Field) (optional), overlapping_field (Field) (optional) |
| producer_consumer_for_each | Allows to write a loop over operators by connecting data to iterate and by requesting the incrementally output merged.The chain of Operators are split into a first part: the producers and a second part: the consumers. These 2 parts will run asynchronously on 2 threads. ///available inputs: producer_consumer_iterableq (object), forward1 (object), forward2 (object) |
| property_field | Incrementaly merge the input. ///available inputs: input (PropertyField) |
| propertyfield_get_attribute | Gets a property from an input field/field container. A PropertyFieldin pin 0, a property name (string) in pin 1 are expected as inputs ///available inputs: property_field (PropertyField, PropertyFieldsContainer), property_name (string) |
| python_generator | Generates .py file with specifications for loaded plugin(s). ///available inputs: dll_source_path (string), output_path (string), load_symbol (string) (optional), library_key (string) (optional) |
| remote_operator_instantiate | Create a local image of an existing remote operator (identified by an id and an address) for a given protocol registered in the streams. A workflow is created with this operator and returned in output ///available inputs: operator_to_send (Int32), output_pin (Int32), streams_to_remote (StreamsContainer), data_sources_to_remote (DataSources) (optional), output_name (string) |
| remote_workflow_instantiate | Sends a local workflow to a remote process (and keep a local image of it) or create a local image of an existing remote workflow (identified by an id and an address) for a given protocol registered in the streams. ///available inputs: workflow_to_send (Workflow, Int32), streams_to_remote (StreamsContainer), data_sources_to_remote (DataSources) (optional) |
| remove_unnecessary_labels | Removes the selected label from a fields container. ///available inputs: permissive (bool) (optional), fields_container (FieldsContainer), label_to_remove (string) |
| scalars_to_field | scalars_to_field() |
| server_path | Returns the platform-specific path to a folder in the Dpf server ///available inputs: subpath (Int32) (optional) |
| set_attribute | Uses the FieldsContainer APIs to modify it. ///available inputs: fields_container (FieldsContainer), property_name (string), property_identifier (LabelSpace) (optional) |
| set_property | Sets a property to an input field/field container. A Fieldin pin 0, a property name (string) in pin 1 and a valid property value in pin 2 are expected as inputs ///available inputs: field (Field, FieldsContainer), property_name (string), property (string, TimeFreqSupport, Scoping, DataTree, Int32, double) |
| split_in_for_each_range | Split a scoping into several pieces so you can iterate it with a for_each loop. ///available inputs: iterable (object) (optional), operator_to_iterate (Operator), pin_index (Int32), scoping (Scoping), chunk_size (Int32) |
| strain_from_voigt | Converts strain field data from Voigt notation (6-component vector) to standard symmetric matrix format (3x3 tensor). ///available inputs: strain_field (Field, FieldsContainer) |
| strain_from_voigt_fc | Converts strain field data from Voigt notation (6-component vector) to standard symmetric matrix format (3x3 tensor). ///available inputs: fields_container (FieldsContainer) |
| txt_file_to_dpf | Take an input string and parse it into dataProcessing type ///available inputs: input_string (string) |
| unitary_field | Takes a field and returns another field of scalars in the same location and scoping as the input field. ///available inputs: field (Field, FieldsContainer) |
| weighted_merge_fields_by_label | Performs a weighted merge on fields of a fields container that share the same label value. ///available inputs: fields_container (FieldsContainer), label (string), merged_field_support (AbstractFieldSupport) (optional), sum_merge (bool) (optional), weights1 (PropertyField), weights2 (PropertyField) |
