10.39. Read Ensemble Info File

Group (Subgroup)

IO (Input)

Description

This Filter reads in information about the crystal structure and phase types of all the Features that are contained in a Cell based volume. These values are needed to allow the calculation of statistics on the volume, if they have not already been provided by some other means. The format of the input file is a simple ASCII text file with the extension .ini or .txt. The first group in the file is the name [EnsembleInfo] in square brackets with the key Number_Phases=number of phases that are contained in the volume. Subsequent groups in the file list the Phase Number, Crystal Structure and Phase Type. The proper values for the crystal structure and phase type come from internal constants within DREAM3D-NX and are listed here:

Crystal Structure

String Name

Internal Value

Laue Name

Hexagonal_High

0

Hexagonal-High 6/mmm

Cubic_High

1

Cubic Cubic-High m3m

Hexagonal_Low

2

Hexagonal-Low 6/m

Cubic_Low

3

Cubic Cubic-Low m3 (Tetrahedral)

Triclinic

4

Triclinic -1

Monoclinic

5

Monoclinic 2/m

OrthoRhombic

6

Orthorhombic mmm

Tetragonal_Low

7

Tetragonal-Low 4/m

Tetragonal_High

8

Tetragonal-High 4/mmm

Trigonal_Low

9

Trigonal-Low -3

Trigonal_High

10

Trigonal-High -3m

UnknownCrystalStructure

999

Undefined Crystal Structure

Phase Type

String Name

Internal Value

PrimaryPhase

0

PrecipitatePhase

1

TransformationPhase

2

MatrixPhase

3

BoundaryPhase

4

UnknownPhaseType

999

Example Input

Phase numbering starts at One (1). Phase Zero (0) is reserved for internal use in DREAM3D-NX For example, if you have a structure that has 2 phases that consist of a Cubic Primary phase and a Hexagonal Matrix phase the file would be the following:

[EnsembleInfo]
Number_Phases=2

[1]
CrystalStructure=Cubic_High
PhaseType=PrimaryPhase

[2]
CrystalStructure=Hexagonal_High
PhaseType=MatrixPhase

Input Parameter(s)

Parameter Name

Parameter Type

Parameter Notes

Description

Input Ensemble Info File

FileSystemPath

The path to the ini formatted input file

Data Container

DataGroupSelection

The path to the data object in which the ensemble information will be stored

Output Ensemble Data

Parameter Name

Parameter Type

Parameter Notes

Description

Ensemble Attribute Matrix

DataObjectName

The name of the created Ensemble Attribute Matrix

Crystal Structures

DataObjectName

The name of the created array representing the crystal structure for each Ensemble

Phase Types

DataObjectName

The name of the created array representing the phase type for each Ensemble

Example Pipelines

DREAM3D-NX Help

If you need help, need to file a bug report or want to request a new feature, please head over to the DREAM3DNX-Issues GitHub site where the community of DREAM3D-NX users can help answer your questions.