# fable-3dxrd/imaged11 architecture

> Architecture diagram of the GitHub repository fable-3dxrd/imaged11, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/fable-3dxrd/imaged11
- Repository: https://github.com/fable-3dxrd/imaged11

## Overview

ImageD11 is a Python toolkit for identifying individual grains from spotty area-detector X-ray diffraction images. A user’s analysis broadly proceeds from image correction and peak detection, through peak selection, crystallographic indexing and grain refinement, to grain and strain characterization. The repository also contains forward-modeling and sinogram/point-by-point reconstruction capabilities. The map combines sampled relationships with documented product scope; many listed subsystems were not sampled in full, so uncertain links are omitted.

Main entry points: [`ImageD11/peaksearcher.py`](https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/peaksearcher.py) (Peak search), [`ImageD11/columnfile.py`](https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/columnfile.py) (Peak columns), [`ImageD11/forward_model/forward_projector.py`](https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/forward_model/forward_projector.py) (Forward projection), [`ImageD11/sinograms/point_by_point.py`](https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/sinograms/point_by_point.py) (Point-by-point indexing)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_peaks["Peak processing"]
  node_peaksearch["Peak search<br/>[peaksearcher.py]"]
  node_correction["Image correction<br/>[correct.py]"]
  node_labelimage["Peak labeling<br/>[labelimage.py]"]
  node_blobcorrector["Blob correction<br/>[blobcorrector.py]"]
  node_peakselection["Peak selection<br/>[peakselect.py]"]
end

subgraph group_crystal["Crystallographic analysis"]
  node_unitcell["Unit cells<br/>[unitcell.py]"]
  node_indexing["Grain indexing<br/>[indexing.py]"]
  node_grains["Grain models<br/>[grain.py]"]
  node_refinement["Grain refinement<br/>[refinegrains.py]"]
end

subgraph group_recon["Reconstruction and mapping"]
  node_forward["Forward modeling<br/>[forward_model.py]"]
  node_forwardproject["Forward projection"]
  node_grainmaps["Grain mapping<br/>[grainmaps.py]"]
  node_sinodataset[("Scan dataset<br/>[dataset.py]")]
  node_sinogeometry["Scan geometry<br/>[geometry.py]"]
  node_pbp["Point-by-point indexing<br/>[point_by_point.py]"]
  node_tensor["Tensor maps<br/>[tensor_map.py]"]
  node_sinogram["Sinogram processing<br/>[sinogram.py]"]
end

subgraph group_foundation["Data and computation"]
  node_columns["Peak columns<br/>[columnfile.py]"]
  node_parameters["Analysis parameters<br/>[parameters.py]"]
  node_geometry["Diffraction geometry<br/>[transform.py]"]
  node_compute["Numerical kernels<br/>[cImageD11.py]"]
  node_forwardio["Scientific data I/O<br/>[io.py]"]
end

node_analyst(("Analyst"))

node_analyst -.->|"initiates analysis"| node_peaksearch
node_peaksearch -->|"corrects images"| node_correction
node_peaksearch -->|"labels peaks"| node_labelimage
node_peaksearch -->|"uses correction"| node_blobcorrector
node_peaksearch -.->|"emits peak data"| node_columns
node_columns -->|"loads parameters"| node_parameters
node_columns -->|"computes geometry"| node_geometry
node_peakselection -.->|"selects ring peaks"| node_unitcell
node_indexing -->|"builds from parameters"| node_unitcell
node_pbp -->|"creates indexer"| node_indexing
node_pbp -.->|"uses geometry"| node_sinogeometry
node_analyst -.->|"requests mapping"| node_pbp
node_forwardproject -->|"uses model"| node_forward
node_forwardproject -->|"uses grain maps"| node_grainmaps
node_forwardproject -->|"uses I/O"| node_forwardio
node_forward -->|"uses unit cell"| node_unitcell
node_grainmaps -->|"matches peaks"| node_forward
node_sinodataset -.->|"uses peak columns"| node_columns
node_tensor -->|"uses geometry"| node_sinogeometry
node_tensor -->|"uses sinograms"| node_sinogram
node_compute -.->|"provides kernels"| node_indexing
node_refinement -.->|"refines grains"| node_grains

click node_peaksearch "https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/peaksearcher.py"
click node_correction "https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/correct.py"
click node_labelimage "https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/labelimage.py"
click node_blobcorrector "https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/blobcorrector.py"
click node_peakselection "https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/peakselect.py"
click node_columns "https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/columnfile.py"
click node_parameters "https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/parameters.py"
click node_geometry "https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/transform.py"
click node_compute "https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/cImageD11.py"
click node_unitcell "https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/unitcell.py"
click node_indexing "https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/indexing.py"
click node_grains "https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/grain.py"
click node_refinement "https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/refinegrains.py"
click node_forward "https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/forward_model/forward_model.py"
click node_forwardproject "https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/forward_model/forward_projector.py"
click node_grainmaps "https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/forward_model/grainmaps.py"
click node_sinodataset "https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/sinograms/dataset.py"
click node_sinogeometry "https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/sinograms/geometry.py"
click node_pbp "https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/sinograms/point_by_point.py"
click node_tensor "https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/sinograms/tensor_map.py"
click node_sinogram "https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/sinograms/sinogram.py"
click node_forwardio "https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/forward_model/io.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_peaksearch,node_correction,node_labelimage,node_blobcorrector,node_peakselection toneBlue
class node_unitcell,node_indexing,node_grains,node_refinement toneAmber
class node_forward,node_forwardproject,node_grainmaps,node_sinodataset,node_sinogeometry,node_pbp,node_tensor,node_sinogram toneMint
class node_columns,node_parameters,node_geometry,node_compute,node_forwardio toneRose
class node_analyst toneIndigo
```

## Components

### Peak processing

- [Peak search](https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/peaksearcher.py): `ImageD11/peaksearcher.py`
- [Image correction](https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/correct.py): `ImageD11/correct.py`
- [Peak labeling](https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/labelimage.py): `ImageD11/labelimage.py`
- [Blob correction](https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/blobcorrector.py): `ImageD11/blobcorrector.py`
- [Peak selection](https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/peakselect.py): `ImageD11/peakselect.py`

### Crystallographic analysis

- [Unit cells](https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/unitcell.py): `ImageD11/unitcell.py`
- [Grain indexing](https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/indexing.py): `ImageD11/indexing.py`
- [Grain models](https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/grain.py): `ImageD11/grain.py`
- [Grain refinement](https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/refinegrains.py): `ImageD11/refinegrains.py`

### Reconstruction and mapping

- [Forward modeling](https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/forward_model/forward_model.py): `ImageD11/forward_model/forward_model.py`
- [Forward projection](https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/forward_model/forward_projector.py): `ImageD11/forward_model/forward_projector.py`
- [Grain mapping](https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/forward_model/grainmaps.py): `ImageD11/forward_model/grainmaps.py`
- [Scan dataset](https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/sinograms/dataset.py): `ImageD11/sinograms/dataset.py`
- [Scan geometry](https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/sinograms/geometry.py): `ImageD11/sinograms/geometry.py`
- [Point-by-point indexing](https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/sinograms/point_by_point.py): `ImageD11/sinograms/point_by_point.py`
- [Tensor maps](https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/sinograms/tensor_map.py): `ImageD11/sinograms/tensor_map.py`
- [Sinogram processing](https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/sinograms/sinogram.py): `ImageD11/sinograms/sinogram.py`

### Data and computation

- [Peak columns](https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/columnfile.py): `ImageD11/columnfile.py`
- [Analysis parameters](https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/parameters.py): `ImageD11/parameters.py`
- [Diffraction geometry](https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/transform.py): `ImageD11/transform.py`
- [Numerical kernels](https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/cImageD11.py): `ImageD11/cImageD11.py`
- [Scientific data I/O](https://github.com/fable-3dxrd/imaged11/blob/master/ImageD11/forward_model/io.py): `ImageD11/forward_model/io.py`

### Other components

- **Analyst**

## Connections

- Analyst → Peak search: initiates analysis
- Peak search → Image correction: corrects images (evidence: `ImageD11/peaksearcher.py`)
- Peak search → Peak labeling: labels peaks (evidence: `ImageD11/peaksearcher.py`)
- Peak search → Blob correction: uses correction (evidence: `ImageD11/peaksearcher.py`)
- Peak search → Peak columns: emits peak data
- Peak columns → Analysis parameters: loads parameters (evidence: `ImageD11/columnfile.py`)
- Peak columns → Diffraction geometry: computes geometry (evidence: `ImageD11/columnfile.py`)
- Peak selection → Unit cells: selects ring peaks (evidence: `ImageD11/peakselect.py`)
- Grain indexing → Unit cells: builds from parameters (evidence: `ImageD11/indexing.py`)
- Point-by-point indexing → Grain indexing: creates indexer (evidence: `ImageD11/sinograms/point_by_point.py`)
- Point-by-point indexing → Scan geometry: uses geometry (evidence: `ImageD11/sinograms/point_by_point.py`)
- Analyst → Point-by-point indexing: requests mapping
- Forward projection → Forward modeling: uses model (evidence: `ImageD11/forward_model/forward_projector.py`)
- Forward projection → Grain mapping: uses grain maps (evidence: `ImageD11/forward_model/forward_projector.py`)
- Forward projection → Scientific data I/O: uses I/O (evidence: `ImageD11/forward_model/forward_projector.py`)
- Forward modeling → Unit cells: uses unit cell (evidence: `ImageD11/forward_model/forward_model.py`)
- Grain mapping → Forward modeling: matches peaks (evidence: `ImageD11/forward_model/grainmaps.py`)
- Scan dataset → Peak columns: uses peak columns (evidence: `ImageD11/sinograms/dataset.py`)
- Tensor maps → Scan geometry: uses geometry (evidence: `ImageD11/sinograms/tensor_map.py`)
- Tensor maps → Sinogram processing: uses sinograms (evidence: `ImageD11/sinograms/tensor_map.py`)
- Numerical kernels → Grain indexing: provides kernels (evidence: `ImageD11/indexing.py`)
- Grain refinement → Grain models: refines grains
