Skip to main content
Ctrl+K

graintrace

  • Getting started
  • Tutorials
  • Algorithms & theory
  • Guides
  • API reference
  • GitHub
  • Getting started
  • Tutorials
  • Algorithms & theory
  • Guides
  • API reference
  • GitHub

Section Navigation

Reconstruction & meshing

  • graintrace.construct_voronoi_mesh
  • graintrace.construct_nf_mesh
  • graintrace.construct_voxel_mesh
  • graintrace.nf_grid_conversion
  • graintrace.generate_random_crystal
  • graintrace.synthetic_hedm_generator
  • graintrace.neper_env
  • graintrace.doctor

Stitching

  • graintrace.scan_stitching_comparison
  • graintrace.hedm_stitching_techniques

Simulation & calibration

  • graintrace.run_cpfe_simulation
  • graintrace.grid_resampling
  • graintrace.material_calibration
  • graintrace.taylor
  • graintrace.base_material_approximation
  • graintrace.experiment_rotation_helper
  • graintrace.orientation_helper

Post-processing

  • graintrace.simulation_postprocessing
  • graintrace.experiment_postprocessing
  • graintrace.plot_postprocessing
  • graintrace.ipf_postprocess
  • graintrace.ipf_orientation_tracking

Rare-event identification

  • graintrace.rare_cluster_indicator
  • graintrace.graph_spatial_cluster
  • graintrace.cluster_indicator
  • graintrace.similarity_metric_library
  • graintrace.rare_criteria_selection_library
  • graintrace.rei_comparison
  • graintrace.user_data_class

Grain tracking & fragmentation

  • graintrace.grain_graph_matching
  • graintrace.tess_to_gnn
  • graintrace.fragmentation

Near-field subpackage

  • graintrace.nf
  • API reference

API reference#

The API documentation for graintrace, grouped by workflow stage. The public top-level names (importable as graintrace.<Name>) are defined by _LAZY_EXPORTS in graintrace/__init__.py.

Reconstruction & meshing

  • graintrace.construct_voronoi_mesh
  • graintrace.construct_nf_mesh
  • graintrace.construct_voxel_mesh
  • graintrace.nf_grid_conversion
  • graintrace.generate_random_crystal
  • graintrace.synthetic_hedm_generator
  • graintrace.neper_env
  • graintrace.doctor

Stitching

  • graintrace.scan_stitching_comparison
  • graintrace.hedm_stitching_techniques

Simulation & calibration

  • graintrace.run_cpfe_simulation
  • graintrace.grid_resampling
  • graintrace.material_calibration
  • graintrace.taylor
  • graintrace.base_material_approximation
  • graintrace.experiment_rotation_helper
  • graintrace.orientation_helper

Post-processing

  • graintrace.simulation_postprocessing
  • graintrace.experiment_postprocessing
  • graintrace.plot_postprocessing
  • graintrace.ipf_postprocess
  • graintrace.ipf_orientation_tracking

Rare-event identification

  • graintrace.rare_cluster_indicator
  • graintrace.graph_spatial_cluster
  • graintrace.cluster_indicator
  • graintrace.similarity_metric_library
  • graintrace.rare_criteria_selection_library
  • graintrace.rei_comparison
  • graintrace.user_data_class

Grain tracking & fragmentation

  • graintrace.grain_graph_matching
  • graintrace.tess_to_gnn
  • graintrace.fragmentation

Near-field subpackage

  • graintrace.nf

previous

Building & testing the docs

next

graintrace.construct_voronoi_mesh

Show Source

© Copyright 2026, Argonne National Laboratory.

Built with the PyData Sphinx Theme 0.23.0.