Data Export Guide
The Voyager API provides multiple methods for exporting your CT scan data. This guide covers all export options and helps you choose the right method for your use case.Export Methods Overview
Voyager offers three main export methods:| Method | Data Scope | Resolution | Output Format | Best For |
|---|---|---|---|---|
| Project Export | Entire project | Original | Zipped folder | Complete backups, archiving |
| Data View Export | Single volume | Downsampled | NRRD | Quick analysis, visualization |
| Individual File Export | Single file | Original | Various | Selective downloads |
Project Export
Project export creates a comprehensive ZIP archive containing all project data.What’s Included
- Meshes: STL, GLB, PLY formats
- Volumes: Full-resolution TIFF stacks and NRRD files
- Radiographs: Original scan images
- Surface Captures: Texture data
- Metadata: Project information and analysis results
Requesting an Export
- Python
- Python Client
Checking Export Status
Project exports are asynchronous and can take 5-30+ minutes. Poll the status endpoint:- Python
- Python Client
Downloading the Export
Once ready, download the ZIP archive:Downloading Data Views
Data views are one of the most efficient ways to download volume data. They provide downsampled, single-file NRRD volumes that are perfect for quick analysis and visualization.Complete Data View Download Example
Here’s a complete example for downloading a data view:- Python
- Python Client
Data View Workflow
The data view download process:- Get project - Retrieve project details to find volume documents
- Find volume - Locate the volume document you want to export
- Get data object ID - Extract the data object ID from the volume document
- Request data view - Call
/api/v2/data/{id}/viewwith parameters - Download file - Download the NRRD file from the returned URL
Data View Parameters Explained
outputFormat: Choose"nrrd"(recommended),"raw", or"tiff"max_voxel_count: Limits total voxels (lower = smaller files)- Default: 1 billion (1,000,000,000)
- For web visualization: 10-50 million
- For quick analysis: 100-500 million
max_dimension_size: Maximum size per dimension (default: 2048)mapped_percentile_range: Intensity mapping[min, max](default:[0.2, 99.8])skip_normalization: Skip normalization step (default:false)
Why Use Data Views?
Data views offer significant advantages:- Single file - NRRD format is a single file vs. multi-file TIFF stacks
- Smaller size - Typically 10-1000x smaller than full volumes
- Faster downloads - Much quicker to download and process
- Web-friendly - NRRD works well for web visualization
- Cached - Subsequent requests use cached data (faster)
Data View vs. Full Volume Export
| Feature | Data View | Full Volume Export |
|---|---|---|
| File Format | Single NRRD file | Multi-file TIFF stack |
| File Size | 1-500 MB | 100 MB - 50+ GB |
| Resolution | Downsampled | Full resolution |
| Download Time | Seconds to minutes | Minutes to hours |
| Use Case | Quick analysis, visualization | Detailed analysis, research |
Data View Export
Data views provide downsampled volume data optimized for quick analysis and visualization. This is one of the most efficient ways to download volume data when you don’t need full resolution.When to Use Data Views
- Quick data exploration - Analyze data without downloading full-resolution volumes
- Web-based visualization - NRRD format is web-friendly and loads quickly
- Testing workflows - Use smaller datasets to test your analysis pipelines
- Reduced storage - Data views are typically 10-1000x smaller than full volumes
- Performance-critical applications - Faster downloads and processing
Understanding Data Views
Data views are cached, downsampled representations of volume data:- First request: Triggers computation (may take longer)
- Subsequent requests: Uses cached data (much faster)
- Format: Single NRRD file (vs. multi-file TIFF stacks for full volumes)
- Size: Typically 1-500 MB (vs. 100 MB - 50+ GB for full volumes)
Requesting and Downloading a Data View
- Python
- Python Client
Data View Parameters
outputFormat:"nrrd"(default),"raw", or"tiff"max_voxel_count: Maximum number of voxels (default: 1 billion)max_dimension_size: Maximum dimension size (default: 2048)mapped_percentile_range: Intensity mapping range[min, max](default:[0.2, 99.8])skip_normalization: Skip normalization (default:false)
Individual File Export
Download specific files from data objects using pre-signed URLs.Getting a Download URL
- Python
- Python Client
Finding Available Files
To find available files in a data object:Export Formats
Mesh Formats
- STL: Standard triangulation format (binary/ASCII)
- GLB: glTF binary format (with textures)
- PLY: Polygon file format (supports colors/normals)
- Deviation PLY: Color-coded comparison meshes
Volume Formats
- TIFF Stack: Multi-file volume data (one slice per file)
- NRRD: Single-file volume format (for data views)
- RAW: Raw binary volume data
Analysis Results
- CSV: Tabular analysis data (Excel-compatible)
- JSON: Structured metadata and results
- PLY: 3D visualization meshes
Required Capabilities
Some export operations require specific capabilities:PROJECT_DATA_EXPORT: Required for project exportsEXPORT_VOLUME: Required for volume exportsEXPORT_POROSITY_DATA: Required for porosity analysis exportsEXPORT_CRACK_DETECTION_DATA: Required for crack analysis exports
Best Practices
1. Export Only What You Need
Select specific data types to reduce export size and time:2. Handle Large Exports
For large exports:- Use streaming downloads
- Monitor disk space
- Consider exporting during off-peak hours
- Use data views for quick analysis
3. Check Export Status
Always check export status before downloading:4. Error Handling
Handle common errors gracefully:Real-World Example
Complete example: Export all active projectsNext Steps
- Export All Projects Example - Complete script for bulk exports
- API Reference - Data Exports - Complete endpoint reference
- Error Handling - Learn about error responses