Skip to content

DOC: Update documentation for various filters #1513

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
imikejackson wants to merge 2 commits into
base: develop
Choose a base branch
from
+126 −10
Open

DOC: Update documentation for various filters #1513

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3f5a398
DOC: Updating various filer documentation files.
imikejackson Jan 19, 2026
ede8e70
DOC: Update docs for Write Nodes and Elements filter
imikejackson Jan 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 57 additions & 9 deletions src/Plugins/OrientationAnalysis/docs/CreateEnsembleInfoFilter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,14 @@ Processing (Generation)

## Description

This **Filter** allows the user to enter basic crystallographic information about each phase. The Laue class, Phase Type, and Phase Name can all be entered by the user. The information is stored in an EnsembleAttributeMatrix. These values are needed to allow the calculation of certain kinds of crystallographic statistics on the volume, if they have not already been provided by some other means. Each row in the table lists the **Crystal Structure**, **Phase Type**, and **Phase Name**. The proper values for the crystal structure and phase type come from internal constants within DREAM3D-NX and are listed here:
This **Filter** allows the user to enter basic crystallographic information about
each phase. The Laue class, Phase Type, and Phase Name can all be entered by the
user. The information is stored in an EnsembleAttributeMatrix. These values are
needed to allow the calculation of certain kinds of crystallographic statistics
on the volume, if they have not already been provided by some other means. Each
row in the table lists the **Crystal Structure**, **Phase Type**, and **Phase Name**.
The proper values for the crystal structure and phase type come from internal
constants within DREAM3D-NX and are listed here:

## DREAM3D-NX Laue Group to Point Group Table

Expand All @@ -25,16 +32,57 @@ This **Filter** allows the user to enter basic crystallographic information abou
| 10 | Trigonal_High | -3m | 20 | 32 |
| 999 | UnknownCrystalStructure | | | |

## DREAM3D-NX Full Crystallographic Table

In the table below, the column labeled `Laue Ops` is the internal DREAM3D-NX class name
and is the name that the user will find the combo-box selection when creating a crystallographic
phase.

| Point Group | (H–M) | Rotation Point Group | Space Group No(s). | Schoenflies | Crystal system | Laue class | Laue Ops | Internal Value |
|-------------|-------------|----------------------|--------------------|---------------|----------------|-------------|-----------------|----------------|
| 1 | 1 | 1 | 1 | C₁ | Triclinic | (\bar{1}) | Triclinic | 0 |
| 2 | (\bar{1}) | 1 | 2 | C(_i) | Triclinic | (\bar{1}) | | |
| 3 | 2 | 2 | 3–5 | C₂ | Monoclinic | 2/m | | |
| 4 | m | 1 | 6–9 | C(_s) | Monoclinic | 2/m | | |
| 5 | 2/m | 2 | 10–15 | C(_{2h}) | Monoclinic | 2/m | Monoclinic | 5 |
| 6 | 222 | 222 | 16–24 | D₂ | Orthorhombic | mmm | | |
| 7 | mm2 | 2 | 25–46 | C(_{2v}) | Orthorhombic | mmm | | |
| 8 | mmm | 222 | 47–74 | D(_{2h}) | Orthorhombic | mmm | OrthoRhombic | 6 |
| 9 | 4 | 4 | 75–80 | C₄ | Tetragonal | 4/m | | |
| 10 | (\bar{4}) | 2 | 81–82 | S₄ | Tetragonal | 4/m | | |
| 11 | 4/m | 4 | 83–88 | C(_{4h}) | Tetragonal | 4/m | Tetragonal_Low | 7 |
| 12 | 422 | 422 | 89–98 | D₄ | Tetragonal | 4/mmm | | |
| 13 | 4mm | 4 | 99–110 | C(_{4v}) | Tetragonal | 4/mmm | | |
| 14 | (\bar{4}2m) | 222 | 111–122 | D(_{2d}) | Tetragonal | 4/mmm | | |
| 15 | 4/mmm | 422 | 123–142 | D(_{4h}) | Tetragonal | 4/mmm | Tetragonal_High | 8 |
| 16 | 3 | 3 | 143–146 | C₃ | Trigonal | (\bar{3}) | | |
| 17 | (\bar{3}) | 3 | 147–148 | C(_{3i}) (S₆) | Trigonal | (\bar{3}) | Trigonal_Low | 9 |
| 18 | 32 | 32 | 149–155 | D₃ | Trigonal | (\bar{3}m) | | |
| 19 | 3m | 3 | 156–161 | C(_{3v}) | Trigonal | (\bar{3}m) | | |
| 20 | (\bar{3}m) | 32 | 162–167 | D(_{3d}) | Trigonal | (\bar{3}m) | Trigonal_High | 10 |
| 21 | 6 | 6 | 168–173 | C₆ | Hexagonal | 6/m | | |
| 22 | (\bar{6}) | 3 | 174 | C(_{3h}) | Hexagonal | 6/m | | |
| 23 | 6/m | 6 | 175–176 | C(_{6h}) | Hexagonal | 6/m | Hexagonal_Low | 2 |
| 24 | 622 | 622 | 177–182 | D₆ | Hexagonal | 6/mmm | | |
| 25 | 6mm | 6 | 183–186 | C(_{6v}) | Hexagonal | 6/mmm | | |
| 26 | (\bar{6}m2) | 32 | 187–190 | D(_{3h}) | Hexagonal | 6/mmm | | |
| 27 | 6/mmm | 622 | 191–194 | D(_{6h}) | Hexagonal | 6/mmm | Hexagonal_High | 0 |
| 28 | 23 | 23 | 195–199 | T | Cubic | m(\bar{3}) | | |
| 29 | m(\bar{3}) | 23 | 200–206 | T(_h) | Cubic | m(\bar{3}) | Cubic_Low | 3 |
| 30 | 432 | 432 | 207–214 | O | Cubic | m(\bar{3})m | | |
| 31 | (\bar{4}3m) | 23 | 215–220 | T(_d) | Cubic | m(\bar{3})m | | |
| 32 | m(\bar{3})m | 432 | 221–230 | O(_h) | Cubic | m(\bar{3})m | Cubic_High | 1 |

### Phase Type

| String Name | Internal Value |
| ------------|----------------|
| PrimaryPhase | 0 |
| PrecipitatePhase | 1 |
| TransformationPhase | 2 |
| MatrixPhase | 3 |
| BoundaryPhase | 4 |
| UnknownPhaseType | 999 |
| String Name | Internal Value |
|---------------------|----------------|
| PrimaryPhase | 0 |
| PrecipitatePhase | 1 |
| TransformationPhase | 2 |
| MatrixPhase | 3 |
| BoundaryPhase | 4 |
| UnknownPhaseType | 999 |

% Auto generated parameter table will be inserted here

Expand Down
8 changes: 8 additions & 0 deletions src/Plugins/SimplnxCore/docs/ReshapeDataArrayFilter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@ Core (Generation)

This **Filter** is used to modify the tuple shape of Data Arrays, Neighbor Lists, and String Arrays within a data structure. It validates the new tuple dimensions to ensure they are positive and differ from the current shape, preventing unnecessary or invalid reshapes.

**THIS FILTER DOES NOT MOVE ANY THE VALUES IN MEMORY. IT SIMPLY UPDATES THE TUPLE DIMENSIONS. This means that if the data does not
have the proper stride for the new dimensions this could result in incorrect results.**

For example if a data set is read in from an HDF5 file with a tuple dimension of 3 x 45 this means that there are 45 columns
and 3 rows. If this data is supposed to be interpreted as 3D points, using this data within DREAM3D-NX would not
work because DREAM3D-NX is "C" ordered and the dimensions should be 3 columns x 45 rows. Using this filter will
**NOT** result the correct ordering of the data because the filter will not move any data in memory.

**NOTE:** If the input array is a Neighbor List or String Array, the filter will throw a warning if the new tuple dimensions are multi-dimensional. This is because these array types do not support multi-dimensional tuple dimensions and the filter will default to reshaping the data to an equivalent 1-dimensional number of tuples.

% Auto generated parameter table will be inserted here
Expand Down
62 changes: 61 additions & 1 deletion src/Plugins/SimplnxCore/docs/WriteNodesAndElementsFilesFilter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,73 @@ IO (Output)

## Description

This **Filter** exports geometric data into structured text files. It allows users to save the following:
This **Filter** exports node based geometries into structured text files. It allows users to save the following:

1. Node Data (Vertices): Export the coordinates of points that define the geometry.
2. Element Data (Connectivity): Export the node indices that make up the edges, faces, or volumes of the geometry.

The filter gives the user the option to export a node file, element file, or both. It also allows the user to decide whether or not to number the nodes and elements and whether or not to include headers for the node and element files.

## Example Node File

In this example output, the following filter parameter options have been selected:

- Number Nodes: ON
- Include Node File Header: ON

The output is listed below where column 1 is controlled by the `Number Nodes` parameter and line #2 is controlled by the `Include Node File Header` parameter.
```
# This file was created by simplnx v1.7.0
NODE_NUM X Y Z
0 0.0000 0.0000 0.0000
1 0.0000 0.2500 0.0000
2 0.2500 0.0000 0.0000
3 0.2500 0.2500 0.0000
4 0.5000 0.0000 0.0000
```

## Example Elements File

In this example output, the following filter parameter options have been selected:

- Number Elements/Cells: ON
- Include Element/Cell File Header: ON

The output is listed below where column 1 is controlled by the `Number Elements/Cells` parameter and line #2 is controlled by the `Include Element/Cell File Header` parameter.

Some explanation as to the columns is requried for this output.

- Column #1 is just the index of the element
- Column #2 is the number of vertices in this element. in this output, 3 since this was exported from a Triangle Geometry
- Columns #3,4,5 are the indices into the node array of the 3 vertices that make up this element. The number of columns may change depending on the kind of geometry being written.

```
# This file was created by simplnx v1.7.0
ELEMENT_NUM NUM_VERTS_IN_ELEMENT V0_Index V1_Index V2_Index
0 3 0 1 2
1 3 2 1 3
2 3 2 3 4
3 3 4 3 5
4 3 4 5 6
5 3 6 5 7
6 3 6 7 8
7 3 8 7 9
8 3 8 9 10
9 3 10 9 11
10 3 10 11 12
```

### Number of Nodes for each Geometry Type

| Geometry Type | Number of Nodes |
|---------------|-----------------|
| Edge | 2 |
| Triangle | 3 |
| Quad | 4 |
| Tetrahedral | 4 |
| Hexahedral | 6 |


% Auto generated parameter table will be inserted here

## License & Copyright
Expand Down
Loading