API : Python SDK

Chloros Python SDK pruža programski pristup mehanizmu za obradu slike Chloros, omogućujući automatizaciju, prilagođene tijekove rada i besprijekornu integraciju s vašim Python aplikacijama i istraživačkim kanalima.

Ključne značajke

  • 🐍 Nativni Python - čist, Pythonic API za obradu slike

  • 🔧 Puni pristup API - Potpuna kontrola nad obradom Chloros

  • 🚀 Automatizacija - Izgradite prilagođene tijekove rada skupne obrade

  • 🔗 Integracija - Ugradite Chloros u postojeće Python aplikacije

  • 📊 Spremno za istraživanje - savršeno za znanstvene analize

  • Paralelna obrada - skalira na vaše CPU jezgre (Chloros+)

Zahtjevi

Zahtjev
Detalji

Chloros instaliran

Windows: Desktop instalacija; Linux: paket .deb

Operativni sustav

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

Python

Python 3.7 ili noviji

Sjećanje

Minimalno 8 GB RAM-a (preporučuje se 16 GB)

Internet

Potrebno za aktivaciju licence

circle-exclamation

Brzi početak

Instalacija

Instalirajte putem pipa:

circle-info

Prvo postavljanje: Prije korištenja SDK, aktivirajte svoju licencu Chloros+ otvaranjem Chloros, Chloros (preglednik) ili Chloros CLI i prijavom sa svojim vjerodajnicama. Ovo treba učiniti samo jednom. Na Linux (bez GUI-ja), koristite: chloros-cli login user@example.com 'password'

Osnovna upotreba

Obradite mapu sa samo nekoliko redaka:

circle-info

Putovi na više platformi: Primjeri kodova na ovoj stranici koriste putove u stilu Windows (npr. C:\\DroneImages\\Flight001). Na Linux umjesto toga koristite staze Linux (npr. /home/user/drone_images/flight001 ili ~/drone_images/flight001). SDK radi identično na obje platforme.

Potpuna kontrola

Za napredne tijekove rada:


Vodič za instalaciju

Preduvjeti

Prije instaliranja SDK, provjerite imate li:

  1. Chloros instaliran — Windows: Desktop instalacijski program (preuzimanje); Linux: .deb paket (Linux instalacija)

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

  3. Aktivna licenca Chloros+ (nadogradnjaarrow-up-right)

Instalirajte putem pip-a

Standardna instalacija:

S podrškom za praćenje napretka:

Razvojna instalacija:

Provjerite instalaciju

Provjerite je li SDK ispravno instaliran:


Prvo postavljanje

Aktivacija licence

SDK koristi istu licencu kao Chloros, Chloros (preglednik) i Chloros CLI. Aktivirajte jednom putem GUI ili CLI:Windows:OtvoriteChloros ili Chloros (preglednik) i prijavite se na kartici Korisnik ili koristite karticu CLI.Linux: Koristite CLI (GUI nije dostupan):

Licenca se pohranjuje lokalno u predmemoriju i traje nakon ponovnog pokretanja.

circle-check
circle-info

Odjava: korisnici SDK mogu programski očistiti predmemorirane vjerodajnice pomoću metode logout(). Pogledajte metodu logout() u API Referenci.

Testiraj vezu

Provjerite da se SDK može povezati s Chloros:


API Referenca

ChlorosLocal Class

Glavna klasa za lokalnu obradu slike Chloros.

Konstruktor

Parametri:

Parametar
Upišite
Zadano
Opis

api_url

str

"http://localhost:5000"

URL lokalne pozadine Chloros

auto_start_backend

bool

True

Automatski pokreni pozadinu ako je potrebno

backend_exe

str

None (automatsko otkrivanje)

Put do pozadinske izvršne

timeout

int

30

Istek zahtjeva u sekundama

backend_startup_timeout

int

60

Istek vremena za pokretanje pozadine (sekunde)

Primjeri:

circle-info

Automatsko otkrivanje više platformi: SDK automatski pokušava ispravnu pozadinsku putanju za vašu platformu:

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

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

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


Metode

create_project(project_name, camera=None)

Napravite novi projekt Chloros.

Parametri:

Parametar
Upišite
Obavezno
Opis

project_name

str

Da

Naziv za projekt

camera

str

Ne

Predložak kamere (npr. "Survey3N_RGN", "Survey3W_OCN")

Vraća: dict - Odgovor na stvaranje projektaPrimjer:


import_images(folder_path, recursive=False)

Uvoz slika iz mape.

Parametri:

Parametar
Upišite
Obavezno
Opis

folder_path

str/put

Da

Put do mape sa slikama

recursive

bool

Ne

Pretraživanje podmapa (zadano: False)

Vraća: dict - Uvoz rezultata s brojem datotekaPrimjer:


configure(**settings)

Konfigurirajte postavke obrade.

Parametri:

Parametar
Upišite
Zadano
Opis

debayer

str

"Standardno (brzo, srednje kvalitete)"

Debayerova metoda

vignette_correction

bool

True

Omogući ispravak vinjete

reflectance_calibration

bool

True

Omogući kalibraciju refleksije

indices

popis

None

Vegetacijski indeksi za izračunavanje

export_format

str

"TIFF (16-bitni)"

Izlazni format

ppk

bool

False

Omogući PPK ispravke

custom_settings

izreka

None

Napredne prilagođene postavke

Formati izvoza:

  • "TIFF (16-bit)" - Preporučeno za GIS/fotogrametriju

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

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

  • "JPG (8-bit)" - Komprimirani izlaz

**Dostupni indeksi:**NDVI, NDRE, GNDVI, OSAVI, CIG, EVI, SAVI, MSAVI, MTVI2, i više.Primjer:


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

Obradite slike projekta.

Parametri:

Parametar
Upišite
Zadano
Opis

mode

str

"parallel"

Način obrade: "paralelni" ili "serijski"

wait

bool

True

Pričekajte završetak

progress_callback

pozivati ​​

None

Funkcija povratnog poziva napretka (progress, msg)

poll_interval

lebdjeti

2.0

Interval prozivanja za napredak (sekunde)

Povrati: dict - Rezultati obrade

circle-exclamation

Primjer:


get_config()

Dobijte trenutnu konfiguraciju projekta.

Povrati: dict - trenutna konfiguracija projektaPrimjer:


get_status()

Dobijte informacije o statusu pozadine uključujući napredak obrade po niti.

Povratak: dict - status pozadine sa sljedećom strukturom:

Primjer:


shutdown_backend()

Isključite pozadinu (ako je pokrenuo SDK).

Primjer:


logout()

Očistite predmemorirane vjerodajnice iz lokalnog sustava.

Opis:

Programski se odjavljuje uklanjanjem predmemoriranih vjerodajnica za provjeru autentičnosti. Ovo je korisno za:

  • Prebacivanje između različitih Chloros+ računa

  • Brisanje vjerodajnica u automatiziranim okruženjima

  • Sigurnosne svrhe (npr. uklanjanje vjerodajnica prije deinstalacije)

Povratak: dict - Rezultat operacije odjavePrimjer:

circle-info

Potrebna je ponovna autentifikacija: Nakon poziva logout(), morate se ponovno prijaviti putem Chloros, Chloros (preglednik) ili Chloros CLI prije korištenja SDK.


Pogodne funkcije

process_folder(folder_path, **options)

Pogodna funkcija jednog retka za obradu mape.

Parametri:

Parametar
Upišite
Zadano
Opis

folder_path

str/put

Obavezno

Put do mape sa slikama

project_name

str

Automatski generirano

Naziv projekta

camera

str

None

Predložak kamere

indices

popis

["NDVI"]

Indeksi za izračun

vignette_correction

bool

True

Omogući ispravak vinjete

reflectance_calibration

bool

True

Omogući kalibraciju refleksije

export_format

str

"TIFF (16-bitni)"

Izlazni format

mode

str

"parallel"

Način obrade

progress_callback

pozivati ​​

None

Povratni poziv napredovanja

Povrati: dict - Obrada rezultataPrimjer:


Podrška za upravitelja konteksta

SDK podržava upravitelje konteksta za automatsko čišćenje:


Potpuni primjeri

circle-info

Korisnici Linux: Svi primjeri u nastavku koriste staze Windows. Zamijenite staze C:\\... svojim stazama Linux (npr. /home/user/... ili ~/...). Sve funkcije SDK identične su na svim platformama.

Primjer 1: Osnovna obrada

Obradite mapu sa zadanim postavkama:


Primjer 2: Prilagođeni tijek rada

Potpuna kontrola nad procesnim cjevovodom:


Primjer 3: Skupna obrada više mapa

Obrada više skupova podataka o letu:


Primjer 4: Integracija istraživačkog cjevovoda

Integrirajte Chloros s analizom podataka:


Primjer 5: Prilagođeno praćenje napretka

Napredno praćenje napretka uz bilježenje:


Primjer 6: Rješavanje grešaka

Robusno rukovanje pogreškama za proizvodnu upotrebu:


Primjer 7: Upravljanje računom i odjava

Upravljajte vjerodajnicama programski:


Primjer 8: Alat za naredbeni redak

Izgradite prilagođeni alat CLI s SDK:

Korištenje:


Rukovanje iznimkama

SDK pruža posebne klase izuzetaka za različite vrste grešaka:

Hijerarhija izuzetaka

Primjeri izuzetaka


Napredne teme

Prilagođena pozadinska konfiguracija

Koristite prilagođenu pozadinsku lokaciju ili konfiguraciju:

Obrada bez blokiranja

Započnite obradu i nastavite s drugim zadacima:

Upravljanje memorijom

Za velike skupove podataka obradite u serijama:


Rješavanje problema

Pozadina se ne pokreće

Problem: SDK ne uspijeva pokrenuti pozadinuRješenja:

  1. Provjerite je li instaliran Chloros:

  1. Provjerite vatrozid (Windows) ili dostupnost priključka (Linux: lsof -i :5000)

  2. Isprobajte ručni pozadinski put:


Licenca nije otkrivenaProblem: SDK upozorava na nedostatak licenceRješenja:

  1. Otvorite Chloros, Chloros (preglednik) ili Chloros CLI i prijavite se.

  2. Provjerite je li licenca spremljena u predmemoriju:

  1. Ako imate problema s vjerodajnicama, izbrišite predmemorirane vjerodajnice i ponovno se prijavite:

  1. Kontaktirajte podršku: info@mapir.camera


Pogreške pri uvozuProblem: ModuleNotFoundError: No module named 'chloros_sdk'Rješenja:


Istek vremena obradeProblem: Obrada je isteklaRješenja:

  1. Povećajte vrijeme čekanja:

  1. Obraditi manje serije

  2. Provjerite raspoloživi prostor na disku

  3. Pratite resurse sustava


Port se već koristiProblem: Pozadinski priključak 5000 zauzetRješenja:

Ili pronađite i zatvorite sukobljeni proces:


Savjeti za izvedbu

Optimizirajte brzinu obrade

  1. Koristite paralelni način rada (zahtijeva Chloros+)

  1. Smanjite izlaznu rezoluciju (ako je prihvatljivo)

  1. Onemogući nepotrebne indekse

  1. Proces na SSD-u (ne na HDD-u)***

Optimizacija memorije

Za velike skupove podataka:


Obrada u pozadini

Oslobodite Python za druge zadatke:


Primjeri integracije

Django integracija

Bočica API

Jupyterova bilježnica


FAQ

P: Da li SDK zahtijeva internetsku vezu?

O: Samo za početnu aktivaciju licence. Nakon prijave putem Chloros, Chloros (preglednik) ili Chloros CLI licenca se lokalno predmemorira i radi izvan mreže 30 dana.***

P: Mogu li koristiti SDK na poslužitelju bez GUI-ja?O: Da! SDK radi bez glave na Windows i Linux poslužiteljima.Linux (preporučeno za bez glave):

  • Instalirajte putem .deb paketa

  • Aktiviraj licencu: chloros-cli login user@example.com 'password'

Windows poslužitelj:

  • Windows poslužitelj 2016 ili noviji

  • Chloros instaliran (jednokratno)

  • Licenca se aktivira putem CLI ili na bilo kojem računalu


P: Koja je razlika između računala, CLI i SDK?

Značajka
GUI radne površine
CLI naredbeni redak
Python SDK

Sučelje

Pokažite i kliknite

Naredba

Python API

Najbolje za

Vizualni rad

Skriptiranje

Integracija

Automatizacija

Ograničeno

dobro

Izvrsno

Fleksibilnost

Osnovno

dobro

Maksimalno

Licenca

Chloros+

Chloros+

Chloros+

P: Mogu li distribuirati aplikacije izgrađene s SDK?A: SDK kod može se integrirati u vaše aplikacije, ali:

  • Krajnji korisnici moraju imati instaliran Chloros

  • Krajnji korisnici trebaju aktivne Chloros+ licence

  • Komercijalna distribucija zahtijeva OEM licencu

Kontaktirajte info@mapir.camera za OEM upite.


P: Kako mogu ažurirati SDK?


P: Gdje se spremaju obrađene slike?

Prema zadanim postavkama, u Putanju projekta:


P: Mogu li obraditi slike iz Python skripti koje se izvode prema rasporedu?O: Da! Koristite svoj planer OS-a s Python skriptama:

Windows: Zakažite raspored putem Planera zadataka za svakodnevno pokretanje.Linux: Raspored putem cron-a:


P: Podržava li SDK async/await?O: Trenutna verzija je sinkrona. Za asinkrono ponašanje koristite wait=False ili pokrenite u zasebnoj niti:


P: Kako se prebacivati ​​između različitih Chloros+ računa?A: Upotrijebite metodu logout() za brisanje predmemoriranih vjerodajnica, a zatim se ponovno prijavite s novim računom:

Nakon odjave, provjerite autentičnost pomoću novog računa putem GUI-ja, preglednika ili CLI prije ponovne upotrebe SDK.


Dobivanje pomoći

Dokumentacija

  • API Referenca: Ova stranica

Kanali podrške

Uzorak koda

Svi ovdje navedeni primjeri testirani su i spremni za proizvodnju. Kopirajte ih i prilagodite za svoj slučaj upotrebe.


LicencaVlasnički softver - Autorska prava (c) 2025 MAPIR Inc.

SDK zahtijeva aktivnu Chloros+ pretplatu. Zabranjeno je neovlašteno korištenje, distribucija ili izmjena.

Last updated