API：Python SDK

Chloros Python SDK 提供对Chloros图像处理引擎的编程访问，支持自动化、自定义工作流，并与您的Python应用程序及研究流程无缝集成。

核心特性

• 🐍 原生Python - 简洁的Python化图像处理接口

• 🔧 全功能访问 - 完全掌控图像处理流程

• 🚀 自动化 - 构建定制化批处理工作流

• 🔗 集成 - 将Chloros嵌入现有Python应用

• 📊 科研就绪 - 完美适配科学分析管道

• ⚡ 并行处理 - 扩展至CPU核心（Chloros+）

系统要求

要求	详细说明
Chloros桌面版	必须本地安装
许可证	Chloros+ (需付费方案)
操作系统	Windows 10/11 (64位)
Python	Python 3.7 或更高版本
内存	最低8GB RAM（推荐16GB）
网络连接	需联网激活许可证

{% 提示 style="warning" %}

许可证要求：Python SDK 需付费订阅 Chloros+ 才能访问 API。 标准（免费）方案不包含API/SDK访问权限。请访问https://cloud.mapir.camera/pricing进行升级。

快速入门

安装

通过 pip 安装：

pip install chloros-sdk

首次设置：使用SDK前，请通过Chloros+打开Chloros或Chloros (浏览器) 或 Chloros CLI 并使用凭证登录。此操作仅需执行一次。

基础用法

处理仅含少量内容的文件夹：

from chloros_sdk import process_folder

# One-line processing
results = process_folder("C:\\DroneImages\\Flight001")

全面控制

用于高级工作流：

from chloros_sdk import ChlorosLocal

# Initialize SDK
chloros = ChlorosLocal()

# Create project
chloros.create_project("MyProject", camera="Survey3N_RGN")

# Import images
chloros.import_images("C:\\DroneImages\\Flight001")

# Configure settings
chloros.configure(
    vignette_correction=True,
    reflectance_calibration=True,
    indices=["NDVI", "NDRE", "GNDVI"]
)

# Process images
chloros.process(mode="parallel", wait=True)

---

安装指南

先决条件

安装 SDK 前，请确保您已具备：

1. 已安装Chloros桌面版 (下载)

2. 已安装Python 3.7+ (python.org)

3. 有效的Chloros+许可证 (升级)

通过pip安装

标准安装：

pip install chloros-sdk

带进度监控支持：

pip install chloros-sdk[progress]

开发环境安装：

pip install chloros-sdk[dev]

安装验证

测试SDK是否正确安装：

import chloros_sdk
print(f"Chloros SDK version: {chloros_sdk.__version__}")

---

初始配置

许可证激活

SDK与Chloros、Chloros（浏览器版）及Chloros CLI共享同一许可证。 通过图形界面或CLI激活一次：

1. 打开Chloros或Chloros（浏览器版），在用户 标签页登录。或直接打开CLI。

2. 输入Chloros+凭证并登录

3. 许可证本地缓存（重启后仍有效）

{% 提示 style="success" %}

一次性设置：通过GUI或CLI登录后，SDK将自动使用缓存许可证。无需额外认证！

**注销**：用户可通过`logout()`方法以编程方式清除缓存凭证。详见API参考文档中的[logout()方法](#logout)。 {% 结束提示 %}

测试连接

验证SDK能否连接至Chloros：

from chloros_sdk import ChlorosLocal

# Initialize SDK (auto-starts backend if needed)
chloros = ChlorosLocal()

# Check status
status = chloros.get_status()
print(f"Backend running: {status['running']}")

---

API 参考

ChlorosLocal 类

本地 Chloros 图像处理的主类。

构造函数

ChlorosLocal(
    api_url="http://localhost:5000",     # Backend URL
    auto_start_backend=True,             # Auto-start backend if not running
    backend_exe=None,                    # Backend path (auto-detected)
    timeout=30,                          # Request timeout (seconds)
    backend_startup_timeout=60           # Backend startup timeout
)

参数：

参数	类型	默认值	描述
api_url	str	"http://localhost:5000"	本地Chloros后端的URL
auto_start_backend	布尔值	True	需要时自动启动后端
backend_exe	字符串	None (自动检测)	后端可执行文件路径
timeout	int	30	请求超时时间（秒）
backend_startup_timeout	int	60	后端启动超时时间（秒）

示例：

# Default (auto-start backend)
chloros = ChlorosLocal()

# Connect to running backend
chloros = ChlorosLocal(auto_start_backend=False)

# Custom backend path
chloros = ChlorosLocal(backend_exe="C:/Custom/chloros-backend.exe")

# Custom timeout
chloros = ChlorosLocal(timeout=60)

---

方法

create_project(project_name, camera=None)

创建新的Chloros项目。

参数：

参数	类型	是否必填	描述
project_name	字符串	是	项目名称
camera	字符串	否	相机模板（例如"Survey3N_RGN", "Survey3W_OCN")

返回值： dict - 项目创建响应示例：

# Basic project
chloros.create_project("DroneField_A")

# With camera template
chloros.create_project("DroneField_A", camera="Survey3N_RGN")

---

import_images(folder_path, recursive=False)

从文件夹导入图像。

参数：

参数	类型	必填	描述
folder_path	字符串/路径	是	图片所在文件夹路径
recursive	布尔值	否	搜索子文件夹（默认：假）

返回值： dict - 包含文件数量的导入结果示例：

# Import from folder
chloros.import_images("C:\\DroneImages\\Flight001")

# Import recursively
chloros.import_images("C:\\DroneImages", recursive=True)

---

configure(**settings)

配置处理设置。

参数：

参数	类型	默认值	描述
debayer	str	"高品质（更快）"	去拜耳化算法
vignette_correction	布尔值	True	启用晕影校正
reflectance_calibration	布尔值	True	启用反射率校准
indices	列表	None	待计算植被指数
export_format	字符串	"TIFF (16位)"	输出格式
ppk	布尔值	False	启用PPK校正
custom_settings	字典	None	高级自定义设置

导出格式：

• "TIFF (16-bit)" - 推荐用于GIS/摄影测量

• "TIFF (32-bit, Percent)" - 科学分析

• "PNG (8-bit)" - 可视化检查

• "JPG (8-bit)" - 压缩输出

**可用索引：**NDVI, NDRE, GNDVI, OSAVI, CIG, EVI, SAVI, MSAVI, MTVI2 等。示例：

# Basic configuration
chloros.configure(
    vignette_correction=True,
    reflectance_calibration=True,
    indices=["NDVI", "NDRE"]
)

# Advanced configuration
chloros.configure(
    debayer="High Quality (Faster)",
    vignette_correction=True,
    reflectance_calibration=True,
    ppk=True,
    export_format="TIFF (32-bit, Percent)",
    indices=["NDVI", "NDRE", "GNDVI", "OSAVI", "CIG"]
)

---

process(mode="parallel", wait=True, progress_callback=None)

处理项目图像。

参数：

参数	类型	默认值	描述
mode	字符串	"parallel"	处理模式："parallel" 或 "serial"
wait	布尔值	True	等待完成
progress_callback	可调用对象	None	进度回调函数(progress, msg)
poll_interval	浮点数	2.0	进度轮询间隔（秒）

返回值： dict - 处理结果

{% 提示 style="warning" %}

并行模式：需Chloros+许可证。 自动扩展至CPU核心数（最多16个工作进程）。

示例：

# Simple processing
results = chloros.process()

# With progress monitoring
def show_progress(progress, message):
    print(f"[{progress}%] {message}")

chloros.process(
    mode="parallel",
    progress_callback=show_progress,
    wait=True
)

# Fire-and-forget (non-blocking)
chloros.process(wait=False)

---

get_config()

获取当前项目配置。

返回值： dict - 当前项目配置示例：

config = chloros.get_config()
print(config['Project Settings'])

---

get_status()

获取后端状态信息。

返回值： dict - 后端状态示例：

status = chloros.get_status()
print(f"Running: {status['running']}")
print(f"URL: {status['url']}")

---

shutdown_backend()

关闭后端（若由SDK启动）。

示例：

chloros.shutdown_backend()

---

logout()

清除本地系统缓存的凭据。

描述：

通过移除缓存的身份验证凭据实现程序化注销。适用于：

• 在不同Chloros+账户间切换

• 在自动化环境中清除凭据

• 安全需求（例如卸载前清除凭据）

返回值： dict - 注销操作结果示例：

from chloros_sdk import ChlorosLocal

# Initialize SDK
chloros = ChlorosLocal()

# Clear cached credentials
result = chloros.logout()
print(f"Logout successful: {result}")

# After logout, login required via GUI/CLI/Browser before next SDK use

需重新认证：调用logout()后， 必须通过Chloros、Chloros（浏览器）或Chloros CLI重新登录，方可使用SDK。

---

便捷函数

process_folder(folder_path, **options)

用于处理文件夹的一行便捷函数。

参数：

参数	类型	默认值	说明
folder_path	字符串/路径	必填	含图像的文件夹路径
project_name	字符串	自动生成	项目名称
camera	字符串	None	相机模板
indices	列表	["NDVI"]	计算索引
vignette_correction	布尔	True	启用晕影校正
reflectance_calibration	布尔值	True	启用反射率校准
export_format	字符串	"TIFF (16位)"	输出格式
mode	字符串	"parallel"	处理模式
progress_callback	可调用对象	None	进度回调函数

返回值： dict - 处理结果示例：

from chloros_sdk import process_folder

# Simple one-liner
results = process_folder("C:\\DroneImages\\Flight001")

# With custom settings
results = process_folder(
    "C:\\DroneImages\\Flight001",
    project_name="Field_A_Survey",
    camera="Survey3N_RGN",
    indices=["NDVI", "NDRE", "GNDVI"],
    mode="parallel"
)

# With progress monitoring
def show_progress(progress, message):
    print(f"[{progress}%] {message}")

results = process_folder(
    "C:\\DroneImages\\Flight001",
    progress_callback=show_progress
)

---

上下文管理器支持

SDK支持上下文管理器实现自动清理：

from chloros_sdk import ChlorosLocal

# Auto-cleanup when done
with ChlorosLocal() as chloros:
    chloros.create_project("MyProject")
    chloros.import_images("C:\\Images")
    chloros.configure(indices=["NDVI"])
    chloros.process()
# Backend automatically shut down here

---

完整示例

示例 1：基础处理

使用默认设置处理文件夹：

from chloros_sdk import process_folder

# Process with default settings
results = process_folder("C:\\Datasets\\Field_A_2025_01_15")

print(f"Processing complete: {results}")

---

示例 2：自定义工作流

完全控制处理管道：

from chloros_sdk import ChlorosLocal

# Initialize SDK
chloros = ChlorosLocal()

# Create project with camera template
chloros.create_project("Research_Plot_A", camera="Survey3N_RGN")

# Import images
import_results = chloros.import_images("C:\\Research\\PlotA")
print(f"Imported {len(import_results.get('files', []))} images")

# Configure advanced settings
chloros.configure(
    debayer="High Quality (Faster)",
    vignette_correction=True,
    reflectance_calibration=True,
    ppk=False,
    export_format="TIFF (16-bit)",
    indices=["NDVI", "NDRE", "GNDVI", "OSAVI"]
)

# Process with progress monitoring
def show_progress(progress, message):
    print(f"Progress: {progress}% - {message}")

chloros.process(
    mode="parallel",
    progress_callback=show_progress,
    wait=True
)

print("Processing complete!")

---

示例 3：批量处理多个文件夹

处理多个飞行数据集：

from chloros_sdk import ChlorosLocal
from pathlib import Path

# Initialize SDK once
chloros = ChlorosLocal()

# List of flight folders
flights = [
    "C:\\Datasets\\Flight_001",
    "C:\\Datasets\\Flight_002",
    "C:\\Datasets\\Flight_003"
]

for flight_path in flights:
    flight_name = Path(flight_path).name
    print(f"\n{'='*60}")
    print(f"Processing: {flight_name}")
    print('='*60)
    
    try:
        # Create project
        chloros.create_project(flight_name, camera="Survey3N_RGN")
        
        # Import images
        chloros.import_images(flight_path)
        
        # Configure
        chloros.configure(
            vignette_correction=True,
            reflectance_calibration=True,
            indices=["NDVI", "NDRE", "GNDVI"]
        )
        
        # Process
        chloros.process(mode="parallel", wait=True)
        
        print(f"✓ {flight_name} completed successfully")
    
    except Exception as e:
        print(f"✗ {flight_name} failed: {e}")

print("\n" + "="*60)
print("All flights processed!")

---

示例 4：研究管道集成

将 Chloros 集成至数据分析：

from chloros_sdk import ChlorosLocal
import pandas as pd
import matplotlib.pyplot as plt

# Initialize Chloros
chloros = ChlorosLocal()

# Field survey data
surveys = [
    {"name": "Plot_A", "folder": "C:\\Research\\PlotA", "biomass": 4500},
    {"name": "Plot_B", "folder": "C:\\Research\\PlotB", "biomass": 3800},
    {"name": "Plot_C", "folder": "C:\\Research\\PlotC", "biomass": 5200}
]

results = []

for survey in surveys:
    # Process with Chloros
    chloros.create_project(survey['name'])
    chloros.import_images(survey['folder'])
    chloros.configure(indices=["NDVI", "NDRE"])
    chloros.process(mode="parallel", wait=True)
    
    # Get results
    config = chloros.get_config()
    
    # Extract NDVI values (example - adjust based on your needs)
    # In real implementation, you would read the processed TIFF files
    
    results.append({
        'plot': survey['name'],
        'biomass': survey['biomass'],
        # Add your NDVI extraction here
    })

# Statistical analysis
df = pd.DataFrame(results)
print("\nResults:")
print(df)

# Create correlation plot
# plt.scatter(df['ndvi'], df['biomass'])
# plt.xlabel('NDVI')
# plt.ylabel('Biomass (kg/ha)')
# plt.title('NDVI vs Biomass Correlation')
# plt.show()

---

示例5：自定义进度监控

通过日志实现高级进度追踪：

from chloros_sdk import ChlorosLocal
from datetime import datetime
import logging

# Setup logging
logging.basicConfig(
    filename=f'processing_{datetime.now():%Y%m%d_%H%M%S}.log',
    level=logging.INFO,
    format='%(asctime)s - %(message)s'
)

# Progress callback with logging
def log_progress(progress, message):
    log_msg = f"[{progress}%] {message}"
    logging.info(log_msg)
    print(log_msg)

# Process with logging
chloros = ChlorosLocal()
chloros.create_project("LoggedProcess")
chloros.import_images("C:\\DroneImages")
chloros.configure(indices=["NDVI", "NDRE"])

logging.info("Starting processing...")
chloros.process(
    mode="parallel",
    progress_callback=log_progress,
    wait=True
)
logging.info("Processing complete!")

---

示例6：错误处理

面向生产环境的健壮错误处理：

from chloros_sdk import ChlorosLocal
from chloros_sdk.exceptions import (
    ChlorosError,
    ChlorosBackendError,
    ChlorosLicenseError,
    ChlorosProcessingError
)

def process_safely(folder_path):
    """Process with comprehensive error handling"""
    try:
        with ChlorosLocal() as chloros:
            chloros.create_project("SafeProcess")
            chloros.import_images(folder_path)
            chloros.configure(indices=["NDVI"])
            chloros.process()
            
        return True, "Success"
    
    except ChlorosLicenseError as e:
        return False, f"License error: {e}. Upgrade to Chloros+ at cloud.mapir.camera/pricing"
    
    except ChlorosBackendError as e:
        return False, f"Backend error: {e}. Ensure Chloros Desktop is installed."
    
    except ChlorosProcessingError as e:
        return False, f"Processing error: {e}"
    
    except FileNotFoundError as e:
        return False, f"Folder not found: {e}"
    
    except ChlorosError as e:
        return False, f"Chloros error: {e}"
    
    except Exception as e:
        return False, f"Unexpected error: {e}"

# Use the safe function
success, message = process_safely("C:\\DroneImages\\Flight001")
if success:
    print(f"✓ {message}")
else:
    print(f"✗ {message}")

---

示例 7：账户管理与注销

程序化管理凭证：

from chloros_sdk import ChlorosLocal

def switch_account():
    """Clear credentials to switch to a different account"""
    try:
        chloros = ChlorosLocal()
        
        # Clear current credentials
        result = chloros.logout()
        print("✓ Credentials cleared successfully")
        print("Please log in with new account via Chloros, Chloros (Browser), or CLI")
        
        return True
    
    except Exception as e:
        print(f"✗ Logout failed: {e}")
        return False

def secure_cleanup():
    """Remove credentials for security purposes"""
    try:
        chloros = ChlorosLocal()
        chloros.logout()
        print("✓ Credentials removed for security")
        
    except Exception as e:
        print(f"Warning: Cleanup error: {e}")

# Switch accounts
if switch_account():
    print("\nRe-authenticate via Chloros GUI/CLI/Browser before next SDK use")

# Or perform secure cleanup
# secure_cleanup()

---

示例 8：命令行工具

基于 SDK 构建自定义工具：

#!/usr/bin/env python
"""
Custom Chloros CLI Tool
Process multiple folders from command line
"""

import sys
import argparse
from pathlib import Path
from chloros_sdk import process_folder

def main():
    parser = argparse.ArgumentParser(description='Custom Chloros Processor')
    parser.add_argument('folders', nargs='+', help='Folders to process')
    parser.add_argument('--indices', nargs='+', default=['NDVI'],
                       help='Indices to calculate (default: NDVI)')
    parser.add_argument('--camera', default=None,
                       help='Camera template')
    parser.add_argument('--format', default='TIFF (16-bit)',
                       help='Export format')
    parser.add_argument('--logout', action='store_true',
                       help='Clear cached credentials before processing')
    
    args = parser.parse_args()
    
    # Handle logout if requested
    if args.logout:
        from chloros_sdk import ChlorosLocal
        chloros = ChlorosLocal()
        chloros.logout()
        print("Credentials cleared. Please re-login via Chloros GUI/CLI/Browser.")
        return 0
    
    successful = []
    failed = []
    
    for folder in args.folders:
        folder_path = Path(folder)
        
        if not folder_path.exists():
            print(f"✗ Skipping {folder}: not found")
            failed.append(folder)
            continue
        
        print(f"\nProcessing: {folder_path.name}...")
        
        try:
            process_folder(
                folder_path,
                camera=args.camera,
                indices=args.indices,
                export_format=args.format
            )
            print(f"✓ {folder_path.name} complete")
            successful.append(folder)
        
        except Exception as e:
            print(f"✗ {folder_path.name} failed: {e}")
            failed.append(folder)
    
    # Summary
    print(f"\n{'='*60}")
    print(f"Summary: {len(successful)} successful, {len(failed)} failed")
    
    return 0 if not failed else 1

if __name__ == '__main__':
    sys.exit(main())

用法：

# Process multiple folders
python my_processor.py "C:\Flight001" "C:\Flight002" --indices NDVI NDRE GNDVI

# Clear cached credentials
python my_processor.py --logout

---

异常处理

SDK 为不同错误类型提供特定异常类：

异常层次结构

ChlorosError                    # Base exception
├── ChlorosBackendError        # Backend startup/connection issues
├── ChlorosLicenseError        # License validation issues
├── ChlorosConnectionError     # Network/connection failures
├── ChlorosProcessingError     # Image processing failures
├── ChlorosAuthenticationError # Authentication failures
└── ChlorosConfigurationError  # Configuration errors

异常示例

from chloros_sdk import ChlorosLocal
from chloros_sdk.exceptions import *

try:
    chloros = ChlorosLocal()
    chloros.process()

except ChlorosLicenseError:
    print("Chloros+ license required. Upgrade at cloud.mapir.camera/pricing")

except ChlorosBackendError:
    print("Backend failed to start. Ensure Chloros Desktop is installed.")

except ChlorosProcessingError as e:
    print(f"Processing failed: {e}")

except ChlorosError as e:
    print(f"General Chloros error: {e}")

---

高级主题

自定义后端配置

使用自定义后端位置或配置：

chloros = ChlorosLocal(
    backend_exe="C:\\Custom\\chloros-backend.exe",
    api_url="http://localhost:5001",  # Custom port
    timeout=60,                        # Longer timeout
    backend_startup_timeout=120        # 2 minutes startup
)

非阻塞处理

启动处理并继续执行其他任务：

# Start processing (non-blocking)
chloros.process(wait=False)

# Do other work here...
print("Processing started in background...")

# Check status later
import time
while True:
    status = chloros.get_config()
    if status.get('processing_complete'):
        break
    time.sleep(5)

print("Processing complete!")

内存管理

针对大型数据集，采用批量处理：

from pathlib import Path

base_folder = Path("C:\\LargeDataset")
batch_size = 100

# Get all image files
images = list(base_folder.glob("*.RAW"))

# Process in batches
for i in range(0, len(images), batch_size):
    batch = images[i:i+batch_size]
    batch_folder = base_folder / f"batch_{i//batch_size}"
    
    # Create batch folder and move images
    # ... (implementation details)
    
    # Process batch
    process_folder(batch_folder)

---

故障排除

后端无法启动

问题： SDK 启动后端失败解决方案：

1. 确认已安装 Chloros 桌面端：

import os
backend_path = r"C:\Program Files\MAPIR\Chloros\resources\backend\chloros-backend.exe"
print(f"Backend exists: {os.path.exists(backend_path)}")

1. 检查防火墙是否阻断Windows

2. 尝试手动指定后端路径：

chloros = ChlorosLocal(backend_exe="C:\\Path\\To\\chloros-backend.exe")

---

未检测到许可证问题： SDK提示许可证缺失解决方案：

1. 打开Chloros、Chloros（浏览器）或Chloros CLI并登录

2. 验证许可证是否已缓存：

from pathlib import Path
import os

# Check cache location (Windows)
cache_path = Path(os.getenv('APPDATA')) / 'Chloros' / 'cache'
print(f"Cache exists: {cache_path.exists()}")

1. 若凭证出现问题，请清除缓存凭证并重新登录：

from chloros_sdk import ChlorosLocal

# Clear cached credentials
chloros = ChlorosLocal()
chloros.logout()

# Then login again via Chloros, Chloros (Browser), or Chloros CLI

1. 联系技术支持：[e-mail]

---

导入错误问题： ModuleNotFoundError: No module named 'chloros_sdk'解决方案：

# Verify installation
pip show chloros-sdk

# Reinstall if needed
pip uninstall chloros-sdk
pip install chloros-sdk

# Check Python environment
python -c "import sys; print(sys.path)"

---

处理超时问题： 处理超时解决方案：

1. 延长超时时间：

chloros = ChlorosLocal(timeout=120)  # 2 minutes

1. 分批处理较小数据量

2. 检查可用磁盘空间

3. 监控系统资源

---

端口已被占用问题：后端端口5000被占用解决方案：

# Use different port
chloros = ChlorosLocal(api_url="http://localhost:5001")

或查找并关闭冲突进程：

# PowerShell
Get-NetTCPConnection -LocalPort 5000

---

性能优化建议

提升处理速度

1. 启用并行模式（需Chloros+）

chloros.process(mode="parallel")  # Up to 16 workers

1. 降低输出分辨率（若可接受）

chloros.configure(export_format="PNG (8-bit)")  # Faster than TIFF

1. 禁用非必要索引

# Only calculate needed indices
chloros.configure(indices=["NDVI"])  # Not all indices

1. 在SSD上处理（而非HDD）***

内存优化

针对大型数据集：

# Process in batches instead of all at once
# See "Memory Management" in Advanced Topics

---

后台处理

释放Python资源供其他任务使用：

chloros.process(wait=False)  # Non-blocking

# Continue with other work
# ...

---

集成示例

Django集成

# views.py
from django.http import JsonResponse
from chloros_sdk import process_folder

def process_images_view(request):
    if request.method == 'POST':
        folder_path = request.POST.get('folder_path')
        
        try:
            results = process_folder(folder_path)
            return JsonResponse({'success': True, 'results': results})
        except Exception as e:
            return JsonResponse({'success': False, 'error': str(e)})

Flask集成

# app.py
from flask import Flask, request, jsonify
from chloros_sdk import process_folder

app = Flask(__name__)

@app.route('/api/process', methods=['POST'])
def process():
    data = request.get_json()
    folder_path = data.get('folder_path')
    
    try:
        results = process_folder(folder_path)
        return jsonify({'success': True, 'results': results})
    except Exception as e:
        return jsonify({'success': False, 'error': str(e)}), 500

if __name__ == '__main__':
    app.run()

Jupyter Notebook集成

# notebook.ipynb
from chloros_sdk import ChlorosLocal
import matplotlib.pyplot as plt

# Initialize
chloros = ChlorosLocal()

# Process
chloros.create_project("JupyterTest")
chloros.import_images("C:\\Data")
chloros.configure(indices=["NDVI"])

# Progress in notebook
from IPython.display import clear_output

def notebook_progress(progress, message):
    clear_output(wait=True)
    print(f"Progress: {progress}%")
    print(message)

chloros.process(progress_callback=notebook_progress)

# Visualize results
# ... (your visualization code)

---

常见问题

Q: SDK是否需要联网？

*答：仅需初始许可证激活时连接。通过Chloros、Chloros（浏览器）或Chloros CLI登录后，许可证将本地缓存并支持离线使用30天。

问：能否在无GUI的服务器上使用SDK？**答：**可以！要求如下：

• 安装Windows Server 2016或更高版本

• 安装Chloros（仅需一次）

• 在任意设备激活许可证（缓存许可证将复制至服务器）

---

问：桌面版、CLI和SDK有何区别？

功能	桌面图形界面	CLI 命令行	Python SDK
界面类型	点击式操作	命令行	Python API
适用场景	可视化工作	脚本编写	系统集成
自动化	有限	良好	卓越
灵活性	基础	良好	最大
许可证	Chloros+	Chloros+	Chloros+

问：能否分发使用SDK构建的应用程序？**答：**SDK代码可集成至您的应用程序，但需满足以下条件：

• 终端用户需安装Chloros

• 终端用户需持有有效的Chloros+许可证

• 商业分发需获取OEM授权

OEM授权咨询请联系[e-mail]。

---

问：如何更新SDK？

pip install --upgrade chloros-sdk

---

问：处理后的图像保存在何处？

默认保存在项目路径中：

Project_Path/
└── MyProject/
    └── Survey3N_RGN/          # Processed outputs

---

问：能否通过定时运行的Python脚本处理图像？**答：**可以！请结合Python脚本使用Windows任务计划程序：

# scheduled_processing.py
from chloros_sdk import process_folder

# Process today's flights
results = process_folder("C:\\Flights\\Today")

通过任务计划程序设置每日运行。

---

问：SDK是否支持异步/等待？**答：**当前版本为同步模式。如需异步行为，请使用wait=False或在独立线程中运行：

import threading

def process_thread():
    chloros.process()

thread = threading.Thread(target=process_thread)
thread.start()

# Continue with other work...

---

问：如何在不同Chloros+账户间切换？**答：**使用logout()方法清除缓存凭证，然后用新账户重新登录：

from chloros_sdk import ChlorosLocal

# Clear current credentials
chloros = ChlorosLocal()
chloros.logout()

# Re-login via Chloros, Chloros (Browser), or Chloros CLI with new account

退出后，请通过图形界面、浏览器或CLI使用新账户进行身份验证，再重新使用SDK。

---

获取帮助

文档

• API参考文档：本页面

支持渠道

• 电子邮件：[e-mail]

• 官网：https://www.mapir.camera/community/contact

• 定价：https://cloud.mapir.camera/pricing

示例代码

此处列出的所有示例均经过测试且可投入生产环境。请根据您的使用场景复制并调整这些代码。

---

许可协议专有软件 - 版权所有 (c) 2025 MAPIR 股份有限公司

SDK 需有效 Chloros+ 订阅服务。禁止未经授权的使用、分发或修改。