API: Python SDK

يوفر Chloros Python SDK يوفر وصولاً برمجياً إلى محرك معالجة الصور Chloros، مما يتيح الأتمتة وسير العمل المخصص والتكامل السلس مع تطبيقات Python وخطوط الأبحاث.

الميزات الرئيسية

  • 🐍 Python الأصلي - API نظيف وبسيط لمعالجة الصور

  • 🔧 وصول كامل إلى API - تحكم كامل في معالجة Chloros

  • 🚀 الأتمتة - إنشاء سير عمل مخصص للمعالجة المجمعة

  • 🔗 التكامل - تضمين Chloros في تطبيقات Python الحالية

  • 📊 جاهز للبحث - مثالي لخطوط أنابيب التحليل العلمي

  • المعالجة المتوازية - يتناسب مع نوى وحدة المعالجة المركزية (Chloros+)

المتطلبات

المتطلبات
التفاصيل

Chloros Desktop

يجب تثبيته محليًا

نظام التشغيل

Windows 10/11 (64 بت)

Python

Python 3.7 أو أعلى

الذاكرة

8 جيجابايت من ذاكرة الوصول العشوائي (RAM) كحد أدنى (يوصى بـ 16 جيجابايت)

الإنترنت

مطلوب لتفعيل الترخيص

circle-info

متطلبات الترخيص: يتطلب Python SDK اشتراكًا مدفوعًا في Chloros+ للوصول إلى API. لا تتوفر إمكانية الوصول إلى API/SDK في الخطط القياسية (المجانية). تفضل بزيارة https://cloud.mapir.camera/pricingarrow-up-right للترقية.

البدء السريع

التثبيت

التثبيت عبر pip:

circle-info

الإعداد الأولي: قبل استخدام SDK، قم بتنشيط ترخيص Chloros+ الخاص بك عن طريق فتح Chloros، Chloros (المتصفح) أو Chloros CLI وتسجيل الدخول باستخدام بيانات اعتمادك. لا يلزم القيام بذلك سوى مرة واحدة.

الاستخدام الأساسي

معالجة مجلد ببضع أسطر فقط:

التحكم الكامل

لسير العمل المتقدم:


دليل التثبيت

المتطلبات الأساسية

قبل تثبيت SDK، تأكد من أن لديك:

  1. Chloros Desktop مثبت (تنزيل)

  2. Python 3.7+ مثبت (python.orgarrow-up-right)

  3. ترخيص Chloros+ نشط (ترقيةarrow-up-right)

التثبيت عبر pip

التثبيت القياسي:

مع دعم مراقبة التقدم:

تثبيت التطوير:

التحقق من التثبيت

اختبر أن SDK مثبت بشكل صحيح:


الإعداد لأول مرة

تنشيط الترخيص

يستخدم SDK نفس الترخيص المستخدم في Chloros و Chloros (المتصفح) و Chloros CLI. قم بالتنشيط مرة واحدة عبر واجهة المستخدم الرسومية أو CLI:

  1. افتح Chloros أو Chloros (المتصفح)وقم بتسجيل الدخول في علامة التبويب المستخدم . أو افتحCLI.

  2. أدخل بيانات اعتماد Chloros+ وقم بتسجيل الدخول

  3. يتم تخزين الترخيص محليًا (يستمر عبر عمليات إعادة التشغيل)

circle-info

الإعداد لمرة واحدة: بعد تسجيل الدخول عبر واجهة المستخدم الرسومية أو CLI، يستخدم SDK الترخيص المخزن مؤقتًا تلقائيًا. لا حاجة إلى مصادقة إضافية!

circle-info

تسجيل الخروج: يمكن لمستخدمي SDK مسح بيانات الاعتماد المخزنة مؤقتًا برمجيًا باستخدام طريقة logout(). راجع طريقة logout() في مرجع API.

اختبار الاتصال

تحقق من أن SDK يمكنه الاتصال بـ Chloros:


مرجع API

فئة ChlorosLocal

الفئة الرئيسية لمعالجة الصور المحلية Chloros.

المنشئ

المعلمات:

المعلمة
النوع
الافتراضي
الوصف

api_url

str

"http://localhost:5000"

URL من الخلفية المحلية Chloros

auto_start_backend

bool

True

بدء تشغيل الخلفية تلقائيًا إذا لزم الأمر

backend_exe

str

None (الكشف التلقائي)

مسار الملف القابل للتنفيذ للخلفية

timeout

int

30

مهلة الطلب بالثواني

backend_startup_timeout

int

60

مهلة بدء تشغيل الخلفية (بالثواني)

أمثلة:


الطرق

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 بت)"

تنسيق الإخراج

ppk

bool

False

تمكين تصحيحات PPK

custom_settings

dict

None

إعدادات مخصصة متقدمة

تنسيقات التصدير:

  • "TIFF (16-bit)" - موصى به لنظم المعلومات الجغرافية/التصوير المساحي

  • "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

وظيفة رد الاتصال للتقدم (التقدم، الرسالة)

poll_interval

float

2.0

فاصل الاستقصاء للتقدم (بالثواني)

النتائج: dict - نتائج المعالجة

circle-info

الوضع المتوازي: يتطلب ترخيص Chloros+. يتكيف تلقائيًا مع نوى وحدة المعالجة المركزية (CPU) (حتى 16 عاملًا).

مثال:


get_config()

الحصول على تكوين المشروع الحالي.

النتائج: dict - تكوين المشروع الحاليمثال:


get_status()

الحصول على معلومات حالة الخلفية.

النتائج: dict - حالة الخلفيةمثال:


shutdown_backend()

إيقاف تشغيل الخلفية (إذا تم تشغيلها بواسطة SDK).

مثال:


logout()

مسح بيانات الاعتماد المخزنة مؤقتًا من النظام المحلي.

الوصف:

تسجيل الخروج برمجيًا عن طريق إزالة بيانات الاعتماد المخزنة مؤقتًا. هذا مفيد في:

  • التبديل بين حسابات Chloros+ المختلفة

  • مسح بيانات الاعتماد في البيئات الآلية

  • أغراض الأمان (على سبيل المثال، إزالة بيانات الاعتماد قبل إلغاء التثبيت)

النتائج: dict - نتيجة عملية تسجيل الخروجمثال:

circle-info

إعادة المصادقة مطلوبة: بعد استدعاء logout()، يجب عليك تسجيل الدخول مرة أخرى عبر Chloros، Chloros (المتصفح)، أو 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 بت)"

تنسيق الإخراج

mode

str

"parallel"

وضع المعالجة

progress_callback

callable

None

استدعاء التقدم

النتائج: dict - نتائج المعالجةمثال:


دعم مدير السياق

يدعم SDK مديري السياق للتنظيف التلقائي:


أمثلة كاملة

مثال 1: المعالجة الأساسية

معالجة مجلد بالإعدادات الافتراضية:


المثال 2: سير العمل المخصص

التحكم الكامل في خط أنابيب المعالجة:


المثال 3: المعالجة المجمعة لعدة مجلدات

معالجة عدة مجموعات بيانات رحلات:


المثال 4: تكامل خط أنابيب البحث

تكامل Chloros مع تحليل البيانات:


المثال 5: مراقبة التقدم المخصصة

تتبع التقدم المتقدم مع التسجيل:


المثال 6: معالجة الأخطاء

معالجة أخطاء قوية للاستخدام في الإنتاج:


المثال 7: إدارة الحساب وتسجيل الخروج

إدارة بيانات الاعتماد برمجيًا:


المثال 8: أداة سطر الأوامر

إنشاء أداة CLI مخصصة باستخدام SDK:

الاستخدام:


معالجة الاستثناءات

توفر SDK فئات استثناء محددة لأنواع مختلفة من الأخطاء:

تسلسل الاستثناءات

أمثلة على الاستثناءات


موضوعات متقدمة

تكوين الخلفية المخصصة

استخدم موقعًا أو تكوينًا مخصصًا للخلفية:

المعالجة غير المعيقة

ابدأ المعالجة واستمر في المهام الأخرى:

إدارة الذاكرة

بالنسبة لمجموعات البيانات الكبيرة، قم بالمعالجة على دفعات:


استكشاف الأخطاء وإصلاحها

الخلفية لا تبدأ

المشكلة: SDK يفشل في بدء تشغيل الخلفيةالحلول:

  1. تحقق من تثبيت Chloros Desktop:

  1. تحقق من أن جدار الحماية Windows لا يقوم بحظره

  2. جرب مسار الخلفية يدويًا:


لم يتم اكتشاف الترخيصالمشكلة: SDK يحذر من فقدان الترخيصالحلول:

  1. افتح Chloros أو Chloros (المتصفح) أو Chloros CLI وقم بتسجيل الدخول.

  2. تحقق من أن الترخيص مخزن في ذاكرة التخزين المؤقت:

  1. إذا واجهت مشكلات في بيانات الاعتماد، فامسح بيانات الاعتماد المخزنة في ذاكرة التخزين المؤقت وأعد تسجيل الدخول:

  1. اتصل بالدعم الفني: info@mapir.camera


أخطاء الاستيرادالمشكلة: ModuleNotFoundError: No module named 'chloros_sdk'الحلول:


انتهاء مهلة المعالجةالمشكلة: انتهاء مهلة المعالجةالحلول:

  1. زيادة مهلة الانتظار:

  1. معالجة دفعات أصغر

  2. التحقق من مساحة القرص المتاحة

  3. مراقبة موارد النظام


المنفذ قيد الاستخدام بالفعلالمشكلة: المنفذ الخلفي 5000 مشغولالحلول:

أو البحث عن العملية المتعارضة وإغلاقها:


نصائح حول الأداء

تحسين سرعة المعالجة

  1. استخدام الوضع المتوازي (يتطلب Chloros+)

  1. تقليل دقة الإخراج (إذا كان ذلك مقبولًا)

  1. تعطيل الفهارس غير الضرورية

  1. المعالجة على SSD (وليس HDD)***

تحسين الذاكرة

بالنسبة لمجموعات البيانات الكبيرة:


المعالجة في الخلفية

تحرير Python لمهام أخرى:


أمثلة على التكامل

تكامل Django

Flask API

Jupyter Notebook


الأسئلة الشائعة

س: هل يتطلب SDK اتصالاً بالإنترنت؟

ج: فقط لتفعيل الترخيص الأولي. بعد تسجيل الدخول عبر Chloros أو Chloros (المتصفح) أو Chloros CLI، يتم تخزين الترخيص محليًا في ذاكرة التخزين المؤقت ويعمل دون اتصال بالإنترنت لمدة 30 يومًا.***

س: هل يمكنني استخدام SDK على خادم بدون واجهة مستخدم رسومية؟ج: نعم! المتطلبات:

  • Windows Server 2016 أو أحدث

  • Chloros مثبت (مرة واحدة)

  • ترخيص مفعل على أي جهاز (ترخيص مخزن مؤقتًا منسوخ إلى الخادم)


س: ما الفرق بين Desktop و CLI و SDK؟

الميزة
واجهة المستخدم الرسومية لـ Desktop
سطر الأوامر لـ CLI
Python SDK

الواجهة

النقر

الأوامر

Python API

الأفضل لـ

العمل البصري

البرمجة النصية

التكامل

الأتمتة

محدودة

جيدة

ممتازة

المرونة

أساسية

جيدة

قصوى

الترخيص

Chloros+

Chloros+

Chloros+

س: هل يمكنني توزيع التطبيقات التي تم إنشاؤها باستخدام SDK؟ج: يمكن دمج كود SDK في تطبيقاتك، ولكن:

  • يحتاج المستخدمون النهائيون إلى تثبيت Chloros

  • يحتاج المستخدمون النهائيون إلى تراخيص Chloros+ نشطة

  • يتطلب التوزيع التجاري ترخيص OEM

اتصل بـ info@mapir.camera للاستفسارات المتعلقة بـ OEM.


س: كيف أقوم بتحديث SDK؟


س: أين يتم حفظ الصور المعالجة؟

بشكل افتراضي، في مسار المشروع:


س: هل يمكنني معالجة الصور من نصوص Python التي تعمل وفقًا للجدول الزمني؟ج: نعم! استخدم Windows Task Scheduler مع نصوص Python:

جدولة عبر جدولة المهام للتشغيل يوميًا.


س: هل يدعم SDK async/await؟ج: الإصدار الحالي متزامن. للحصول على سلوك غير متزامن، استخدم wait=False أو قم بالتشغيل في مؤشر ترابط منفصل:


س: كيف يمكنني التبديل بين حسابات Chloros+ المختلفة؟ج: استخدم طريقة logout() لمسح بيانات الاعتماد المخزنة مؤقتًا، ثم أعد تسجيل الدخول بالحساب الجديد:

بعد تسجيل الخروج، قم بالمصادقة باستخدام الحساب الجديد عبر واجهة المستخدم الرسومية أو المتصفح أو CLI قبل استخدام SDK مرة أخرى.


الحصول على المساعدة

الوثائق

  • مرجع API: هذه الصفحة

قنوات الدعم

نموذج الكود

جميع الأمثلة المدرجة هنا تم اختبارها وهي جاهزة للاستخدام. انسخها وقم بتكييفها حسب حالتك.


الترخيصبرنامج مملوك - حقوق النشر (c) 2025 MAPIR Inc.

يتطلب SDK اشتراكًا نشطًا في Chloros+. يُحظر الاستخدام أو التوزيع أو التعديل غير المصرح به.

Last updated