API: Python SDK

Az Chloros Python SDK programozási hozzáférést biztosít az Chloros képfeldolgozó motorhoz, lehetővé téve az automatizálást, az egyedi munkafolyamatokat és a zökkenőmentes integrációt az Python alkalmazásokkal és kutatási folyamatokkal.

Főbb jellemzők

  • 🐍 Natív Python - Tiszta, Pythonic API képfeldolgozáshoz

  • 🔧 Teljes API hozzáférés - Teljes ellenőrzés az Chloros feldolgozás felett

  • 🚀 Automatizálás - Egyedi kötegelt feldolgozási munkafolyamatok létrehozása

  • 🔗 Integráció - Chloros beágyazása meglévő Python alkalmazásokba

  • 📊 Kutatásra kész - Tökéletes tudományos elemzési folyamatokhoz

  • Párhuzamos feldolgozás - A CPU magokhoz igazodik (Chloros+)

Követelmények

Követelmény
Részletek

Chloros Desktop

Helyileg kell telepíteni

Operációs rendszer

Windows 10/11 (64 bites)

Python

Python 3.7 vagy újabb

Memória

Minimum 8 GB RAM (16 GB ajánlott)

Internet

A licenc aktiválásához szükséges

circle-info

Licenc követelmény: Az Python SDK használatához fizetős Chloros+ előfizetés szükséges az API hozzáféréshez. A standard (ingyenes) csomagok nem biztosítanak hozzáférést az API/SDK-hez. A frissítéshez látogasson el az https://cloud.mapir.camera/pricingarrow-up-right oldalra.

Gyors indítás

Telepítés

Telepítés pip segítségével:

circle-info

Első beállítás: Az SDK használata előtt aktiválja az Chloros+ licencét az Chloros, Chloros (böngésző) vagy az Chloros CLI megnyitásával és a hitelesítő adataival való bejelentkezéssel. Ezt csak egyszer kell megtennie.

Alapvető használat

Feldolgozzon egy mappát néhány sorral:

Teljes ellenőrzés

Haladó munkafolyamatokhoz:


Telepítési útmutató

Előfeltételek

Az SDK telepítése előtt győződjön meg arról, hogy rendelkezik a következővel:

  1. Chloros Desktop telepítve (letöltés)

  2. Python 3.7+ telepítve (python.orgarrow-up-right)

  3. Aktív Chloros+ licenc (frissítésarrow-up-right)

Telepítés pip segítségével

Normál telepítés:

Haladásfigyelés támogatással:

Fejlesztői telepítés:

Telepítés ellenőrzése

Ellenőrizze, hogy az SDK helyesen van-e telepítve:


Első beállítás

Licenc aktiválása

Az SDK ugyanazt a licencet használja, mint az Chloros, Chloros (böngésző) és Chloros CLI. Aktiválja egyszer a GUI-n vagy az CLI-en keresztül:

  1. Nyissa meg az Chloros vagy az Chloros (böngésző)programot, és jelentkezzen be a Felhasználó fülön. Vagy nyissa meg azCLI fájlt.

  2. Írja be Chloros+ hitelesítő adatait, és jelentkezzen be

  3. A licenc helyileg tárolódik (újraindítás után is megmarad)

circle-info

Egyszeri beállítás: A GUI vagy az CLI segítségével történő bejelentkezés után az SDK automatikusan a tárolt licencet használja. Nincs szükség további hitelesítésre!

circle-info

Kijelentkezés: Az SDK felhasználók programozással törölhetik a gyorsítótárban tárolt hitelesítő adatokat az logout() módszerrel. Lásd logout() módszer az API Referenciában.

Kapcsolat tesztelése

Ellenőrizze, hogy az SDK képes-e csatlakozni az Chloros-hez:


API hivatkozás

ChlorosLocal osztály

Fő osztály a helyi Chloros képfeldolgozáshoz.

Konstruktor

Paraméterek:

Paraméter
Típus
Alapértelmezett
Leírás

api_url

str

"http://localhost:5000"

URL a helyi Chloros háttérprogramhoz

auto_start_backend

bool

True

Szükség esetén automatikusan indítsa el a háttérprogramot

backend_exe

str

None (automatikus felismerés)

A háttérprogram futtatható fájljának elérési útja

timeout

int

30

Kérés időtúllépése másodpercben

backend_startup_timeout

int

60

A háttérprogram indításának időtúllépése (másodperc)

Példák:


Módszerek

create_project(project_name, camera=None)

Új Chloros projekt létrehozása.

Paraméterek:

Paraméter
Típus
Szükséges
Leírás

project_name

str

Igen

A projekt neve

camera

str

Nem

Kamera sablon (pl. „Survey3N_RGN”, „Survey3W_OCN”)

Visszatérési érték: dict – Projekt létrehozásának válaszaPélda:


import_images(folder_path, recursive=False)

Képek importálása egy mappából.

Paraméterek:

Paraméter
Típus
Szükséges
Leírás

folder_path

str/Path

Igen

A képeket tartalmazó mappa elérési útja

recursive

bool

Nem

Almappák keresése (alapértelmezett: False)

Visszatérési értékek: dict - Importálási eredmények a fájlok számávalPélda:


configure(**settings)

A feldolgozási beállítások konfigurálása.

Paraméterek:

Paraméter
Típus
Alapértelmezett
Leírás

debayer

str

„Kiváló minőség (gyorsabb)"

Debayer-módszer

vignette_correction

bool

True

Vignettázás-korrekció engedélyezése

reflectance_calibration

bool

True

Reflektancia-kalibrálás engedélyezése

indices

lista

None

Számítandó vegetációs indexek

export_format

str

"TIFF (16 bites)”

Kimeneti formátum

ppk

bool

False

PPK-korrekciók engedélyezése

custom_settings

dict

None

Speciális egyéni beállítások

Export formátumok:

  • "TIFF (16-bit)" - Ajánlott GIS/fotogrammetria esetén

  • "TIFF (32-bit, Percent)" - Tudományos elemzés

  • "PNG (8-bit)" - Vizuális ellenőrzés

  • "JPG (8-bit)" - Tömörített kimenet

**Elérhető indexek:**NDVI, NDRE, GNDVI, OSAVI, CIG, EVI, SAVI, MSAVI, MTVI2 és még sok más.Példa:


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

A projekt képek feldolgozása.

Paraméterek:

Paraméter
Típus
Alapértelmezett
Leírás

mode

str

"parallel"

Feldolgozási mód: „parallel” vagy „serial”

wait

bool

True

Várjon a befejezésre

progress_callback

callable

None

Haladás visszahívási funkció (haladás, üzenet)

poll_interval

float

2.0

Haladás lekérdezési intervallum (másodperc)

Visszatérési értékek: dict - Feldolgozási eredmények

circle-info

Párhuzamos mód: Chloros+ licenc szükséges. Automatikusan skálázódik a CPU magjaihoz (legfeljebb 16 munkás).

Példa:


get_config()

A jelenlegi projektkonfiguráció lekérése.

Visszatérési érték: dict - Jelenlegi projektkonfigurációPélda:


get_status()

A háttérrendszer állapotának lekérdezése.

Visszatérési érték: dict - A háttérrendszer állapotaPélda:


shutdown_backend()

A háttérrendszer leállítása (ha az SDK indította el).

Példa:


logout()

Törli a helyi rendszerből a gyorsítótárban tárolt hitelesítő adatokat.

Leírás:

Programozással jelentkezik ki a gyorsítótárban tárolt hitelesítő adatok eltávolításával. Ez a következő esetekben hasznos:

  • Különböző Chloros+ fiókok közötti váltás

  • Hitelesítő adatok törlése automatizált környezetekben

  • Biztonsági célok (pl. a hitelesítő adatok eltávolítása az eltávolítás előtt)

Visszatérési érték: dict - Kijelentkezés művelet eredményePélda:

circle-info

Újra hitelesítés szükséges: Az logout() hívása után újra be kell jelentkeznie az Chloros, Chloros (böngésző) vagy az Chloros CLI segítségével, mielőtt az SDK-et használná.


Kényelmi funkciók

process_folder(folder_path, **options)

Egy soros kényelmi funkció egy mappa feldolgozásához.

Paraméterek:

Paraméter
Típus
Alapértelmezett
Leírás

folder_path

str/Path

Szükséges

A képeket tartalmazó mappa elérési útja

project_name

str

Automatikusan generált

Projekt neve

camera

str

None

Kamera sablon

indices

list

["NDVI"]

Számítandó indexek

vignette_correction

bool

True

Vignettkorrekció engedélyezése

reflectance_calibration

bool

True

Reflektancia kalibrálás engedélyezése

export_format

str

"TIFF (16 bites)"

Kimeneti formátum

mode

str

"parallel"

Feldolgozási mód

progress_callback

callable

None

Haladás visszahívás

Visszatérési értékek: dict - Feldolgozási eredményekPélda:


Kontextuskezelő támogatás

Az SDK támogatja a kontextuskezelőket az automatikus tisztításhoz:


Teljes példák

1. példa: Alapvető feldolgozás

Egy mappa feldolgozása az alapértelmezett beállításokkal:


2. példa: Egyéni munkafolyamat

A feldolgozási folyamat teljes ellenőrzése:


3. példa: Több mappa kötegelt feldolgozása

Több repülési adatkészlet feldolgozása:


4. példa: Kutatási folyamat integrálása

Az Chloros integrálása az adatelemzéssel:


5. példa: Egyedi előrehaladás-figyelés

Fejlett előrehaladás-követés naplózással:


6. példa: Hiba kezelése

Robusztus hiba kezelése termelési használatra:


7. példa: Fiókkezelés és kijelentkezés

Hitelesítő adatok programozással történő kezelése:


8. példa: Parancssori eszköz

Egyéni CLI eszköz létrehozása az SDK segítségével:

Használat:


Kivételkezelés

Az SDK különböző hibatípusokhoz specifikus kivételosztályokat biztosít:

Kivételek hierarchiája

Kivételek példái


Haladó témák

Egyéni háttérkonfiguráció

Egyéni háttérhely vagy konfiguráció használata:

Nem blokkoló feldolgozás

Indítsa el a feldolgozást, és folytassa más feladatokkal:

Memóriakezelés

Nagy adathalmazok esetén kötegelt feldolgozás:


Hibaelhárítás

A háttér nem indul el

Probléma: SDK nem tudja elindítani a háttértMegoldások:

  1. Ellenőrizze, hogy az Chloros Desktop telepítve van-e:

  1. Ellenőrizze, hogy az Windows tűzfal nem blokkolja-e

  2. Próbálja meg a háttérprogram kézi elérési útját:


A licenc nem találhatóProbléma: SDK figyelmeztet a hiányzó licencreMegoldások:

  1. Nyissa meg az Chloros, Chloros (böngésző) vagy Chloros CLI alkalmazást, és jelentkezzen be.

  2. Ellenőrizze, hogy a licenc cache-ben van-e:

  1. Ha hitelesítési problémák merülnek fel, törölje a cache-ben tárolt hitelesítési adatokat, és jelentkezzen be újra:

  1. Vegye fel a kapcsolatot az ügyfélszolgálattal: info@mapir.camera


Importálási hibákProbléma: ModuleNotFoundError: No module named 'chloros_sdk'Megoldások:


Feldolgozási időtúllépésProbléma: A feldolgozás időtúllépéseMegoldások:

  1. Növelje az időtúllépést:

  1. Kisebb adagokat dolgozzon fel

  2. Ellenőrizze a rendelkezésre álló lemezterületet

  3. Figyelje a rendszer erőforrásait


A port már használatban vanProbléma: A háttérport 5000 foglaltMegoldások:

Vagy keresse meg és zárja be az ütköző folyamatot:


Teljesítményre vonatkozó tippek

A feldolgozási sebesség optimalizálása

  1. Párhuzamos mód használata (Chloros+ szükséges)

  1. A kimeneti felbontás csökkentése (ha elfogadható)

  1. Kapcsolja ki a felesleges indexeket

  1. Feldolgozás SSD-n (nem HDD-n)***

Memóriaoptimalizálás

Nagy adatállományok esetén:


Háttérfeldolgozás

Szabadítson fel Python-ot más feladatokhoz:


Integrációs példák

Django integráció

Flask API

Jupyter Notebook


GYIK

K: Az SDK internetkapcsolatot igényel?

V: Csak az első licencteljesítmény aktiválásához. Miután bejelentkezett az Chloros, Chloros (böngésző) vagy Chloros CLI segítségével, a licenc helyileg tárolódik, és 30 napig offline módban is működik.***

K: Használhatom az SDK-et GUI nélküli szerveren?V: Igen! Követelmények:

  • Windows Server 2016 vagy újabb verzió

  • Chloros telepítve (egyszeri)

  • Licenc aktiválva bármely gépen (a cache-elt licenc másolva a szerverre)


K: Mi a különbség a Desktop, az CLI és az SDK között?

Funkció
Desktop GUI
CLI Parancssor
Python SDK

Felület

Pont-kattintás

Parancssor

Python API

Legalkalmasabb

Vizuális munka

Szkriptelés

Integráció

Automatizálás

Korlátozott

Kiváló

Rugalmasság

Alapszintű

Maximális

Licenc

Chloros+

Chloros+

Chloros+

K: Terjeszthetem az SDK segítségével létrehozott alkalmazásokat?V: Az SDK kód integrálható az alkalmazásaiba, de:

  • A végfelhasználóknak telepíteniük kell az Chloros programot.

  • A végfelhasználóknak aktív Chloros+ licenccel kell rendelkezniük.

  • Kereskedelmi terjesztéshez OEM licenc szükséges.

OEM-rel kapcsolatos kérdésekkel forduljon az info@mapir.camera-hez.


K: Hogyan frissíthetem az SDK programot?


K: Hol kerülnek mentésre a feldolgozott képek?

Alapértelmezés szerint a Projekt elérési útjában:


K: Feldolgozhatok képeket az ütemezett Python szkriptekből?V: Igen! Használja az Windows Feladatütemezőt az Python szkriptekkel:

A Feladatütemező segítségével ütemezze be a napi futtatást.


K: Az SDK támogatja az async/await funkciót?V: A jelenlegi verzió szinkron. Aszinkron viselkedéshez használja az wait=False-et, vagy futtassa külön szálban:


K: Hogyan válthatok a különböző Chloros+ fiókok között?V: Az logout() módszerrel törölje a gyorsítótárban tárolt hitelesítő adatokat, majd jelentkezzen be újra az új fiókkal:

Kijelentkezés után hitelesítse magát az új fiókkal a GUI, a böngésző vagy az CLI segítségével, mielőtt újra használná az SDK-et.


Segítség

Dokumentáció

  • API Referencia: Ez az oldal

Támogatási csatornák

Minta kód

Az itt felsorolt példák mindegyike tesztelt és termeléskész. Másolja és alkalmazza őket a saját felhasználási esetéhez.


LicencSaját fejlesztésű szoftver - Szerzői jog (c) 2025 MAPIR Inc.

Az SDK aktív Chloros+ előfizetést igényel. A jogosulatlan használat, terjesztés vagy módosítás tilos.

Last updated