# m-anagn/root_tracking_nikonax_confocal architecture

> Architecture diagram of the GitHub repository m-anagn/root_tracking_nikonax_confocal, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-20). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/m-anagn/root_tracking_nikonax_confocal
- Repository: https://github.com/m-anagn/root_tracking_nikonax_confocal

## Overview

This repository supports automated live root-tip tracking during confocal Z-stack acquisition, followed by offline fluorescence analysis. In the documented JOBS workflow, the upstream script analyzes each acquired slice and records measurements; the downstream script reads those records, selects a focus slice, computes safe stage targets, and repositions the microscope. A separate Fiji/ImageJ Groovy script processes the time-lapse and exports ROI fluorescence measurements. The analysis stages and JOBS wiring are documented in the README; their implementation details were not sampled.

Main entry points: [`tracking/Downstream.py`](https://github.com/m-anagn/root_tracking_nikonax_confocal/blob/main/tracking/Downstream.py) (Stack selection and movement), [`tracking/Upstream.py`](https://github.com/m-anagn/root_tracking_nikonax_confocal/blob/main/tracking/Upstream.py) (Slice tracking), [`Analysis/Root_tracking_processing.groovy`](https://github.com/m-anagn/root_tracking_nikonax_confocal/blob/main/Analysis/Root_tracking_processing.groovy) (Maximum projection)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_acquisition["Live acquisition"]
  node_jobs["NIS-Elements JOBS"]
  node_microscope["Confocal microscope"]
end

subgraph group_tracking["Root tracking"]
  node_upstream["Slice tracking<br/>[Upstream.py]"]
  node_slice_log[("Slice records<br/>[Upstream.py]")]
  node_downstream["Stack selection and movement<br/>[Downstream.py]"]
  node_tracking_results["Tracking reports<br/>[Downstream.py]"]
end

subgraph group_analysis["Image analysis"]
  node_time_lapse["Time-lapse dataset"]
  node_projection["Maximum projection"]
  node_registration["Bleach correction and registration"]
  node_root_rois["Root ROI generation"]
  node_fluorescence["Fluorescence measurements"]
  node_csv["Measurement CSV"]
end

node_operator(("Experiment operator"))

node_operator -->|"configures and runs"| node_jobs
node_jobs -->|"runs per slice"| node_upstream
node_jobs -->|"runs per point"| node_downstream
node_microscope -->|"provides image and position"| node_upstream
node_upstream -->|"appends records"| node_slice_log
node_slice_log -->|"reads records"| node_downstream
node_downstream -->|"repositions stage"| node_microscope
node_downstream -->|"writes reports"| node_tracking_results
node_operator -->|"imports manually"| node_time_lapse
node_time_lapse -->|"processes"| node_projection
node_projection -->|"continues processing"| node_registration
node_registration -->|"segments and analyzes skeleton"| node_root_rois
node_root_rois -->|"defines measurement regions"| node_fluorescence
node_fluorescence -->|"exports measurements"| node_csv

click node_upstream "https://github.com/m-anagn/root_tracking_nikonax_confocal/blob/main/tracking/Upstream.py"
click node_slice_log "https://github.com/m-anagn/root_tracking_nikonax_confocal/blob/main/tracking/Upstream.py"
click node_downstream "https://github.com/m-anagn/root_tracking_nikonax_confocal/blob/main/tracking/Downstream.py"
click node_tracking_results "https://github.com/m-anagn/root_tracking_nikonax_confocal/blob/main/tracking/Downstream.py"
click node_projection "https://github.com/m-anagn/root_tracking_nikonax_confocal/blob/main/Analysis/Root_tracking_processing.groovy"
click node_registration "https://github.com/m-anagn/root_tracking_nikonax_confocal/blob/main/Analysis/Root_tracking_processing.groovy"
click node_root_rois "https://github.com/m-anagn/root_tracking_nikonax_confocal/blob/main/Analysis/Root_tracking_processing.groovy"
click node_fluorescence "https://github.com/m-anagn/root_tracking_nikonax_confocal/blob/main/Analysis/Root_tracking_processing.groovy"
click node_csv "https://github.com/m-anagn/root_tracking_nikonax_confocal/blob/main/Analysis/Root_tracking_processing.groovy"

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_jobs,node_microscope toneBlue
class node_upstream,node_slice_log,node_downstream,node_tracking_results toneAmber
class node_time_lapse,node_projection,node_registration,node_root_rois,node_fluorescence,node_csv toneMint
class node_operator toneIndigo
```

## Components

### Live acquisition

- **NIS-Elements JOBS**
- **Confocal microscope**

### Root tracking

- [Slice tracking](https://github.com/m-anagn/root_tracking_nikonax_confocal/blob/main/tracking/Upstream.py): `tracking/Upstream.py`
- [Slice records](https://github.com/m-anagn/root_tracking_nikonax_confocal/blob/main/tracking/Upstream.py): `tracking/Upstream.py`
- [Stack selection and movement](https://github.com/m-anagn/root_tracking_nikonax_confocal/blob/main/tracking/Downstream.py): `tracking/Downstream.py`
- [Tracking reports](https://github.com/m-anagn/root_tracking_nikonax_confocal/blob/main/tracking/Downstream.py): `tracking/Downstream.py`

### Image analysis

- **Time-lapse dataset**
- [Maximum projection](https://github.com/m-anagn/root_tracking_nikonax_confocal/blob/main/Analysis/Root_tracking_processing.groovy): `Analysis/Root_tracking_processing.groovy`
- [Bleach correction and registration](https://github.com/m-anagn/root_tracking_nikonax_confocal/blob/main/Analysis/Root_tracking_processing.groovy): `Analysis/Root_tracking_processing.groovy`
- [Root ROI generation](https://github.com/m-anagn/root_tracking_nikonax_confocal/blob/main/Analysis/Root_tracking_processing.groovy): `Analysis/Root_tracking_processing.groovy`
- [Fluorescence measurements](https://github.com/m-anagn/root_tracking_nikonax_confocal/blob/main/Analysis/Root_tracking_processing.groovy): `Analysis/Root_tracking_processing.groovy`
- [Measurement CSV](https://github.com/m-anagn/root_tracking_nikonax_confocal/blob/main/Analysis/Root_tracking_processing.groovy): `Analysis/Root_tracking_processing.groovy`

### Other components

- **Experiment operator**

## Connections

- Experiment operator → NIS-Elements JOBS: configures and runs (evidence: `README.md`)
- NIS-Elements JOBS → Slice tracking: runs per slice (evidence: `README.md`)
- NIS-Elements JOBS → Stack selection and movement: runs per point (evidence: `README.md`)
- Confocal microscope → Slice tracking: provides image and position (evidence: `tracking/Upstream.py`)
- Slice tracking → Slice records: appends records (evidence: `tracking/Upstream.py`)
- Slice records → Stack selection and movement: reads records (evidence: `tracking/Downstream.py`)
- Stack selection and movement → Confocal microscope: repositions stage (evidence: `tracking/Downstream.py`)
- Stack selection and movement → Tracking reports: writes reports (evidence: `tracking/Downstream.py`)
- Experiment operator → Time-lapse dataset: imports manually (evidence: `README.md`)
- Time-lapse dataset → Maximum projection: processes (evidence: `README.md`)
- Maximum projection → Bleach correction and registration: continues processing (evidence: `README.md`)
- Bleach correction and registration → Root ROI generation: segments and analyzes skeleton (evidence: `README.md`)
- Root ROI generation → Fluorescence measurements: defines measurement regions (evidence: `README.md`)
- Fluorescence measurements → Measurement CSV: exports measurements (evidence: `README.md`)
