API: Python SDK

Chloros Python SDK omogoča programski dostop do procesorja za obdelavo slik Chloros, kar omogoča avtomatizacijo, prilagojene delovne tokove in nemoteno integracijo z vašimi aplikacijami Python in raziskovalnimi procesi.

Ključne značilnosti

  • 🐍 Native Python - Čisti, Pythonic API za obdelavo slik

  • 🔧 Popoln dostop do API - Popoln nadzor nad obdelavo Chloros

  • 🚀 Avtomatizacija - Ustvarjanje prilagojenih delovnih tokov za obdelavo v serijah

  • 🔗 Integracija – vključite Chloros v obstoječe aplikacije Python

  • 📊 Pripravljen za raziskave – idealen za znanstvene analitične poti

  • Vzporedna obdelava – prilagaja se vašim jedrom CPU (Chloros+)

Zahteve

Zahteva
Podrobnosti

Chloros Desktop

Mora biti nameščen lokalno

Operacijski sistem

Windows 10/11 (64-bitni)

Python

Python 3.7 ali višji

Pomnilnik

Najmanj 8 GB RAM (priporočeno 16 GB)

Internet

Potreben za aktivacijo licence

circle-info

Zahteve za licenco: Python SDK zahteva plačano naročnino Chloros+ za dostop do API. Standardni (brezplačni) načrti nimajo dostopa do API/SDK. Obiščite https://cloud.mapir.camera/pricingarrow-up-right, da nadgradite.

Hitri začetek

Namestitev

Namestite prek pip:

circle-info

Prva namestitev: Pred uporabo SDK aktivirajte svojo licenco Chloros+ tako, da odprete Chloros, Chloros (brskalnik) ali Chloros CLI in se prijavite s svojimi poverilnicami. To je treba narediti le enkrat.

Osnovna uporaba

Obdelajte mapo z le nekaj vrsticami:

Popoln nadzor

Za napredne delovne tokove:


Predpogoji

Pred namestitvijo SDK se prepričajte, da imate:

  1. Chloros Desktop (prenesi)

  2. Aktivno licenco Chloros+ (nadgradnjaarrow-up-right)

Namestitev prek pip

Standardna namestitev:

S podporo za spremljanje napredka:

Namestitev za razvoj:

Preverjanje namestitve

Preverite, ali je SDK pravilno nameščen:


Prva namestitev

Aktiviranje licence

SDK uporablja isto licenco kot Chloros, Chloros (brskalnik) in Chloros CLI. Aktivirajte enkrat prek GUI ali CLI:

  1. Odprite Chloros ali Chloros (brskalnik)in se prijavite na kartici Uporabnik . Ali pa odpriteCLI.

  2. Vnesite svoje poverilnice Chloros+ in se prijavite

  3. Licenca se shrani v lokalni predpomnilnik (ohrani se tudi po ponovnem zagonu)

Enkratna nastavitev: Po prijavi prek GUI ali CLI, SDK samodejno uporabi shranjeno licenco. Dodatna avtentifikacija ni potrebna!

circle-info

Odjava: SDK uporabniki lahko programsko izbrišejo shranjena pooblastila z metodo logout(). Glejte metodo logout() v referenčnem priročniku API.

Preizkus povezave

Preverite, ali se SDK lahko poveže z Chloros:


API Reference

Razred ChlorosLocal

Glavni razred za lokalno obdelavo slik Chloros.

Konstruktor

Parametri:

Parameter
Tip
Privzeto
Opis

api_url

str

"http://localhost:5000"

URL lokalnega Chloros backenda

auto_start_backend

bool

True

Samodejni zagon backenda, če je potrebno

backend_exe

str

None (samodejno zaznavanje)

Pot do izvedljive datoteke backenda

timeout

int

30

Časovni limit zahtevka v sekundah

backend_startup_timeout

int

60

Časovni limit za zagon backenda (v sekundah)

Primeri:


Metode

create_project(project_name, camera=None)

Ustvari nov projekt Chloros.

Parametri:

Parameter
Tip
Obvezno
Opis

project_name

str

Da

Ime projekta

camera

str

Ne

Predloga kamere (npr. »Survey3N_RGN«, »Survey3W_OCN«)

Vrne: dict – odgovor na ustvarjanje projektaPrimer:


import_images(folder_path, recursive=False)

Uvoz slike iz mape.

Parametri:

Parameter
Tip
Obvezno
Opis

folder_path

str/Pot

Da

Pot do mape s slikami

recursive

bool

Ne

Iskanje podmap (privzeto: False)

Vrne: dict – Rezultati uvoza s številom datotekPrimer:


configure(**settings)

Konfigurirajte nastavitve obdelave.

Parametri:

Parameter
Tip
Privzeto
Opis

debayer

str

»Visoka kakovost (hitrejša)«

Metoda Debayer

vignette_correction

bool

True

Omogoči popravek vinjete

reflectance_calibration

bool

True

Omogoči kalibracijo odbojnosti

indices

seznam

None

Indeksi vegetacije za izračun

export_format

str

"TIFF (16-bit)"

Izhodni format

ppk

bool

False

Omogoči PPK popravke

custom_settings

dict

None

Napredne prilagojene nastavitve

Izvozni formati:

  • "TIFF (16-bit)" – priporočljivo za GIS/fotogrametrijo

  • "TIFF (32-bit, Percent)" – znanstvena analiza

  • "PNG (8-bit)" – vizualni pregled

  • "JPG (8-bit)" – stisnjena izhodna datoteka

**Razpoložljivi indeksi:**NDVI, NDRE, GNDVI, OSAVI, CIG, EVI, SAVI, MSAVI, MTVI2 in drugi.Primer:


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

Obdelajte slike projekta.

Parametri:

Parameter
Tip
Privzeto
Opis

mode

str

"parallel"

Način obdelave: »vzporedno« ali »zaporedno«

wait

bool

True

Čakaj na dokončanje

progress_callback

callable

None

Funkcija za povratno klicanje napredka (napredek, msg)

poll_interval

float

2.0

Interval za preverjanje napredka (sekunde)

Vrne: dict – Rezultati obdelave

circle-info

Vzporedni način: Zahteva licenco Chloros+. Samodejno se prilagaja vašim jedrom CPU (do 16 delavcev).

Primer:


get_config()

Pridobi trenutno konfiguracijo projekta.

Vrne: dict – Trenutna konfiguracija projektaPrimer:


get_status()

Pridobi informacije o stanju backenda.

Vrne: dict - Stanje backendaPrimer:


shutdown_backend()

Zapre backend (če ga je zagnal SDK).

Primer:


logout()

Izbriše shranjena poverilnica iz lokalnega sistema.

Opis:

Programsko se odjavi z odstranitvijo shranjenih poverilnic za avtentifikacijo. To je koristno za:

  • Preklapljanje med različnimi računi Chloros+

  • Izbris poverilnic v avtomatiziranih okoljih

  • Varnostne namene (npr. odstranitev poverilnic pred odstranitvijo programa)

Vrne: dict – Rezultat operacije odjavePrimer:

circle-info

Potrebna ponovna avtentifikacija: Po klicu logout() se morate ponovno prijaviti prek Chloros, Chloros (brskalnik) ali Chloros CLI, preden uporabite SDK.


Funkcije za lažje delo

process_folder(folder_path, **options)

Enovrstična priročna funkcija za obdelavo mape.

Parametri:

Parameter
Tip
Privzeto
Opis

folder_path

str/Path

Obvezno

Pot do mape s slikami

project_name

str

Samodejno ustvarjeno

Ime projekta

camera

str

None

Predloga kamere

indices

list

["NDVI"]

Indeksi za izračun

vignette_correction

bool

True

Omogoči popravek vinjete

reflectance_calibration

bool

True

Omogoči kalibracijo odbojnosti

export_format

str

"TIFF (16-bit)"

Izhodni format

mode

str

"parallel"

Način obdelave

progress_callback

callable

None

Povratni klic napredka

Vrne: dict – Rezultati obdelavePrimer:


Podpora za upravitelja konteksta

SDK podpira upravitelje konteksta za samodejno čiščenje:


Celotni primeri

Primer 1: Osnovna obdelava

Obdelava mape s privzetimi nastavitvami:


Primer 2: Prilagojeni delovni tok

Popoln nadzor nad potekom obdelave:


Primer 3: Obdelava več map v paketu

Obdelava več podatkovnih nizov letov:


Primer 4: integracija raziskovalnega procesa

Integracija Chloros z analizo podatkov:


Primer 5: prilagojeno spremljanje napredka

Napredno spremljanje napredka z beleženjem:


Primer 6: Obravnavanje napak

Zanesljivo obravnavanje napak za uporabo v proizvodnji:


Primer 7: Upravljanje računa in odjava

Programsko upravljanje poverilnic:


Primer 8: Orodje za ukazno vrstico

Izdelajte prilagojeno orodje CLI z SDK:

Uporaba:


Obravnavanje izjem

SDK zagotavlja posebne razrede izjem za različne vrste napak:

Hierarhija izjem

Primeri izjem


Napredne teme

Prilagojena konfiguracija backenda

Uporabite prilagojeno lokacijo ali konfiguracijo backenda:

Neoviranje obdelave

Začnite obdelavo in nadaljujte z drugimi nalogami:

Upravljanje pomnilnika

Za velike podatkovne nize obdelujte v serijah:


Odpravljanje težav

Backend se ne zažene

Težava: SDK ne more zažeti backenda.Rešitve:

  1. Preverite, ali je nameščen Chloros Desktop:

  1. Preverite, ali Windows požarni zid ne blokira

  2. Poskusite z ročno potjo backenda:


Licenca ni zaznanaTežava: SDK opozarja na manjkajočo licencoRešitve:

  1. Odprite Chloros, Chloros (brskalnik) ali Chloros CLI in se prijavite.

  2. Preverite, ali je licenca shranjena v predpomnilniku:

  1. Če imate težave s poverilnicami, počistite shranjene poverilnice in se ponovno prijavite:

  1. Obrnite se na podporo: info@mapir.camera


Napake pri uvozuTežava: ModuleNotFoundError: No module named 'chloros_sdk'Rešitve:


Časovni limit obdelaveTežava: Časovni limit obdelaveRešitve:

  1. Podaljšajte časovni limit:

  1. Obdelujte manjše serije

  2. Preverite razpoložljivi prostor na disku

  3. Nadzorujte sistemske vire


Vrata so že v uporabiProblem: Vrata 5000 v ozadju so zasedenaRešitve:

Ali poiščite in zaprite proces, ki povzroča konflikt:


Nasveti za izboljšanje zmogljivosti

Optimizirajte hitrost obdelave

  1. Uporabite vzporedni način (zahteva Chloros+)

  1. Zmanjšajte ločljivost izhoda (če je sprejemljivo)

  1. Onemogočite nepotrebne indekse

  1. Obdelujte na SSD (ne na HDD)***

Optimiziranje pomnilnika

Za velike podatkovne nize:


Obdelava v ozadju

Sprostite Python za druge naloge:


Primeri integracije

Integracija Django

Flask API

Jupyter Notebook


Pogosta vprašanja

V: Ali SDK zahteva internetno povezavo?

O: Samo za začetno aktiviranje licence. Po prijavi prek Chloros, Chloros (brskalnik) ali Chloros CLI se licenca shrani v lokalni predpomnilnik in deluje brez povezave 30 dni.***

V: Ali lahko uporabljam SDK na strežniku brez grafičnega vmesnika?O: Da! Zahteve:

  • Windows Server 2016 ali novejši

  • Chloros nameščen (enkratno)

  • Licenca aktivirana na katerem koli računalniku (licenca v predpomnilniku kopirana na strežnik)


V: Kakšna je razlika med Desktop, CLI in SDK?

Funkcija
Desktop GUI
CLI ukazna vrstica
Python SDK

Vmesnik

Klikni in izberi

Ukazna vrstica

Python API

Najbolj primerno za

Vizualno delo

Pisanje skriptov

Integracija

Avtomatizacija

Omejena

Dobra

Odlična

Prilagodljivost

Osnovna

Dobra

Največja

Licenca

Chloros+

Chloros+

Chloros+

V: Ali lahko distribuiram aplikacije, ustvarjene z SDK?O: Kodo SDK lahko vključite v svoje aplikacije, vendar:

  • Končni uporabniki morajo imeti nameščen Chloros.

  • Končni uporabniki morajo imeti aktivne licence Chloros+.

  • Komercialna distribucija zahteva licenco OEM.

Za vprašanja v zvezi z OEM se obrnite na info@mapir.camera.


V: Kako posodobim SDK?


V: Kje se shranijo obdelane slike?

Privzeto v poti projekta:


V: Ali lahko obdelujem slike iz skriptov Python, ki tečejo po urniku?O: Da! Uporabite Windows Task Scheduler s skripti Python:

Načrtujte prek načrtovalnika opravil, da se izvaja dnevno.


V: Ali SDK podpira async/await?O: Trenutna različica je sinhrona. Za asinhrono delovanje uporabite wait=False ali izvajajte v ločenem niti:


V: Kako preklopim med različnimi računi Chloros+?O: Uporabite metodo logout(), da izbrišete shranjena poverilnica, nato se ponovno prijavite z novim računom:

Po odjavi se avtentificirajte z novim računom prek GUI, brskalnika ali CLI, preden ponovno uporabite SDK.


Pomoč

Dokumentacija

  • API Referenca: Ta stran

Kanali podpore

Vzorec kode

Vsi tukaj navedeni primeri so preizkušeni in pripravljeni za uporabo. Kopirajte jih in prilagodite za svoj primer uporabe.


SDK zahteva aktivno naročnino Chloros+. Neodobrena uporaba, distribucija ali sprememba je prepovedana.

Last updated