OOF2: The Manual

Name

OOF.PixelGroup.Rename — Rename an existing PixelGroup in the given Microstructure.

Synopsis

OOF.PixelGroup.Rename(microstructure,group,new_name)

Details

  • Parent Menu: OOF.PixelGroup
  • Callback: function renamePixelGroup in module ooflib.common.IO.pixelgroupmenu
  • Parameters:

    microstructure
    Type: The path to an existing Microstructure object.
    group
    PixelGroup to be renamed. Type: The name of a PixelGroup.
    new_name
    New name for the group, in quotation marks. Type: A character string.

Description

Assign a new name to a PixelGroup. The new_name must be unique, just as it must be for a new group.