API : Python SDK

Chloros Python SDK omogoča programski dostop do motorja 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

  • 🐍 Nativni Python – Čist, Pythonski API za obdelavo slik

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

  • 🚀 Avtomatizacija – Ustvarjanje prilagojenih delovnih tokov za obdelavo v paketih

  • 🔗 Integracija – Vgradnja Chloros v obstoječe aplikacije Python

  • 📊 Pripravljeno za raziskave – Idealno za znanstvene analitične procese

  • Vzporedna obdelava – prilagaja se številu jeder vašega procesorja (Chloros+)

Zahteve

Zahteva
Podrobnosti

Chloros nameščen

Windows: namestitveni program za namizne računalnike; Linux: paket .deb

Operacijski sistem

Windows 10/11 (64-bitni), Linux x86_64 (amd64), Linux arm64 (NVIDIA Jetson JetPack 6)

Python

Python 3.7 ali višja

Pomnilnik

Najmanj 8 GB RAM (priporočeno 16 GB)

Internet

Potreben za aktivacijo licence

circle-exclamation

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 podatki. To je treba narediti le enkrat. Na Linux (brez grafičnega vmesnika) uporabite: chloros-cli login user@example.com 'password'

Osnovna uporaba

Obdelajte mapo z le nekaj vrsticami:

circle-info

Potki za različne platforme: Primeri kode na tej strani uporabljajo potke v slogu Windows (npr. C:\\DroneImages\\Flight001). V sistemu Linux namesto tega uporabite poti v slogu Linux (npr. /home/user/drone_images/flight001 ali ~/drone_images/flight001). SDK deluje enako na obeh platformah.

Popoln nadzor

Za napredne delovne tokove:


Predpogoji

Pred namestitvijo SDK se prepričajte, da imate:

  1. Chloros nameščen — Windows: Namestitveni program za namizje (prenos); Linux: paket .deb (Namestitev)

  2. Python 3.7+ nameščen (python.orgarrow-up-right)

  3. Aktivna licenca 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 grafičnega vmesnika ali CLI:Windows:OdpriteChloros ali Chloros (brskalnik) in se prijavite na zavihku Uporabnik ali uporabite CLI.Linux: Uporabite CLI (GUI ni na voljo):

Licenca je shranjena v lokalnem predpomnilniku in ostane veljavna tudi po ponovnem zagonu računalnika.

circle-check
circle-info

Odjava: Uporabniki SDK 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:


Referenca API

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 ozadja, če je potrebno

backend_exe

str

None (samodejno zaznavanje)

Pot do izvedljive datoteke ozadja

timeout

int

30

Časovna omejitev zahtevka v sekundah

backend_startup_timeout

int

60

Časovna omejitev za zagon ozadja (v sekundah)

Primeri:

circle-info

Samodejno zaznavanje med platformami: SDK samodejno poskusi pravo pot do ozadja za vašo platformo:

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

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

  • Linux (ročno): /opt/mapir/chloros/backend/chloros-backend


Metode

create_project(project_name, camera=None)

Ustvarite 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/Path

Da

Pot do mape s slikami

recursive

bool

Ne

Iskanje v podmapah (privzeto: False)

Vrne: dict - Rezultati uvoza s številom datotekPrimer:


configure(**settings)

Nastavi nastavitve obdelave.

Parametri:

Parameter
Tip
Privzeto
Opis

debayer

str

"Standard (Hitro, Srednja kakovost)"

Metoda Debayer

vignette_correction

bool

True

Omogoči popravek vinjetiranja

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čeno za GIS/fotogrametrijo

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

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

  • "JPG (8-bit)" – Stisnjen izhod

**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: »parallel« ali »serial«

wait

bool

True

Počakaj na zaključek

progress_callback

callable

None

Funkcija povratnega klica za napredek (progress, msg)

poll_interval

float

2.0

Interval poizvedovanja za napredek (sekunde)

Vrne: dict - Rezultati obdelave

circle-exclamation

Primer:


get_config()

Pridobi trenutno konfiguracijo projekta.

Vrne: dict - Trenutna konfiguracija projektaPrimer:


get_status()

Pridobi informacije o stanju ozadja, vključno z napredkom obdelave po posameznih niti.

Vrne: dict - Stanje ozadja z naslednjo strukturo:

Primer:


shutdown_backend()

Zaustavi backend (če je bil zagnan s SDK).

Primer:


logout()

Izbriše shranjena pooblastila 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

seznam

["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 upraviteljev konteksta

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


Celotni primeri

circle-info

Uporabniki Linux: Vsi spodnji primeri uporabljajo poti Windows. Pot C:\\... zamenjajte s svojimi potmi Linux (npr. /home/user/... ali ~/...). Vse funkcionalnosti SDK so enake na vseh platformah.

Primer 1: Osnovna obdelava

Obdelajte mapo s privzetimi nastavitvami:


Primer 2: Prilagojeni potek dela

Popoln nadzor nad potekom obdelave:


Primer 3: Obdelava več map v paketu

Obdelava več naborov podatkov o letih:


Primer 4: Integracija v raziskovalni proces

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 produkciji:


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

Konfiguracija prilagojenega ozadja

Uporabite prilagojeno lokacijo ali konfiguracijo ozadja:

Nezablokirajoča obdelava

Začnite obdelavo in nadaljujte z drugimi nalogami:

Upravljanje pomnilnika

Za velike nize podatkov obdelujte v serijah:


Odpravljanje težav

Backend se ne zažene

Težava: SDK ne more zagnati backendaRešitve:

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

  1. Preverite požarni zid (Windows) ali razpoložljivost vrat (Linux: lsof -i :5000)

  2. Poskusite z ročno potjo do backenda:


Licenca ni zaznanaProblem: 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, izbrišite 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:


Časovna omejitev obdelaveTežava: Obdelava se prekine zaradi časovne omejitveRešitve:

  1. Podaljšajte časovno omejitev:

  1. Obdelujte manjše serije

  2. Preverite razpoložljivi prostor na disku

  3. Nadzorujte sistemske vire


Vrata so že v uporabiTežava: Vrata strežnika 5000 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 to sprejemljivo)

  1. Onemogočite nepotrebne indekse

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

Optimizacija pomnilnika

Za velike podatkovne nize:


Obdelava v ozadju

Sprostite Python za druge naloge:


Primeri integracije

Integracija z Djangom

Flask API

Jupyter Notebook


Pogosta vprašanja

V: Ali SDK zahteva internetno povezavo?

O: Samo za začetno aktivacijo 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! SDK deluje brez grafičnega vmesnika na strežnikih Windows in Linux.Linux (priporočeno za brez grafičnega vmesnika):

  • Namestite prek paketa .deb

  • Aktivirajte licenco: chloros-cli login user@example.com 'password'

Strežnik Windows:

  • Strežnik Windows 2016 ali novejši

  • Nameščen Chloros (enkratno)

  • Licenca aktivirana prek CLI ali na katerem koli računalniku


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

Funkcija
Desktop GUI
CLI ukazna vrstica
Python SDK

Vmesnik

Točka-klik

Ukazna vrstica

Python API

Najbolj primerno za

Vizualno delo

Skriptiranje

Integracija

Avtomatizacija

Omejena

Dobra

Odlična

Prilagodljivost

Osnovna

Dobra

Največja

Licenca

Chloros+

Chloros+

Chloros+

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

  • Končni uporabniki morajo imeti nameščeno Chloros

  • Končni uporabniki morajo imeti aktivne licence Chloros+

  • Komercialna distribucija zahteva licenco OEM

Za poizvedbe glede licenc 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 se izvajajo po urniku?O: Da! Uporabite načrtovalnik operacijskega sistema s skripti Python:

Windows: Načrtujte prek načrtovalnika opravil, da se izvaja dnevno.Linux: Načrtujte prek cron:


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


V: Kako preklopim med različnimi računi Chloros+?O: Uporabite metodo logout() za izbris shranjenih poverilnic, nato se ponovno prijavite z novim računom:

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


Pomoč

Dokumentacija

  • API Referenca: Ta stran

Kanali podpore

Primer kode

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


LicencaLastniška programska oprema – Avtorske pravice (c) 2025 MAPIR Inc.

SDK zahteva aktivno naročnino Chloros+. Neodobrena uporaba, distribucija ali spreminjanje je prepovedano.

Last updated