OOF2: The Manual

Name

OOF.LoadData.Microstructure.DefineCategory.PixelGroups — Assign pixel groups to pixel categories. Used internally in data files.

Synopsis

OOF.LoadData.Microstructure.DefineCategory.PixelGroups(microstructure,category,groups)

Details

  • Parent Menu: OOF.LoadData.Microstructure.DefineCategory
  • Callback: function _readPixelGroups in module ooflib.common.IO.pixelgroupmenu
  • Parameters:

    microstructure
    Type: The path to an existing Microstructure object.
    category
    Pixel category. Type: Integer.
    groups
    List of names of pixel groups. Type: A list of character strings.

Description

Add pixel groups to category definitions inside a Microstructure data file. The groups argument is a Python list of strings, where each string is the name of a group belonging to the given category of pixel.

Example.  The command

OOF.LoadData.Microstructure.DefineCategory.PixelGroups(microstructure='tiny3',
             category=0,
             groups=['negativland', 'talkingheads'])

puts all pixels in category 0 in the Microstructure named tiny3 into the pixel groups named negativland and talkingheads.

This command is only used in data files.