API : Python SDK

Chloros Python SDK pakub programmilist juurdepääsu Chloros pilditöötlusmootorile, võimaldades automatiseerimist, kohandatud töövooge ja sujuvat integratsiooni teie Python rakenduste ja uurimisprotsessidega.

Peamised omadused

  • 🐍 Native Python - Puhas, Pythonic API pilditöötluseks

  • 🔧 Täielik API juurdepääs - Täielik kontroll Chloros töötlemise üle

  • 🚀 Automatiseerimine - Kohandatud partiide töötlemise töövoogude loomine

  • 🔗 Integreerimine – Chloros integreerimine olemasolevatesse Python rakendustesse

  • 📊 Uurimistööks valmis – ideaalne teadusliku analüüsi protsesside jaoks

  • Paralleelne töötlemine – skaleeritav vastavalt teie CPU tuumadele (Chloros+)

Nõuded

Nõue
Detailid

Chloros Desktop

Peab olema kohalikult installitud

Operatsioonisüsteem

Windows 10/11 (64-bitine)

Python

Python 3.7 või uuem

Mälu

Minimaalselt 8 GB RAM (soovitatav 16 GB)

Internet

Vajalik litsentsi aktiveerimiseks

circle-info

Litsentsinõuded: Python SDK nõuab tasulist Chloros+ tellimust, et pääseda juurde API-ile. Standard (tasuta) paketid ei sisalda juurdepääsu API/SDK-ile. Külasta https://cloud.mapir.camera/pricingarrow-up-right, et uuendada.

Kiirstart

Paigaldamine

Paigaldage pipi kaudu:

circle-info

Esmane seadistamine: Enne SDK kasutamist aktiveerige oma Chloros+ litsents, avades Chloros, Chloros (brauser) või Chloros CLI ja logige sisse oma kasutajatunnuse ja parooliga. Seda tuleb teha ainult üks kord.

Põhiline kasutus

Käsitlege kaustu vaid mõne rea abil:

Täielik kontroll

Täpsemate töövoogude jaoks:


Paigaldusjuhend

Eeltingimused

Enne SDK paigaldamist veenduge, et teil on:

  1. Chloros Desktop installitud (alla laadida)

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

  3. Aktiivne Chloros+ litsents (uuendaminearrow-up-right)

Paigaldamine pipi kaudu

Standardne paigaldamine:

Progressi jälgimise toega:

Arendusinstallatsioon:

Installatsiooni kontrollimine

Kontrollige, kas SDK on õigesti installitud:


Esmane seadistamine

Litsentsi aktiveerimine

SDK kasutab sama litsentsi kui Chloros, Chloros (brauser) ja Chloros CLI. Aktiveerige üks kord GUI või CLI kaudu:

  1. Avage Chloros või Chloros (brauser)ja logige sisse kasutaja . Või avageCLI.

  2. Sisestage oma Chloros+ kasutajatunnus ja parool ning logige sisse

  3. Litsents salvestatakse kohalikku vahemällu (säilib ka pärast taaskäivitamist)

Ühekordne seadistamine: Pärast sisselogimist GUI või CLI kaudu kasutab SDK automaatselt salvestatud litsentsi. Täiendavat autentimist ei ole vaja!

Väljumine: SDK kasutajad saavad vahemällu salvestatud autentimisandmed programmeerimise teel kustutada, kasutades meetodit logout(). Vaadake logout() meetodit API viites.

Ühenduse testimine

Veenduge, et SDK saab ühenduda Chloros-iga:


API viide

ChlorosLocal klass

Peamine klass kohaliku Chloros pilditöötluse jaoks.

Konstruktor

Parameetrid:

Parameeter
Tüüp
Vaikimisi
Kirjeldus

api_url

str

"http://localhost:5000"

URL kohaliku Chloros tagapõhja kohta

auto_start_backend

bool

True

Vajadusel käivita backend automaatselt

backend_exe

str

None (auto-detect)

Tagapõhja käivitatava faili asukoht

timeout

int

30

Päringu aegumine sekundites

backend_startup_timeout

int

60

Tagapõhja käivitamise aegumine (sekundites)

Näited:


Meetodid

create_project(project_name, camera=None)

Loo uus Chloros projekt.

Parameetrid:

Parameeter
Tüüp
Nõutav
Kirjeldus

project_name

str

Jah

Projekti nimi

camera

str

Ei

Kaamera mall (nt „Survey3N_RGN”, „Survey3W_OCN”)

Tagastab: dict – Projekti loomise vastusNäide:


import_images(folder_path, recursive=False)

Piltide importimine kaustast.

Parameetrid:

Parameeter
Tüüp
Nõutav
Kirjeldus

folder_path

str/Path

Jah

Pildid sisaldava kausta tee

recursive

bool

Ei

Otsi alamkaustadest (vaikimisi: False)

Tagastab: dict - Importimise tulemused koos failide arvugaNäide:


configure(**settings)

Konfigureerige töötlemise seaded.

Parameetrid:

Parameeter
Tüüp
Vaikimisi
Kirjeldus

debayer

str

„Kõrge kvaliteet (kiirem)”

Debayer-meetod

vignette_correction

bool

True

Vignette-korrektsiooni lubamine

reflectance_calibration

bool

True

Peegelduskalibreerimise lubamine

indices

list

None

Arvutatavad taimestiku indeksid

export_format

str

"TIFF (16-bit)"

Väljundvorming

ppk

bool

False

Luba PPK-korrektsioonid

custom_settings

dict

None

Täpsemad kohandatud seaded

Ekspordivormingud:

  • "TIFF (16-bit)" – soovitatav GIS/fotogramm-meetria jaoks

  • "TIFF (32-bit, Percent)" – teaduslik analüüs

  • "PNG (8-bit)" – visuaalne kontroll

  • "JPG (8-bit)" – kompresseeritud väljund

**Saadaval olevad indeksid:**NDVI, NDRE, GNDVI, OSAVI, CIG, EVI, SAVI, MSAVI, MTVI2 jm.Näide:


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

Töötle projekti pilte.

Parameetrid:

Parameeter
Tüüp
Vaikimisi
Kirjeldus

mode

str

"parallel"

Töötlemisrežiim: „parallel” või „serial”

wait

bool

True

Oota lõpetamist

progress_callback

callable

None

Edusammude tagasiside funktsioon (progress, msg)

poll_interval

float

2.0

Edusammude küsitlusintervall (sekundites)

Tagastab: dict - Töötlemise tulemused

circle-info

Paralleelrežiim: Nõuab Chloros+ litsentsi. Skaleerub automaatselt teie CPU tuumadele (kuni 16 töötajat).

Näide:


get_config()

Hangi praegune projekti konfiguratsioon.

Tagastab: dict - Praegune projekti konfiguratsioonNäide:


get_status()

Saab tagasiside staatuse teabe.

Tagastab: dict - Tagasiside staatusNäide:


shutdown_backend()

Sulgeb backendi (kui see on käivitatud SDK poolt).

Näide:


logout()

Kustutab kohalikust süsteemist vahemällu salvestatud autentimisandmed.

Kirjeldus:

Programmeeritult logib välja, eemaldades vahemällu salvestatud autentimise andmed. See on kasulik:

  • Erinevate Chloros+ kontode vahel vahetamiseks

  • Automaatsetes keskkondades autentimise andmete kustutamiseks

  • Turvalisuse eesmärgil (nt autentimise andmete eemaldamiseks enne desinstallimist)

Tagastab: dict - Välja logimise tulemusNäide:

Uuesti autentimine vajalik: Pärast logout() kutsumist peate uuesti sisse logima Chloros, Chloros (brauser) või Chloros CLI kaudu, enne kui saate kasutada SDK.


Mugavusfunktsioonid

process_folder(folder_path, **options)

Üherealine mugavusfunktsioon kausta töötlemiseks.

Parameetrid:

Parameeter
Tüüp
Vaikimisi
Kirjeldus

folder_path

str/Path

Nõutav

Pildid sisaldava kausta tee

project_name

str

Automaatselt genereeritud

Projekti nimi

camera

str

None

Kaamera mall

indices

list

["NDVI"]

Arvutamiseks vajalikud indeksid

vignette_correction

bool

True

Vignette'i korrigeerimise lubamine

reflectance_calibration

bool

True

Peegelduskalibreerimise lubamine

export_format

str

"TIFF (16-bit)"

Väljundvorming

mode

str

"parallel"

Töötlemisrežiim

progress_callback

callable

None

Edusammude tagasiside

Tagastab: dict - Töötlemise tulemusedNäide:


Kontekstihalduri tugi

SDK toetab kontekstihaldureid automaatseks puhastamiseks:


Täielikud näited

Näide 1: Põhiline töötlemine

Kausta töötlemine vaikimisi seadetega:


Näide 2: Kohandatud töövoog

Täielik kontroll töötlemisprotsessi üle:


Näide 3: Mitme kausta töötlemine partiidena

Mitme lennu andmekogumi töötlemine:


Näide 4: Uurimistöö protsessi integreerimine

Chloros integreerimine andmete analüüsiga:


Näide 5: Kohandatud protsessi jälgimine

Täpsem protsessi jälgimine logimisega:


Näide 6: Veakäsitlus

Töökindel veakäsitlus tootmiskasutamiseks:


Näide 7: Kontode haldamine ja väljalogimine

Haldage kasutajatunnuseid programmiliselt:


Näide 8: käsurea tööriist

CLI tööriista loomine SDK abil:

Kasutamine:


Erandite käsitlemine

SDK pakub erinevate veatüüpide jaoks spetsiifilisi erandiklasse:

Erandite hierarhia

Erandite näited


Täpsemad teemad

Kohandatud tagapõhja konfiguratsioon

Kasutage kohandatud tagapõhja asukohta või konfiguratsiooni:

Mitteblokeeriv töötlemine

Alustage töötlemist ja jätkake teiste ülesannetega:

Mäluhaldus

Suurte andmekogumite puhul töötlege partiidena:


Veaotsing

Backend ei käivitu

Probleem: SDK ei suuda backendit käivitada.Lahendused:

  1. Kontrollige, kas Chloros Desktop on installitud:

  1. Kontrollige, et Windows tulemüür ei blokeeri

  2. Proovige käsitsi backendi teekonda:


Litsentsi ei tuvastatudProbleem: SDK hoiatab puuduva litsentsi kohtaLahendused:

  1. Avage Chloros, Chloros (brauser) või Chloros CLI ja logige sisse.

  2. Kontrollige, kas litsents on vahemällu salvestatud:

  1. Kui teil on probleeme kasutajatunnustega, kustutage vahemällu salvestatud kasutajatunnused ja logige uuesti sisse:

  1. Võtke ühendust tugiteenistusega: info@mapir.camera


Importimise veadProbleem: ModuleNotFoundError: No module named 'chloros_sdk'Lahendused:


Töötlemise aegumineProbleem: Töötlemine aegubLahendused:

  1. Suurendage aegumist:

  1. Töötle väiksemaid partiisid

  2. Kontrolli vaba kettaruumi

  3. Jälgi süsteemi ressursse


Port on juba kasutuselProbleem: Backend-port 5000 on hõivatudLahendused:

Või leia ja sulge konflikti tekitav protsess:


Jõudluse näpunäited

Optimeerige töötlemiskiirust

  1. Kasutage paralleelrežiimi (nõuab Chloros+)

  1. Vähendage väljundi resolutsiooni (kui see on vastuvõetav)

  1. Keelake mittevajalikud indeksid

  1. Töötlege SSD-l (mitte HDD-l)***

Mälu optimeerimine

Suurte andmekogumite puhul:


Taustatöötlus

Vabastage Python muude ülesannete jaoks:


Integreerimise näited

Django integreerimine

Flask API

Jupyter Notebook


KKK

K: Kas SDK vajab internetiühendust?

V: Ainult esialgse litsentsi aktiveerimiseks. Pärast sisselogimist Chloros, Chloros (brauser) või Chloros CLI kaudu salvestatakse litsents kohalikku vahemällu ja töötab offline-režiimis 30 päeva.***

K: Kas ma saan kasutada SDK serveris, millel pole graafilist kasutajaliidest?V: Jah! Nõuded:

  • Windows Server 2016 või uuem

  • Chloros installitud (ühekordne)

  • Litsents aktiveeritud mis tahes masinal (vahemällu salvestatud litsents kopeeritud serverisse)


K: Mis vahe on Desktop, CLI ja SDK vahel?

Funktsioon
Desktop GUI
CLI käsurida
Python SDK

Liides

Punkt-klõps

Käsk

Python API

Sobib kõige paremini

Visuaalne töö

Skriptimine

Integreerimine

Automatiseerimine

Piiratud

Hea

Suurepärane

Paindlikkus

Põhiline

Hea

Maksimaalne

Litsents

Chloros+

Chloros+

Chloros+

K: Kas ma saan levitada SDK-ga loodud rakendusi?V: SDK-koodi saab integreerida teie rakendustesse, kuid:

  • Lõppkasutajad peavad olema installinud Chloros

  • Lõppkasutajad vajavad aktiivseid Chloros+ litsentse

  • Kommertsiaalne levitamine nõuab OEM-litsentsi

OEM-küsimuste korral võtke ühendust info@mapir.camera-iga.


K: Kuidas uuendada SDK-i?


K: Kuhu salvestatakse töödeldud pildid?

Vaikimisi projekti kataloogi:


K: Kas ma saan töödelda pilte Python skriptidest, mis töötavad graafiku alusel?V: Jah! Kasutage Windows ülesannete planeerijat koos Python skriptidega:

Kavandage ülesannete planeerija abil igapäevane käivitamine.


K: Kas SDK toetab async/await?V: Praegune versioon on sünkroonne. Asünkroonse käitumise jaoks kasutage wait=False või käivitage eraldi niidis:


K: Kuidas vahetada erinevate Chloros+ kontode vahel?V: Kasutage logout() meetodit, et kustutada vahemällu salvestatud autentimisandmed, seejärel logige uuesti sisse uue kontoga:

Pärast väljalogimist autentigeerige uus konto GUI, brauseri või CLI kaudu, enne kui kasutate uuesti SDK.


Abi saamine

Dokumentatsioon

  • API viide: see lehekülg

Abikanalid

Näidiskood

Kõik siin loetletud näited on testitud ja valmis tootmiseks. Kopeerige need ja kohandage oma kasutusjuhtumile.


LitsentsOmanditarkvara – Autoriõigus (c) 2025 MAPIR Inc.

SDK nõuab aktiivset Chloros+ tellimust. Ebaseaduslik kasutamine, levitamine või muutmine on keelatud.

Last updated