10.129. Rename DataObject

Group (Subgroup)

Core (Memory/Management)

Description

This Filter renames a single Data Object of any type (geometry, attribute matrix, data group, data array, neighbor list, string array, etc.). The object remains at its original parent in the Data Structure; only the leaf name changes.

When to Use This Filter

Standardize names imported from external files (e.g., rename “Phi1, PHI, Phi2” to “EulerAngles_0, _1, _2” before using a multi-component-array filter).
Resolve a name collision before adding a new object with the same name (alternatively, use Delete Data to remove the colliding object).
Make pipeline output names match the expectations of a downstream consumer.

WARNING: Downstream References Do Not Auto-Update

If any filter later in the pipeline references the renamed object by its old name, that filter will fail preflight when re-run. Re-select the renamed object in any downstream filter parameters.

Name Constraints

The new name must be non-empty and must not collide with another object at the same parent. The filter validates this at preflight.

Required Input Sources

Data Object to Rename – a path to any existing DataObject in the Data Structure.

Input Parameter(s)

Parameter Name	Parameter Type	Description
Allow Overwrite	Bool	If true existing object with `New Name` and all of its nested objects will be removed to free up the name for the target DataObject
DataObject to Rename	DataPathSelection	DataPath pointing to the target DataObject
New Name	String	Target DataObject name

Example Pipelines

License & Copyright

Please see the description file distributed with this Plugin

DREAM3D-NX Help

If you need help, need to file a bug report or want to request a new feature, please head over to the DREAM3DNX-Issues GitHub site where the community of DREAM3D-NX users can help answer your questions.