API : Python SDK

Chloros Python SDK menyediakan akses terprogram kepada enjin pemprosesan imej Chloros, membolehkan automasi, aliran kerja tersuai dan penyepaduan lancar dengan aplikasi dan saluran paip penyelidikan Python anda.

Ciri Utama

  • 🍅 Python asli - Bersih, Pythonic API untuk pemprosesan imej

  • 🔧 Akses API Penuh - Kawalan sepenuhnya ke atas pemprosesan Chloros

  • 🚀 Automasi - Bina aliran kerja pemprosesan kelompok tersuai

  • 🔗 Integrasi - Benamkan Chloros dalam aplikasi Python sedia ada

  • 📊 Sedia Penyelidikan - Sesuai untuk saluran paip analisis saintifik

  • Pemprosesan Selari - Skala kepada teras CPU anda (Chloros+)

Keperluan

Keperluan
Butiran

Chloros Desktop

Mesti dipasang secara tempatan

Sistem Pengendalian

Windows 10/11 (64-bit)

Python

Python 3.7 atau lebih tinggi

Memori

8GB RAM minimum (16GB disyorkan)

Internet

Diperlukan untuk pengaktifan lesen

Keperluan Lesen: Python SDK memerlukan langganan Chloros+ berbayar untuk akses API. Pelan standard (percuma) tidak mempunyai akses API/SDK. Lawati https://cloud.mapir.camera/pricingarrow-up-right untuk menaik taraf.

Mula Pantas

Pemasangan

Pasang melalui pip:

circle-info

Persediaan Kali Pertama: Sebelum menggunakan SDK, aktifkan lesen Chloros+ anda dengan membuka Chloros, Chloros (Pelayar) atau Chloros XPROTX000232 dalam log masuk dengan cPROTX00232 anda. Ini hanya perlu dilakukan sekali sahaja.

Penggunaan Asas

Proses folder dengan hanya beberapa baris:

Kawalan Penuh

Untuk aliran kerja lanjutan:


Panduan Pemasangan

Prasyarat

Sebelum memasang SDK, pastikan anda mempunyai:

  1. Chloros Desktop dipasang (muat turun)

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

  3. lesen Chloros+ aktif (naik tarafarrow-up-right)

Pasang melalui pip

Pemasangan standard:

Dengan sokongan pemantauan kemajuan:

Pemasangan pembangunan:

Sahkan Pemasangan

Uji bahawa SDK dipasang dengan betul:


Persediaan Kali Pertama

Pengaktifan Lesen

SDK menggunakan lesen yang sama seperti Chloros, Chloros (Pelayar) dan Chloros CLI. Aktifkan sekali melalui GUI atau CLI:

  1. Buka Chloros atau Chloros (Pelayar)dan log masuk pada tab Pengguna . Atau, bukaCLI.

  2. Masukkan bukti kelayakan Chloros+ anda dan log masuk

  3. Lesen dicache secara setempat (berterusan sepanjang but semula)

circle-check
circle-info

Log Keluar: Pengguna SDK boleh mengosongkan bukti kelayakan cache secara pemrograman menggunakan kaedah logout(). Lihat kaedah log keluar() dalam Rujukan API.

Sambungan Ujian

Sahkan SDK boleh menyambung ke Chloros:


Rujukan API

Kelas ChlorosLocal

Kelas utama untuk pemprosesan imej Chloros tempatan.

Pembina

Parameter:

Parameter
Taip
Lalai
Penerangan

api_url

str

"http://localhost:5000"

URL daripada bahagian belakang Chloros tempatan

auto_start_backend

bool

True

Mulakan bahagian belakang secara automatik jika perlu

backend_exe

str

None (auto-kesan)

Laluan ke bahagian belakang boleh laku

timeout

int

30

Minta tamat masa dalam beberapa saat

backend_startup_timeout

int

60

Tamat masa untuk permulaan bahagian belakang (saat)

Contoh:


Kaedah

create_project(project_name, camera=None)

Buat projek Chloros baharu.

Parameter:

Parameter
Taip
Diperlukan
Penerangan

project_name

str

Ya

Nama untuk projek

camera

str

Tidak

Templat kamera (cth., "Survey3N_RGN", "Survey3W_OCN")

Pemulangan: dict - Respons penciptaan projekContoh:


import_images(folder_path, recursive=False)

Import imej dari folder.

Parameter:

Parameter
Taip
Diperlukan
Penerangan

folder_path

str/Laluan

Ya

Laluan ke folder dengan imej

recursive

bool

Tidak

Cari subfolder (lalai: Palsu)

Pemulangan: dict - Import hasil carian dengan kiraan failContoh:


configure(**settings)

Konfigurasikan tetapan pemprosesan.

Parameter:

Parameter
Taip
Lalai
Penerangan

debayer

str

"Kualiti Tinggi (Lebih Cepat)"

Kaedah Debayer

vignette_correction

bool

True

Dayakan pembetulan vignet

reflectance_calibration

bool

True

Dayakan penentukuran pantulan

indices

senarai

None

Indeks tumbuh-tumbuhan untuk dikira

export_format

str

"TIFF (16-bit)"

Format output

ppk

bool

False

Dayakan pembetulan PPK

custom_settings

dict

None

Tetapan tersuai lanjutan

Format Eksport:

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

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

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

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

Indeks yang Tersedia:NDVI, NDRE, GNDVI, OSAVI, CIG, EVI, SAVI, MSAVI0, XPROTX02, MSAVI0, XPROTX02, MSAVI0, MSAVI0, MSAVI0, MSAVI0, 88XPROTX0, MSAVI0, NDVI000282NDVI000282XPROTX000282Contoh:


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

Memproses imej projek.

Parameter:

Parameter
Taip
Lalai
Penerangan

mode

str

"parallel"

Mod pemprosesan: "selari" atau "siri"

wait

bool

True

Tunggu sehingga selesai

progress_callback

boleh dipanggil

None

Fungsi panggil balik kemajuan(progres, msg)

poll_interval

terapung

2.0

Selang pengundian untuk kemajuan (saat)

Pemulangan: dict - Memproses hasil

Mod Selari: Memerlukan lesen Chloros+. Skala secara automatik kepada teras CPU anda (sehingga 16 pekerja).

Contoh:


get_config()

Dapatkan konfigurasi projek semasa.

Pemulangan: dict - Konfigurasi projek semasaContoh:


get_status()

Dapatkan maklumat status bahagian belakang.

Pemulangan: dict - Status hujung belakangContoh:


shutdown_backend()

Matikan bahagian belakang (jika dimulakan oleh SDK).

Contoh:


logout()

Kosongkan bukti kelayakan cache daripada sistem setempat.

Penerangan:

Log keluar secara pemrograman dengan mengalih keluar bukti kelayakan pengesahan cache. Ini berguna untuk:

  • Bertukar antara akaun Chloros+ yang berbeza

  • Membersihkan kelayakan dalam persekitaran automatik

  • Tujuan keselamatan (cth., mengalih keluar bukti kelayakan sebelum menyahpasang)

Pemulangan: dict - Hasil operasi Log KeluarContoh:

circle-info

Pengesahan Semula Diperlukan: Selepas memanggil logout(), anda mesti log masuk semula melalui Chloros, Chloros (Pelayar) atau Chloros CLI sebelum menggunakan CLI.256XPROTX.


Fungsi Keselesaan

process_folder(folder_path, **options)

Fungsi kemudahan satu baris untuk memproses folder.

Parameter:

Parameter
Taip
Lalai
Penerangan

folder_path

str/Laluan

Diperlukan

Laluan ke folder dengan imej

project_name

str

Dijana secara automatik

Nama projek

camera

str

None

Templat kamera

indices

senarai

["NDVI"]

Indeks untuk dikira

vignette_correction

bool

True

Dayakan pembetulan vignet

reflectance_calibration

bool

True

Dayakan penentukuran pantulan

export_format

str

"TIFF (16-bit)"

Format output

mode

str

"parallel"

Mod pemprosesan

progress_callback

boleh dipanggil

None

Panggil balik kemajuan

Pemulangan: dict - Memproses hasilContoh:


Sokongan Pengurus Konteks

SDK menyokong pengurus konteks untuk pembersihan automatik:


Contoh Lengkap

Contoh 1: Pemprosesan Asas

Proses folder dengan tetapan lalai:


Contoh 2: Aliran Kerja Tersuai

Kawalan penuh ke atas saluran paip pemprosesan:


Contoh 3: Memproses Kelompok Berbilang Folder

Memproses beberapa set data penerbangan:


Contoh 4: Penyepaduan Saluran Paip Penyelidikan

Sepadukan Chloros dengan analisis data:


Contoh 5: Pemantauan Kemajuan Tersuai

Penjejakan kemajuan lanjutan dengan pengelogan:


Contoh 6: Pengendalian Ralat

Pengendalian ralat yang teguh untuk kegunaan pengeluaran:


Contoh 7: Pengurusan Akaun dan Log Keluar

Urus kelayakan secara pemrograman:


Contoh 8: Alat Baris Perintah

Bina alat CLI tersuai dengan SDK:

Penggunaan:


Pengendalian Pengecualian

SDK menyediakan kelas pengecualian khusus untuk jenis ralat yang berbeza:

Hierarki Pengecualian

Contoh Pengecualian


Topik Lanjutan

Konfigurasi Bahagian Belakang Tersuai

Gunakan lokasi atau konfigurasi bahagian belakang tersuai:

Pemprosesan Tidak Menyekat

Mula memproses dan teruskan dengan tugas lain:

Pengurusan Memori

Untuk set data yang besar, proses dalam kelompok:


Menyelesaikan masalah

Bahagian Belakang Tidak Bermula

Isu: SDK gagal untuk memulakan hujung belakangPenyelesaian:

  1. Sahkan Chloros Desktop dipasang:

  1. Semak Windows Firewall tidak menyekat

  2. Cuba laluan hujung belakang manual:


Lesen Tidak DikesanIsu: SDK memberi amaran tentang kehilangan lesenPenyelesaian:

  1. Buka Chloros, Chloros (Pelayar) atau Chloros CLI dan log masuk.

  2. Sahkan lesen dicache:

  1. Jika mengalami isu kelayakan, kosongkan bukti kelayakan cache dan log masuk semula:

  1. Hubungi sokongan: info@mapir.camera


Ralat ImportIsu: ModuleNotFoundError: No module named 'chloros_sdk'Penyelesaian:


Tamat Masa PemprosesanIsu: Tamat masa pemprosesanPenyelesaian:

  1. Tingkatkan tamat masa:

  1. Proses kelompok yang lebih kecil

  2. Semak ruang cakera yang tersedia

  3. Pantau sumber sistem


Pelabuhan Sudah DigunakanIsu: Port hujung belakang 5000 didudukiPenyelesaian:

Atau cari dan tutup proses bercanggah:


Petua Prestasi

Optimumkan Kelajuan Pemprosesan

  1. Gunakan Mod Selari (memerlukan Chloros+)

  1. Kurangkan Resolusi Output (jika boleh diterima)

  1. Lumpuhkan Indeks Tidak Perlu

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

Pengoptimuman Memori

Untuk set data yang besar:


Pemprosesan Latar Belakang

Kosongkan Python untuk tugasan lain:


Contoh Integrasi

Integrasi Django

Kelalang API

Buku Nota Jupyter


Soalan Lazim

S: Adakah SDK memerlukan sambungan internet?

J: Hanya untuk pengaktifan lesen awal. Selepas log masuk melalui Chloros, Chloros (Pelayar) atau Chloros CLI, lesen dicache secara setempat dan berfungsi di luar talian selama 30 hari.***

S: Bolehkah saya menggunakan SDK pada pelayan tanpa GUI?J: Ya! Keperluan:

  • Windows Server 2016 atau lebih baru

  • Chloros dipasang (sekali)

  • Lesen diaktifkan pada mana-mana mesin (lesen cache disalin ke pelayan)


S: Apakah perbezaan antara Desktop, CLI dan SDK?

Ciri
GUI Desktop
CLI Baris Perintah
Python SDK

Antaramuka

Klik titik

Perintah

Python API

Terbaik Untuk

Kerja visual

Skrip

Integrasi

Automasi

Terhad

Baik

Cemerlang

Fleksibiliti

Asas

Baik

Maksimum

Lesen

Chloros+

Chloros+

Chloros+

S: Bolehkah saya mengedarkan apl yang dibina dengan SDK?J: Kod SDK boleh disepadukan ke dalam aplikasi anda, tetapi:

  • Pengguna akhir memerlukan Chloros dipasang

  • Pengguna akhir memerlukan lesen Chloros+ aktif

  • Pengedaran komersial memerlukan pelesenan OEM

Hubungi info@mapir.camera untuk pertanyaan OEM.


S: Bagaimanakah cara saya mengemas kini SDK?


S: Di manakah imej yang diproses disimpan?

Secara lalai, dalam Laluan Projek :


S: Bolehkah saya memproses imej daripada skrip Python berjalan mengikut jadual?J: Ya! Gunakan Windows Task Scheduler dengan skrip Python:

Jadualkan melalui Penjadual Tugas untuk dijalankan setiap hari.


S: Adakah SDK menyokong async/menunggu?J: Versi semasa adalah segerak. Untuk tingkah laku tak segerak, gunakan wait=False atau jalankan dalam urutan berasingan:


S: Bagaimanakah cara saya bertukar antara akaun Chloros+ yang berbeza?J: Gunakan kaedah logout() untuk mengosongkan bukti kelayakan cache, kemudian log masuk semula dengan akaun baharu:

Selepas log keluar, sahkan dengan akaun baharu melalui GUI, Penyemak Imbas atau CLI sebelum menggunakan SDK sekali lagi.


Mendapatkan Bantuan

Dokumentasi

  • Rujukan API: Halaman ini

Saluran Sokongan

Kod Contoh

Semua contoh yang disenaraikan di sini telah diuji dan sedia pengeluaran. Salin dan sesuaikan mereka untuk kes penggunaan anda.


LesenPerisian Milik - Hak Cipta (c) 2025 MAPIR Inc.

SDK memerlukan langganan Chloros+ yang aktif. Penggunaan, pengedaran atau pengubahsuaian yang tidak dibenarkan adalah dilarang.

Last updated