🧰 RMI 360 Imaging Workflow Python Toolbox

A modular workflow built with ArcGIS Python Toolbox for processing and deploying 360° corridor imagery.

Optimized for Mosaic 51 cameras, with planned support for Insta360. Includes tools for OID creation, AWS publishing, and detailed reporting.

❗ ArcGIS Pro Note: When adding the Toolbox to ArcGIS Pro, you may see a warning icon (❗) upon loading. If this occurs, simply remove the Toolbox and add it again to resolve the issue. New: The rmi_360_env_checker.pyt toolbox is now included to check for all required Python libraries in your ArcGIS Pro environment before running the main tools.

Tested using ArcGIS Pro 3.4.3 and 3.5.4. Be sure to check that your ArcGIS Pro Python Environment has the dependencies in requirements.txt

ℹ️ The “Oriented Imagery” tools require Standard or Advanced licenses. All other functions are available with Basic or higher.

⚠️ Unit Tests Note: Many unit tests may currently be broken due to some bug fixes in this release.

---

📦 Overview

• 🎞️ Processes captured imagery using Mosaic Processor (with support for MistikaVR or MosaicStitcher)
• 🧭 ArcGIS Oriented Imagery Dataset (OID) creation and enrichment
• 🏷️ EXIF metadata tagging
• 🛣️ Linear referencing support for image positioning
• 🧩 Custom attributing based on config-driven logic
• 🌍 Geocoding of image locations using spatial reference datasets
• 🗂️ File renaming and organization
• ☁️ AWS S3 upload with resumable transfer logic
• 📈 Lambda-based progress monitoring and status dashboard
• 📊 HTML & JSON reporting of process steps and status

⚠️ Image Enhancement Removed: Post-stitch image enhancement has been removed due to technical limitations that caused visible seam lines in panoramic imagery. Enhancement should occur before or during the stitching process for optimal results.

---

🧩 Key Features

Feature	Description
Toolbox Structure	Built as an ArcGIS .pyt Toolbox + modular tool wrappers & utilities
Config-Driven	YAML-based config with expression resolution and field registries
AWS Integration	Upload to S3 with TransferManager + Lambda schedule tracking
Resumable Transfers	Upload interruption protection + log recovery
HTML & JSON Reporting	Auto-generated step summaries and final status reports
Image Metadata Support	Auto tag EXIF metadata + rename by GPS, time, reel, frame, etc.

---

📁 Repository Structure

rmi-360-workflow-pyt/
├── rmi_360_workflow.pyt                # ArcGIS Python Toolbox
├── rmi_360_env_checker.pyt             # ArcGIS Python Toolbox for environment checking
├── configs/
│   ├── config.sample.yaml              # Config template
│   └── esri_oid_fields_registry.yaml   # ESRI OID field definitions
├── tools/                              # ArcGIS tool wrappers
├── utils/                              # Reusable logic
│   ├── manager/                        # Managers (ConfigManager, LogManager, PathManager, ProgressorManager)
│   ├── shared/                         # Shared utilities
│   └── validators/                     # Validators
├── aws_lambdas/                        # Lambda upload status functions
├── templates/                          # HTML report templates
├── legacy_docs/                        # Full documentation set
├── docs/                               # Updated documentation set  (TODO: implement using sphinx)
├── dev_docs/                           # Future development documentation

---

✅ Quick Start (Dev Mode)

git clone https://github.com/camrex/rmi-360-workflow-pyt.git
cd rmi-360-workflow-pyt

# Copy and edit config
cp configs/config.sample.yaml configs/config.yaml

---

🧭 ArcGIS Pro Environment Setup

1. Open ArcGIS Pro and load a project (.aprx).

2. Verify Python Environment: In the Catalog pane, right-click Toolboxes → Add Toolbox, and add rmi_360_env_checker.pyt. Run the Check Required Python Packages tool to ensure all required libraries are installed. If any libraries are missing, install them using the Python Command Prompt or the ArcGIS Pro Package Manager before proceeding.

3. Add the Workflow Toolbox: Again in the Catalog pane, right-click Toolboxes → Add Toolbox, and add rmi_360_workflow.pyt.

4. Access the Toolbox Tools: Tools are grouped under:

   • Setup
   • Individual Tools
   • Orchestrator

5. Use individual tools or run the full pipeline with ProcessMosaic360Workflow.

---

🎞 Mosaic Processor Usage Notes

• The RunMosaicProcessorTool wraps the Mosaic CLI (requires Mosaic Processor + MistikaVR).
• It executes two passes:
  • Image rendering and reel fixing
  • GPX integration to embed GPS
• Requires .grp calibration file (provided by Mosaic) and raw .mp4 input folders.

---

📖 Documentation

📚 Complete Documentation - Comprehensive Sphinx-generated documentation including:

• 🚀 User Guide: Installation, configuration, and quick start
• 🛠️ Tools Documentation: Detailed tool guides and usage
• ⚙️ Configuration: Complete configuration reference
• ☁️ AWS Integration: Setup guides and best practices
• 📋 API Reference: Full Python API documentation
• 👨‍💻 Developer Guide: Contributing and architecture

Legacy Documentation

Note: The documentation below is being migrated to the new Sphinx system. For the most up-to-date information, please refer to the Complete Documentation above.

• 📘 Toolbox Overview
• 🔧 Tool Guides
• ⚙️ Configuration Guide
• 🧰 Shared Utilities
• ☁️ AWS Setup Guide
• 📋 Schema Changelog
• 📄 TODO (Developer Tasks)
• 📝 Changelog
• 🛣 Roadmap

Building Documentation Locally

# Install documentation dependencies
pip install sphinx sphinx_rtd_theme

# Build documentation
cd docs
make html

# View documentation
# Open docs/_build/html/index.html in your browser

---

📝 License

Licensed under the MIT License. © 2025 RMI Valuation.

This project integrates with external proprietary software (e.g., ArcGIS Pro, Mosaic Processor, MistikaVR). Use of those tools is governed by their respective licenses and is not covered by this repository's license.