API: Python SDK

Chloros Python SDK poskytuje programový přístup k enginu pro zpracování obrazu Chloros, což umožňuje automatizaci, přizpůsobení pracovních postupů a hladkou integraci s vašimi aplikacemi Python a výzkumnými procesy.

Klíčové vlastnosti

  • 🐍 Nativní Python - Čistý, pythonský API pro zpracování obrazu

  • 🔧 Plný přístup k API - Kompletní kontrola nad zpracováním Chloros

  • 🚀 Automatizace - Vytvářejte vlastní pracovní postupy pro dávkové zpracování

  • 🔗 Integrace – Vložte Chloros do stávajících aplikací Python

  • 📊 Připraveno pro výzkum – Ideální pro vědecké analytické procesy

  • Paralelní zpracování – Škálovatelné podle počtu jader vašeho procesoru (Chloros+)

Požadavky

Požadavek
Podrobnosti

Chloros Desktop

Musí být nainstalován lokálně

Operační systém

Windows 10/11 (64bitový)

Python

Python 3.7 nebo vyšší

Paměť

Minimálně 8 GB RAM (doporučeno 16 GB)

Internet

Nutný pro aktivaci licence

circle-info

Požadavky na licenci: Python SDK vyžaduje placené předplatné Chloros+ pro přístup k API. Standardní (bezplatné) plány nemají přístup k API/SDK. Chcete-li provést upgrade, navštivte https://cloud.mapir.camera/pricingarrow-up-right.

Rychlý start

Instalace

Instalace pomocí pip:

circle-info

První nastavení: Před použitím SDK aktivujte licenci Chloros+ otevřením Chloros, Chloros (prohlížeč) nebo Chloros CLI a přihlášením se pomocí svých přihlašovacích údajů. Toto je nutné provést pouze jednou.

Základní použití

Zpracujte složku pomocí několika řádků:

Plná kontrola

Pro pokročilé pracovní postupy:


Průvodce instalací

Předpoklady

Před instalací SDK se ujistěte, že máte:

  1. Nainstalovaný Chloros Desktop (stáhnout)

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

  3. Aktivní licence Chloros+ (upgradearrow-up-right)

Instalace přes pip

Standardní instalace:

S podporou sledování průběhu:

Instalace pro vývojáře:

Ověření instalace

Otestujte, zda je SDK nainstalován správně:


První nastavení

Aktivace licence

SDK používá stejnou licenci jako Chloros, Chloros (prohlížeč) a Chloros CLI. Aktivujte jednou prostřednictvím grafického uživatelského rozhraní nebo CLI:

  1. Otevřete Chloros nebo Chloros (prohlížeč)a přihlaste se na kartě Uživatel . Nebo otevřeteCLI.

  2. Zadejte své přihlašovací údaje Chloros+ a přihlaste se

  3. Licence je uložena v místní mezipaměti (zůstává zachována i po restartu)

circle-info

Jednorázové nastavení: Po přihlášení přes GUI nebo CLI SDK automaticky použije uloženou licenci. Není potřeba žádné další ověření!

circle-info

Odhlášení: SDK uživatelé mohou programově vymazat uložená přihlašovací údaje pomocí metody logout(). Viz metoda logout() v referenční příručce API.

Testování připojení

Ověřte, zda se SDK může připojit k Chloros:


API Reference

Třída ChlorosLocal

Hlavní třída pro lokální zpracování obrazu Chloros.

Konstruktor

Parametry:

Parametr
Typ
Výchozí hodnota
Popis

api_url

str

"http://localhost:5000"

URL lokálního backendu Chloros

auto_start_backend

bool

True

V případě potřeby automaticky spustit backend

backend_exe

str

None (automatická detekce)

Cesta k spustitelnému souboru backendu

timeout

int

30

Časový limit požadavku v sekundách

backend_startup_timeout

int

60

Časový limit pro spuštění backendu (sekundy)

Příklady:


Metody

create_project(project_name, camera=None)

Vytvoří nový projekt Chloros.

Parametry:

Parametr
Typ
Povinný
Popis

project_name

str

Ano

Název projektu

camera

str

Ne

Šablona kamery (např. „Survey3N_RGN“, „Survey3W_OCN“)

Vrací: dict - Odpověď na vytvoření projektuPříklad:


import_images(folder_path, recursive=False)

Importuje obrázky ze složky.

Parametry:

Parametr
Typ
Povinný
Popis

folder_path

str/Path

Ano

Cesta ke složce s obrázky

recursive

bool

Ne

Prohledat podsložky (výchozí: False)

Vrací: dict - Výsledky importu s počtem souborůPříklad:


configure(**settings)

Konfigurace nastavení zpracování.

Parametry:

Parametr
Typ
Výchozí hodnota
Popis

debayer

str

„Vysoká kvalita (rychlejší)“

Metoda Debayer

vignette_correction

bool

True

Povolit korekci viněty

reflectance_calibration

bool

True

Povolit kalibraci odrazivosti

indices

seznam

None

Vegetační indexy pro výpočet

export_format

str

„TIFF (16bitový)“

Výstupní formát

ppk

bool

False

Povolit korekce PPK

custom_settings

dict

None

Pokročilá vlastní nastavení

Formáty exportu:

  • "TIFF (16-bit)" – doporučeno pro GIS/fotogrammetrii

  • "TIFF (32-bit, Percent)" – vědecká analýza

  • "PNG (8-bit)" – vizuální kontrola

  • "JPG (8-bit)" – komprimovaný výstup

**Dostupné indexy:**NDVI, NDRE, GNDVI, OSAVI, CIG, EVI, SAVI, MSAVI, MTVI2 a další.Příklad:


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

Zpracujte obrázky projektu.

Parametry:

Parametr
Typ
Výchozí hodnota
Popis

mode

str

"parallel"

Režim zpracování: „parallel“ nebo „serial“

wait

bool

True

Čekání na dokončení

progress_callback

callable

None

Funkce zpětného volání průběhu (progress, msg)

poll_interval

float

2.0

Interval dotazování na průběh (sekundy)

Vrací: dict – Výsledky zpracování

circle-info

Paralelní režim: Vyžaduje licenci Chloros+. Automaticky se přizpůsobí jádrům vašeho procesoru (až 16 pracovníků).

Příklad:


get_config()

Získá aktuální konfiguraci projektu.

Vrací: dict – aktuální konfigurace projektu.Příklad:


get_status()

Získá informace o stavu backendu.

Vrací: dict – stav backenduPříklad:


shutdown_backend()

Vypne backend (pokud byl spuštěn pomocí SDK).

Příklad:


logout()

Vymaže uložená přihlašovací údaje z lokálního systému.

Popis:

Programově se odhlásí odstraněním uložených přihlašovacích údajů. To je užitečné pro:

  • Přepínání mezi různými účty Chloros+

  • Vymazání přihlašovacích údajů v automatizovaných prostředích

  • Bezpečnostní účely (např. odstranění přihlašovacích údajů před odinstalací)

Vrací: dict – výsledek odhlášeníPříklad:

circle-info

Vyžadováno opětovné ověření: Po volání logout() se musíte znovu přihlásit pomocí Chloros, Chloros (prohlížeč) nebo Chloros CLI, než začnete používat SDK.


Pomocné funkce

process_folder(folder_path, **options)

Jednořádková pomocná funkce pro zpracování složky.

Parametry:

Parametr
Typ
Výchozí hodnota
Popis

folder_path

str/Path

Povinné

Cesta ke složce s obrázky

project_name

str

Automaticky generováno

Název projektu

camera

str

None

Šablona kamery

indices

list

["NDVI"]

Indexy pro výpočet

vignette_correction

bool

True

Povolit korekci vinětace

reflectance_calibration

bool

True

Povolit kalibraci odrazivosti

export_format

str

„TIFF (16 bitů)“

Výstupní formát

mode

str

"parallel"

Režim zpracování

progress_callback

callable

None

Zpětné volání průběhu

Vrací: dict – Výsledky zpracováníPříklad:


Podpora správce kontextu

SDK podporuje správce kontextu pro automatické čištění:


Kompletní příklady

Příklad 1: Základní zpracování

Zpracování složky s výchozím nastavením:


Příklad 2: Vlastní pracovní postup

Plná kontrola nad zpracovatelským procesem:


Příklad 3: Hromadné zpracování více složek

Zpracování více datových sad letů:


Příklad 4: Integrace výzkumného potrubí

Integrace Chloros s analýzou dat:


Příklad 5: Vlastní sledování průběhu

Pokročilé sledování průběhu s protokolováním:


Příklad 6: Zpracování chyb

Robustní zpracování chyb pro produkční použití:


Příklad 7: Správa účtů a odhlášení

Programová správa přihlašovacích údajů:


Příklad 8: Nástroj příkazového řádku

Vytvořte vlastní nástroj CLI pomocí SDK:

Použití:


Zpracování výjimek

SDK poskytuje specifické třídy výjimek pro různé typy chyb:

Hierarchie výjimek

Příklady výjimek


Pokročilá témata

Vlastní konfigurace backendu

Použijte vlastní umístění nebo konfiguraci backendu:

Nezablokované zpracování

Spusťte zpracování a pokračujte v dalších úkolech:

Správa paměti

U velkých datových sad zpracovávejte v dávkách:


Řešení problémů

Backend se nespustí

Problém: SDK se nedaří spustit backend.Řešení:

  1. Ověřte, zda je nainstalován Chloros Desktop:

  1. Zkontrolujte, zda Windows Firewall neblokuje

  2. Zkuste ruční cestu k backendu:


Licence nebyla detekovánaProblém: SDK varuje před chybějící licencíŘešení:

  1. Otevřete Chloros, Chloros (prohlížeč) nebo Chloros CLI a přihlaste se.

  2. Ověřte, zda je licence uložena v mezipaměti:

  1. Pokud máte problémy s přihlašovacími údaji, vymažte je z mezipaměti a přihlaste se znovu:

  1. Kontaktujte podporu: info@mapir.camera


Chyby při importuProblém: ModuleNotFoundError: No module named 'chloros_sdk'Řešení:


Časový limit zpracováníProblém: Časový limit zpracování vypršel.Řešení:

  1. Prodlužte časový limit:

  1. Zpracovávejte menší dávky.

  2. Zkontrolujte dostupný prostor na disku.

  3. Sledujte systémové zdroje.


Port již je používánProblém: Backend port 5000 je obsazenŘešení:

Nebo najděte a ukončete konfliktní proces:


Tipy pro zvýšení výkonu

Optimalizace rychlosti zpracování

  1. Použijte paralelní režim (vyžaduje Chloros+)

  1. Snižte výstupní rozlišení (pokud je to přijatelné)

  1. Deaktivujte nepotřebné indexy

  1. Zpracovávejte na SSD (nikoli HDD)***

Optimalizace paměti

Pro velké datové sady:


Zpracování na pozadí

Uvolněte Python pro jiné úkoly:


Příklady integrace

Integrace Django

Flask API

Jupyter Notebook


Často kladené otázky

Otázka: Vyžaduje SDK připojení k internetu?

Odpověď: Pouze pro počáteční aktivaci licence. Po přihlášení přes Chloros, Chloros (prohlížeč) nebo Chloros CLI se licence uloží do místní mezipaměti a funguje offline po dobu 30 dnů.***

Otázka: Mohu používat SDK na serveru bez grafického uživatelského rozhraní?Odpověď: Ano! Požadavky:

  • Windows Server 2016 nebo novější

  • Nainstalovaný Chloros (jednorázově)

  • Licence aktivovaná na libovolném počítači (licence uložená v mezipaměti zkopírovaná na server)


Otázka: Jaký je rozdíl mezi Desktop, CLI a SDK?

Funkce
Desktop GUI
CLI Příkazový řádek
Python SDK

Rozhraní

Ukazatel myši

Příkazový řádek

Python API

Nejvhodnější pro

Vizuální práce

Skriptování

Integrace

Automatizace

Omezená

Dobrá

Vynikající

Flexibilita

Základní

Dobrá

Maximální

Licence

Chloros+

Chloros+

Chloros+

Otázka: Mohu distribuovat aplikace vytvořené pomocí SDK?Odpověď: Kód SDK lze integrovat do vašich aplikací, ale:

  • Koncoví uživatelé musí mít nainstalovaný Chloros.

  • Koncoví uživatelé musí mít aktivní licence Chloros+.

  • Komerční distribuce vyžaduje OEM licence.

Pro dotazy týkající se OEM kontaktujte info@mapir.camera.


Otázka: Jak aktualizuji SDK?


Otázka: Kam se ukládají zpracované obrázky?

Ve výchozím nastavení do cesty projektu:


Otázka: Mohu zpracovávat obrázky ze skriptů Python spouštěných podle plánu?Odpověď: Ano! Použijte plánovač úloh Windows se skripty Python:

Naplánujte pomocí Plánovače úloh denní spuštění.


Otázka: Podporuje SDK async/await?Odpověď: Aktuální verze je synchronní. Pro asynchronní chování použijte wait=False nebo spusťte v samostatném vlákně:


Otázka: Jak mohu přepínat mezi různými účty Chloros+?Odpověď: Použijte metodu logout() k vymazání uložených přihlašovacích údajů a poté se znovu přihlaste pomocí nového účtu:

Po odhlášení se před dalším použitím SDK ověřte pomocí nového účtu přes GUI, prohlížeč nebo CLI.


Nápověda

Dokumentace

  • API Reference: Tato stránka

Kanály podpory

Ukázkový kód

Všechny zde uvedené příklady jsou otestované a připravené k použití. Zkopírujte je a přizpůsobte pro své použití.


SDK vyžaduje aktivní předplatné Chloros+. Neoprávněné použití, distribuce nebo úprava jsou zakázány.

Last updated