API : Python SDK

Il Chloros Python SDK fornisce accesso programmatico al motore di elaborazione delle immagini Chloros, consentendo l'automazione, flussi di lavoro personalizzati e una perfetta integrazione con le vostre applicazioni Python e le vostre pipeline di ricerca.

Caratteristiche principali

• 🐍 Nativo Python - API pulito e in stile Python per l'elaborazione delle immagini

• 🔧 Accesso completo a API - Controllo completo sull'elaborazione Chloros

• 🚀 Automazione - Crea flussi di lavoro personalizzati per l'elaborazione in batch

• 🔗 Integrazione - Incorpora Chloros nelle applicazioni Python esistenti

• 📊 Pronto per la ricerca - Perfetto per le pipeline di analisi scientifiche

• ⚡ Elaborazione parallela - Scalabile in base ai core della CPU (Chloros+)

Requisiti

Requisito	Dettagli
Chloros installato	Windows: programma di installazione desktop; Linux: pacchetto .deb
Licenza	Chloros+ (è richiesto un piano a pagamento)
Sistema operativo	Windows 10/11 (64 bit), Linux x86_64 (amd64), Linux arm64 (NVIDIA Jetson JetPack 6)
Python	Python 3.7 o superiore
Memoria	Minimo 8 GB di RAM (consigliati 16 GB)
Internet	Necessario per l'attivazione della licenza

Requisiti di licenza: Python SDK richiede un abbonamento a pagamento Chloros+ per l'accesso a API. I piani Standard (gratuiti) non includono l'accesso a API/SDK. Visita https://cloud.mapir.camera/pricing per effettuare l'upgrade.

Guida rapida

Installazione

Installare tramite pip:

pip install chloros-sdk

Configurazione iniziale: prima di utilizzare SDK, attiva la tua licenza Chloros+ aprendo Chloros, Chloros (Browser) o Chloros CLI ed effettuando l'accesso con le proprie credenziali. Questa operazione deve essere eseguita una sola volta. Su Linux (senza GUI), utilizzare: chloros-cli login [e-mail] 'password'

Utilizzo di base

Elabora una cartella con poche righe:

from chloros_sdk import process_folder

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

# One-line processing (Linux)
results = process_folder("/home/user/drone_images/flight001")

Percorsi multipiattaforma: gli esempi di codice in questa pagina utilizzano percorsi in stile Windows (ad es. C:\\DroneImages\\Flight001). Su Linux, utilizzare invece percorsi Linux (ad es., /home/user/drone_images/flight001 o ~/drone_images/flight001). SDK funziona in modo identico su entrambe le piattaforme.

Controllo completo

Per flussi di lavoro avanzati:

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")  # Windows
# chloros.import_images("/home/user/drone_images/flight001")  # Linux

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

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

---

Guida all'installazione

Prerequisiti

Prima di installare SDK, assicurarsi di disporre di:

1. Chloros installato — Windows: programma di installazione desktop (scarica); Linux: pacchetto .deb (Installazione)

2. Python 3.7+ installato (python.org)

3. Licenza Chloros+ attiva (aggiornamento)

Installazione tramite pip

Installazione standard:

pip install chloros-sdk

Con supporto al monitoraggio dello stato di avanzamento:

pip install chloros-sdk[progress]

Installazione di sviluppo:

pip install chloros-sdk[dev]

Verifica dell'installazione

Verifica che SDK sia installato correttamente:

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

---

Configurazione iniziale

Attivazione della licenza

SDK utilizza la stessa licenza di Chloros, Chloros (Browser) e Chloros CLI. Attivare una volta tramite l'interfaccia grafica o CLI:Windows:AprireChloros o Chloros (Browser) ed effettuare il login nella scheda Utente , oppure utilizzare CLI.Linux: Utilizzare CLI (GUI non disponibile):

chloros-cli login [e-mail] 'your_password'

La licenza viene memorizzata nella cache locale e persiste anche dopo il riavvio.

Configurazione una tantum: dopo aver effettuato l'accesso tramite l'interfaccia grafica o CLI, SDK utilizza automaticamente la licenza memorizzata nella cache. Non è necessaria alcuna autenticazione aggiuntiva!

Disconnessione: gli utenti di SDK possono cancellare le credenziali memorizzate nella cache a livello di programmazione utilizzando il metodo logout(). Vedere il metodo logout() nella Documentazione di riferimento di API.

Verifica della connessione

Verificare che SDK sia in grado di connettersi a 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']}")

---

Riferimento API

Classe ChlorosLocal

Classe principale per l'elaborazione delle immagini Chloros locale.

Costruttore

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
)

Parametri:

Parametro	Tipo	Predefinito	Descrizione
api_url	str	"http://localhost:5000"	URL del backend locale Chloros
auto_start_backend	bool	True	Avvia automaticamente il backend se necessario
backend_exe	str	None (rilevamento automatico)	Percorso dell'eseguibile del backend
timeout	int	30	Timeout della richiesta in secondi
backend_startup_timeout	int	60	Timeout per l'avvio del backend (secondi)

Esempi:

# Default (auto-start backend, auto-detect path on Windows and Linux)
chloros = ChlorosLocal()

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

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

# Custom backend path (Linux)
chloros = ChlorosLocal(backend_exe="/opt/mapir/chloros/backend/chloros-backend")

# Custom timeout with longer startup (e.g., for Jetson)
chloros = ChlorosLocal(timeout=60, backend_startup_timeout=120)

Rilevamento automatico multipiattaforma: SDK prova automaticamente il percorso del backend corretto per la tua piattaforma:

• Windows: C:\Program Files\MAPIR\Chloros\resources\backend\chloros-backend.exe

• Linux (.deb): /usr/lib/chloros/chloros-backend

• Linux (manuale): /opt/mapir/chloros/backend/chloros-backend

---

Metodi

create_project(project_name, camera=None)

Crea un nuovo progetto Chloros.

Parametri:

Parametro	Tipo	Obbligatorio	Descrizione
project_name	str	Sì	Nome del progetto
camera	str	No	Modello di telecamera (ad es., "Survey3N_RGN", "Survey3W_OCN")

Restituisce: dict - Risposta di creazione del progettoEsempio:

# Basic project
chloros.create_project("DroneField_A")

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

---

import_images(folder_path, recursive=False)

Importa immagini da una cartella.

Parametri:

Parametro	Tipo	Obbligatorio	Descrizione
folder_path	str/Path	Sì	Percorso della cartella contenente le immagini
recursive	bool	No	Cerca nelle sottocartelle (impostazione predefinita: False)

Restituisce: dict - Risultati dell'importazione con il numero di fileEsempio:

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

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

---

configure(**settings)

Configura le impostazioni di elaborazione.

Parametri:

Parametro	Tipo	Predefinito	Descrizione
debayer	str	"Standard (Veloce, Qualità media)"	Metodo di debayering
vignette_correction	bool	True	Abilita correzione vignettatura
reflectance_calibration	bool	True	Abilita calibrazione della riflettanza
indices	list	None	Indici di vegetazione da calcolare
export_format	str	"TIFF (16-bit)"	Formato di output
ppk	bool	False	Abilita correzioni PPK
custom_settings	dict	None	Impostazioni personalizzate avanzate

Formati di esportazione:

• "TIFF (16-bit)" - Consigliato per GIS/fotogrammetria

• "TIFF (32-bit, Percent)" - Analisi scientifica

• "PNG (8-bit)" - Ispezione visiva

• "JPG (8-bit)" - Output compresso

**Indici disponibili:**NDVI, NDRE, GNDVI, OSAVI, CIG, EVI, SAVI, MSAVI, MTVI2 e altri.Esempio:

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

# Advanced configuration
chloros.configure(
    debayer="Standard (Fast, Medium Quality)",
    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)

Elabora le immagini del progetto.

Parametri:

Parametro	Tipo	Predefinito	Descrizione
mode	str	"parallel"	Modalità di elaborazione: "parallel" o "serial"
wait	bool	True	Attendere il completamento
progress_callback	callable	None	Funzione di callback di avanzamento (progress, msg)
poll_interval	float	2.0	Intervallo di polling per l'avanzamento (secondi)

Restituisce: dict - Risultati dell'elaborazione

Modalità parallela: Richiede licenza Chloros+. Si adatta automaticamente ai core della CPU (fino a 16 worker).

Esempio:

# 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()

Ottiene la configurazione corrente del progetto.

Restituisce: dict - Configurazione attuale del progettoEsempio:

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

---

get_status()

Ottiene le informazioni sullo stato del backend, compreso lo stato di avanzamento dell'elaborazione per thread.

Restituisce: dict - Stato del backend con la seguente struttura:

{
    "running": True,
    "url": "http://localhost:5000",
    "processing": {
        "percent": 75.0,
        "phase": "processing"
    },
    "export": {
        "percent": 50.0,
        "phase": "exporting",
        "active": True
    }
}

Esempio:

status = chloros.get_status()
print(f"Running: {status['running']}")
print(f"URL: {status['url']}")
print(f"Processing: {status['processing']['percent']}%")
print(f"Export: {status['export']['percent']}% - Active: {status['export']['active']}")

---

shutdown_backend()

Arresta il backend (se avviato da SDK).

Esempio:

chloros.shutdown_backend()

---

logout()

Cancella le credenziali memorizzate nella cache dal sistema locale.

Descrizione:

Effettua il logout a livello di programmazione rimuovendo le credenziali di autenticazione memorizzate nella cache. Ciò è utile per:

• Passare da un account Chloros+ all'altro

• Cancellare le credenziali in ambienti automatizzati

• Motivi di sicurezza (ad es. rimuovere le credenziali prima della disinstallazione)

Restituisce: dict - Risultato dell'operazione di logoutEsempio:

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

Richiesta di nuova autenticazione: Dopo aver chiamato logout(), è necessario effettuare nuovamente l'accesso tramite Chloros, Chloros (Browser) o Chloros CLI prima di utilizzare SDK.

---

Funzioni di utilità

process_folder(folder_path, **options)

Funzione di utilità su una riga per elaborare una cartella.

Parametri:

Parametro	Tipo	Predefinito	Descrizione
folder_path	str/Path	Obbligatorio	Percorso della cartella con le immagini
project_name	str	Generato automaticamente	Nome del progetto
camera	str	None	Modello fotocamera
indices	list	["NDVI"]	Indici da calcolare
vignette_correction	bool	True	Abilita correzione vignettatura
reflectance_calibration	bool	True	Abilita calibrazione riflettanza
export_format	str	"TIFF (16 bit)"	Formato di output
mode	str	"parallel"	Modalità di elaborazione
progress_callback	callable	None	Callback di avanzamento

Restituisce: dict - Risultati dell'elaborazioneEsempio:

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
)

---

Supporto dei gestori di contesto

SDK supporta i gestori di contesto per la pulizia automatica:

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

---

Esempi completi

Utenti di Linux: Tutti gli esempi riportati di seguito utilizzano percorsi Windows. Sostituire i percorsi C:\\... con i propri percorsi Linux (ad es., /home/user/... o ~/...). Tutte le funzionalità di SDK sono identiche su tutte le piattaforme.

Esempio 1: Elaborazione di base

Elaborazione di una cartella con impostazioni predefinite:

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}")

---

Esempio 2: Flusso di lavoro personalizzato

Controllo completo sulla pipeline di elaborazione:

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="Standard (Fast, Medium Quality)",
    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!")

---

Esempio 3: Elaborazione in batch di più cartelle

Elaborazione di più set di dati di volo:

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!")

---

Esempio 4: Integrazione nella pipeline di ricerca

Integrazione di Chloros con l'analisi dei dati:

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()

---

Esempio 5: Monitoraggio personalizzato dello stato di avanzamento

Monitoraggio avanzato dello stato di avanzamento con registrazione:

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!")

---

Esempio 6: Gestione degli errori

Gestione degli errori robusta per l'uso in produzione:

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 is installed (Windows installer or Linux .deb package)."
    
    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}")

---

Esempio 7: Gestione dell'account e disconnessione

Gestione delle credenziali a livello di programmazione:

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()

---

Esempio 8: Strumento da riga di comando

Creazione di uno strumento CLI personalizzato con 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())

Utilizzo:

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

# Clear cached credentials
python my_processor.py --logout

---

Gestione delle eccezioni

SDK fornisce classi di eccezioni specifiche per diversi tipi di errore:

Gerarchia delle eccezioni

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

Esempi di eccezioni

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 is installed (Windows installer or Linux .deb package).")

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

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

---

Argomenti avanzati

Configurazione personalizzata del backend

Utilizza una posizione o una configurazione personalizzata del backend:

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
)

Elaborazione non bloccante

Avvia l'elaborazione e prosegui con altre attività:

# 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!")

Gestione della memoria

Per set di dati di grandi dimensioni, elaborare in batch:

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)

---

Risoluzione dei problemi

Il backend non si avvia

Problema: SDK non riesce ad avviare il backendSoluzioni:

1. Verificare che Chloros sia installato:

import os
import platform

# Auto-detect backend path
if platform.system() == "Windows":
    backend_path = r"C:\Program Files\MAPIR\Chloros\resources\backend\chloros-backend.exe"
else:
    backend_path = "/usr/lib/chloros/chloros-backend"

print(f"Backend exists: {os.path.exists(backend_path)}")

1. Controllare il firewall (Windows) o la disponibilità della porta (Linux: lsof -i :5000)

2. Provare il percorso backend manuale:

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

# Linux
chloros = ChlorosLocal(backend_exe="/opt/mapir/chloros/backend/chloros-backend")

---

Licenza non rilevataProblema: SDK segnala la mancanza della licenzaSoluzioni:

1. Aprire Chloros, Chloros (Browser) o Chloros CLI ed effettuare l'accesso.

2. Verificare che la licenza sia memorizzata nella cache:

from pathlib import Path
import os
import platform

# Check cache location
if platform.system() == "Windows":
    cache_path = Path(os.getenv('APPDATA')) / 'Chloros' / 'cache'
else:
    cache_path = Path.home() / '.cache' / 'chloros'

print(f"Cache exists: {cache_path.exists()}")

1. In caso di problemi con le credenziali, cancellare le credenziali memorizzate nella cache ed effettuare nuovamente l'accesso:

from chloros_sdk import ChlorosLocal

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

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

1. Contattare l'assistenza: [e-mail]

---

Errori di importazioneProblema: ModuleNotFoundError: No module named 'chloros_sdk'Soluzioni:

# 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)"

---

Timeout di elaborazioneProblema: Timeout di elaborazioneSoluzioni:

1. Aumentare il timeout:

chloros = ChlorosLocal(timeout=120)  # 2 minutes

1. Elaborare batch più piccoli

2. Verificare lo spazio disponibile su disco

3. Monitorare le risorse di sistema

---

Porta già in usoProblema: Porta backend 5000 occupataSoluzioni:

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

Oppure individuare e chiudere il processo in conflitto:

# Windows PowerShell
Get-NetTCPConnection -LocalPort 5000

# Linux
lsof -i :5000
kill $(lsof -t -i :5000)

---

Suggerimenti per le prestazioni

Ottimizzare la velocità di elaborazione

1. Utilizzare la modalità parallela (richiede Chloros+)

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

1. Ridurre la risoluzione di output (se accettabile)

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

1. Disattivare gli indici non necessari

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

1. Eseguire l'elaborazione su SSD (non su HDD)***

Ottimizzazione della memoria

Per set di dati di grandi dimensioni:

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

---

Elaborazione in background

Liberare Python per altre attività:

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

# Continue with other work
# ...

---

Esempi di integrazione

Integrazione con 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 API

# 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)

---

Domande frequenti

D: SDK richiede una connessione a Internet?

R: Solo per l'attivazione iniziale della licenza. Dopo aver effettuato l'accesso tramite Chloros, Chloros (Browser) o Chloros CLI, la licenza viene memorizzata nella cache locale e funziona offline per 30 giorni.***

D: Posso utilizzare SDK su un server senza interfaccia grafica?R: Sì! SDK funziona in modalità headless sia su server Windows che Linux.Linux (consigliato per modalità headless):

• Installazione tramite pacchetto .deb

• Attivazione della licenza: chloros-cli login [e-mail] 'password'

Server Windows:

• Server Windows 2016 o versioni successive

• Chloros installato (una tantum)

• Licenza attivata tramite CLI o su qualsiasi macchina

---

D: Qual è la differenza tra Desktop, CLI e SDK?

Funzionalità	Interfaccia grafica Desktop	Riga di comando CLI	Python SDK
Interfaccia	Point-and-click	Comandi	Python API
Ideale per	Lavoro visivo	Scripting	Integrazione
Automazione	Limitata	Buona	Eccellente
Flessibilità	Base	Buona	Massima
Licenza	Chloros+	Chloros+	Chloros+

D: Posso distribuire app create con SDK?R: Il codice SDK può essere integrato nelle tue applicazioni, ma:

• Gli utenti finali devono avere Chloros installato

• Gli utenti finali devono disporre di licenze Chloros+ attive

• La distribuzione commerciale richiede una licenza OEM

Contatta [e-mail] per richieste relative alle licenze OEM.

---

D: Come si aggiorna SDK?

pip install --upgrade chloros-sdk

---

D: Dove vengono salvate le immagini elaborate?

Per impostazione predefinita, nel percorso del progetto:

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

---

D: Posso elaborare immagini da script Python in esecuzione a intervalli regolari?R: Sì! Utilizza lo scheduler del tuo sistema operativo con gli script Python:

# scheduled_processing.py
from chloros_sdk import process_folder

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

Windows: Pianifica tramite Task Scheduler per l'esecuzione giornaliera.Linux: Pianifica tramite cron:

# Run at 2 AM daily
0 2 * ** /usr/bin/python3 /home/user/scheduled_processing.py >> /var/log/chloros.log 2>&1

---

D: SDK supporta async/await?R: La versione attuale è sincrona. Per un comportamento asincrono, usa wait=False o esegui in un thread separato:

import threading

def process_thread():
    chloros.process()

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

# Continue with other work...

---

D: Come faccio a passare da un account Chloros+ all'altro?R: Utilizza il metodo logout() per cancellare le credenziali memorizzate nella cache, quindi effettua nuovamente l'accesso con il nuovo account:

from chloros_sdk import ChlorosLocal

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

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

Dopo aver effettuato il logout, autenticarsi con il nuovo account tramite l'interfaccia grafica, il browser o CLI prima di utilizzare nuovamente SDK.

---

Ottenere assistenza

Documentazione

• Riferimento API: Questa pagina

Canali di assistenza

• E-mail: [e-mail]

• Sito web: https://www.mapir.camera/community/contact

• Prezzi: https://cloud.mapir.camera/pricing

Codice di esempio

Tutti gli esempi qui elencati sono stati testati e sono pronti per la produzione. Copiateli e adattateli al vostro caso d'uso.

---

LicenzaSoftware proprietario - Copyright (c) 2025 MAPIR Inc.

SDK richiede un abbonamento Chloros+ attivo. È vietato l'uso, la distribuzione o la modifica non autorizzati.