Skip to content

Commit

Permalink
FILTER: EDAX .ang file Hex Grid To Sqaure Grid Converter (#738)
Browse files Browse the repository at this point in the history
* DOC: Update docs, add comments to source codes. Adjust human name of filter

---------

Signed-off-by: Michael Jackson <[email protected]>
Co-authored-by: Michael Jackson <[email protected]>
  • Loading branch information
nyoungbq and imikejackson authored Oct 17, 2023
1 parent 677ddc6 commit 8ba8129
Show file tree
Hide file tree
Showing 11 changed files with 923 additions and 6 deletions.
2 changes: 2 additions & 0 deletions src/Plugins/OrientationAnalysis/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ set(FilterList
AlignSectionsMutualInformationFilter
BadDataNeighborOrientationCheckFilter
CAxisSegmentFeaturesFilter
ConvertHexGridToSquareGridFilter
ConvertOrientations
ConvertQuaternionFilter
CreateEnsembleInfoFilter
Expand Down Expand Up @@ -165,6 +166,7 @@ set(filter_algorithms
AlignSectionsMutualInformation
BadDataNeighborOrientationCheck
CAxisSegmentFeatures
ConvertHexGridToSquareGrid
ConvertQuaternion
CreateEnsembleInfo
EBSDSegmentFeatures
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Convert Hexagonal Grid Data to Square Grid Data (TSL - .ang)

## Group (Subgroup)

Sampling (Resolution)

## Description

This **Filter** will convert TSL .ang files on hexagonal grids to TSL .ang files on square grids by means of interpolation between points. Note that the resulting square grid .ang files may have more or less rows of data and that some data may be interpolated based on its neighbor data. By default, the spacing of the square grid will be the spacing between columns in the hexagonal grid.

This **Filter** is useful since most DREAM3D-NX routines for analyzing Ebsd data require a square grid. After using this **Filter** to bulk convert the EDAX/TSL .ang files to square grids, it is suggested to use the {ref}`Import Orientation File(s) to H5Ebsd <OrientationAnalysis/EbsdToH5EbsdFilter:Description>` **Filter** to convert the square grid .ang files to the H5Ebsd format. The user can then use the {ref}`Read H5Ebsd File <OrientationAnalysis/ReadH5EbsdFilter:Description>` **Filter** to import the H5Ebsd file into DREAM.3D for analysis.

The use of this **Filter** is similar to the use of the {ref}`Import Orientation File(s) to H5Ebsd <OrientationAnalysis/EbsdToH5EbsdFilter:Description>` **Filter**. Please consult that **Filter's** documentation for a detailed description of the various user interface elements. Note that unlike the {ref}`Import Orientation File(s) to H5Ebsd <OrientationAnalysis/EbsdToH5EbsdFilter:Description>` **Filter**, this **Filter** does not require either the *Stacking Order* or the *Reference Frame* to be modified.

% Auto generated parameter table will be inserted here

## Example Pipelines

## License & Copyright

Please see the description file distributed with this **Plugin**

## 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](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) GItHub site where the community of DREAM3D-NX users can help answer your questions.
10 changes: 10 additions & 0 deletions src/Plugins/OrientationAnalysis/docs/ReadAngDataFilter.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,16 @@ If the data has come from a TSL acquisition system and the settings of the acqui

The user also may want to assign un-indexed pixels to be ignored by flagging them as "bad". The Threshold Objects **Filter** can be used to define this *mask* by thresholding on values such as *Confidence Index* > 0.1 or *Image Quality* > desired quality.

### Note About Sample Grid

OIMAnalysis can create EBSD data sampled on a hexagonal grid. The user can look in the .ang file into the header (those lines starting with the "#" character) for a line that is:

```text
# GRID: HexGrid
```

If the user's .ang files are hexagonal grid files then they will need to run the {ref}`Convert EDAX Hex Grid to Square Grid (.ang)<OrientationAnalysis/ConvertHexGridToSquareGridFilter:Description>` filter to first convert the input files square gridded files.

% Auto generated parameter table will be inserted here

## Example Pipelines
Expand Down
Loading

0 comments on commit 8ba8129

Please sign in to comment.