multi-recording-results

Multi-recording results data reference

Complete output data format documentation for the multi-recording (cross-recording) cindra ROI tracking pipeline.

---

Scope

Covers:

• Complete output data reference: every file, directory, array shape, dtype, and NPZ key produced by the pipeline
• Directory structure for per-recording multi-recording output
• Processing phase and file creation timeline
• Data serialization formats (ROIMask, ROIStatistics)
• Data type conventions and memory-mapping guidance
• Output completeness verification

Does not cover:

• Configuration parameters or prerequisites (see /multi-recording-configuration)
• Processing workflow, batch operations, or status monitoring (see /multi-recording-processing)
• Single-recording output data formats (see /single-recording-results)

---

Available tools

Use these cindra MCP tools to query and verify multi-recording output data programmatically. Prefer these over manual file reads whenever possible.

Verification tool

Tool	Purpose
verify_multi_recording_output_tool	Verifies completeness of all expected output files per dataset

Query tools

Tool	Purpose
query_multi_recording_overview_tool	Queries dataset structure, per-recording mask counts, timing, and completion status
query_multi_recording_registration_quality_tool	Queries deformation field statistics and transformed image availability per recording
query_multi_recording_tracking_summary_tool	Queries template count, recording count distribution, and cluster statistics
query_roi_statistics_tool	Queries per-ROI spatial statistics (use dataset parameter for multi-recording)
query_traces_tool	Queries fluorescence traces for specific ROIs (use dataset parameter for multi-rec)
query_cross_recording_traces_tool	Queries fluorescence traces for specific ROIs across all recordings in a dataset

Recommended query order

1. query_multi_recording_overview_tool — understand dataset composition and processing completeness
2. query_multi_recording_registration_quality_tool — review deformation field magnitudes and transformed image availability
3. query_multi_recording_tracking_summary_tool — review template counts, cluster IDs, and recording count distribution
4. query_roi_statistics_tool (with dataset parameter) — inspect per-ROI spatial statistics and tracking metadata
5. query_traces_tool (with dataset parameter) — examine tracked ROI fluorescence activity per recording
6. query_cross_recording_traces_tool — compare longitudinal activity patterns for the same ROIs across sessions

Important: Deformation field magnitude does not indicate registration quality — it only reflects how much the field of view shifted between sessions. Similarly, an ROI appearing in fewer recordings does not indicate tracking failure — ROIs can be active in some sessions and inactive in others. The only reliable way to assess cross-day registration quality is visual inspection: confirm that backward-deformed templates overlap with the same structures across days. Use /visualization for this.

---

Output data reference

All results are saved under {cindra_root}/multi_recording/{dataset_name}/ within each recording's cindra output directory. The pipeline produces per-recording output for every recording, plus a shared configuration file in the main recording (first after natural sorting). Channel 2 files are only present for dual-channel recordings where both channels are functional.

Directory structure

{cindra_root}/multi_recording/{dataset_name}/
├── multi_recording_configuration.yaml                     # Shared config (main recording only)
├── multi_recording_runtime_data.yaml                      # Per-recording runtime metadata
├── registration_arrays/                            # Diffeomorphic registration data
│   ├── deform_field_y.npy
│   ├── deform_field_x.npy
│   ├── transformed_mean_image.npy
│   ├── transformed_enhanced_mean_image.npy
│   └── transformed_maximum_projection.npy
├── registration_deformed_masks.npz                 # Forward-deformed ROI masks
├── tracking_template_masks.npz                     # Consensus template masks
├── roi_masks.npz                                   # Backward-transformed extraction masks
├── roi_statistics.npz                              # Backward-transformed shape statistics
├── cell_fluorescence.npy                           # Extracted fluorescence traces
├── neuropil_fluorescence.npy
├── subtracted_fluorescence.npy
├── spikes.npy
└── cell_colocalization.npy                         # Dual-channel only

Processing phase and file creation timeline

Phase 1 — Discovery: Executed once across all recordings. Creates multi_recording_configuration.yaml (main recording only), multi_recording_runtime_data.yaml for each recording, and runs the following sub-steps:

1. Context resolution: Creates output directories, saves configuration and initial runtime data.
2. ROI selection: Filters single-recording ROIs by probability, size, and MROI margins. Updates multi_recording_runtime_data.yaml with selected ROI indices.
3. Registration: Computes diffeomorphic deformation fields, transforms reference images and selected ROI masks to shared visual space. Creates registration_arrays/ and registration_deformed_masks.npz.
4. Tracking: Clusters deformed masks across recordings using Jaccard distance and hierarchical clustering. Creates tracking_template_masks.npz.
5. Backward projection: Applies inverse deformation to project template masks back to each recording's native coordinate system. Creates roi_masks.npz and roi_statistics.npz.

Phase 2 — Extraction: Executed independently per recording (parallelizable). Extracts fluorescence from registered binary data using backward-transformed template masks. Creates cell_fluorescence.npy, neuropil_fluorescence.npy, subtracted_fluorescence.npy, spikes.npy, and optionally cell_colocalization.npy.

---

Registration arrays

Saved in registration_arrays/ subdirectory. All files are .npy format, float32 dtype.

Deformation fields:

File	Shape	Description
deform_field_y.npy	(height, width)	Y-dimension displacement field for diffeomorphic warping
deform_field_x.npy	(height, width)	X-dimension displacement field for diffeomorphic warping

Channel 1 transformed images:

File	Shape	Description
transformed_mean_image.npy	(height, width)	Mean image warped to shared visual space
transformed_enhanced_mean_image.npy	(height, width)	Enhanced mean image warped to shared visual space
transformed_maximum_projection.npy	(height, width)	Maximum projection warped to shared visual space

Channel 2 transformed images (dual-channel only, same shape and dtype):

File	Description
transformed_mean_image_channel_2.npy	Channel 2 mean image in shared space
transformed_enhanced_mean_image_channel_2.npy	Channel 2 enhanced mean in shared space
transformed_maximum_projection_channel_2.npy	Channel 2 max projection in shared space

---

Registration deformed masks

File: registration_deformed_masks.npz (channel 1), registration_deformed_masks_channel_2.npz (channel 2)

Uses the ROIMask.save_list() serialization format. Contains the selected single-recording ROI masks after forward deformation to the shared visual space.

NPZ key	Dtype	Shape	Description
pixel_counts	uint32	(num_rois,)	Number of pixels in each deformed ROI
y_pixels	int32	(total_pixels,)	Y-coordinates of all ROI pixels (concatenated)
x_pixels	int32	(total_pixels,)	X-coordinates of all ROI pixels (concatenated)
pixel_weights	float32	(total_pixels,)	Spatial filter weights for each pixel
centroids	int32	(num_rois, 2)	ROI centroid coordinates (y, x) in shared space
radius	float32	(num_rois,)	Fitted radius per ROI
cluster_id	uint32	(num_rois,)	Tracking cluster ID (0 = unclustered)
recording_count	uint16	(num_rois,)	Number of recordings ROI appears in
frame_width	uint32	(1,)	Frame width in pixels

---

Tracking template masks

File: tracking_template_masks.npz (channel 1), tracking_template_masks_channel_2.npz (channel 2)

Uses the same ROIMask.save_list() serialization format as deformed masks. Contains consensus template masks generated by clustering deformed ROI masks across recordings. Each template represents an ROI reliably identified across multiple recordings. cluster_id uniquely identifies each tracked ROI. recording_count records how many recordings contributed to the template.

---

Backward-transformed extraction data (roi_masks.npz, roi_statistics.npz)

Saved at the multi_recording output root. Uses the same ROIStatistics.save_list() serialization format as single-recording output. Contains template masks projected back to the recording's native coordinate system via inverse deformation, with full shape statistics computed for each ROI.

roi_masks.npz — same NPZ keys and dtypes as the tracking template masks (see above).

roi_statistics.npz:

NPZ key	Dtype	Shape	Description
footprints	uint16	(num_rois,)	Set to pixel_count for tracked ROIs (bypass detection)
compactness	float32	(num_rois,)	Ratio of actual to expected mean radius (1.0=circular)
solidity	float32	(num_rois,)	Ratio of soma pixels to convex hull area
pixel_count	uint32	(num_rois,)	Total pixels in complete ROI
aspect_ratio	float32	(num_rois,)	Ellipse axis ratio indicating elongation
normalized_pixel_count	float32	(num_rois,)	Pixel count normalized by expected ROI size (soma)
skewness	float32	(num_rois,)	Neuropil-corrected fluorescence skewness
plane_index	int32	(num_rois,)	Imaging plane index for each ROI

Channel 2 uses identical keys in roi_masks_channel_2.npz and roi_statistics_channel_2.npz.

---

Fluorescence traces

Saved at the multi_recording output root. All files are .npy format, float32 dtype.

Channel 1 (always present):

File	Shape	Description
cell_fluorescence.npy	(num_rois, frames)	Lambda-weighted somatic fluorescence traces
neuropil_fluorescence.npy	(num_rois, frames)	Neuropil fluorescence traces
subtracted_fluorescence.npy	(num_rois, frames)	Neuropil-and-baseline-subtracted fluorescence
spikes.npy	(num_rois, frames)	Deconvolved spike estimates

Channel 2 (dual-channel only, same shapes):

File	Description
cell_fluorescence_channel_2.npy	Channel 2 somatic fluorescence
neuropil_fluorescence_channel_2.npy	Channel 2 neuropil fluorescence
subtracted_fluorescence_channel_2.npy	Channel 2 subtracted fluorescence
spikes_channel_2.npy	Channel 2 deconvolved spikes

If spike_deconvolution.extract_spikes is False, subtracted_fluorescence.npy and spikes.npy are filled with zeroes.

Optional colocalization file (dual-channel only):

File	Shape	Description
cell_colocalization.npy	(num_rois, 2)	Column 0: is_colocalized label (1.0 or 0.0), column 1: probability

---

Per-recording runtime metadata (multi_recording_runtime_data.yaml)

A YAML file containing scalar metadata from all processing stages. Array fields are set to None in the YAML and saved as separate .npy/.npz files (documented above).

Section	Key fields
io	recording_id, data_path, dataset_name, mroi_region_borders, dataset_output_paths, selected_roi_indices, selected_roi_indices_channel_2
registration	deform_field_y, deform_field_x, transformed_mean_image, transformed_enhanced_mean_image, transformed_maximum_projection (and *_channel_2 variants), deformed_roi_masks, deformed_roi_masks_channel_2 — all array fields, set to None in YAML because their data is saved separately as .npy files in registration_arrays/ and .npz files at the dataset root
tracking	template_masks, template_masks_channel_2, template_diameter, template_diameter_channel_2 (mask fields saved as NPZ, set to None in YAML)
timing	registration_time, tracking_time, backward_transform_time, total_discovery_time, extraction_time, deconvolution_time, total_extraction_time, date_processed, python_version, cindra_version

---

Data type conventions

Category	Dtype	Examples
Pixel coordinates	int32	y_pixels, x_pixels, centroids
Images and traces	float32	transformed images, fluorescence, spikes, correlations
Counts / dimensions	uint32	pixel_counts, cluster_id, frame_width
Small counts	uint16	footprints, recording_count
Plane indices	int32	plane_index
Plane counts	uint8	plane_count
Deformation fields	float32	deform_field_y, deform_field_x

All .npy files are saved with allow_pickle=False. Arrays support memory-mapped loading via np.load(path, mmap_mode='r+') for efficient access to large datasets. NPZ archives do not support memory mapping and are always eagerly loaded.

---

Related skills

Skill	Relationship
/multi-recording-configuration	Configuration parameter reference for the multi-recording pipeline
/multi-recording-processing	Processing workflow that produces this output
/single-recording-results	Companion output data reference for the single-recording pipeline
/visualization	Launch viewers and query tools to visualize and inspect this output data

---

Verification checklist

Use verify_multi_recording_output_tool to automate this verification. The tool checks all expected files and NPZ keys across every recording in the dataset and returns a completeness verdict with any missing items listed. Fall back to the manual checklist below only if the MCP tool is unavailable.

Multi-Recording Output Completeness:

Shared files (main recording only):
- [ ] `multi_recording_configuration.yaml` exists

Per-recording files (every recording):
- [ ] `multi_recording_runtime_data.yaml` exists with non-zero timing fields

Registration data (per recording):
- [ ] `registration_arrays/deform_field_y.npy` exists
- [ ] `registration_arrays/deform_field_x.npy` exists
- [ ] `registration_arrays/transformed_mean_image.npy` exists
- [ ] `registration_arrays/transformed_enhanced_mean_image.npy` exists
- [ ] `registration_arrays/transformed_maximum_projection.npy` exists
- [ ] `registration_deformed_masks.npz` exists and contains `pixel_counts`, `y_pixels`, `x_pixels` keys
- [ ] Channel 2 registration files exist if dual-channel

Tracking data (per recording, identical across recordings):
- [ ] `tracking_template_masks.npz` exists and contains `pixel_counts`, `cluster_id`, `recording_count` keys
- [ ] Channel 2 tracking files exist if dual-channel

Extraction data (per recording):
- [ ] `roi_masks.npz` exists with backward-transformed template masks
- [ ] `roi_statistics.npz` exists with shape statistics
- [ ] `cell_fluorescence.npy` exists with shape (num_rois, num_frames)
- [ ] `neuropil_fluorescence.npy` exists with shape matching cell_fluorescence
- [ ] `subtracted_fluorescence.npy` exists with shape matching cell_fluorescence
- [ ] `spikes.npy` exists with shape matching cell_fluorescence
- [ ] Channel 2 trace files exist if dual-channel
- [ ] `cell_colocalization.npy` exists if dual-channel with shape (num_rois, 2)
- [ ] Fluorescence trace shapes are consistent across all per-recording files