```{index} single: Filters; Group MicroTexture Regions
```
# Group MicroTexture Regions

**THIS FILTER IS UNTESTED, UNVERIFIED AND UNVALIDATED. IT IS AN EXPERIMENTAL FILTER THAT IS UNDERGOING LONG TERM DEVELOPMENT
AND TESTING. USE AT YOUR OWN RISK**

## Group (Subgroup)

Reconstruction Filters (Grouping)

## Description

This Filter groups neighboring **Features** that have c-axes aligned within a user defined tolerance.  The algorithm for grouping the **Features** is analogous to the algorithm for segmenting the **Features** - only the average orientation of the **Features** are used instead of the orientations of the individual **Cells** and the criterion for grouping only considers the alignment of the c-axes.  The user can specify a tolerance for how closely aligned the c-axes must be for neighbor **Features** to be grouped.

NOTE: This filter is intended for use with *Hexagonal* materials.  While the c-axis is actually just referring to the <001> direction and thus will operate on any symmetry, the utility of grouping by <001> alignment is likely only important/useful in materials with anisotropy in that direction (like materials with *Hexagonal* symmetry).

Developer Note: It is **very important** for end users to **seed** the data if they *ever* intend to replicate the calculations. The randomness involed in this filter aims to help avoid bias developing in the output, however with out of core this will severely slow down the calculations at runtime. In order to remedy this we are in the process of developing a floodfill method, but the bias formed by sequential parsing is something one should consider when utilizing this method.


### Input Parameter(s)

| Parameter Name | Parameter Type | Parameter Notes | Description |
|----------------|----------------|-----------------|-------------|
| Use Non-Contiguous Neighbors | Bool |  |  |
| Non-Contiguous Neighbor List | NeighborListSelection |  | List of non-contiguous neighbors for each Feature. |
| Contiguous Neighbor List | NeighborListSelection |  | List of contiguous neighbors for each Feature. |
| Group C-Axes With Running Average | Bool |  |  |
| C-Axis Alignment Tolerance (Degrees) | Scalar Value |Float32 |  |

### Random Number Seed Parameters

| Parameter Name | Parameter Type | Parameter Notes | Description |
|----------------|----------------|-----------------|-------------|
| Use Seed for Random Generation | Bool |  | When true the user will be able to put in a seed for random generation |
| Seed | Scalar Value |UInt64 | The seed fed into the random generator |

### Input Cell Data

| Parameter Name | Parameter Type | Parameter Notes | Description |
|----------------|----------------|-----------------|-------------|
| Cell Feature Ids | Array Selection | Allowed Types: int32 Comp. Shape: 1 | Data Array that specifies to which Feature each Element belongs |

### Input Feature Data

| Parameter Name | Parameter Type | Parameter Notes | Description |
|----------------|----------------|-----------------|-------------|
| Feature Phases | Array Selection | Allowed Types: int32 Comp. Shape: 1 | Specifies to which Ensemble each Feature belongs |
| Volumes | Array Selection | Allowed Types: float32 Comp. Shape: 1 |  |
| Average Quaternions | Array Selection | Allowed Types: float32 Comp. Shape: 4 | Specifies the average orientation of each Feature in quaternion representation |

### Input Ensemble Data

| Parameter Name | Parameter Type | Parameter Notes | Description |
|----------------|----------------|-----------------|-------------|
| Crystal Structures | Array Selection | Allowed Types: uint32 Comp. Shape: 1 | Enumeration representing the crystal structure for each Ensemble |

### Output Data Object(s)

| Parameter Name | Parameter Type | Parameter Notes | Description |
|----------------|----------------|-----------------|-------------|
| Cell Parent Ids Array name | DataObjectName |  |  |
| Feature Parent Ids Array Name | DataObjectName |  |  |
| New Cell Feature Attribute Matrix | DataGroupCreation |  |  |
| Active Array Name | DataObjectName |  |  |
| Stored Seed Value Array Name | DataObjectName |  |  |

## References

## 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/discussions) GitHub site where the community of DREAM3D-NX users can help answer your questions.