API: Python SDK

Chloros Python SDK ger programmatisk åtkomst till bildbehandlingsmotorn Chloros, vilket möjliggör automatisering, anpassade arbetsflöden och sömlös integration med dina Python-applikationer och forskningspipelines.

Viktiga funktioner

  • 🐍 Native Python - Ren, Pythonic API för bildbehandling

  • 🔧 Fullständig API-åtkomst - Fullständig kontroll över Chloros-bearbetning

  • 🚀 Automatisering - Skapa anpassade arbetsflöden för batchbearbetning

  • 🔗 Integration – Bädda in Chloros i befintliga Python-applikationer

  • 📊 Forskningsklar – Perfekt för vetenskapliga analyspipelines

  • Parallell bearbetning – Skalar till dina CPU-kärnor (Chloros+)

Krav

Krav
Detaljer

Chloros Desktop

Måste installeras lokalt

Operativsystem

Windows 10/11 (64-bitars)

Python

Python 3.7 eller högre

Minne

Minst 8 GB RAM (16 GB rekommenderas)

Internet

Krävs för licensaktivering

circle-info

Licenskrav: Python SDK kräver ett betalt Chloros+-abonnemang för åtkomst till API. Standardabonnemang (gratis) har inte tillgång till API/SDK. Besök https://cloud.mapir.camera/pricingarrow-up-right för att uppgradera.

Snabbstart

Installation

Installera via pip:

circle-info

Första installationen: Innan du använder SDK måste du aktivera din Chloros+-licens genom att öppna Chloros, Chloros (webbläsare) eller Chloros CLI och logga in med dina inloggningsuppgifter. Detta behöver bara göras en gång.

Grundläggande användning

Bearbeta en mapp med bara några rader:

Full kontroll

För avancerade arbetsflöden:


Installationsguide

Förutsättningar

Innan du installerar SDK, se till att du har:

  1. Chloros Desktop installerat (nedladdning)

  2. Python 3.7+ installerat (python.orgarrow-up-right)

  3. Aktiv Chloros+-licens (uppgraderingarrow-up-right)

Installera via pip

Standardinstallation:

Med stöd för övervakning av framsteg:

Utvecklingsinstallation:

Verifiera installationen

Testa att SDK är korrekt installerat:


Första installationen

Licensaktivering

SDK använder samma licens som Chloros, Chloros (webbläsare) och Chloros CLI. Aktivera en gång via GUI eller CLI:

  1. Öppna Chloros eller Chloros (webbläsare)och logga in på fliken Användare . Eller öppnaCLI.

  2. Ange dina Chloros+-inloggningsuppgifter och logga in

  3. Licensen cachas lokalt (kvarstår efter omstart)

circle-info

Engångsinstallation: Efter inloggning via GUI eller CLI använder SDK automatiskt den cachade licensen. Ingen ytterligare autentisering behövs!

circle-info

Logga ut: SDK-användare kan programmatiskt rensa cachade autentiseringsuppgifter med metoden logout(). Se logout()-metoden i API-referensen.

Testa anslutningen

Kontrollera att SDK kan ansluta till Chloros:


API Referens

ChlorosLocal-klass

Huvudklass för lokal Chloros-bildbehandling.

Konstruktör

Parametrar:

Parameter
Typ
Standardvärde
Beskrivning

api_url

str

"http://localhost:5000"

URL av lokal Chloros backend

auto_start_backend

bool

True

Starta backend automatiskt vid behov

backend_exe

str

None (automatisk detektering)

Sökväg till backend-körbar fil

timeout

int

30

Begär tidsgräns i sekunder

backend_startup_timeout

int

60

Timeout för start av backend (sekunder)

Exempel:


Metoder

create_project(project_name, camera=None)

Skapa ett nytt Chloros-projekt.

Parametrar:

Parameter
Typ
Obligatorisk
Beskrivning

project_name

str

Ja

Namn på projektet

camera

str

Nej

Kameramall (t.ex. "Survey3N_RGN", "Survey3W_OCN")

Returnerar: dict – Svar på projektskapandeExempel:


import_images(folder_path, recursive=False)

Importera bilder från en mapp.

Parametrar:

Parameter
Typ
Obligatorisk
Beskrivning

folder_path

str/Path

Ja

Sökväg till mapp med bilder

recursive

bool

Nej

Sök i undermappar (standard: False)

Returnerar: dict - Importerade resultat med antal filerExempel:


configure(**settings)

Konfigurera bearbetningsinställningar.

Parametrar:

Parameter
Typ
Standard
Beskrivning

debayer

str

"Hög kvalitet (snabbare)"

Debayer-metod

vignette_correction

bool

True

Aktivera vignettkorrigering

reflectance_calibration

bool

True

Aktivera reflektanskalibrering

indices

list

None

Vegetationsindex att beräkna

export_format

str

"TIFF (16-bit)"

Utmatningsformat

ppk

bool

False

Aktivera PPK-korrigeringar

custom_settings

dict

None

Avancerade anpassade inställningar

Exportformat:

  • "TIFF (16-bit)" – Rekommenderas för GIS/fotogrammetri

  • "TIFF (32-bit, Percent)" – Vetenskaplig analys

  • "PNG (8-bit)" – Visuell inspektion

  • "JPG (8-bit)" – Komprimerad utdata

**Tillgängliga index:**NDVI, NDRE, GNDVI, OSAVI, CIG, EVI, SAVI, MSAVI, MTVI2 och fler.Exempel:


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

Bearbeta projektbilderna.

Parametrar:

Parameter
Typ
Standard
Beskrivning

mode

str

"parallel"

Bearbetningsläge: "parallel" eller "serial"

wait

bool

True

Vänta på slutförande

progress_callback

callable

None

Återkopplingsfunktion för framsteg (progress, msg)

poll_interval

float

2.0

Pollningsintervall för framsteg (sekunder)

Returnerar: dict - Bearbetningsresultat

circle-info

Parallellt läge: Kräver Chloros+ licens. Skalar automatiskt till dina CPU-kärnor (upp till 16 arbetare).

Exempel:


get_config()

Hämta aktuell projektkonfiguration.

Returnerar: dict – Aktuell projektkonfigurationExempel:


get_status()

Hämta information om backend-status.

Returnerar: dict - Backend-statusExempel:


shutdown_backend()

Stäng av backend (om den startats av SDK).

Exempel:


logout()

Rensa cachade autentiseringsuppgifter från det lokala systemet.

Beskrivning:

Loggar ut programmatiskt genom att ta bort cachade autentiseringsuppgifter. Detta är användbart för:

  • Växla mellan olika Chloros+-konton

  • Rensa autentiseringsuppgifter i automatiserade miljöer

  • Säkerhetsändamål (t.ex. ta bort autentiseringsuppgifter innan avinstallation)

Returnerar: dict - Resultat av utloggningsåtgärdExempel:

circle-info

Omcertifiering krävs: Efter att ha anropat logout() måste du logga in igen via Chloros, Chloros (webbläsare) eller Chloros CLI innan du använder SDK.


Praktiska funktioner

process_folder(folder_path, **options)

Enradig praktisk funktion för att bearbeta en mapp.

Parametrar:

Parameter
Typ
Standard
Beskrivning

folder_path

str/Path

Obligatoriskt

Sökväg till mapp med bilder

project_name

str

Autogenererad

Projektnamn

camera

str

None

Kameramall

indices

list

["NDVI"]

Index att beräkna

vignette_correction

bool

True

Aktivera vignettkorrigering

reflectance_calibration

bool

True

Aktivera reflektanskalibrering

export_format

str

"TIFF (16-bit)"

Utmatningsformat

mode

str

"parallel"

Bearbetningsläge

progress_callback

callable

None

Återkoppling av förlopp

Returnerar: dict - BearbetningsresultatExempel:


Stöd för kontextmanager

SDK stöder kontextmanagers för automatisk rensning:


Kompletta exempel

Exempel 1: Grundläggande bearbetning

Bearbeta en mapp med standardinställningar:


Exempel 2: Anpassat arbetsflöde

Full kontroll över bearbetningspipeline:


Exempel 3: Batchbearbetning av flera mappar

Bearbeta flera flygdatauppsättningar:


Exempel 4: Integrering av forskningspipeline

Integrera Chloros med dataanalys:


Exempel 5: Anpassad övervakning av framsteg

Avancerad spårning av framsteg med loggning:


Exempel 6: Felhantering

Robust felhantering för produktionsanvändning:


Exempel 7: Kontohantering och utloggning

Hantera inloggningsuppgifter programmatiskt:


Exempel 8: Kommandoradsverktyg

Skapa ett anpassat CLI-verktyg med SDK:

Användning:


Undantagshantering

SDK tillhandahåller specifika undantagsklasser för olika feltyper:

Undantagshierarki

Exempel på undantag


Avancerade ämnen

Anpassad backend-konfiguration

Använd en anpassad backend-plats eller konfiguration:

Icke-blockerande bearbetning

Starta bearbetningen och fortsätt med andra uppgifter:

Minnehantering

För stora datamängder, bearbeta i batcher:


Felsökning

Backend startar inte

Problem: SDK kan inte starta backendLösningar:

  1. Kontrollera att Chloros Desktop är installerat:

  1. Kontrollera att Windows brandvägg inte blockerar

  2. Prova manuell backend-sökväg:


Licens upptäcks inteProblem: SDK varnar om saknad licensLösningar:

  1. Öppna Chloros, Chloros (webbläsare) eller Chloros CLI och logga in.

  2. Kontrollera att licensen finns i cacheminnet:

  1. Om du har problem med inloggningsuppgifterna, rensa cacheminnet och logga in igen:

  1. Kontakta supporten: info@mapir.camera


ImportfelProblem: ModuleNotFoundError: No module named 'chloros_sdk'Lösningar:


BearbetningstidsgränsProblem: Bearbetningstiden löper utLösningar:

  1. Öka tidsgränsen:

  1. Bearbeta mindre batchar

  2. Kontrollera tillgängligt diskutrymme

  3. Övervaka systemresurser


Porten används redanProblem: Backend-port 5000 upptagenLösningar:

Eller hitta och stäng den konfliktande processen:


Tips för prestanda

Optimera bearbetningshastigheten

  1. Använd parallellt läge (kräver Chloros+)

  1. Minska utgångsupplösningen (om det är acceptabelt)

  1. Inaktivera onödiga index

  1. Bearbeta på SSD (inte HDD)***

Minnesoptimering

För stora datamängder:


Bakgrundsbehandling

Frigör Python för andra uppgifter:


Integrations exempel

Django-integration

Flask API

Jupyter Notebook


Vanliga frågor

F: Kräver SDK en internetanslutning?

S: Endast för initial licensaktivering. Efter inloggning via Chloros, Chloros (webbläsare) eller Chloros CLI sparas licensen lokalt och fungerar offline i 30 dagar.***

F: Kan jag använda SDK på en server utan GUI?S: Ja! Krav:

  • Windows Server 2016 eller senare

  • Chloros installerat (engångsinstallation)

  • Licens aktiverad på valfri maskin (cachelagrad licens kopierad till servern)


F: Vad är skillnaden mellan Desktop, CLI och SDK?

Funktion
Desktop GUI
CLI Kommandorad
Python SDK

Gränssnitt

Pek-och-klicka

Kommando

Python API

Bäst för

Visuellt arbete

Skriptning

Integration

Automatisering

Begränsad

Bra

Utmärkt

Flexibilitet

Grundläggande

Bra

Maximal

Licens

Chloros+

Chloros+

Chloros+

F: Kan jag distribuera appar som skapats med SDK?S: SDK-kod kan integreras i dina applikationer, men:

  • Slutanvändarna måste ha Chloros installerat

  • Slutanvändarna måste ha aktiva Chloros+-licenser

  • Kommersiell distribution kräver OEM-licensiering.

Kontakta info@mapir.camera för OEM-förfrågningar.


F: Hur uppdaterar jag SDK?


F: Var sparas bearbetade bilder?

Som standard i projektvägen:


F: Kan jag bearbeta bilder från Python-skript som körs enligt schema?S: Ja! Använd Windows Task Scheduler med Python-skript:

Schemalägg via Task Scheduler för att köra dagligen.


F: Stöder SDK async/await?S: Den aktuella versionen är synkron. För asynkron funktion, använd wait=False eller kör i separat tråd:


F: Hur växlar jag mellan olika Chloros+-konton?S: Använd metoden logout() för att rensa cachade inloggningsuppgifter och logga sedan in igen med det nya kontot:

Efter utloggning, autentisera med det nya kontot via GUI, webbläsaren eller CLI innan du använder SDK igen.


Få hjälp

Dokumentation

  • API Referens: Denna sida

Supportkanaler

Exempelkod

Alla exempel som listas här är testade och produktionsklara. Kopiera och anpassa dem för ditt användningsfall.


SDK kräver ett aktivt Chloros+-abonnemang. Obehörig användning, distribution eller modifiering är förbjuden.

Last updated