OOF2: The Manual

OOF.OrientationMap.Pole_Figure
Prev  6.2. Menus  Next

Name

OOF.OrientationMap.Pole_Figure — Plot a pole figure for a microstructure.

Synopsis

OOF.OrientationMap.Pole_Figure(microstructure, pixels, symmetry, pole, nBins, min, max, colormap, size, filename, overwrite)

Details

  • Parent Menu: OOF.OrientationMap
  • Callback: function _makePoleFigure in module ooflib.SWIG.orientationmap.polefigure

  • Parameters:

    microstructure
    The Microstructure from which to generate a pole figure. Type: The path to an existing Microstructure object.
    pixels
    Pixels to include in the pole figure. Type: The name of a PixelGroup, or every or selection.
    symmetry
    The crystal symmetry to assume for each pixel. All equivalent orientations will be included. Type: An object from the AnisoCrystalSymmetry enumerated class.
    pole
    The pole to plot. Type: An object of the Direction class.
    nBins
    The number of bins to use in the x and y directions in the projected plot. Type: Integer.
    min
    Minimum value to plot (MRD), or 'automatic' Type: An integer, a real number, or the value automatic.
    max
    Maximum value to plot (MRD), or 'automatic' Type: An integer, a real number, or the value automatic.
    colormap
    How MRD values are converted to colors. Type: An object of the ColorMap class.
    size
    Size of the plot (number of pixels along an edge). Type: Integer.
    filename
    The name of the pdf file to create. Type: A character string.
    overwrite
    Overwrite an existing file? Type: Boolean: True or False.

Description

Plot a pole figure for the given Microstructure as a pdf file.

Prev  Up  Next
OOF.OrientationMap.Load  Home  OOF.PixelGroup.AddSelection