API : Python SDK

Chloros Python SDK memberikan akses programatik ke mesin pemrosesan gambar Chloros, memungkinkan otomatisasi, alur kerja kustom, dan integrasi yang mulus dengan aplikasi dan alur kerja penelitian Python Anda.

Fitur Utama

  • 🐍 Python Asli - Kode bersih dan Pythonic untuk pemrosesan gambar

  • 🔧 Akses Penuh - Kontrol penuh atas pemrosesan gambar

  • 🚀 Otomatisasi - Bangun alur kerja pemrosesan batch kustom

  • 🔗 Integrasi - Embed Chloros dalam aplikasi Python yang sudah ada

  • 📊 Siap untuk Penelitian - Sempurna untuk alur kerja analisis ilmiah

  • Pemrosesan Paralel - Skalabel hingga inti CPU Anda (Chloros+)

Persyaratan

Persyaratan
Rincian

Chloros Desktop

Harus diinstal secara lokal

Sistem Operasi

Windows 10/11 (64-bit)

Python

Python 3.7 atau lebih tinggi

Memori

Minimal 8GB RAM (disarankan 16GB)

Internet

Diperlukan untuk aktivasi lisensi

circle-info

Persyaratan Lisensi: Python SDK memerlukan langganan berbayar Chloros+ untuk akses API. Rencana standar (gratis) tidak memiliki akses ke API/SDK. Kunjungi https://cloud.mapir.camera/pricingarrow-up-right untuk melakukan upgrade.

Panduan Cepat

Instalasi

Instal melalui pip:

circle-info

Pengaturan Awal: Sebelum menggunakan SDK, aktifkan lisensi Chloros+ Anda dengan membuka Chloros, Chloros (Browser) atau Chloros CLI dan masuk dengan kredensial Anda. Ini hanya perlu dilakukan sekali.

Penggunaan Dasar

Proses folder dengan beberapa baris saja:

Kontrol Penuh

Untuk alur kerja lanjutan:


Panduan Instalasi

Persyaratan

Sebelum menginstal SDK, pastikan Anda memiliki:

  1. Chloros Desktop terinstal (download)

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

  3. Lisensi Chloros+ yang aktif (upgradearrow-up-right)

Instalasi melalui pip

Instalasi standar:

Dengan dukungan pemantauan progres:

Instalasi pengembangan:

Verifikasi Instalasi

Uji apakah SDK terinstal dengan benar:


Pengaturan Pertama Kali

Aktivasi Lisensi

SDK menggunakan lisensi yang sama dengan Chloros, Chloros (Browser), dan Chloros CLI. Aktivasi sekali melalui antarmuka pengguna (GUI) atau CLI:

  1. Buka Chloros atau Chloros (Browser)dan masuk ke tab Pengguna . Atau, bukaCLI.

  2. Masukkan kredensial Chloros+ Anda dan masuk

  3. Lisensi disimpan secara lokal (tetap ada setelah reboot)

circle-info

Pengaturan Satu Kali: Setelah masuk melalui antarmuka pengguna (GUI) atau CLI, SDK secara otomatis menggunakan lisensi yang disimpan. Tidak diperlukan otentikasi tambahan!

circle-info

Logout: Pengguna SDK dapat menghapus kredensial yang disimpan secara programatik menggunakan metode logout(). Lihat metode logout() dalam Referensi API.

Uji Koneksi

Verifikasi apakah SDK dapat terhubung ke Chloros:


Referensi API

Kelas ChlorosLocal

Kelas utama untuk pemrosesan gambar Chloros lokal.

Konstruktor

Parameter:

Parameter
Tipe
Default
Deskripsi

api_url

str

"http://localhost:5000"

URL dari backend lokal Chloros

auto_start_backend

bool

True

Mulai backend secara otomatis jika diperlukan

backend_exe

str

None (deteksi otomatis)

Jalan ke executable backend

timeout

int

30

Batas waktu permintaan dalam detik

backend_startup_timeout

int

60

Batas waktu untuk memulai backend (detik)

Contoh:


Metode

create_project(project_name, camera=None)

Buat proyek Chloros baru.

Parameter:

Parameter
Tipe
Diperlukan
Deskripsi

project_name

str

Ya

Nama untuk proyek

camera

str

Tidak

Template kamera (misalnya, "Survey3N_RGN", "Survey3W_OCN")

Hasil: dict - Respons pembuatan proyekContoh:


import_images(folder_path, recursive=False)

Impor gambar dari folder.

Parameter:

Parameter
Tipe
Diperlukan
Deskripsi

folder_path

str/Path

Ya

Jalan ke folder dengan gambar

recursive

bool

Tidak

Cari subfolder (default: False)

Mengembalikan: dict - Hasil impor dengan jumlah fileContoh:


configure(**settings)

Konfigurasi pengaturan pemrosesan.

Parameter:

Parameter
Tipe
Default
Deskripsi

debayer

str

"Kualitas Tinggi (Lebih Cepat)"

Metode Debayer

vignette_correction

bool

True

Aktifkan koreksi vignette

reflectance_calibration

bool

True

Aktifkan kalibrasi reflektansi

indices

daftar

None

Indeks vegetasi yang akan dihitung

export_format

string

"TIFF (16-bit)"

Format output

ppk

bool

False

Aktifkan koreksi PPK

custom_settings

dict

None

Pengaturan kustom lanjutan

Format Ekspor:

  • "TIFF (16-bit)" - Direkomendasikan untuk GIS/fotogrametri

  • "TIFF (32-bit, Percent)" - Analisis ilmiah

  • "PNG (8-bit)" - Inspeksi visual

  • "JPG (8-bit)" - Output terkompresi

**Indeks Tersedia:**NDVI, NDRE, GNDVI, OSAVI, CIG, EVI, SAVI, MSAVI, MTVI2, dan lainnya.Contoh:


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

Proses gambar proyek.

Parameter:

Parameter
Tipe
Default
Deskripsi

mode

str

"parallel"

Mode pemrosesan: "parallel" atau "serial"

wait

bool

True

Tunggu hingga selesai

progress_callback

callable

None

Fungsi panggilan balik kemajuan (progress, msg)

poll_interval

float

2.0

Interval polling untuk kemajuan (detik)

Mengembalikan: dict - Hasil pemrosesan

circle-info

Mode Paralel: Membutuhkan lisensi Chloros+. Secara otomatis menyesuaikan dengan inti CPU Anda (hingga 16 pekerja).

Contoh:


get_config()

Mendapatkan konfigurasi proyek saat ini.

Mengembalikan: dict - Konfigurasi proyek saat iniContoh:


get_status()

Mendapatkan informasi status backend.

Mengembalikan: dict - Status backendContoh:


shutdown_backend()

Matikan backend (jika dimulai oleh SDK).

Contoh:


logout()

Hapus kredensial yang disimpan di sistem lokal.

Deskripsi:

Keluar secara programatik dengan menghapus kredensial otentikasi yang disimpan dalam cache. Hal ini berguna untuk:

  • Beralih antara akun Chloros+ yang berbeda

  • Membersihkan kredensial dalam lingkungan otomatis

  • Tujuan keamanan (misalnya, menghapus kredensial sebelum uninstall)

Mengembalikan: dict - Hasil operasi logoutContoh:

circle-info

Re-authentication Required: Setelah memanggil logout(), Anda harus masuk kembali melalui Chloros, Chloros (Browser), atau Chloros CLI sebelum menggunakan SDK.


Fungsi Kemudahan

process_folder(folder_path, **options)

Fungsi kemudahan satu baris untuk memproses folder.

Parameter:

Parameter
Tipe
Default
Deskripsi

folder_path

str/Path

Diperlukan

Jalan ke folder dengan gambar

project_name

str

Dibuat otomatis

Nama proyek

camera

str

None

Template kamera

indices

list

["NDVI"]

Indeks untuk perhitungan

vignette_correction

bool

True

Aktifkan koreksi vignette

reflectance_calibration

bool

True

Aktifkan kalibrasi reflektansi

export_format

str

"TIFF (16-bit)"

Format output

mode

str

"parallel"

Mode pemrosesan

progress_callback

callable

None

Panggilan balik kemajuan

Mengembalikan: dict - Hasil pemrosesanContoh:


Dukungan Pengelola Konteks

SDK mendukung pengelola konteks untuk pembersihan otomatis:


Contoh Lengkap

Contoh 1: Pemrosesan Dasar

Memproses folder dengan pengaturan default:


Contoh 2: Alur Kerja Kustom

Kontrol penuh atas alur pemrosesan:


Contoh 3: Pemrosesan Berkelompok Beberapa Folder

Memproses beberapa dataset penerbangan:


Contoh 4: Integrasi Jalur Kerja Penelitian

Integrasikan Chloros dengan analisis data:


Contoh 5: Pemantauan Kemajuan Kustom

Pemantauan kemajuan lanjutan dengan pencatatan:


Contoh 6: Penanganan Kesalahan

Penanganan kesalahan yang andal untuk penggunaan produksi:


Contoh 7: Manajemen Akun dan Keluar

Kelola kredensial secara programatik:


Contoh 8: Alat Baris Perintah

Bangun alat CLI kustom dengan SDK:

Penggunaan:


Penanganan Kecuali

SDK menyediakan kelas pengecualian khusus untuk jenis kesalahan yang berbeda:

Hierarki Pengecualian

Contoh Pengecualian


Topik Lanjutan

Konfigurasi Backend Kustom

Gunakan lokasi atau konfigurasi backend kustom:

Pemrosesan Non-Blokir

Mulai pemrosesan dan lanjutkan dengan tugas lain:

Pengelolaan Memori

Untuk dataset besar, proses secara bertahap:


Pemecahan Masalah

Backend Tidak Berjalan

Masalah: SDK gagal memulai backendSolusi:

  1. Pastikan Chloros Desktop terinstal:

  1. Periksa apakah Windows Firewall tidak memblokir

  2. Coba jalur backend manual:


Lisensi Tidak TerdeteksiMasalah: SDK menampilkan peringatan tentang lisensi yang hilangSolusi:

  1. Buka Chloros, Chloros (Browser) atau Chloros CLI dan login.

  2. Verifikasi lisensi telah disimpan dalam cache:

  1. Jika mengalami masalah kredensial, hapus kredensial yang disimpan dalam cache dan login ulang:

  1. Hubungi dukungan: info@mapir.camera


Kesalahan ImporMasalah: ModuleNotFoundError: No module named 'chloros_sdk'Solusi:


Waktu Pengolahan HabisMasalah: Waktu pengolahan habisSolusi:

  1. Tingkatkan batas waktu:

  1. Proses dalam batch yang lebih kecil

  2. Periksa ruang disk yang tersedia

  3. Pantau sumber daya sistem


Port Sudah DigunakanMasalah: Port belakang 5000 terpakaiSolusi:

Atau temukan dan tutup proses yang bertentangan:


Tips Kinerja

Optimalkan Kecepatan Pemrosesan

  1. Gunakan Mode Paralel (membutuhkan Chloros+)

  1. Kurangi Resolusi Output (jika dapat diterima)

  1. Nonaktifkan Indeks yang Tidak Diperlukan

  1. Proses di SSD (bukan HDD)***

Optimasi Memori

Untuk dataset besar:


Pemrosesan Latar Belakang

Bebaskan Python untuk tugas lain:


Contoh Integrasi

Integrasi Django

Flask API

Jupyter Notebook


FAQ

Q: Apakah SDK memerlukan koneksi internet?

A: Hanya untuk aktivasi lisensi awal. Setelah masuk melalui Chloros, Chloros (Browser) atau Chloros CLI, lisensi disimpan secara lokal dan dapat digunakan offline selama 30 hari.***

Q: Apakah saya dapat menggunakan SDK pada server tanpa antarmuka grafis (GUI)? A: Ya! Persyaratan:

  • Windows Server 2016 atau versi terbaru

  • Chloros terinstal (sekali saja)

  • Lisensi diaktifkan di mesin mana pun (lisensi yang disimpan di cache disalin ke server)


Q: Apa perbedaan antara Desktop, CLI, dan SDK?

Fitur
Desktop GUI
CLI Baris Perintah
Python SDK

Antarmuka

Klik dan pilih

Baris perintah

Python API

Terbaik Untuk

Pekerjaan visual

Pemrograman

Integrasi

Otomatisasi

Terbatas

Baik

Sangat baik

Fleksibilitas

Dasar

Baik

Maksimal

Lisensi

Chloros+

Chloros+

Chloros+

Q: Bisakah saya mendistribusikan aplikasi yang dibangun dengan SDK?A: Kode SDK dapat diintegrasikan ke dalam aplikasi Anda, tetapi:

  • Pengguna akhir memerlukan Chloros yang terinstal

  • Pengguna akhir memerlukan lisensi Chloros+ yang aktif

  • Distribusi komersial memerlukan lisensi OEM

Hubungi info@mapir.camera untuk pertanyaan terkait OEM.


Q: Bagaimana cara memperbarui SDK?


Q: Di mana gambar yang diproses disimpan?

Secara default, di jalur proyek:


Q: Apakah saya dapat memproses gambar dari skrip Python yang berjalan secara terjadwal?A: Ya! Gunakan Windows Task Scheduler dengan skrip Python:

Jadwalkan melalui Task Scheduler untuk dijalankan setiap hari.


Q: Apakah SDK mendukung async/await?A: Versi saat ini bersifat sinkron. Untuk perilaku asinkron, gunakan wait=False atau jalankan di thread terpisah:


Q: Bagaimana cara beralih antara akun Chloros+ yang berbeda?A: Gunakan metode logout() untuk menghapus kredensial yang disimpan, lalu masuk kembali dengan akun baru:

Setelah keluar, otentikasi dengan akun baru melalui antarmuka pengguna (GUI), browser, atau CLI sebelum menggunakan SDK lagi.


Mendapatkan Bantuan

Dokumen

  • Referensi API: Halaman ini

Saluran Dukungan

Contoh Kode

Semua contoh yang tercantum di sini telah diuji dan siap digunakan. Salin dan sesuaikan untuk kasus penggunaan Anda.


LisensiPerangkat Lunak Proprietary - Hak Cipta (c) 2025 MAPIR Inc.

SDK memerlukan langganan Chloros+ yang aktif. Penggunaan, distribusi, atau modifikasi tanpa izin dilarang.

Last updated