```{index} single: Filters; Extract Vertex Geometry
```
# Extract Vertex Geometry

## Group (Subgroup)

Core Filters (Geometry)

## Description

This filter will extract all the voxel centers of an Image Geometry or a RectilinearGrid geometry
into a new Vertex Geometry. The user is given the option to copy or move cell arrays over to the
newly created VertexGeometry. The user can also supply a mask array which has the effect of only
creating a vertex if the mask value = TRUE.

![Example showing the use of a Mask array to only generate specific points.](Images/ExtractVertexGeometry_1.png)


### Input Image or RectilinearGrid Geometry

| Parameter Name | Parameter Type | Parameter Notes | Description |
|----------------|----------------|-----------------|-------------|
| Input Geometry | Geometry Selection | Image, Rectilinear Grid | The input Image/RectilinearGrid Geometry to convert |

### Optional Data Mask

| Parameter Name | Parameter Type | Parameter Notes | Description |
|----------------|----------------|-----------------|-------------|
| Use Mask Array | Bool |  | Specifies whether or not to use a mask array when extracting cell centers. |
| Mask Array | Array Selection | Allowed Types: uint8, boolean Comp. Shape: 1 | DataPath to the boolean mask array. Values that are true will mark that cell/point as usable. |

### Cell Arrays to Move/Copy

| Parameter Name | Parameter Type | Parameter Notes | Description |
|----------------|----------------|-----------------|-------------|
| Array Handling | Choices |  | [0] Move or [1] Copy input data arrays |
| Included Attribute Arrays | MultiArraySelection |  | The arrays to copy/move to the vertex array |

### Output Vertex Geometry

| Parameter Name | Parameter Type | Parameter Notes | Description |
|----------------|----------------|-----------------|-------------|
| Output Vertex Geometry | DataGroupCreation |  | The complete path to the vertex geometry that will be created |
| Output Vertex Attribute Matrix Name | DataObjectName |  | The name of the vertex attribute matrix that will be created |
| Output Shared Vertex List Name | DataObjectName |  | The name of the shared vertex list that will be created |

## Example Pipelines

PrebuiltPipelines/Examples/Extract Vertex Geometry.json

## 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.
