API: Python SDK

Chloros Python SDK nodrošina programmatisku piekļuvi Chloros attēlu apstrādes dzinējam, ļaujot automatizēt, pielāgot darba plūsmas un vienkārši integrēt ar jūsu Python lietojumprogrammām un pētniecības procesiem.

Galvenās funkcijas

  • 🐍 Native Python - Tīrs, Pythonic API attēlu apstrādei

  • 🔧 Pilnīga API piekļuve - Pilnīga kontrole pār Chloros apstrādi

  • 🚀 Automatizācija - Izveidojiet pielāgotas partiju apstrādes darba plūsmas

  • 🔗 Integrācija - Ievietojiet Chloros esošajās Python lietojumprogrammās

  • 📊 Pētniecībai gatavs - Ideāli piemērots zinātniskās analīzes procesiem

  • Paralēla apstrāde - Mērogs atbilstoši jūsu CPU kodoliem (Chloros+)

Prasības

Prasība
Detalizēta informācija

Chloros Desktop

Jāinstalē lokāli

Operētājsistēma

Windows 10/11 (64 bitu)

Python

Python 3.7 vai jaunāka versija

Atmiņa

Vismaz 8 GB RAM (ieteicams 16 GB)

Internets

Nepieciešams licences aktivizēšanai

circle-info

Licences prasības: Python SDK piekļuvei API ir nepieciešama maksas Chloros+ abonementa. Standarta (bezmaksas) plāniem nav piekļuves API/SDK. Apmeklējiet https://cloud.mapir.camera/pricingarrow-up-right, lai veiktu uzlabojumus.

Ātrs sākums

Instalēšana

Instalējiet, izmantojot pip:

circle-info

Pirmā uzstādīšana: Pirms SDK lietošanas aktivizējiet savu Chloros+ licenci, atverot Chloros, Chloros (pārlūks) vai Chloros CLI un pieteikties ar savām identifikācijas ziņām. Tas jādara tikai vienu reizi.

Pamata lietošana

Apstrādājiet mapes ar tikai dažām rindām:

Pilnīga kontrole

Papildu darbplūsmas:


Uzstādīšanas rokasgrāmata

Priekšnoteikumi

Pirms uzstādīt SDK, pārliecinieties, ka jums ir:

  1. Chloros Desktop ir instalēts (lejupielādēt)

  2. Python 3.7+ ir instalēts (python.orgarrow-up-right)

  3. Aktīva Chloros+ licence (atjauninājumsarrow-up-right)

Instalēšana ar pip

Standarta instalēšana:

Ar progresa uzraudzības atbalstu:

Attīstības instalācija:

Instalācijas pārbaude

Pārbaudiet, vai SDK ir instalēts pareizi:


Pirmā uzstādīšana

Licences aktivizēšana

SDK izmanto to pašu licenci kā Chloros, Chloros (pārlūks) un Chloros CLI. Aktivizējiet vienreiz, izmantojot GUI vai CLI:

  1. Atveriet Chloros vai Chloros (pārlūks)un pieteikties lietotāja cilnē. Vai arī atverietCLI.

  2. Ievadiet savas Chloros+ piekļuves datus un pieteikties

  3. Licence tiek saglabāta vietējā cache (paliek pēc pārstartēšanas)

circle-info

Vienreizēja konfigurācija: Pēc pieteikšanās caur GUI vai CLI, SDK automātiski izmanto saglabāto licenci. Nav nepieciešama papildu autentifikācija!

circle-info

Iziet: SDK lietotāji var programmatiski dzēst cache atmiņā saglabātās paroles, izmantojot logout() metodi. Skatīt logout() metodi API atsauces dokumentā.

Pārbaudiet savienojumu

Pārbaudiet, vai SDK var savienoties ar Chloros:


API atsauce

ChlorosLocal klase

Galvenā klase vietējai Chloros attēlu apstrādei.

Konstruktors

Parametri:

Parametrs
Tips
Noklusējums
Apraksts

api_url

str

"http://localhost:5000"

URL vietējā Chloros backend

auto_start_backend

bool

True

Automātiski sākt backend, ja nepieciešams

backend_exe

str

None (automātiska atpazīšana)

Ceļš uz backend izpildāmo failu

timeout

int

30

Pieprasījuma laika limits sekundēs

backend_startup_timeout

int

60

Laika limits backend uzsākšanai (sekundēs)

Piemēri:


Metodes

create_project(project_name, camera=None)

Izveido jaunu Chloros projektu.

Parametri:

Parametrs
Tips
Nepieciešams
Apraksts

project_name

str

Projekta nosaukums

camera

str

Kameras veidne (piemēram, "Survey3N_RGN", "Survey3W_OCN")

Atgriež: dict - Projekta izveides atbildePiemērs:


import_images(folder_path, recursive=False)

Importē attēlus no mapes.

Parametri:

Parametrs
Tips
Nepieciešams
Apraksts

folder_path

str/Path

Ceļš uz mapes ar attēliem

recursive

bool

Meklēt apakšmapes (noklusējums: False)

Atgriež: dict - Importēšanas rezultāti ar failu skaituPiemērs:


configure(**settings)

Konfigurējiet apstrādes iestatījumus.

Parametri:

Parametrs
Tips
Noklusējums
Apraksts

debayer

str

"Augsta kvalitāte (ātrāka)"

Debayer metode

vignette_correction

bool

True

Iespējot vinjetes korekciju

reflectance_calibration

bool

True

Iespējot atstarojuma kalibrēšanu

indices

saraksts

None

Aprēķināmie veģetācijas indeksi

export_format

str

"TIFF (16 bitu)"

Izvades formāts

ppk

bool

False

Aktivizēt PPK korekcijas

custom_settings

dict

None

Papildu pielāgotie iestatījumi

Eksporta formāti:

  • "TIFF (16-bit)" - Ieteicams GIS/fotogrammetrijai

  • "TIFF (32-bit, Percent)" - Zinātniskai analīzei

  • "PNG (8-bit)" - Vizuālai pārbaudei

  • "JPG (8-bit)" - saspiesta izvade

**Pieejamie indeksi:**NDVI, NDRE, GNDVI, OSAVI, CIG, EVI, SAVI, MSAVI, MTVI2 un citi.Piemērs:


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

Apstrādājiet projekta attēlus.

Parametri:

Parametrs
Tips
Noklusējums
Apraksts

mode

str

"parallel"

Apstrādes režīms: "parallel" vai "serial"

wait

bool

True

Gaidīt pabeigšanu

progress_callback

izsaucams

None

Progresa atgriezeniskā funkcija (progress, msg)

poll_interval

float

2.0

Progresa aptaujas intervāls (sekundes)

Atgriež: dict - Apstrādes rezultāti

circle-info

Paralēlais režīms: Nepieciešama Chloros+ licence. Automātiski pielāgojas jūsu CPU kodoliem (līdz 16 darbiniekiem).

Piemērs:


get_config()

Iegūst pašreizējo projekta konfigurāciju.

Atgriež: dict - Pašreizējā projekta konfigurācijaPiemērs:


get_status()

Iegūstiet informāciju par backend statusu.

Atgriež: dict - Backend statusPiemērs:


shutdown_backend()

Aizver backend (ja tas ir palaists ar SDK).

Piemērs:


logout()

Dzēš no vietējās sistēmas cache atmiņā saglabātās autentifikācijas datus.

Apraksts:

Programmatiski iziet no sistēmas, dzēšot cache atmiņā saglabātos autentifikācijas datus. Tas ir noderīgi:

  • Pārslēgšanās starp dažādiem Chloros+ kontiem

  • Autentifikācijas datu dzēšana automatizētās vidēs

  • Drošības nolūkos (piemēram, autentifikācijas datu dzēšana pirms atinstalēšanas)

Atgriež: dict - Izslēgšanās darbības rezultātsPiemērs:

circle-info

Nepieciešama atkārtota autentifikācija: Pēc logout() izsaukšanas jums ir jāpiesakās atkārtoti, izmantojot Chloros, Chloros (pārlūkprogramma) vai Chloros CLI, pirms izmantot SDK.


Ērtības funkcijas

process_folder(folder_path, **options)

Vienrindas ērtības funkcija mapes apstrādei.

Parametri:

Parametrs
Tips
Noklusējums
Apraksts

folder_path

str/Celiņš

Nepieciešams

Celiņš uz mapi ar attēliem

project_name

str

Automātiski ģenerēts

Projekta nosaukums

camera

str

None

Kameras veidne

indices

saraksts

["NDVI"]

Aprēķināmi indeksi

vignette_correction

bool

True

Iespējot vinjetes korekciju

reflectance_calibration

bool

True

Iespējot atstarošanas kalibrēšanu

export_format

str

"TIFF (16 bitu)"

Izvades formāts

mode

str

"parallel"

Apstrādes režīms

progress_callback

izsaucams

None

Progresa atgriezeniskā saite

Atgriež: dict - Apstrādes rezultātiPiemērs:


Konteksta pārvaldnieka atbalsts

SDK atbalsta konteksta pārvaldniekus automātiskai tīrīšanai:


Pilnīgi piemēri

1. piemērs: Pamata apstrāde

Apstrādājiet mapi ar noklusējuma iestatījumiem:


2. piemērs: Pielāgota darba plūsma

Pilnīga kontrole pār apstrādes cauruļvadu:


3. piemērs: vairāku mapju apstrāde partijās

Vairāku lidojumu datu kopu apstrāde:


4. piemērs: pētniecības procesa integrācija

Chloros integrācija ar datu analīzi:


5. piemērs: Pielāgota progresa uzraudzība

Uzlabota progresa uzraudzība ar reģistrēšanu:


6. piemērs: Kļūdu apstrāde

Robusta kļūdu apstrāde ražošanas vajadzībām:


7. piemērs: Konta pārvaldība un iziet no sistēmas

Pārvaldiet autentifikācijas datus ar programmas palīdzību:


8. piemērs: Komandrindas rīks

Izveidojiet pielāgotu CLI rīku ar SDK:

Lietošana:


Izņēmumu apstrāde

SDK nodrošina specifiskas izņēmumu klases dažādiem kļūdu veidiem:

Izņēmumu hierarhija

Izņēmumu piemēri


Papildu tēmas

Pielāgota backend konfigurācija

Izmantojiet pielāgotu backend atrašanās vietu vai konfigurāciju:

Ne bloķējoša apstrāde

Sāciet apstrādi un turpiniet ar citām uzdevumiem:

Atmiņas pārvaldība

Lieliem datu kopumiem veiciet apstrādi partijās:


Problēmu novēršana

Aizmugure nedarbojas

Problēma: SDK nevar sākt aizmuguriRisinājumi:

  1. Pārbaudiet, vai ir instalēts Chloros Desktop:

  1. Pārbaudiet, vai Windows ugunsmūris neblokē

  2. Mēģiniet manuāli ievadīt backend ceļu:


Licence nav atklātaProblēma: SDK brīdina par trūkstošu licenciRisinājumi:

  1. Atveriet Chloros, Chloros (pārlūks) vai Chloros CLI un piesakieties.

  2. Pārbaudiet, vai licence ir saglabāta kešatmiņā:

  1. Ja rodas problēmas ar autentifikācijas datiem, izdzēsiet cache atmiņā saglabātos autentifikācijas datus un atkārtoti pieteikties:

  1. Sazinieties ar atbalsta dienestu: info@mapir.camera


Importēšanas kļūdasProblēma: ModuleNotFoundError: No module named 'chloros_sdk'Risinājumi:


Apstrādes laika limitsProblēma: Apstrādes laika limits ir beidzies.Risinājumi:

  1. Palieliniet laika limitu:

  1. Apstrādājiet mazākas partijas.

  2. Pārbaudiet pieejamo diska vietu.

  3. Uzraugiet sistēmas resursus


Ports jau tiek izmantotsProblēma: Aizmugures ports 5000 ir aizņemtsRisinājumi:

Vai atrodiet un aizveriet konfliktējošo procesu:


Padomi par veiktspēju

Optimizējiet apstrādes ātrumu

  1. Izmantojiet paralēlo režīmu (nepieciešams Chloros+)

  1. Samaziniet izvades izšķirtspēju (ja tas ir pieņemams)

  1. Atvienojiet nevajadzīgos indeksus

  1. Apstrādājiet uz SSD (nevis HDD)***

Atmiņas optimizācija

Lieliem datu kopumiem:


Fona apstrāde

Atbrīvojiet Python citām uzdevumiem:


Integrācijas piemēri

Django integrācija

Flask API

Jupyter Notebook


Bieži uzdotie jautājumi

J: Vai SDK ir nepieciešams interneta savienojums?

A: Tikai sākotnējai licences aktivizēšanai. Pēc ieejas caur Chloros, Chloros (pārlūkprogramma) vai Chloros CLI licence tiek saglabāta vietējā cache atmiņā un darbojas bezsaistē 30 dienas.***

J: Vai varu izmantot SDK serverī bez GUI?A: Jā! Prasības:

  • Windows Server 2016 vai jaunāka versija

  • Chloros instalēta (vienreizēji)

  • Licence aktivizēta jebkurā datorā (kešatmiņā saglabātā licence kopēta uz serveri)


J: Kāda ir atšķirība starp Desktop, CLI un SDK?

Funkcija
Desktop GUI
CLI komandrinda
Python SDK

Saskarnes

Punktu klikšķis

Komanda

Python API

Vislabāk piemērots

Vizuālam darbam

Skriptiem

Integrācijai

Automatizācija

Ierobežota

Laba

Izcila

Elastība

Pamata

Laba

Maksimāla

Licence

Chloros+

Chloros+

Chloros+

J: Vai es varu izplatīt ar SDK izveidotas lietotnes?A: SDK kodu var integrēt jūsu lietotnēs, bet:

  • Galalietotājiem ir nepieciešams instalēt Chloros

  • Galalietotājiem ir nepieciešamas aktīvas Chloros+ licences

  • Komerciālai izplatīšanai ir nepieciešama OEM licence

Sazinieties ar info@mapir.camera, ja Jums ir jautājumi par OEM.


J: Kā atjaunināt SDK?


J: Kur tiek saglabāti apstrādātie attēli?

Pēc noklusējuma, projekta ceļā:


J: Vai varu apstrādāt attēlus no Python skriptiem, kas darbojas pēc grafika?A: Jā! Izmantojiet Windows uzdevumu plānotāju ar Python skriptiem:

Plānojiet ikdienas darbību, izmantojot uzdevumu plānotāju.


J: Vai SDK atbalsta async/await?A: Pašreizējā versija ir sinhronizēta. Lai izmantotu async funkciju, izmantojiet wait=False vai palaidiet atsevišķā pavedienā:


J: Kā pārslēgties starp dažādiem Chloros+ kontiem?A: Izmantojiet logout() metodi, lai dzēstu kešatmiņā saglabātās paroles, pēc tam atkārtoti piesakieties ar jauno kontu:

Pēc iziet no konta, autentificējieties ar jauno kontu, izmantojot GUI, pārlūku vai CLI, pirms atkārtoti izmantot SDK.


Palīdzība

Dokumentācija

  • API atsauce: Šī lapa

Atbalsta kanāli

Parauga kods

Visi šeit uzskaitītie piemēri ir pārbaudīti un gatavi izmantošanai. Kopējiet un pielāgojiet tos savām vajadzībām.


LicenceProprietārā programmatūra - Autortiesības (c) 2025 MAPIR Inc.

SDK prasa aktīvu Chloros+ abonementu. Neatļauta izmantošana, izplatīšana vai modificēšana ir aizliegta.

Last updated