10.160. Write SPParks Sites File
Group (Subgroup)
IO (Output)
Description
This filter writes a data file in the format used by SPPARKS. SPPARKS (Stochastic Parallel PARticle Kinetic Simulator) is an open-source Kinetic Monte Carlo code from Sandia National Laboratories used to simulate microstructure evolution, such as grain growth.
SPPARKS represents the microstructure as a set of sites. In this export each site corresponds to one Cell (voxel) of the input Image Geometry, and the value stored at each site is that cell’s Feature Id (the grain it belongs to). The Values section of the file is therefore a list of pairs: the first number in each pair is the site ID (running from 1), and the second number is the Feature Id at that site.
The header lines describe the lattice the sites live on:
LINE 1 is intentionally left blank (a separator).
LINE 2 records the spatial dimension (always
3 dimensionfor a 3D Image Geometry).LINE 3 is the total number of Cells (sites).
LINE 4 is the maximum number of neighbors per site. For a 3D cubic lattice this is
26 max neighbors(the 26 surrounding cells), and SPPARKS expects exactly this value for this lattice type.LINES 5, 6, and 7 give the box extents along x, y, and z. These pairs (for example
0 200) are cell-index extents — dimensionless counts of cells along each axis — not physical lengths in microns.LINE 8 is a blank separator before the
Valueskeyword.
More information can be found in the SPPARKS documentation for read_sites and dump.
Required Input Sources
Image Geometry – the voxel grid whose cells become SPPARKS sites.
Cell Feature Ids – produced by a segmentation filter such as Segment Features (Scalar). The Feature Id at each cell becomes that site’s value.
Example Output
[LINE 1]
[LINE 2] 3 dimension
[LINE 3] 8000000 sites
[LINE 4] 26 max neighbors
[LINE 5] 0 200 xlo xhi
[LINE 6] 0 200 ylo yhi
[LINE 7] 0 200 zlo zhi
[LINE 8]
[LINE 9] Values
[LINE 10]
1 944
2 944
3 944
4 944
5 509
6 509
7 509
..
Input Parameter(s)
Parameter Name |
Parameter Type |
Parameter Notes |
Description |
|---|---|---|---|
Output File Path |
FileSystemPath |
The path to the output file |
Input Data Objects
Parameter Name |
Parameter Type |
Parameter Notes |
Description |
|---|---|---|---|
Input Image Geometry |
Geometry Selection |
Image |
The image geometry holding the arrays to write |
Cell Feature Ids |
Array Selection |
Allowed Types: int32 Comp. Shape: 1 |
Data Array that specifies to which Feature each Element belongs |
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.