OOF2: The Manual

OOF.LoadData.Microstructure.Categories
Prev  6.2. Menus  Next

Name

OOF.LoadData.Microstructure.Categories — Assign pixels to categories. Used internally in data files.

Synopsis

OOF.LoadData.Microstructure.Categories(microstructure, categories)

Details

  • Parent Menu: OOF.LoadData.Microstructure
  • Callback: function _readCategories in module ooflib.common.IO.microstructureIO

  • Parameters:

    microstructure
    Type: The path to an existing Microstructure object.
    categories
    Category map for pixels. Type: A list of lists of integers. The sublists must all have the same size.

Description

Load pixel categories from a saved Microstructure. Categories are defined in OOF.LoadData.Microstructure.

The categories parameter is a Python list of Python lists of integers where each sublist contains the categories for a row of pixels in the microstructure. The categories in each row are given from left to right, and the rows are ordered from bottom to top.

This command is only used in data files.

See Also

Prev  Up  Next
OOF.LoadData.Microstructure.DefineCategory.PixelGroups  Home  OOF.LoadData.Microstructure.EndCategories