API : Python SDK

Chloros Python SDK , Chloros görüntü işleme motoruna programlı erişim sağlayarak otomasyon, özel iş akışları ve Python uygulamalarınızla ve araştırma süreçlerinizle sorunsuz entegrasyon imkanı sunar.

Temel Özellikler

  • 🐍 Yerel Python - Görüntü işleme için temiz, Python tarzı API

  • 🔧 Tam API Erişimi - Chloros işleme üzerinde tam kontrol

  • 🚀 Otomasyon - Özel toplu işleme iş akışları oluşturun

  • 🔗 Entegrasyon - Chloros'i mevcut Python uygulamalarına gömün

  • 📊 Araştırmaya Hazır - Bilimsel analiz iş akışları için mükemmel

  • Paralel İşleme - CPU çekirdeklerinize göre ölçeklenir (Chloros+)

Gereksinimler

Gereksinim
Ayrıntılar

Chloros Yüklü

Windows: Masaüstü yükleyici; Linux: .deb paketi

İşletim Sistemi

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

Python

Python 3.7 veya üstü

Bellek

En az 8 GB RAM (16 GB önerilir)

İnternet

Lisans etkinleştirme için gereklidir

circle-exclamation

Hızlı Başlangıç

Kurulum

pip ile kurun:

circle-info

İlk Kurulum: SDK'i kullanmadan önce, Chloros+ lisansınızı etkinleştirmek için Chloros, Chloros (Tarayıcı) veya Chloros CLI'i açıp kimlik bilgilerinizi kullanarak oturum açarak etkinleştirin. Bu işlem sadece bir kez yapılmalıdır. Linux'te (GUI yok), şunu kullanın: chloros-cli login user@example.com 'password'

Temel Kullanım

Sadece birkaç satırla bir klasörü işleyin:

circle-info

Çapraz Platform Yolları: Bu sayfadaki kod örnekleri, Windows tarzı yolları kullanır (ör. C:\\DroneImages\\Flight001). Linux'te bunun yerine Linux yollarını kullanın (ör. /home/user/drone_images/flight001 veya ~/drone_images/flight001). SDK her iki platformda da aynı şekilde çalışır.

Tam Kontrol

Gelişmiş iş akışları için:


Kurulum Kılavuzu

Ön Koşullar

SDK'i kurmadan önce şunlara sahip olduğunuzdan emin olun:

  1. Chloros yüklü — Windows: Masaüstü yükleyicisi (indirme); Linux: .deb paketi (Linux Kurulumu)

  2. Python 3.7+ yüklü (python.orgarrow-up-right)

  3. Etkin Chloros+ lisansı (yükseltmearrow-up-right)

pip ile yükleme

Standart yükleme:

İlerleme izleme desteği ile:

Geliştirme kurulumu:

Kurulumu Doğrulama

SDK'in doğru şekilde kurulduğunu test edin:


İlk Kurulum

Lisans Etkinleştirme

SDK, Chloros, Chloros (Tarayıcı) ve Chloros CLI ile aynı lisansı kullanır. GUI veya CLI aracılığıyla bir kez etkinleştirin:Windows: Chloros veya Chloros (Tarayıcı)'ı açın ve Kullanıcı sekmesinden oturum açın veya CLI'i kullanın.Linux: CLI'i kullanın (GUI mevcut değildir):

Lisans yerel olarak önbelleğe alınır ve yeniden başlatmalarda kalıcıdır.

circle-check
circle-info

Oturumu Kapatma: SDK kullanıcıları, logout() yöntemini kullanarak önbelleğe alınmış kimlik bilgilerini programlı olarak silebilir. API Referansı'ndaki logout() yöntemi bölümüne bakın.

Bağlantıyı Test Etme

SDK'in Chloros'e bağlanabildiğini doğrulayın:


API Referansı

ChlorosLocal Sınıfı

Yerel Chloros görüntü işleme için ana sınıf.

Yapıcı

Parametreler:

Parametre
Tür
Varsayılan
Açıklama

api_url

str

"http://localhost:5000"

Yerel Chloros arka ucunun URL'i

auto_start_backend

bool

True

Gerekirse arka ucu otomatik olarak başlat

backend_exe

str

None (otomatik algılama)

Arka uç yürütülebilir dosyasının yolu

timeout

int

30

İstek zaman aşımı (saniye)

backend_startup_timeout

int

60

Arka uç başlatma zaman aşımı (saniye)

Örnekler:

circle-info

Çapraz platform otomatik algılama: SDK, platformunuz için doğru arka uç yolunu otomatik olarak dener:

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

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

  • Linux (manuel): /opt/mapir/chloros/backend/chloros-backend


Yöntemler

create_project(project_name, camera=None)

Yeni bir Chloros projesi oluşturun.

Parametreler:

Parametre
Tür
Gerekli
Açıklama

project_name

str

Evet

Projenin adı

camera

str

Hayır

Kamera şablonu (ör. "Survey3N_RGN", "Survey3W_OCN")

Dönüş: dict - Proje oluşturma yanıtıÖrnek:


import_images(folder_path, recursive=False)

Bir klasörden görüntüleri içe aktarın.

Parametreler:

Parametre
Tür
Gerekli
Açıklama

folder_path

str/Yol

Evet

Görüntülerin bulunduğu klasörün yolu

recursive

bool

Hayır

Alt klasörleri ara (varsayılan: False)

Döndürür: dict - Dosya sayısı ile birlikte içe aktarma sonuçlarıÖrnek:


configure(**settings)

İşleme ayarlarını yapılandırır.

Parametreler:

Parametre
Tür
Varsayılan
Açıklama

debayer

str

"Standart (Hızlı, Orta Kalite)"

Debayer yöntemi

vignette_correction

bool

True

Vinyet düzeltmesini etkinleştir

reflectance_calibration

bool

True

Yansıma kalibrasyonunu etkinleştir

indices

liste

None

Hesaplanacak bitki örtüsü indeksleri

export_format

str

"TIFF (16-bit)"

Çıktı formatı

ppk

bool

False

PPK düzeltmelerini etkinleştir

custom_settings

dict

None

Gelişmiş özel ayarlar

Dışa Aktarım Biçimleri:

  • "TIFF (16-bit)" - GIS/fotogrametri için önerilir

  • "TIFF (32-bit, Percent)" - Bilimsel analiz

  • "PNG (8-bit)" - Görsel inceleme

  • "JPG (8-bit)" - Sıkıştırılmış çıktı

**Kullanılabilir Dizinler:**NDVI, NDRE, GNDVI, OSAVI, CIG, EVI, SAVI, MSAVI, MTVI2 ve daha fazlası.Örnek:


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

Proje görüntülerini işleyin.

Parametreler:

Parametre
Tür
Varsayılan
Açıklama

mode

str

"parallel"

İşleme modu: "parallel" veya "serial"

wait

bool

True

Tamamlanana kadar bekle

progress_callback

çağrılabilir

None

İlerleme geri arama işlevi (progress, msg)

poll_interval

float

2.0

İlerleme için yoklama aralığı (saniye)

Döndürür: dict - İşleme sonuçları

circle-exclamation

Örnek:


get_config()

Mevcut proje yapılandırmasını alır.

Döndürür: dict - Mevcut proje yapılandırmasıÖrnek:


get_status()

İş parçacığı başına işleme ilerlemesi dahil olmak üzere arka uç durum bilgilerini alır.

Döndürür: dict - Aşağıdaki yapıya sahip arka uç durumu:

Örnek:


shutdown_backend()

Arka ucu kapatır (SDK ile başlatılmışsa).

Örnek:


logout()

Yerel sistemden önbelleğe alınmış kimlik bilgilerini temizler.

Açıklama:

Önbelleğe alınmış kimlik bilgilerini kaldırarak programlı olarak oturumu kapatır. Bu, aşağıdakiler için kullanışlıdır:

  • Farklı Chloros+ hesapları arasında geçiş yapmak

  • Otomatik ortamlarda kimlik bilgilerini temizlemek

  • Güvenlik amaçları (ör. kaldırma işleminden önce kimlik bilgilerini kaldırmak)

Döndürür: dict - Oturum kapatma işlemi sonucuÖrnek:

circle-info

Yeniden Kimlik Doğrulama Gerekli: logout() çağrısından sonra, Chloros, Chloros (Tarayıcı) veya Chloros CLI aracılığıyla yeniden oturum açmanız gerekir.


Kolaylık İşlevleri

process_folder(folder_path, **options)

Bir klasörü işlemek için tek satırlık kolaylık işlevi.

Parametreler:

Parametre
Tür
Varsayılan
Açıklama

folder_path

str/Yol

Gerekli

Görüntülerin bulunduğu klasörün yolu

project_name

str

Otomatik olarak oluşturulur

Proje adı

camera

str

None

Kamera şablonu

indices

list

["NDVI"]

Hesaplanacak indeksler

vignette_correction

bool

True

Vinyet düzeltmesini etkinleştir

reflectance_calibration

bool

True

Yansıma kalibrasyonunu etkinleştir

export_format

str

"TIFF (16-bit)"

Çıktı biçimi

mode

str

"parallel"

İşleme modu

progress_callback

çağrılabilir

None

İlerleme geri çağrısı

Döndürür: dict - İşleme sonuçlarıÖrnek:


Bağlam Yöneticisi Desteği

SDK, otomatik temizleme için bağlam yöneticilerini destekler:


Tam Örnekler

circle-info

Linux Kullanıcıları: Aşağıdaki tüm örneklerde Windows yolları kullanılmaktadır. C:\\... yollarını kendi Linux yollarınızla değiştirin (ör. /home/user/... veya ~/...). Tüm SDK işlevleri tüm platformlarda aynıdır.

Örnek 1: Temel İşleme

Bir klasörü varsayılan ayarlarla işleyin:


Örnek 2: Özel İş Akışı

İşleme boru hattı üzerinde tam kontrol:


Örnek 3: Birden Fazla Klasörü Toplu İşleme

Birden fazla uçuş veri setini işleyin:


Örnek 4: Araştırma Boru Hattı Entegrasyonu

Chloros'i veri analizi ile entegre etme:


Örnek 5: Özel İlerleme İzleme

Günlük kaydı ile gelişmiş ilerleme takibi:


Örnek 6: Hata Yönetimi

Üretim kullanımı için sağlam hata işleme:


Örnek 7: Hesap Yönetimi ve Oturumu Kapatma

Kimlik bilgilerini programlı olarak yönetme:


Örnek 8: Komut Satırı Aracı

SDK ile özel bir CLI aracı oluşturun:

Kullanım:


İstisna İşleme

SDK, farklı hata türleri için belirli istisna sınıfları sağlar:

İstisna Hiyerarşisi

İstisna Örnekleri


Gelişmiş Konular

Özel Arka Uç Yapılandırması

Özel bir arka uç konumu veya yapılandırması kullanın:

Engellemesiz İşleme

İşlemeyi başlatın ve diğer görevlere devam edin:

Bellek Yönetimi

Büyük veri kümeleri için, toplu işler halinde işleyin:


Sorun Giderme

Arka Uç Başlamıyor

Sorun: SDK arka ucu başlatamıyorÇözümler:

  1. Chloros'in kurulu olduğunu doğrulayın:

  1. Güvenlik duvarını (Windows) veya bağlantı noktası kullanılabilirliğini (Linux: lsof -i :5000) kontrol edin

  2. Manuel arka uç yolunu deneyin:


Lisans AlgılanmadıSorun: SDK, eksik lisans konusunda uyarı veriyorÇözümler:

  1. Chloros, Chloros (Tarayıcı) veya Chloros CLI'i açın ve oturum açın.

  2. Lisansın önbelleğe alındığını doğrulayın:

  1. Kimlik bilgisi sorunları yaşıyorsanız, önbelleğe alınmış kimlik bilgilerini temizleyin ve yeniden oturum açın:

  1. Destek ekibiyle iletişime geçin: info@mapir.camera


İçe Aktarma HatalarıSorun: ModuleNotFoundError: No module named 'chloros_sdk'Çözümler:


İşlem Zaman AşımıSorun: İşlem zaman aşımına uğradıÇözümler:

  1. Zaman aşımını artırın:

  1. Daha küçük gruplar halinde işleyin

  2. Kullanılabilir disk alanını kontrol edin

  3. Sistem kaynaklarını izleyin


Bağlantı Noktası Zaten KullanılıyorSorun: Arka uç bağlantı noktası 5000 meşgulÇözümler:

Veya çakışan işlemi bulun ve kapatın:


Performans İpuçları

İşlem Hızını Optimize Edin

  1. Paralel Modu Kullanın (Chloros+ gerektirir)

  1. Çıktı Çözünürlüğünü Düşürün (kabul edilebilirse)

  1. Gereksiz Dizinleri Devre Dışı Bırakın

  1. SSD'de İşleyin (HDD değil)***

Bellek Optimizasyonu

Büyük veri kümeleri için:


Arka Plan İşleme

Diğer görevler için Python'i boşaltın:


Entegrasyon Örnekleri

Django Entegrasyonu

Flask API

Jupyter Notebook


SSS

S: SDK için internet bağlantısı gerekli mi?

C: Yalnızca ilk lisans etkinleştirme için gereklidir. Chloros, Chloros (Tarayıcı) veya Chloros CLI üzerinden oturum açtıktan sonra lisans yerel olarak önbelleğe alınır ve 30 gün boyunca çevrimdışı olarak çalışır.***

S: SDK'i GUI'siz bir sunucuda kullanabilir miyim?C: Evet! SDK, hem Windows hem de Linux sunucularında başsız olarak çalışır.Linux (headless için önerilir):

  • .deb paketi ile yükleyin

  • Lisansı etkinleştirin: chloros-cli login user@example.com 'password'

Windows Sunucusu:

  • Windows Sunucu 2016 veya üstü

  • Chloros yüklü (tek seferlik)

  • Lisans, CLI aracılığıyla veya herhangi bir makinede etkinleştirilir


S: Desktop, CLI ve SDK arasındaki fark nedir?

Özellik
Desktop GUI
CLI Komut Satırı
Python SDK

Arayüz

Nokta-tıklama

Komut

Python API

En Uygun Olduğu Alan

Görsel çalışma

Komut dosyası oluşturma

Entegrasyon

Otomasyon

Sınırlı

İyi

Mükemmel

Esneklik

Temel

İyi

Maksimum

Lisans

Chloros+

Chloros+

Chloros+

S: SDK ile oluşturulan uygulamaları dağıtabilir miyim?C: SDK kodu uygulamalarınıza entegre edilebilir, ancak:

  • Son kullanıcıların Chloros'i yüklemiş olması gerekir

  • Son kullanıcıların aktif Chloros+ lisanslarına sahip olması gerekir

  • Ticari dağıtım için OEM lisanslaması gerekir

OEM ile ilgili sorularınız için info@mapir.camera ile iletişime geçin.


S: SDK'i nasıl güncelleyebilirim?


S: İşlenmiş görüntüler nereye kaydedilir?

Varsayılan olarak, Proje Yolu'na:


S: Zamanlanmış olarak çalışan Python komut dosyalarından görüntüleri işleyebilir miyim?C: Evet! Python komut dosyalarıyla işletim sisteminizin zamanlayıcısını kullanın:

Windows: Görev Zamanlayıcı aracılığıyla günlük olarak çalışacak şekilde zamanlayın.Linux: Cron aracılığıyla zamanlayın:


S: SDK async/await'i destekliyor mu?C: Mevcut sürüm senkronize çalışır. Asenkron davranış için wait=False'i kullanın veya ayrı bir iş parçacığında çalıştırın:


S: Farklı Chloros+ hesapları arasında nasıl geçiş yapabilirim?C: Önbelleğe alınmış kimlik bilgilerini temizlemek için logout() yöntemini kullanın, ardından yeni hesapla yeniden oturum açın:

Oturumu kapattıktan sonra, SDK'i tekrar kullanmadan önce GUI, Tarayıcı veya CLI aracılığıyla yeni hesapla kimlik doğrulaması yapın.


Yardım Alma

Belgeler

  • API Referansı: Bu sayfa

Destek Kanalları

Örnek Kod

Burada listelenen tüm örnekler test edilmiş ve kullanıma hazırdır. Bunları kopyalayıp kullanım durumunuza göre uyarlayın.


LisansTescilli Yazılım - Telif Hakkı (c) 2025 MAPIR Inc.

SDK, aktif bir Chloros+ aboneliği gerektirir. Yetkisiz kullanım, dağıtım veya değişiklik yasaktır.

Last updated