API: Python SDK

Chloros Python SDK giver programmatisk adgang til Chloros billedbehandlingsmotor, hvilket muliggør automatisering, tilpassede arbejdsgange og problemfri integration med dine Python applikationer og forskningspipelines.

Nøglefunktioner

  • 🐍 Native Python - Rent, Pythonic API til billedbehandling

  • 🔧 Fuld API-adgang - Fuld kontrol over Chloros-behandling

  • 🚀 Automatisering - Opbyg brugerdefinerede batchbehandlingsworkflows

  • 🔗 Integration - Integrer Chloros i eksisterende Python-applikationer

  • 📊 Klar til forskning - Perfekt til videnskabelige analysepipelines

  • Parallel behandling - Skaleres til dine CPU-kerner (Chloros+)

Krav

Krav
Detaljer

Chloros Desktop

Skal være installeret lokalt

Operativsystem

Windows 10/11 (64-bit)

Python

Python 3.7 eller højere

Hukommelse

Minimum 8 GB RAM (16 GB anbefales)

Internet

Kræves til aktivering af licens

circle-info

Licenskrav: Python SDK kræver et betalt Chloros+ abonnement for at få adgang til API. Standardabonnementer (gratis) har ikke adgang til API/SDK. Besøg https://cloud.mapir.camera/pricingarrow-up-right for at opgradere.

Hurtig start

Installation

Installer via pip:

circle-info

Første gangs opsætning: Inden du bruger SDK, skal du aktivere din Chloros+-licens ved at åbne Chloros, Chloros (browser) eller Chloros CLI og logge ind med dine loginoplysninger. Dette behøver kun at gøres én gang.

Grundlæggende brug

Behandl en mappe med blot et par linjer:

Fuld kontrol

Til avancerede arbejdsgange:


Installationsvejledning

Forudsætninger

Før du installerer SDK, skal du sikre dig, at du har:

  1. Chloros Desktop installeret (download)

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

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

Installation via pip

Standardinstallation:

Med understøttelse af fremskridtsovervågning:

Udviklingsinstallation:

Bekræft installation

Test, at SDK er installeret korrekt:


Første opsætning

Licensaktivering

SDK bruger samme licens som Chloros, Chloros (browser) og Chloros CLI. Aktiver én gang via GUI eller CLI:

  1. Åbn Chloros eller Chloros (browser)og log ind på fanen Bruger fanen. Eller åbnCLI.

  2. Indtast dine Chloros+ legitimationsoplysninger og log ind

  3. Licensen gemmes lokalt (bevares ved genstart)

circle-info

Engangsopsætning: Efter login via GUI eller CLI bruger SDK automatisk den cachelagrede licens. Der kræves ingen yderligere godkendelse!

circle-info

Logout: SDK-brugere kan programmatisk rydde cachelagrede legitimationsoplysninger ved hjælp af metoden logout(). Se logout()-metoden i API-referencen.

Test forbindelse

Kontroller, at SDK kan oprette forbindelse til Chloros:


API-reference

ChlorosLocal-klasse

Hovedklasse til lokal Chloros-billedbehandling.

Konstruktør

Parametre:

Parameter
Type
Standard
Beskrivelse

api_url

str

"http://localhost:5000"

URL af lokal Chloros backend

auto_start_backend

bool

True

Start automatisk backend, hvis nødvendigt

backend_exe

str

None (auto-detect)

Sti til backend-eksekverbar fil

timeout

int

30

Anmodningstidsfrist i sekunder

backend_startup_timeout

int

60

Tidsfrist for backend-opstart (sekunder)

Eksempler:


Metoder

create_project(project_name, camera=None)

Opret et nyt Chloros-projekt.

Parametre:

Parameter
Type
Påkrævet
Beskrivelse

project_name

str

Ja

Navn på projektet

camera

str

Nej

Kameraskabelon (f.eks. "Survey3N_RGN", "Survey3W_OCN")

Returnerer: dict - Svar på oprettelse af projektEksempel:


import_images(folder_path, recursive=False)

Importer billeder fra en mappe.

Parametre:

Parameter
Type
Påkrævet
Beskrivelse

folder_path

str/Path

Ja

Sti til mappe med billeder

recursive

bool

Nej

Søg i undermapper (standard: Falsk)

Returnerer: dict - Importer resultater med filantalEksempel:


configure(**settings)

Konfigurer behandlingsindstillinger.

Parametre:

Parameter
Type
Standard
Beskrivelse

debayer

str

"Høj kvalitet (hurtigere)"

Debayer-metode

vignette_correction

bool

True

Aktivér vignettekorrektion

reflectance_calibration

bool

True

Aktivér reflektanskalibrering

indices

liste

None

Vegetationsindekser, der skal beregnes

export_format

str

"TIFF (16-bit)"

Outputformat

ppk

bool

False

Aktivér PPK-korrektioner

custom_settings

dict

None

Avancerede brugerdefinerede indstillinger

Eksportformater:

  • "TIFF (16-bit)" - Anbefales til GIS/fotogrammetri

  • "TIFF (32-bit, Percent)" - Videnskabelig analyse

  • "PNG (8-bit)" - Visuel inspektion

  • "JPG (8-bit)" - Komprimeret output

**Tilgængelige indekser:**NDVI, NDRE, GNDVI, OSAVI, CIG, EVI, SAVI, MSAVI, MTVI2 og flere.Eksempel:


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

Behandl projektbillederne.

Parametre:

Parameter
Type
Standard
Beskrivelse

mode

str

"parallel"

Behandlingsmodus: "parallel" eller "seriel"

wait

bool

True

Vent på færdiggørelse

progress_callback

callable

None

Tilbagekaldsfunktion for fremskridt (fremskridt, msg)

poll_interval

float

2.0

Polling-interval for fremskridt (sekunder)

Returnerer: dict - Behandlingsresultater

circle-info

Parallel tilstand: Kræver Chloros+ licens. Skaleres automatisk til dine CPU-kerner (op til 16 arbejdere).

Eksempel:


get_config()

Hent den aktuelle projektkonfiguration.

Returnerer: dict - Aktuel projektkonfigurationEksempel:


get_status()

Henter backend-statusoplysninger.

Returnerer: dict - Backend-statusEksempel:


shutdown_backend()

Lukker backend (hvis startet af SDK).

Eksempel:


logout()

Rydder cachelagrede legitimationsoplysninger fra det lokale system.

Beskrivelse:

Logger programmatisk ud ved at fjerne cachelagrede legitimationsoplysninger. Dette er nyttigt til:

  • Skift mellem forskellige Chloros+-konti

  • Rydning af legitimationsoplysninger i automatiserede miljøer

  • Sikkerhedsformål (f.eks. fjernelse af legitimationsoplysninger før afinstallation)

Returnerer: dict - Resultat af logout-operationEksempel:

circle-info

Genbekræftelse påkrævet: Efter at have kaldt logout() skal du logge ind igen via Chloros, Chloros (browser) eller Chloros CLI, før du bruger SDK.


Praktiske funktioner

process_folder(folder_path, **options)

Enkel praktisk funktion til at behandle en mappe.

Parametre:

Parameter
Type
Standard
Beskrivelse

folder_path

str/Path

Påkrævet

Sti til mappe med billeder

project_name

str

Autogenereret

Projektnavn

camera

str

None

Kameraskabelon

indices

liste

["NDVI"]

Indekser til beregning

vignette_correction

bool

True

Aktivér vignettekorrektion

reflectance_calibration

bool

True

Aktivér reflektanskalibrering

export_format

str

"TIFF (16-bit)"

Outputformat

mode

str

"parallel"

Behandlingsmodus

progress_callback

callable

None

Progress callback

Returnerer: dict - BehandlingsresultaterEksempel:


Understøttelse af kontekststyring

SDK understøtter kontekststyring til automatisk oprydning:


Komplette eksempler

Eksempel 1: Grundlæggende behandling

Behandl en mappe med standardindstillinger:


Eksempel 2: Tilpasset arbejdsgang

Fuld kontrol over behandlingspipeline:


Eksempel 3: Batchbehandling af flere mapper

Behandl flere flyvedatasæt:


Eksempel 4: Integration af forskningspipeline

Integrer Chloros med dataanalyse:


Eksempel 5: Brugerdefineret overvågning af fremskridt

Avanceret sporing af fremskridt med logning:


Eksempel 6: Fejlhåndtering

Robust fejlhåndtering til produktionsbrug:


Eksempel 7: Kontoadministration og logout

Administrer legitimationsoplysninger programmatisk:


Eksempel 8: Kommandolinjeværktøj

Byg et brugerdefineret CLI-værktøj med SDK:

Anvendelse:


Håndtering af undtagelser

SDK indeholder specifikke undtagelsesklasser for forskellige fejltyper:

Undtagelseshierarki

Eksempler på undtagelser


Avancerede emner

Brugerdefineret backend-konfiguration

Brug en brugerdefineret backend-placering eller -konfiguration:

Ikke-blokerende behandling

Start behandlingen og fortsæt med andre opgaver:

Hukommelsesstyring

For store datasæt skal du behandle i batches:


Fejlfinding

Backend starter ikke

Problem: SDK kan ikke starte backendLøsninger:

  1. Kontroller, at Chloros Desktop er installeret:

  1. Kontroller, at Windows Firewall ikke blokerer

  2. Prøv manuel backend-sti:


Licens ikke fundetProblem: SDK advarer om manglende licensLøsninger:

  1. Åbn Chloros, Chloros (browser) eller Chloros CLI og log ind.

  2. Kontroller, at licensen er gemt i cachen:

  1. Hvis du oplever problemer med legitimationsoplysninger, skal du rydde cachelagrede legitimationsoplysninger og logge ind igen:

  1. Kontakt support: info@mapir.camera


ImportfejlProblem: ModuleNotFoundError: No module named 'chloros_sdk'Løsninger:


Behandlingstid udløbetProblem: Behandlingstiden udløberLøsninger:

  1. Forøg timeout:

  1. Behandl mindre batcher

  2. Kontroller ledig diskplads

  3. Overvåg systemressourcer


Port allerede i brugProblem: Backend-port 5000 optagetLøsninger:

Eller find og luk den konfliktende proces:


Tips til ydeevne

Optimer behandlingshastigheden

  1. Brug parallel tilstand (kræver Chloros+)

  1. Reducer outputopløsningen (hvis det er acceptabelt)

  1. Deaktiver unødvendige indekser

  1. Behandl på SSD (ikke HDD)***

Hukommelsesoptimering

For store datasæt:


Baggrundsbehandling

Frigør Python til andre opgaver:


Integrations eksempler

Django-integration

Flask API

Jupyter Notebook


Ofte stillede spørgsmål

Spørgsmål: Kræver SDK en internetforbindelse?

Svar: Kun til den første licensaktivering. Efter login via Chloros, Chloros (browser) eller Chloros CLI gemmes licensen lokalt og fungerer offline i 30 dage.***

Spørgsmål: Kan jeg bruge SDK på en server uden GUI?Svar: Ja! Krav:

  • Windows Server 2016 eller nyere

  • Chloros installeret (engangsinstallation)

  • Licens aktiveret på en hvilken som helst maskine (cachelagret licens kopieret til serveren)


Spørgsmål: Hvad er forskellen mellem Desktop, CLI og SDK?

Funktion
Desktop GUI
CLI Kommandolinje
Python SDK

Grænseflade

Point-click

Kommando

Python API

Bedst til

Visuelt arbejde

Scripting

Integration

Automatisering

Begrænset

God

Fremragende

Fleksibilitet

Grundlæggende

God

Maksimal

Licens

Chloros+

Chloros+

Chloros+

Spørgsmål: Kan jeg distribuere apps, der er udviklet med SDK?Svar: SDK-kode kan integreres i dine applikationer, men:

  • Slutbrugerne skal have Chloros installeret.

  • Slutbrugerne skal have aktive Chloros+-licenser.

  • Kommerciel distribution kræver OEM-licenser.

Kontakt info@mapir.camera for spørgsmål vedrørende OEM.


Spørgsmål: Hvordan opdaterer jeg SDK?


Spørgsmål: Hvor gemmes de behandlede billeder?

Som standard i projektstien:


Spørgsmål: Kan jeg behandle billeder fra Python-scripts, der kører efter en tidsplan?Svar: Ja! Brug Windows Task Scheduler med Python-scripts:

Planlæg via Task Scheduler til at køre dagligt.


Spørgsmål: Understøtter SDK async/await?Svar: Den aktuelle version er synkron. For asynkron adfærd skal du bruge wait=False eller køre i en separat tråd:


Spørgsmål: Hvordan skifter jeg mellem forskellige Chloros+-konti?Svar: Brug metoden logout() til at rydde cachelagrede legitimationsoplysninger, og log derefter ind igen med den nye konto:

Efter logout skal du godkende den nye konto via GUI, browser eller CLI, før du bruger SDK igen.


Få hjælp

Dokumentation

  • API Reference: Denne side

Supportkanaler

Eksempelkode

Alle eksempler, der er angivet her, er testet og klar til brug. Kopier og tilpas dem til dit brugsscenarie.


SDK kræver et aktivt Chloros+-abonnement. Uautoriseret brug, distribution eller ændring er forbudt.

Last updated