10.92. Initialize Image Geometry Cell Data
Group (Subgroup)
Processing (Cleanup)
Description
This Filter overwrites every cell within a user-defined subvolume of an Image Geometry with either a constant value or random values. Use this to reset a region of interest, mask out an area for testing, or stub in synthetic data for development.
Subvolume Specification
The subvolume is specified by minimum and maximum cell indices along each axis (X, Y, Z). Indices are 0-based, inclusive – a min of 5 and a max of 9 includes cells 5, 6, 7, 8, and 9 (5 cells). The min must be less than or equal to the max along each axis. The min must be at least 0 and the max must be less than the geometry’s dimension along that axis.
The subvolume operates only on cells inside this index range; cells outside are unaffected.
Initialization Type
The Initialization Type parameter provides three modes:
Manual [0]: every cell in the subvolume is set to a single user-specified constant value. The value is reinterpreted into each array’s data type (e.g., 1.5 → 1 for an int array, 1.5 → 1.5 for a float array, anything non-zero → true for a bool array).
Random [1]: every cell is set to an independent random value drawn from the full range of the array’s data type. For uint8, this means 0-255. For float32, this means the full IEEE-754 range (which produces extreme values rarely useful for visualization).
Random With Range [2]: every cell is set to an independent random value drawn from the user-specified [min, max] interval. The min/max are interpreted in the array’s data type.
Multiple cell arrays can be initialized in one filter pass; each gets independently-drawn random values when in Random mode.
Random Seed
The random modes use a configurable seed for reproducibility. Enable Use Seed for Random Generation and supply an integer to make results deterministic across pipeline runs. With the option disabled, a time-based seed is used (results vary per run).
Behavior on Boolean Arrays
For boolean arrays in random modes, each cell is set to a uniformly-chosen true/false. Range parameters are ignored for boolean arrays.
Required Input Sources
Input Image Geometry – the geometry whose cell data will be modified in-place. Typically produced by Create Image Geometry, ITK Import Image Stack, or an EBSD reader.
Cell Attribute Arrays to Initialize – one or more cell-level arrays already attached to the geometry’s Cell Attribute Matrix.
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 Value |
Scalar Value |
UInt64 |
The seed fed into the random generator |
Stored Seed Value Array Name |
DataObjectName |
Name of array holding the seed value |
Input Parameter(s)
Parameter Name |
Parameter Type |
Parameter Notes |
Description |
|---|---|---|---|
Min Point |
Vector of UInt64 Values |
Order=X (Column),Y (Row),Z (Plane) |
The minimum x, y, z bound in cells |
Max Point |
Vector of UInt64 Values |
Order=X (Column),Y (Row),Z (Plane) |
The maximum x, y, z bound in cells |
Initialization Type |
Choices |
Tells how to initialize the data |
|
Initialization Value |
Scalar Value |
Float64 |
The initialization value if Manual Initialization Type is selected |
Initialization Range |
Vector of Float64 Values |
Order=, |
The initialization range if Random With Range Initialization Type is selected |
Input Data Objects
Parameter Name |
Parameter Type |
Parameter Notes |
Description |
|---|---|---|---|
Cell Arrays |
MultiArraySelection |
The cell data arrays in which to initialize a sub-volume to zeros |
|
Image Geometry |
Geometry Selection |
Image |
The geometry containing the cell data for which to initialize |
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 GitHub site where the community of DREAM3D-NX users can help answer your questions.