Outputs¶
Common Output Files¶
| Output | Created when | Meaning | Main code |
|---|---|---|---|
planes.json |
planes exist | serialized plane geometry, label_name, and attached summaries |
autoflow/core/pipeline.py |
planes.h5 |
planes exist | one root group per plane with geometry, label_name, path metadata, metrics, and a payload_json mirror |
autoflow/plane_io.py, autoflow/core/pipeline.py |
plane_positions.json |
planes exist | portable v2 plane coordinates with world/local centers, normal, source geometry, group, path rank, and relative path position | autoflow/plane_io.py |
plane_metrics.json |
plane metrics run | time-resolved plane metrics with explicit plane_index values |
autoflow/core/pipeline.py |
plane_qc.json |
plane metrics run | fork and path QC | autoflow/core/pipeline.py |
plane_metrics_pixelwise.h5 |
plane metrics run | per-plane pixelwise derived samples | autoflow/core/pipeline.py |
pwv.json |
PWV runs successfully | PWV fit results for each configured PWV group | autoflow/core/pipeline.py, autoflow/algorithms/pwv.py |
pwv_<group>.png |
PWV plotting succeeds | per-group two-panel plot with time-to-foot fit and all plane flowrate waveforms | autoflow/algorithms/pwv.py |
derived_metrics_pixelwise.npz |
derived metrics run | whole-volume WSS, pressure-gradient intermediates, reconstructed relative pressure, optional TKE, and requested vortex-kinematics arrays (uncompressed NPZ for faster export) | autoflow/processing.py |
quality_report.json |
every processed case | staged automated QC with pass, warn, fail, or not_run checks and suggested review actions |
autoflow/quality.py, autoflow/processing.py |
summary.json |
every processed case; also updated by GUI video export when present | single-case summary including request flags plus stage and video timings | autoflow/processing.py, autoflow/ui/app.py |
phase_unwrap.npz |
optional phase-unwrapping run | wrapped/unwrapped phase, flow, signed wrap_count, wrap_mask, and mask_used |
autoflow/processing.py |
batch_report.json |
batch run | batch summary report | autoflow/api.py, autoflow/processing.py |
time_summary.txt |
batch run | timing summary | autoflow/api.py, autoflow/processing.py |
Video Outputs¶
| Output | Created when | Meaning |
|---|---|---|
planes_rotate.mp4 |
plane video export requested from CLI, Python API, or GUI |
rotating plane overview with configurable index labels that default to planeidx=<index>; MP4 only |
streamlines_video.mp4 or streamlines_rotate.mp4 |
streamlines video export requested from CLI, Python API, or GUI |
time-resolved streamline movie |
wss_video.mp4 or wss_rotate.mp4 |
wss video export requested from CLI, Python API, or GUI |
WSS movie |
tke_video.mp4 or tke_rotate.mp4 |
tke video export requested and TKE available |
TKE movie |
pressure_gradient_video.mp4 or pressure_gradient_rotate.mp4 |
pg video export requested from CLI, Python API, or GUI |
pressure-gradient movie |
relative_pressure_video.mp4 or relative_pressure_rotate.mp4 |
pg video export requested from CLI, Python API, or GUI |
relative-pressure movie |
Segmentation Sidecars¶
| Output | Created when | Meaning |
|---|---|---|
*_threshold_segmentation.h5 |
threshold segmentation succeeds | saved threshold segmentation |
source input H5 segmask dataset |
auto segmentation succeeds on an H5 input | embedded reusable auto segmentation cache written back into the source H5 |
*_auto_segmentation.nii.gz |
auto segmentation succeeds | saved predicted segmentation NIfTI used by the run in the same HF/AP/RL geometry convention used by the nnUNet training/export scripts |
*_auto_segmentation_feature_*.nii.gz |
static 3D auto segmentation succeeds | saved nnUNet feature-channel NIfTI inputs; grouped 4D preprocessing keeps temporary source maps out of the output directory |
| user-selected H5, NPY, or NPZ file | Segmentation dock Source -> Save... |
manual save of the active segmentation |
Notes¶
derived_metrics_pixelwise.npzstores whole-volume derived arrays- When
vortexis requested,derived_metrics_pixelwise.npzincludesvorticity,vorticity_magnitude,q_criterion,swirling_strength, their phase-peak arrays, andvortex_support_mask. plane_metrics_pixelwise.h5stores per-plane slice-cellwise samples- TKE outputs remain optional and are absent for inputs that do not carry TKE
pwv.jsonis also mirrored intosummary.jsonaspwv_results,pwv_file, andpwv_plot_filessummary.jsonrecordsrequested_metrics,requested_videos,stage_times_sec,video_times_sec,pressure_method,centerline_pressure_profiles, and the generated quality reportsummary.jsonalso records optionalphase_unwrapmethod/device, skip reason, elapsed time, and wrap statistics- multi-group H5 inputs write separate case subdirectories whose names include the H5 data-group path
- GUI
Export Videos...also updatessummary.jsonwith refreshedvideos, refreshedvideo_times_sec, and agui_video_exportrecord for that export run planes.jsonandplanes.h5store per-planelabel_namefromlabel_mappluspath_infowhen path metadata is available; grouped multi-label workflows can therefore expose both readable plane labels andpath_info.group_namein those filesplanes.h5stores each plane as a root group such asplane_0000,plane_0001, and mirrors the full record again aspayload_jsoninside that group- GUI scene objects are not saved files, but grouped workflows keep stable internal keys such as
segmask_group_<group>,skeleton_<group>,graph_<group>,smooth_path_<group>_<path_idx>,plane_<group>_<plane_idx>, andpathline_<group>_<plane_idx>while showing shorter browser-visible names likeplane 5andpathline 5 - PWV scene planes are represented as one grouped browser object named
PWV planes plane_positions.jsonuses schemaautoflow.plane_positions.v2;center_world_mmis meaningful across cases only when their AutoFlow canonical world-mm frames are registered- offline video export writes MP4 only; no GIF fallback is generated