API : Python SDK

Το Chloros Python SDK παρέχει προγραμματιστική πρόσβαση στον κινητήρα επεξεργασίας εικόνων Chloros, επιτρέποντας την αυτοματοποίηση, τις προσαρμοσμένες ροές εργασίας και την απρόσκοπτη ενσωμάτωση με τις εφαρμογές Python και τις ερευνητικές σας διαδικασίες.

Βασικά χαρακτηριστικά

  • 🐍 Εγγενές Python - Καθαρό, Pythonic API για επεξεργασία εικόνων

  • 🔧 Πλήρης πρόσβαση στο API - Πλήρης έλεγχος της επεξεργασίας Chloros

  • 🚀 Αυτοματοποίηση - Δημιουργία προσαρμοσμένων ροών εργασίας μαζικής επεξεργασίας

  • 🔗 Ενσωμάτωση - Ενσωματώστε το Chloros σε υπάρχουσες εφαρμογές Python

  • 📊 Έτοιμο για έρευνα - Ιδανικό για επιστημονικές αναλύσεις

  • Παράλληλη επεξεργασία - Κλιμακώνεται ανάλογα με τους πυρήνες της CPU σας (Chloros+)

Απαιτήσεις

Απαίτηση
Λεπτομέρειες

Chloros Desktop

Πρέπει να είναι εγκατεστημένο τοπικά

Λειτουργικό σύστημα

Windows 10/11 (64-bit)

Python

Python 3.7 ή νεότερη έκδοση

Μνήμη

Ελάχιστη μνήμη RAM 8 GB (συνιστάται 16 GB)

Διαδίκτυο

Απαιτείται για την ενεργοποίηση της άδειας χρήσης

circle-info

Απαιτήσεις άδειας χρήσης: Το Python SDK απαιτεί συνδρομή Chloros+ επί πληρωμή για πρόσβαση στο API. Τα βασικά (δωρεάν) πακέτα δεν έχουν πρόσβαση στο API/SDK. Επισκεφθείτε το https://cloud.mapir.camera/pricingarrow-up-right για αναβάθμιση.

Γρήγορη εκκίνηση

Εγκατάσταση

Εγκαταστήστε μέσω pip:

circle-info

Πρώτη ρύθμιση: Πριν χρησιμοποιήσετε το SDK, ενεργοποιήστε την άδεια χρήσης Chloros+ ανοίγοντας το Chloros, Chloros (Browser) ή το Chloros CLI και συνδεθείτε με τα διαπιστευτήριά σας. Αυτό χρειάζεται να γίνει μόνο μία φορά.

Βασική χρήση

Επεξεργαστείτε ένα φάκελο με λίγες μόνο γραμμές:

Πλήρης έλεγχος

Για προηγμένες ροές εργασίας:


Οδηγός εγκατάστασης

Προαπαιτούμενα

Πριν εγκαταστήσετε το SDK, βεβαιωθείτε ότι διαθέτετε:

  1. Chloros Desktop εγκατεστημένο (download)

  2. Python 3.7+ εγκατεστημένο (python.orgarrow-up-right)

  3. Ενεργή άδεια Chloros+ (αναβάθμισηarrow-up-right)

Εγκατάσταση μέσω pip

Τυπική εγκατάσταση:

Με υποστήριξη παρακολούθησης προόδου:

Εγκατάσταση ανάπτυξης:

Επαλήθευση εγκατάστασης

Ελέγξτε ότι το SDK έχει εγκατασταθεί σωστά:


Πρώτη ρύθμιση

Ενεργοποίηση άδειας χρήσης

Το SDK χρησιμοποιεί την ίδια άδεια χρήσης με τα Chloros, Chloros (Browser) και Chloros CLI. Ενεργοποιήστε μία φορά μέσω του GUI ή του CLI:

  1. Ανοίξτε το Chloros ή το Chloros (Browser)και συνδεθείτε στην καρτέλα Χρήστη . Εναλλακτικά, ανοίξτε τοCLI.

  2. Εισαγάγετε τα διαπιστευτήριά σας Chloros+ και συνδεθείτε

  3. Η άδεια αποθηκεύεται τοπικά (διατηρείται μετά από επανεκκινήσεις)

circle-info

Μία φορά μόνο ρύθμιση: Μετά τη σύνδεση μέσω του GUI ή του CLI, το SDK χρησιμοποιεί αυτόματα την αποθηκευμένη άδεια χρήσης. Δεν απαιτείται επιπλέον πιστοποίηση!

circle-info

Αποσύνδεση: Οι χρήστες του SDK μπορούν να διαγράψουν προγραμματικά τα αποθηκευμένα διαπιστευτήρια χρησιμοποιώντας τη μέθοδο logout(). Δείτε τη μέθοδο logout() στην αναφορά API.

Δοκιμή σύνδεσης

Επαληθεύστε ότι το SDK μπορεί να συνδεθεί στο Chloros:


Αναφορά API

ChlorosLocal Class

Κύρια κλάση για τοπική επεξεργασία εικόνας Chloros.

Κατασκευαστής

Παράμετροι:

Παράμετρος
Τύπος
Προεπιλογή
Περιγραφή

api_url

str

"http://localhost:5000"

URL του τοπικού Chloros backend

auto_start_backend

bool

True

Αυτόματη εκκίνηση του backend, αν χρειαστεί

backend_exe

str

None (αυτόματη ανίχνευση)

Διαδρομή προς το εκτελέσιμο backend

timeout

int

30

Χρονικό όριο αιτήματος σε δευτερόλεπτα

backend_startup_timeout

int

60

Χρονικό όριο για εκκίνηση του backend (δευτερόλεπτα)

Παραδείγματα:


Μέθοδοι

create_project(project_name, camera=None)

Δημιουργία νέου έργου Chloros.

Παράμετροι:

Παράμετρος
Τύπος
Απαιτείται
Περιγραφή

project_name

str

Ναι

Όνομα για το έργο

camera

str

Όχι

Πρότυπο κάμερας (π.χ. "Survey3N_RGN", "Survey3W_OCN")

Επιστρέφει: dict - Απόκριση δημιουργίας έργουΠαράδειγμα:


import_images(folder_path, recursive=False)

Εισαγωγή εικόνων από φάκελο.

Παράμετροι:

Παράμετρος
Τύπος
Απαιτείται
Περιγραφή

folder_path

str/Path

Ναι

Διαδρομή προς φάκελο με εικόνες

recursive

bool

Όχι

Αναζήτηση υποφακέλων (προεπιλογή: False)

Επιστρέφει: dict - Αποτελέσματα εισαγωγής με αριθμό αρχείωνΠαράδειγμα:


configure(**settings)

Διαμόρφωση ρυθμίσεων επεξεργασίας.

Παράμετροι:

Παράμετρος
Τύπος
Προεπιλογή
Περιγραφή

debayer

str

"Υψηλή ποιότητα (ταχύτερη)"

Μέθοδος Debayer

vignette_correction

bool

True

Ενεργοποίηση διόρθωσης βινιέτας

reflectance_calibration

bool

True

Ενεργοποίηση βαθμονόμησης ανακλαστικότητας

indices

λίστα

None

Δείκτες βλάστησης προς υπολογισμό

export_format

str

"TIFF (16-bit)"

Μορφή εξόδου

ppk

bool

False

Ενεργοποίηση διορθώσεων PPK

custom_settings

dict

None

Προηγμένες προσαρμοσμένες ρυθμίσεις

Μορφές εξαγωγής:

  • "TIFF (16-bit)" - Συνιστάται για GIS/φωτογραμμετρία

  • "TIFF (32-bit, Percent)" - Επιστημονική ανάλυση

  • "PNG (8-bit)" - Οπτική επιθεώρηση

  • "JPG (8-bit)" - Συμπιεσμένη έξοδος

**Διαθέσιμοι δείκτες:**NDVI, NDRE, GNDVI, OSAVI, CIG, EVI, SAVI, MSAVI, MTVI2 και άλλα.Παράδειγμα:


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

Επεξεργασία των εικόνων του έργου.

Παράμετροι:

Παράμετρος
Τύπος
Προεπιλογή
Περιγραφή

mode

str

"parallel"

Λειτουργία επεξεργασίας: "parallel" ή "serial"

wait

bool

True

Αναμονή για ολοκλήρωση

progress_callback

callable

None

Λειτουργία επιστροφής κλήσης προόδου (progress, msg)

poll_interval

float

2.0

Διάστημα δειγματοληψίας για την πρόοδο (δευτερόλεπτα)

Επιστρέφει: dict - Αποτελέσματα επεξεργασίας

circle-info

Παράλληλη λειτουργία: Απαιτείται άδεια Chloros+. Προσαρμόζεται αυτόματα στους πυρήνες της CPU σας (έως 16 workers).

Παράδειγμα:


get_config()

Λήψη της τρέχουσας διαμόρφωσης του έργου.

Επιστρέφει: dict - Τρέχουσα διαμόρφωση του έργουΠαράδειγμα:


get_status()

Λήψη πληροφοριών κατάστασης του backend.

Επιστρέφει: dict - Κατάσταση του backendΠαράδειγμα:


shutdown_backend()

Τερματισμός του backend (εάν έχει ξεκινήσει από το SDK).

Παράδειγμα:


logout()

Εκκαθάριση των αποθηκευμένων διαπιστευτηρίων από το τοπικό σύστημα.

Περιγραφή:

Αποσυνδέεται προγραμματικά αφαιρώντας τα αποθηκευμένα διαπιστευτήρια ελέγχου ταυτότητας. Αυτό είναι χρήσιμο για:

  • Εναλλαγή μεταξύ διαφορετικών λογαριασμών Chloros+

  • Εκκαθάριση διαπιστευτηρίων σε αυτοματοποιημένα περιβάλλοντα

  • Λόγους ασφαλείας (π.χ. αφαίρεση διαπιστευτηρίων πριν από την απεγκατάσταση)

Επιστρέφει: dict - Αποτέλεσμα της λειτουργίας αποσύνδεσηςΠαράδειγμα:

circle-info

Απαιτείται εκ νέου πιστοποίηση: Μετά την κλήση του logout(), πρέπει να συνδεθείτε ξανά μέσω του Chloros, του Chloros (Browser) ή Chloros CLI πριν χρησιμοποιήσετε το SDK.


Λειτουργίες ευκολίας

process_folder(folder_path, **options)

Λειτουργία ευκολίας μιας γραμμής για την επεξεργασία ενός φακέλου.

Παράμετροι:

Παράμετρος
Τύπος
Προεπιλογή
Περιγραφή

folder_path

str/Path

Απαιτείται

Διαδρομή προς φάκελο με εικόνες

project_name

str

Αυτόματη δημιουργία

Όνομα έργου

camera

str

None

Πρότυπο κάμερας

indices

list

["NDVI"]

Δείκτες για υπολογισμό

vignette_correction

bool

True

Ενεργοποίηση διόρθωσης βινιέτας

reflectance_calibration

bool

True

Ενεργοποίηση βαθμονόμησης ανακλαστικότητας

export_format

str

"TIFF (16-bit)"

Μορφή εξόδου

mode

str

"parallel"

Λειτουργία επεξεργασίας

progress_callback

callable

None

Επιστροφή κλήσης προόδου

Επιστροφές: dict - Αποτελέσματα επεξεργασίαςΠαράδειγμα:


Υποστήριξη διαχειριστή περιβάλλοντος

Το SDK υποστηρίζει διαχειριστές περιβάλλοντος για αυτόματο καθαρισμό:


Πλήρη παραδείγματα

Παράδειγμα 1: Βασική επεξεργασία

Επεξεργασία φακέλου με προεπιλεγμένες ρυθμίσεις:


Παράδειγμα 2: Προσαρμοσμένη ροή εργασίας

Πλήρης έλεγχος της ροής επεξεργασίας:


Παράδειγμα 3: Μαζική επεξεργασία πολλαπλών φακέλων

Επεξεργασία πολλαπλών συνόλων δεδομένων πτήσεων:


Παράδειγμα 4: Ενσωμάτωση ροής έρευνας

Ενσωμάτωση του Chloros με ανάλυση δεδομένων:


Παράδειγμα 5: Προσαρμοσμένη παρακολούθηση προόδου

Προηγμένη παρακολούθηση προόδου με καταγραφή:


Παράδειγμα 6: Αντιμετώπιση σφαλμάτων

Σταθερή αντιμετώπιση σφαλμάτων για χρήση σε παραγωγή:


Παράδειγμα 7: Διαχείριση λογαριασμού και αποσύνδεση

Διαχείριση διαπιστευτηρίων μέσω προγραμματισμού:


Παράδειγμα 8: Εργαλείο γραμμής εντολών

Δημιουργήστε ένα προσαρμοσμένο εργαλείο CLI με το SDK:

Χρήση:


Χειρισμός εξαιρέσεων

Το SDK παρέχει συγκεκριμένες κατηγορίες εξαιρέσεων για διαφορετικούς τύπους σφαλμάτων:

Ιεραρχία εξαιρέσεων

Παραδείγματα εξαιρέσεων


Προχωρημένα θέματα

Προσαρμοσμένη διαμόρφωση backend

Χρησιμοποιήστε μια προσαρμοσμένη θέση ή διαμόρφωση backend:

Επεξεργασία χωρίς μπλοκάρισμα

Ξεκινήστε την επεξεργασία και συνεχίστε με άλλες εργασίες:

Διαχείριση μνήμης

Για μεγάλα σύνολα δεδομένων, επεξεργαστείτε τα σε παρτίδες:


Αντιμετώπιση προβλημάτων

Το backend δεν ξεκινά

Πρόβλημα: Το SDK δεν ξεκινά το backend.Λύσεις:

  1. Βεβαιωθείτε ότι το Chloros Desktop είναι εγκατεστημένο:

  1. Ελέγξτε ότι το Windows Firewall δεν το εμποδίζει

  2. Δοκιμάστε τη χειροκίνητη διαδρομή του backend:


Η άδεια χρήσης δεν ανιχνεύεταιΠρόβλημα: Το SDK προειδοποιεί για την έλλειψη άδειας χρήσηςΛύσεις:

  1. Ανοίξτε το Chloros, το Chloros (πρόγραμμα περιήγησης) ή το Chloros CLI και συνδεθείτε.

  2. Βεβαιωθείτε ότι η άδεια χρήσης είναι αποθηκευμένη στην προσωρινή μνήμη:

  1. Εάν αντιμετωπίζετε προβλήματα με τα διαπιστευτήρια, διαγράψτε τα αποθηκευμένα διαπιστευτήρια και συνδεθείτε ξανά:

  1. Επικοινωνήστε με την υποστήριξη: info@mapir.camera


Σφάλματα εισαγωγήςΠρόβλημα: ModuleNotFoundError: No module named 'chloros_sdk'Λύσεις:


Χρονικό όριο επεξεργασίαςΠρόβλημα: Χρονικό όριο επεξεργασίαςΛύσεις:

  1. Αύξηση του χρονικού ορίου:

  1. Επεξεργασία μικρότερων παρτίδων

  2. Έλεγχος διαθέσιμου χώρου στο δίσκο

  3. Παρακολούθηση πόρων συστήματος


Θύρα ήδη σε χρήσηΠρόβλημα: Η θύρα 5000 του backend είναι κατειλημμένηΛύσεις:

Ή εντοπίστε και κλείστε τη διεργασία που προκαλεί τη σύγκρουση:


Συμβουλές για την απόδοση

Βελτιστοποίηση της ταχύτητας επεξεργασίας

  1. Χρησιμοποιήστε την παράλληλη λειτουργία (απαιτείται Chloros+)

  1. Μειώστε την ανάλυση εξόδου (εάν είναι αποδεκτό)

  1. Απενεργοποιήστε τους περιττούς δείκτες

  1. Επεξεργαστείτε σε SSD (όχι HDD)***

Βελτιστοποίηση μνήμης

Για μεγάλα σύνολα δεδομένων:


Επεξεργασία στο παρασκήνιο

Απελευθερώστε Python για άλλες εργασίες:


Παραδείγματα ενσωμάτωσης

Ενσωμάτωση Django

Flask API

Jupyter Notebook


Συχνές ερωτήσεις

Ε: Το SDK απαιτεί σύνδεση στο διαδίκτυο;

Α: Μόνο για την αρχική ενεργοποίηση της άδειας χρήσης. Αφού συνδεθείτε μέσω του Chloros, του Chloros (Browser) ή του Chloros CLI, η άδεια χρήσης αποθηκεύεται τοπικά και λειτουργεί εκτός σύνδεσης για 30 ημέρες.***

Ε: Μπορώ να χρησιμοποιήσω το SDK σε έναν διακομιστή χωρίς GUI;Α: Ναι! Απαιτήσεις:

  • Windows Server 2016 ή νεότερη έκδοση

  • Chloros εγκατεστημένο (μία φορά)

  • Άδεια ενεργοποιημένη σε οποιονδήποτε υπολογιστή (άδεια χρήσης αποθηκευμένη στο cache και αντιγραμμένη στον διακομιστή)


Ε: Ποια είναι η διαφορά μεταξύ Desktop, CLI και SDK;

Χαρακτηριστικό
Desktop GUI
CLI Γραμμή εντολών
Python SDK

Διεπαφή

Point-click

Εντολή

Python API

Κατάλληλο για

Οπτική εργασία

Σενάρια

Ενσωμάτωση

Αυτοματοποίηση

Περιορισμένη

Καλή

Εξαιρετική

Ευελιξία

Βασική

Καλή

Μέγιστη

Άδεια

Chloros+

Chloros+

Chloros+

Ε: Μπορώ να διανέμω εφαρμογές που έχουν δημιουργηθεί με το SDK;Α: Ο κώδικας SDK μπορεί να ενσωματωθεί στις εφαρμογές σας, αλλά:

  • Οι τελικοί χρήστες πρέπει να έχουν εγκατεστημένο το Chloros

  • Οι τελικοί χρήστες πρέπει να έχουν ενεργές άδειες Chloros+

  • Η εμπορική διανομή απαιτεί άδεια OEM.

Επικοινωνήστε με το info@mapir.camera για ερωτήσεις σχετικά με το OEM.


Ε: Πώς μπορώ να ενημερώσω το SDK;


Ε: Πού αποθηκεύονται οι επεξεργασμένες εικόνες;

Από προεπιλογή, στη διαδρομή του έργου:


Ε: Μπορώ να επεξεργαστώ εικόνες από σενάρια Python που εκτελούνται σύμφωνα με το πρόγραμμα;Α: Ναι! Χρησιμοποιήστε το Windows Task Scheduler με σενάρια Python:

Προγραμματίστε μέσω του Task Scheduler να εκτελείται καθημερινά.


Ε: Το SDK υποστηρίζει async/await;Α: Η τρέχουσα έκδοση είναι συγχρονισμένη. Για ασύγχρονη συμπεριφορά, χρησιμοποιήστε το wait=False ή εκτελέστε σε ξεχωριστό νήμα:


Ε: Πώς μπορώ να εναλλάσσω διαφορετικούς λογαριασμούς Chloros+;Α: Χρησιμοποιήστε τη μέθοδο logout() για να διαγράψετε τα αποθηκευμένα διαπιστευτήρια και, στη συνέχεια, συνδεθείτε ξανά με τον νέο λογαριασμό:

Μετά την αποσύνδεση, πραγματοποιήστε έλεγχο ταυτότητας με τον νέο λογαριασμό μέσω του GUI, του προγράμματος περιήγησης ή του CLI πριν χρησιμοποιήσετε ξανά το SDK.


Λήψη βοήθειας

Τεκμηρίωση

  • Αναφορά API: Αυτή η σελίδα

Κανάλια υποστήριξης

Δείγμα κώδικα

Όλα τα παραδείγματα που αναφέρονται εδώ έχουν δοκιμαστεί και είναι έτοιμα για παραγωγή. Αντιγράψτε τα και προσαρμόστε τα για τη δική σας περίπτωση χρήσης.


Άδεια χρήσηςΙδιόκτητο λογισμικό - Πνευματικά δικαιώματα (c) 2025 MAPIR Inc.

Το SDK απαιτεί ενεργή συνδρομή στο Chloros+. Απαγορεύεται η μη εξουσιοδοτημένη χρήση, διανομή ή τροποποίηση.

Last updated