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ız ve araştırma süreçlerinizle sorunsuz entegrasyon imkanı sunar.

Temel Özellikler

  • 🐍 Yerel Python - Görüntü işleme için temiz, Pythonic 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 yerleştirin

  • 📊 Araştırmaya Hazır - Bilimsel analiz süreçleri için mükemmel

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

Gereksinimler

Gereksinim
Ayrıntılar

Chloros Masaüstü

Yerel olarak yüklenmiş olmalıdır

İşletim Sistemi

Windows 10/11 (64 bit)

Python

Python 3.7 veya üstü

Bellek

En az 8 GB RAM (16 GB önerilir)

İnternet

Lisans etkinleştirme için gereklidir

circle-info

Lisans Gereksinimi: Python SDK, API erişimi için ücretli Chloros+ aboneliği gerektirir. Standart (ücretsiz) planlar API/SDK erişimine sahip değildir. Yükseltmek için https://cloud.mapir.camera/pricingarrow-up-right adresini ziyaret edin.

Hızlı Başlangıç

Kurulum

Pip ile kurulum:

circle-info

İlk Kurulum: SDK'i kullanmadan önce, Chloros+ lisansınızı Chloros, Chloros (Tarayıcı) veya Chloros CLI'i açarak ve kimlik bilgilerinizi girerek etkinleştirin. Bu işlem sadece bir kez yapılmalıdır.

Temel Kullanım

Birkaç satırlık bir klasörü işleyin:

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 Masaüstü yüklü (indirme)

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

  3. Aktif 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:

  1. Chloros veya Chloros (Tarayıcı)'yi açın ve Kullanıcı sekmesinde oturum açın. VeyaCLI'i açın.

  2. Chloros+ kimlik bilgilerinizi girin ve oturum açın

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

circle-info

Tek Seferlik Kurulum: GUI veya CLI üzerinden oturum açtıktan sonra, SDK otomatik olarak önbelleğe alınmış lisansı kullanır. Ek kimlik doğrulama gerekmez!

circle-info

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

Bağlantıyı Test Et

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.

Oluşturucu

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-detect)

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:


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üşler: 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önüş: dict - Dosya sayısı ile içe aktarma sonuçlarıÖrnek:


configure(**settings)

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

Parametreler:

Parametre
Tür
Varsayılan
Açıklama

debayer

str

"Yüksek Kalite (Daha Hızlı)"

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ı biçimi

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

Tamamlanmasını bekle

progress_callback

çağrılabilir

None

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

poll_interval

float

2.0

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

Dönüş değerleri: dict - İşleme sonuçları

circle-info

Paralel Mod: Chloros+ lisansı gerektirir. CPU çekirdeklerinize göre otomatik olarak ölçeklenir (en fazla 16 işçi).

Örnek:


get_config()

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

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


get_status()

Arka uç durum bilgilerini alır.

Dönüş: dict - Arka uç durumuÖrnek:


shutdown_backend()

Arka ucu kapatır (SDK tarafından 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ğıdaki durumlarda kullanışlıdır:

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

  • Otomatik ortamlarda kimlik bilgilerini temizlemek

  • Güvenlik amaçları (ör. kaldırmadan önce kimlik bilgilerini kaldırmak)

Döndürdüğü değer: dict - Oturumu kapatma işleminin sonucuÖrnek:

circle-info

Yeniden kimlik doğrulama gerekli: logout() çağrıldıktan sonra, Chloros, Chloros (Tarayıcı) veya Chloros CLI kullanmadan önce SDK kullanmalısınız.


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 endeksler

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ürdükleri: dict - İşleme sonuçlarıÖrnek:


Bağlam Yöneticisi Desteği

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


Tam Örnekler

Örnek 1: Temel İşleme

Varsayılan ayarlarla bir klasörü işleyin:


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

İşleme boru hattı üzerinde tam kontrol:


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

Birden çok uçuş veri kümesini işleme:


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

Chloros'i veri analizi ile entegre edin:


Örnek 5: Özel İlerleme İzleme

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


Örnek 6: Hata İşleme

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


Örnek 7: Hesap Yönetimi ve Oturum Kapatma

Kimlik bilgilerini programlı olarak yönetin:


Ö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 özel 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 olarak işleyin:


Sorun Giderme

Arka Uç Başlamıyor

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

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

  1. Windows Güvenlik Duvarı'nın engellemediğini kontrol edin

  2. Manuel arka uç yolunu deneyin:


Lisans AlgılanmadıSorun: SDK eksik lisans hakkında 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ınmış olduğunu doğrulayın:

  1. Kimlik bilgileriyle ilgili sorun yaşıyorsanız, önbelleğe alınmış kimlik bilgilerini temizleyin ve yeniden giriş yapı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 doluÇö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 değil)***

Bellek Optimizasyonu

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


Arka Plan İşleme

Python'i diğer görevler için 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! Gereksinimler:

  • Windows Server 2016 veya üstü

  • Chloros yüklü (tek seferlik)

  • Herhangi bir makinede etkinleştirilmiş lisans (önbelleğe alınmış lisans sunucuya kopyalanır)


S: Masaüstü, CLI ve SDK arasındaki fark nedir?

Özellik
Masaüstü GUI
CLI Komut Satırı
Python SDK

Arayüz

Nokta-tıklama

Komut

Python API

En Uygun

Görsel çalışma

Komut dosyası

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üklemesi gerekir.

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

  • Ticari dağıtım için OEM lisansı 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: İşlenen görüntüler nereye kaydedilir?

Varsayılan olarak, Proje Yolu'nda:


S: Python komut dosyalarında zamanlanmış olarak görüntüleri işleyebilir miyim?C: Evet! Windows Görev Zamanlayıcıyı Python komut dosyalarıyla birlikte kullanın:

Görev Zamanlayıcı ile günlük olarak çalışacak şekilde zamanlayın.


S: SDK async/await'i destekliyor mu?C: Mevcut sürüm senkronize çalışır. Async davranışı için wait=False 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: logout() yöntemini kullanarak önbelleğe alınmış kimlik bilgilerini temizleyin, 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 üretime hazırdır. Kullanım durumunuza göre kopyalayıp uyarlayabilirsiniz.


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