OOF2: The Manual

OOF.LoadData.Skeleton.NewPeriodic
Prev  6.2. Menus  Next

Name

OOF.LoadData.Skeleton.NewPeriodic — Load a Skeleton.

Synopsis

OOF.LoadData.Skeleton.NewPeriodic(name, microstructure, left_right_periodicity, top_bottom_periodicity)

Details

  • Parent Menu: OOF.LoadData.Skeleton
  • Callback: function _newSkelPeriodic in module ooflib.engine.IO.skeletonIO

  • Parameters:

    name
    Name for the Skeleton. Type: A character string.
    microstructure
    Type: The path to an existing Microstructure object.
    left_right_periodicity
    Whether the skeleton is periodic in the horizontal direction Type: Boolean: True or False.
    top_bottom_periodicity
    Whether the skeleton is periodic in the vertical direction Type: Boolean: True or False.

Description

Skeletons are stored in data files as a series of commands. This is the first one. It's called “NewPeriodic” because its arguments set the Skeleton's periodicity. The old OOF.LoadData.Skeleton.New command, without periodicity parameters, still exists for backwards compatibility, but should never be used in new data files.

This command is used only in data files and is not directly accessible from the OOF2 user interface.

See Also

Prev  Up  Next
OOF.LoadData.Skeleton.New  Home  OOF.LoadData.Skeleton.NodeGroup