Python

説明

Python SDKは、主に次の3つのユーティリティライブラリを使用して呼び出しを容易にします。

  1. requests - HTTPリクエストを送信するために使用

  2. numpy - 行列データを便利に操作するために使用

  3. opencv-python - 画像データを保存するために使用

インターフェース定義

関数名 機能説明 パラメータと戻り値

get_sdk_version()

SDKバージョン番号を取得します

パラメータ: なし

戻り値:

version: str型、SDKバージョン番号

get_info(ip: str)

カメラの基本情報を取得します。シリアル番号、IPアドレス、モデルなどのデバイスパラメータを含みます。取得に失敗した場合はNoneを返します。

パラメータ:

ip: str型、カメラのIPアドレス

戻り値:

info: dict型、以下のフィールドを含みます:

* sn: str型、カメラのシリアル番号

* ip: str型、カメラのIPアドレス

* model: str型、カメラのモデル

* alias: str型、カメラ名

* width: int型、画像の幅

* height: int型、画像の高さ

get_header(ip: str, frame_id: str, timeout: int = 2000)

カメラ写真情報(幅、高さを含む)を取得します。取得に失敗した場合はNoneを返します。

パラメータ:

ip: str型、カメラのIPアドレス

frame_id: str型、カメラのフレームID

timeout: int型、タイムアウト時間(ミリ秒)、デフォルトは2000ms

戻り値:

header: dict型、カメラ写真情報(幅、高さを含む)

get_config(ip: str, frame_id: str = "")

カメラの現在または指定されたフレームの設定パラメータを取得します。取得に失敗した場合はNoneを返します。

パラメータ:

ip: str型、カメラのIPアドレス

frame_id: str型、データを取得するフレームID。空文字列の場合は最新の設定を返します。

戻り値:

config: dict型、カメラの設定パラメータ

set_config(ip: str, config: dict)

カメラ設定パラメータを更新します。成功した場合は現在の設定を返し、失敗した場合はNoneを返します。

パラメータ:

ip: str型、カメラのIPアドレス

config: dict型、設定パラメータ(get_configと同様に定義)

戻り値:

latest_config: dict型、更新後のカメラ設定(configと同様に定義)

trigger_frame(ip: str, pointcloud: bool = True)

フレームをトリガーして撮影します。フレームには2D画像と点群データが含まれる場合があります。フレームIDでインデックスを指定します。失敗した場合はNoneを返します。

パラメータ:

ip: str型、カメラのIPアドレス

pointcloud: bool型、点群データをリクエストするかどうか。Falseに設定すると、2D画像データのみを含むフレームがトリガーされます。

戻り値:

frame_id: str型、撮影トリガー後に返されるフレームID

get_image(ip: str, frame_id: str)

フレームIDに基づいて2D画像を取得します。失敗した場合はNoneを返します。

パラメータ:

ip: str型、カメラのIPアドレス

frame_id: str型、データを取得するフレームID(trigger_frameから取得可能)

戻り値:

image: numpy.ndarray型、取得された画像データ

get_point_cloud(ip: str, frame_id: str)

フレームIDに基づいて点群データを取得します。失敗した場合はNoneを返します。

パラメータ:

ip: str型、カメラのIPアドレス

frame_id: str型、データを取得するフレームID(trigger_frameから取得可能)

戻り値:

point_map: numpy.ndarray型、2D画像とピクセル単位で整合した点群データ

search_camera()

ネットワーク内の使用可能なカメラデバイスを検索します。見つからない場合や失敗した場合はNoneを返します。

パラメータ: なし

戻り値:

found_camera: list型、検索されたカメラ情報のリスト

Linuxでの実行

多くのDebian系LinuxシステムにはPython環境がプリインストールされています。

PythonサンプルプログラムのREADME.mdに記載されている手順を実行してください。

Windowsでの実行

Python on Windows for beginnersを参考にしてPython環境をセットアップしてください。

PythonサンプルプログラムのREADME.mdに記載されている手順を実行してください。