Transport Layerクラス

システムモジュール

PyStSystem

class stapipy.PyStSystem

システムモジュールクラス

create_first_device(self, access_flags=ETLDeviceAccessFlags.AccessControl) → PyStDevice

システムで最初に見つかったデバイスを作成し、デバイスモジュールを返します。

パラメータ

access_flags (ETLDeviceAccessFlags) -- デバイスアクセスフラグを指定します。

戻り値

デバイスモジュール

戻り値の型

PyStDevice

deregister_callback(self, PyStRegisteredCallback registered_cb, check_all=False)

コールバック登録を解除します。

パラメータ

• registered_cb (PyStRegisteredCallback) -- 登録されているコールバック

• check_all (bool) -- このPyStSystemのコピーモジュールを含む、全てのモジュールにregistered_cbが登録されていれば、その登録を解除するフラグ

deregister_callbacks(self, check_all=False)

全てのコールバック登録を解除します。

パラメータ

check_all (bool) -- このPyStSystemのコピーモジュールを含む、全てのモジュールに登録されているコールバックの登録を解除するフラグ

get_interface(self, size_t index) → PyStInterface

指定されたインターフェイスモジュールを取得します。

パラメータ

index (int) -- インターフェイスのインデックス値。0 から interface_count 未満の値を指定します。

戻り値

インターフェイスモジュール

戻り値の型

PyStInterface

get_registered_callbacks(self, check_all=False) → list

登録されたコールバックのリストを取得します。

パラメータ

check_all (bool) -- このPyStSystemのコピーモジュールも含む、登録されているコールバックを取得するフラグ

戻り値

PyStRegisteredCallbackオブジェクトのリストまたはNone

戻り値の型

list of PyStRegisteredCallback

info

PyStSystem.info: PyStSystemInfo

プロパティー：モジュール情報

Getter

戻り値を返します。

戻り値の型

PyStSystemInfo

interface_count

PyStSystem.interface_count: int

プロパティー：システムで利用可能なインターフェイスの数。最新状態のインターフェイス数を取得するには、update_interface_list()を呼び出す必要があります。

Getter

戻り値を返します。

戻り値の型

int

port

PyStSystem.port: PyStPort

プロパティー：モジュールポート

Getter

ポートが返されます。

戻り値の型

PyStPort

register_callback(self, callback_func, user_data=None) → PyStRegisteredCallback

このPyStSystemにコールバック関数を登録します。

パラメータ

• callback_func -- トリガーされる関数

• user_data -- ユーザデータ（オプショナル）

戻り値

登録されたコールバックのオブジェクト

戻り値の型

PyStRegisteredCallback

release(self)

このPyStSystemのリソースを解放します。コールバック登録も解除します。

start_event_acquisition(self)

イベント取得スレッドを開始します。コールバックを登録したら、この関数を呼び出す必要があります。イベント取得スレッドを停止する場合はstop_event_acquisition()を呼び出します。

stop_event_acquisition(self)

イベント取得スレッドを停止します。イベント取得スレッド開始後、イベント取得スレッドを停止するためにこの関数を呼び出します。

update_interface_list(self) → bool

このシステムで利用可能なインターフェイスを検出し、インターフェイスリストを更新します。

戻り値

インターフェイスリストが更新された場合、True が返されます。

戻り値の型

bool

vendor

PyStSystem.vendor: EStSystemVendor

プロパティー：システムベンダー

Getter

戻り値を返します。

戻り値の型

EStSystemVendor

PyStSystemInfo

class stapipy.PyStSystemInfo

システムモジュール情報クラス

char_encoding

PyStSystemInfo.char_encoding: ETLCharEncoding

プロパティー：GenTL TL_INFO_CHAR_ENCODING情報

Getter

戻り値を返します。

戻り値の型

ETLCharEncoding

display_name

PyStSystemInfo.display_name: str

プロパティー：GenTL TL_INFO_DISPLAYNAME情報

Getter

戻り値を返します。

戻り値の型

str

gentl_version_major

PyStSystemInfo.gentl_version_major: int

プロパティー：GenTL TL_INFO_GENTL_VER_MAJOR情報

Getter

戻り値を返します。

戻り値の型

int

gentl_version_minor

PyStSystemInfo.gentl_version_minor: int

プロパティー：GenTL TL_INFO_GENTL_VER_MINOR情報

Getter

戻り値を返します。

戻り値の型

int

model

PyStSystemInfo.model: str

プロパティー：GenTL TL_INFO_MODEL情報

Getter

戻り値を返します。

戻り値の型

str

name

PyStSystemInfo.name: str

プロパティー：GenTL TL_INFO_NAME情報

Getter

戻り値を返します。

戻り値の型

str

path_name

PyStSystemInfo.path_name: str

プロパティー：GenTL TL_INFO_PATHNAME情報

Getter

戻り値を返します。

戻り値の型

str

tl_id

PyStSystemInfo.tl_id: str

プロパティー：GenTL TL_INFO_ID情報

Getter

戻り値を返します。

戻り値の型

str

tl_type

PyStSystemInfo.tl_type: str

プロパティー：GenTL TL_INFO_TLTYPE情報

Getter

戻り値を返します。

戻り値の型

str

vendor

PyStSystemInfo.vendor: str

プロパティー：GenTL TL_INFO_VENDOR情報

Getter

戻り値を返します。

戻り値の型

str

version

PyStSystemInfo.version: str

プロパティー：GenTL TL_INFO_VERSION情報

Getter

戻り値を返します。

戻り値の型

str

PyStSystemList

class stapipy.PyStSystemList

システムモジュールリストクラス

create_first_device(self, access_flags=ETLDeviceAccessFlags.AccessControl) → PyStDevice

システムで最初に見つかったデバイスを作成し、デバイスモジュールを返します。

パラメータ

access_flags (ETLDeviceAccessFlags) -- デバイスアクセスフラグを指定します。

戻り値

デバイスモジュール

戻り値の型

PyStDevice

deregister(self, int index) → PyStSystem

リスト内の要素の登録を解除します。

パラメータ

index -- 登録を解除する要素のリスト位置を指定します。

戻り値

登録を解除する要素

戻り値の型

PyStSystem

register(self, PyStSystem item)

リストに要素を登録します。

パラメータ

item -- 登録する要素

戻り値

リスト内の要素数

戻り値の型

int

release(self)

PyStSystemListのリソースを解放します。登録されている個々のPyStSystemリソースも解放します。

インターフェイスモジュール

PyStInterface

class stapipy.PyStInterface

インターフェイスモジュールクラス

create_device_by_id(self, unicode device_id, access_flags=ETLDeviceAccessFlags.AccessControl) → PyStDevice

指定したデバイス(カメラ)をオープンし、デバイスモジュールを返します。

パラメータ

• device_id (str) -- デバイスIDを指定します。

• access_flags (ETLDeviceAccessFlags) -- デバイスアクセスフラグを指定します。

戻り値

デバイスモジュール

戻り値の型

PyStDevice

create_device_by_index(self, size_t index, access_flags=ETLDeviceAccessFlags.AccessControl) → PyStDevice

指定したデバイス(カメラ)をオープンし、デバイスモジュールを返します。

パラメータ

• index (int) -- オープンするデバイスのインデックス値。0 から device_count 未満の値を指定します。

• access_flags (ETLDeviceAccessFlags) -- デバイスアクセスフラグを指定します。

戻り値

デバイスモジュール

戻り値の型

PyStDevice

create_first_device(self, access_flags=ETLDeviceAccessFlags.AccessControl) → PyStDevice

システムで最初に見つかったデバイスを作成し、デバイスモジュールを返します。

パラメータ

access_flags (ETLDeviceAccessFlags) -- デバイスアクセスフラグを指定します。

戻り値

デバイスモジュール

戻り値の型

PyStDevice

deregister_callback(self, PyStRegisteredCallback registered_cb, check_all=False)

コールバック登録を解除します。

パラメータ

• registered_cb (PyStRegisteredCallback) -- 登録されているコールバック

• check_all (bool) -- このPyStInterfaceのコピーモジュールを含む、全てのモジュールにregistered_cbが登録されていれば、その登録を解除するフラグ

deregister_callbacks(self, check_all=False)

全てのコールバック登録を解除します。

パラメータ

check_all (bool) -- このPyStInterfaceのコピーモジュールを含む、全てのモジュールに登録されているコールバックの登録を解除するフラグ

device_count

PyStInterface.device_count: int

プロパティー：認識されているデバイスの数。最新状態のデバイス数を取得するには、update_device_list()を呼び出す必要があります。

Getter

戻り値を返します。

戻り値の型

int

get_device_info(self, size_t index) → PyStDeviceInfo

指定したインデックスのデバイス情報を取得します。

パラメータ

index (int) -- オープンするデバイスのインデックス値。0 から device_count 未満の値を指定します。

戻り値

デバイス情報

戻り値の型

PyStDeviceInfo

get_registered_callbacks(self, check_all=False) → list

登録されたコールバックのリストを取得します。

パラメータ

check_all (bool) -- このPyStInterfaceのコピーモジュールも含む、登録されたコールバックを取得するフラグ

戻り値

PyStRegisteredCallbackオブジェクトのリストまたはNone

戻り値の型

list of PyStRegisteredCallback

info

PyStInterface.info: PyStInterfaceInfo

プロパティー：モジュール情報

Getter

戻り値を返します。

戻り値の型

PyStInterfaceInfo

interface_type

PyStInterface.interface_type: EStInterfaceType

プロパティー：インターフェイスタイプ

Getter

戻り値を返します。

戻り値の型

EStInterfaceType

is_device_available(self, size_t index, flag) → bool

指定したデバイス(カメラ)が利用可能かどうか確認します。

パラメータ

• index (int) -- オープンするデバイスのインデックス値。0 から device_count 未満の値を指定します。

• flag (ETLDeviceAccessFlags) -- デバイスアクセスフラグ

戻り値

デバイス(カメラ)が利用可能な場合Trueが返されます。

戻り値の型

bool

port

PyStInterface.port: PyStPort

プロパティー：モジュールポート

Getter

ポートが返されます。

戻り値の型

PyStPort

register_callback(self, callback_func, user_data=None) → PyStRegisteredCallback

このPyStInterfaceにコールバック関数を登録します。

パラメータ

• callback_func -- トリガーされる関数

• user_data -- ユーザデータ（オプショナル）

戻り値

登録されたコールバックのオブジェクト

戻り値の型

PyStRegisteredCallback

start_event_acquisition(self)

イベント取得スレッドを開始します。コールバックを登録したら、この関数を呼び出す必要があります。イベント取得スレッドを停止する場合はstop_event_acquisition()を呼び出します。

stop_event_acquisition(self)

イベント取得スレッドを停止します。イベント取得スレッド開始後、イベント取得スレッドを停止するためにこの関数を呼び出します。

update_device_list(self) → bool

接続されているデバイス(カメラ)を検出し、デバイス(カメラ)リストを更新します。

戻り値

デバイス(カメラ)リストが更新された場合、True が返されます。

戻り値の型

bool

update_device_list_timeout

PyStInterface.update_device_list_timeout: int

プロパティー：デバイス(カメラ)リスト更新時のタイムアウト時間[ms]

Getter

戻り値を返します。

Setter

値を設定します。

戻り値の型

int

PyStInterfaceInfo

class stapipy.PyStInterfaceInfo

インターフェイス情報クラス

display_name

PyStInterfaceInfo.display_name: str

プロパティー：GenTL INTERFACE_INFO_DISPLAYNAME情報

Getter

戻り値を返します。

戻り値の型

str

interface_id

PyStInterfaceInfo.interface_id: str

プロパティー：GenTL INTERFACE_INFO_ID情報

Getter

戻り値を返します。

戻り値の型

str

tl_type

PyStInterfaceInfo.tl_type: str

プロパティー：GenTL INTERFACE_INFO_TLTYPE情報

Getter

戻り値を返します。

戻り値の型

str

デバイスモジュール

PyStDevice

class stapipy.PyStDevice

デバイスモジュールクラス

acquisition_start(self)

カメラのAcquisitionStartコマンドを実行し、カメラからのデータ出力を開始します。

acquisition_stop(self)

カメラのAcquisitionStopコマンドを実行し、カメラからのデータ出力を停止します。

create_datastream(self, size_t index=0) → PyStDataStream

データストリームをオープンし、データストリームモジュールを返します。

パラメータ

index (int) -- オープンするデータストリーム。0 から datastream_count 数未満の値を指定します。

戻り値

データストリームモジュール

戻り値の型

PyStDataStream

datastream_count

PyStDevice.datastream_count: int

プロパティー：データストリームの数

Getter

戻り値を返します。

戻り値の型

int

deregister_callback(self, PyStRegisteredCallback registered_cb, check_all=False)

コールバック登録を解除します。

パラメータ

• registered_cb (PyStRegisteredCallback) -- 登録されているコールバック

• check_all (bool) -- このPyStDeviceのコピーモジュールを含む、全てのモジュールにregistered_cbが登録されていれば、その登録を解除するフラグ

deregister_callbacks(self, check_all=False)

全てのコールバック登録を解除します。

パラメータ

check_all (bool) -- このPyStDeviceのコピーモジュールも含む、全のこのモジュールコールバック登録を解除するフラグ

get_registered_callbacks(self, check_all=False) → list

登録されたコールバックのリストを取得します。

パラメータ

check_all (bool) -- このPyStDeviceのコピーモジュールを含む、登録されたコールバックを取得するフラグ

戻り値

PyStRegisteredCallbackオブジェクトのリストまたはNone

戻り値の型

list of PyStRegisteredCallback

info

PyStDevice.info: PyStDeviceInfo

プロパティー：モジュール情報

Getter

戻り値を返します。

戻り値の型

PyStDeviceInfo

interface

PyStDevice.interface: PyStInterface

プロパティー：デバイスのインターフェイスモジュール

Getter

インターフェイスモジュールを返します。

戻り値の型

PyStInterface

is_device_lost

PyStDevice.is_device_lost: bool

プロパティー：デバイス(カメラ)との接続が切断されたかどうかを示すフラグ

Getter

デバイスが切断されたらTrueを返します。

戻り値の型

bool

local_port

PyStDevice.local_port: PyStPort

プロパティー：ローカルポート

Getter

戻り値を返します。

戻り値の型

PyStPort

register_callback(self, callback_func, user_data=None) → PyStRegisteredCallback

このPyStDeviceにコールバック関数を登録します。

パラメータ

• callback_func -- トリガーされる関数

• user_data -- ユーザデータ（オプショナル）

戻り値

登録されたコールバックのオブジェクト

戻り値の型

PyStRegisteredCallback

release(self)

PyStDeviceのリソースを解放します。コールバック登録も解除します。

remote_port

PyStDevice.remote_port: PyStPort

プロパティー：リモートポート

Getter

戻り値を返します。

戻り値の型

PyStPort

start_event_acquisition(self)

イベント取得スレッドを開始します。コールバックを登録したら、この関数を呼び出す必要があります。イベント取得スレッドを停止する場合はstop_event_acquisition()を呼び出します。

stop_event_acquisition(self)

イベント取得スレッドを停止します。イベント取得スレッド開始後、イベント取得スレッドを停止するためにこの関数を呼び出します。

PyStDeviceInfo

class stapipy.PyStDeviceInfo

デバイス情報クラス

access_status

PyStDeviceInfo.access_status: ETLDeviceAccessStatus

プロパティー：GenTL DEVICE_INFO_ACCESS_STATUS情報

Getter

戻り値を返します。

戻り値の型

ETLDeviceAccessStatus

device_id

PyStDeviceInfo.device_id: str

プロパティー：GenTL DEVICE_INFO_ID情報

Getter

戻り値を返します。

戻り値の型

str

display_name

PyStDeviceInfo.display_name: str

プロパティー：GenTL DEVICE_INFO_DISPLAYNAME情報

Getter

戻り値を返します。

戻り値の型

str

model

PyStDeviceInfo.model: str

プロパティー：GenTL DEVICE_INFO_MODEL情報

Getter

戻り値を返します。

戻り値の型

str

serial_number

PyStDeviceInfo.serial_number: str

プロパティー：GenTL DEVICE_INFO_SERIAL_NUMBER情報

Getter

戻り値を返します。

戻り値の型

str

timestamp_frequency

PyStDeviceInfo.timestamp_frequency: int

プロパティー：GenTL DEVICE_INFO_TIMESTAMP_FREQUENCY情報

Getter

戻り値を返します。

戻り値の型

int

tl_type

PyStDeviceInfo.tl_type: str

プロパティー：GenTL DEVICE_INFO_TLTYPE情報

Getter

戻り値を返します。

戻り値の型

str

user_defined_name

PyStDeviceInfo.user_defined_name: str

プロパティー：GenTL DEVICE_INFO_USER_DEFINED_NAME 情報

Getter

戻り値を返します。

戻り値の型

str

vendor

PyStDeviceInfo.vendor: str

プロパティー：GenTL DEVICE_INFO_VENDOR情報

Getter

戻り値を返します。

戻り値の型

str

version

PyStDeviceInfo.version: str

プロパティー：GenTL DEVICE_INFO_VERSION情報

Getter

戻り値を返します。

戻り値の型

str

PyStDeviceList

class stapipy.PyStDeviceList

デバイスモジュールリストクラス

acquisition_start(self)

カメラのAcquisitionStartコマンドを実行し、カメラからのデータ出力を開始します。

acquisition_stop(self)

カメラのAcquisitionStopコマンドを実行し、カメラからのデータ出力を停止します。

deregister(self, int index) → PyStDevice

リスト内の要素の登録を解除します。

パラメータ

index -- 登録を解除する要素のリスト位置を指定します。

戻り値

登録を解除する要素

戻り値の型

PyStDevice

register(self, PyStDevice item)

リストに要素を登録します。

パラメータ

item -- 登録する要素

戻り値

リスト内の要素数

戻り値の型

int

release(self)

PyStDeviceListのリソースを解放します。登録されている個々のPyStDeviceリソースも解放します。

データストリームモジュール

PyStDataStream

class stapipy.PyStDataStream

データストリームモジュールクラス

buffer_count

PyStDataStream.buffer_count: int

プロパティー：ストリーミング時に作成されるバッファの数

Getter

現在の値が返されます。

Setter

値を設定します。

戻り値の型

int

current_bps

PyStDataStream.current_bps: float

プロパティー：現在のデータレート[bytes/s]

Getter

戻り値を返します。

戻り値の型

float

current_fps

PyStDataStream.current_fps: float

プロパティー：現在のフレーム(ブロック)レート[fps]

Getter

戻り値を返します。

戻り値の型

float

deregister_callback(self, PyStRegisteredCallback registered_cb, check_all=False)

コールバック登録を解除します。

パラメータ

• registered_cb (PyStRegisteredCallback) -- 登録されているコールバック

• check_all (bool) -- このPyStDataStreamのコピーモジュールを含む、全てのモジュールにregistered_cbが登録されていれば、その登録を解除するフラグ

deregister_callbacks(self, check_all=False)

全てのコールバック登録を解除します。

パラメータ

check_all (bool) -- このPyStDataStreamのコピーモジュールを含む、全てのモジュールに登録されているコールバックの登録を解除するフラグ

device

PyStDataStream.device: PyStDevice

プロパティー：このデータストリームのデバイスモジュール

Getter

戻り値を返します。

戻り値の型

PyStDevice

get_registered_callbacks(self, check_all=False) → list

登録されたコールバックのリストを取得します。

パラメータ

check_all (bool) -- このPyStDataStreamのコピーモジュールも含む、登録されたコールバックを取得するフラグ

戻り値

PyStRegisteredCallbackオブジェクトのリストまたはNone

戻り値の型

list of PyStRegisteredCallback

info

PyStDataStream.info: PyStDataStreamInfo

プロパティー：モジュール情報

Getter

戻り値を返します。

戻り値の型

PyStDataStreamInfo

is_grabbing

PyStDataStream.is_grabbing: bool

プロパティー：デバイス(カメラ)からデータを取得中か否かを示すフラグ

Getter

戻り値を返します。

戻り値の型

bool

port

PyStDataStream.port: PyStPort

プロパティー：モジュールポート

Getter

ポートが返されます。

戻り値の型

PyStPort

register_callback(self, callback_func, user_data=None) → PyStRegisteredCallback

このPyStDataStreamにコールバック関数を登録します。

パラメータ

• callback_func -- トリガーされる関数

• user_data -- ユーザデータ（オプショナル）

戻り値

登録されたコールバックのオブジェクト

戻り値の型

PyStRegisteredCallback

release(self)

PyStDataStreamのリソースを解放します。コールバック登録も解除します。

retrieve_buffer(self, uint32_t timeout=5000, handling_timeout=EStTimeoutHandling.ThrowException) → PyStStreamBuffer

転送が完了したバッファを取得します。

パラメータ

• timeout (int) -- 転送の完了を待機する時間[ms]を指定します。

• handling_timeout (EStTimeoutHandling) -- タイムアウトが発生した際の動作を指定します。

戻り値

ストリームバッファモジュール。タイムアウトの場合はNoneを返します。

戻り値の型

PyStStreamBuffer or None

start_acquisition(self, uint64_t num_to_acquire=-1, start_flags=ETLAcqStartFlags.Default)

ホスト側のデータ取得を開始します。

パラメータ

• num_to_acquire (int) -- 取得するバッファの数を指定します。 指定した数のバッファを取得した場合も別途 stop_acquisition() の呼び出しが必要になります。無限の場合は-1を指定します。

• start_flags (ETLAcqStartFlags) -- 取り込み開始フラグ

start_event_acquisition(self)

イベント取得スレッドを開始します。コールバックを登録したら、この関数を呼び出す必要があります。イベント取得スレッドを停止する場合はstop_event_acquisition()を呼び出します。

stop_acquisition(self, stop_flags=ETLAcqStopFlags.Default)

ホスト側のデータ取得を停止します。

パラメータ

stop_flags (ETLAcqStopFlags) -- 取り込み停止フラグ

stop_event_acquisition(self)

イベント取得スレッドを停止します。イベント取得スレッド開始後、イベント取得スレッドを停止するためにこの関数を呼び出します。

PyStDataStreamInfo

class stapipy.PyStDataStreamInfo

データストリーム情報クラス

buf_alignment

PyStDataStreamInfo.buf_alignment: int

プロパティー：GenTL STREAM_INFO_BUF_ALIGNMENT情報

Getter

戻り値を返します。

戻り値の型

int

buf_announce_min

PyStDataStreamInfo.buf_announce_min: int

プロパティー：GenTL STREAM_INFO_BUF_ANNOUNCE_MIN情報

Getter

戻り値を返します。

戻り値の型

int

datastream_id

PyStDataStreamInfo.datastream_id: str

プロパティー：GenTL STREAM_INFO_ID情報

Getter

戻り値を返します。

戻り値の型

str

is_grabbing

PyStDataStreamInfo.is_grabbing: bool

プロパティー：GenTL STREAM_INFO_IS_GRABBING情報

Getter

戻り値を返します。

戻り値の型

bool

is_payloadsize_defined

PyStDataStreamInfo.is_payloadsize_defined: bool

プロパティー：GenTL STREAM_INFO_DEFINES_PAYLOADSIZE情報

Getter

戻り値を返します。

戻り値の型

bool

num_announced

PyStDataStreamInfo.num_announced: int

プロパティー：GenTL STREAM_INFO_NUM_ANNOUNCED情報

Getter

戻り値を返します。

戻り値の型

int

num_await_delivery

PyStDataStreamInfo.num_await_delivery: int

プロパティー：GenTL STREAM_INFO_NUM_AWAIT_DELIVERY情報

Getter

戻り値を返します。

戻り値の型

int

num_chunks_max

PyStDataStreamInfo.num_chunks_max: int

プロパティー：GenTL STREAM_INFO_NUM_CHUNKS_MAX情報

Getter

戻り値を返します。

戻り値の型

int

num_delivered

PyStDataStreamInfo.num_delivered: int

プロパティー：GenTL STREAM_INFO_NUM_DELIVERED情報

Getter

戻り値を返します。

戻り値の型

int

num_queued

PyStDataStreamInfo.num_queued: int

プロパティー：GenTL STREAM_INFO_NUM_QUEUED情報

Getter

戻り値を返します。

戻り値の型

int

num_started

PyStDataStreamInfo.num_started: int

プロパティー：GenTL STREAM_INFO_NUM_STARTED情報

Getter

戻り値を返します。

戻り値の型

int

num_underrun

PyStDataStreamInfo.num_underrun: int

プロパティー：GenTL STREAM_INFO_NUM_UNDERRUN情報

Getter

戻り値を返します。

戻り値の型

int

payload_size

PyStDataStreamInfo.payload_size: int

プロパティー：GenTL STREAM_INFO_PAYLOAD_SIZE情報

Getter

戻り値を返します。

戻り値の型

int

tl_type

PyStDataStreamInfo.tl_type: str

プロパティー：GenTL STREAM_INFO_TLTYPE 情報

Getter

戻り値を返します。

戻り値の型

str

PyStDataStreamList

class stapipy.PyStDataStreamList

データストリームモジュールリストクラス

deregister(self, int index) → PyStDataStream

リスト内の要素の登録を解除します。

パラメータ

index -- 登録を解除する要素のリスト位置を指定します。

戻り値

登録を解除する要素

戻り値の型

PyStDataStream

is_grabbing_all

PyStDataStreamList.is_grabbing_all: bool

プロパティー：すべてのデータストリームからデータを取得中か否かを示すフラグ

Getter

戻り値を返します。

戻り値の型

bool

is_grabbing_any

PyStDataStreamList.is_grabbing_any: bool

プロパティー：いずれかのデータストリームからデータを取得中か否かを示すフラグ

Getter

戻り値を返します。

戻り値の型

bool

register(self, PyStDataStream item)

リストに要素を登録します。

パラメータ

item -- 登録する要素

戻り値

リスト内の要素数

戻り値の型

int

release(self)

PyStDataStreamListのリソースを解放します。登録されている個々のPyStDataStreamリソースも解放します。

retrieve_buffer(self, uint32_t timeout=5000, handling_timeout=EStTimeoutHandling.ThrowException) → PyStStreamBuffer

転送が完了したバッファを取得します。

パラメータ

• timeout (int) -- 転送の完了を待機する時間[ms]を指定します。

• handling_timeout (EStTimeoutHandling) -- タイムアウトが発生した際の動作を指定します。

戻り値

ストリームバッファモジュール。タイムアウトの場合はNoneを返します。

戻り値の型

PyStStreamBuffer or None

start_acquisition(self, uint64_t num_to_acquire=-1, start_flags=ETLAcqStartFlags.Default)

ホスト側のデータ取得を開始します。

パラメータ

• num_to_acquire (int) -- 取得するバッファの数を指定します。 指定した数のバッファを取得した場合も別途 stop_acquisition() の呼び出しが必要になります。無限の場合は-1を指定します。

• start_flags (ETLAcqStartFlags) -- 取り込み開始フラグ

stop_acquisition(self, stop_flags=ETLAcqStopFlags.Default)

ホスト側のデータ取得を停止します。

パラメータ

stop_flags (ETLAcqStopFlags) -- 取り込み停止フラグ

ストリームバッファモジュール

PyStStreamBuffer

class stapipy.PyStStreamBuffer

ストリームバッファモジュールクラス

datastream

PyStStreamBuffer.datastream: PyStDataStream

プロパティー：このストリームバッファのデータストリームモジュール

Getter

戻り値を返します。

戻り値の型

PyStDataStream

deregister_callback(self, PyStRegisteredCallback registered_cb, check_all=False)

コールバック登録を解除します。

パラメータ

• registered_cb (PyStRegisteredCallback) -- 登録されているコールバック

• check_all (bool) -- このPyStStreamBufferのコピーモジュールを含む、全てのモジュールにregistered_cbが登録されていれば、その登録を解除するフラグ

deregister_callbacks(self, check_all=False)

全てのコールバック登録を解除します。

パラメータ

check_all (bool) -- このPyStStreamBufferのコピーモジュールを含む、全てのモジュールに登録されているコールバックの登録を解除するフラグ

get_chunk_nodemap(self) → PyNodeMap

バッファにチャンクがある場合、チャンクノードマップを取得します。チャンクがなければ例外が発生します。

戻り値

チャンクデータ用のノードマップ

戻り値の型

PyNodeMap

get_image(self) → PyStImage

画像オブジェクトを取得します。

戻り値

画像オブジェクト

戻り値の型

PyStImage

get_registered_callbacks(self, check_all=False) → list

登録されたコールバックのリストを取得します。

パラメータ

check_all (bool) -- このPyStStreamBufferのコピーモジュールも含む、登録されたコールバックを取得するフラグ

戻り値

PyStRegisteredCallbackオブジェクトのリストまたはNone

戻り値の型

list of PyStRegisteredCallback

info

PyStStreamBuffer.info: PyStStreamBufferInfo

プロパティー：モジュール情報

Getter

戻り値を返します。

戻り値の型

PyStStreamBufferInfo

port

PyStStreamBuffer.port: PyStPort

プロパティー：モジュールポート

Getter

ポートが返されます。

戻り値の型

PyStPort

register_callback(self, callback_func, user_data=None) → PyStRegisteredCallback

このPyStStreamBufferにコールバック関数を登録します。

パラメータ

• callback_func -- トリガーされる関数

• user_data -- ユーザデータ（オプショナル）

戻り値

登録されたコールバックのオブジェクト

戻り値の型

PyStRegisteredCallback

release(self)

ストリームバッファのリソースを解放します。コールバック登録も解除します。

start_event_acquisition(self)

イベント取得スレッドを開始します。コールバックを登録したら、この関数を呼び出す必要があります。イベント取得スレッドを停止する場合はstop_event_acquisition()を呼び出します。

stop_event_acquisition(self)

イベント取得スレッドを停止します。イベント取得スレッド開始後、イベント取得スレッドを停止するためにこの関数を呼び出します。

PyStStreamBufferInfo

class stapipy.PyStStreamBufferInfo

ストリームバッファ情報クラス

buffer_size

PyStStreamBufferInfo.buffer_size: int

プロパティー：GenTL BUFFER_INFO_SIZE情報

Getter

戻り値を返します。

戻り値の型

int

chunk_layout_id

PyStStreamBufferInfo.chunk_layout_id: int

プロパティー：GenTL BUFFER_INFO_CHUNKLAYOUTID情報

Getter

戻り値を返します。

戻り値の型

int

data_size

PyStStreamBufferInfo.data_size: int

プロパティー：GenTL BUFFER_INFO_DATA_SIZE情報

Getter

戻り値を返します。

戻り値の型

int

delivered_chunk_payload_size

PyStStreamBufferInfo.delivered_chunk_payload_size: int

プロパティー：GenTL BUFFER_INFO_DELIVERED_CHUNKPAYLOADSIZE情報

Getter

戻り値を返します。

戻り値の型

int

delivered_image_height

PyStStreamBufferInfo.delivered_image_height: int

プロパティー：GenTL BUFFER_INFO_DELIVERED_IMAGEHEIGHT情報

Getter

戻り値を返します。

戻り値の型

int

filename

PyStStreamBufferInfo.filename: str

プロパティー：GenTL BUFFER_INFO_FILENAME情報

Getter

戻り値を返します。

戻り値の型

str

frame_id

PyStStreamBufferInfo.frame_id: int

プロパティー：GenTL BUFFER_INFO_FRAMEID情報

Getter

戻り値を返します。

戻り値の型

int

has_chunk_data

PyStStreamBufferInfo.has_chunk_data: bool

プロパティー：GenTL BUFFER_INFO_CONTAINS_CHUNKDATA情報

Getter

戻り値を返します。

戻り値の型

bool

height

PyStStreamBufferInfo.height: int

プロパティー：GenTL BUFFER_INFO_HEIGHT情報

Getter

戻り値を返します。

戻り値の型

int

image_offset

PyStStreamBufferInfo.image_offset: int

プロパティー：GenTL BUFFER_INFO_IMAGEOFFSET情報

Getter

戻り値を返します。

戻り値の型

int.

is_acquiring

PyStStreamBufferInfo.is_acquiring: bool

プロパティー：GenTL BUFFER_INFO_IS_ACQUIRING情報

Getter

戻り値を返します。

戻り値の型

bool

is_data_larger_than_buffer

PyStStreamBufferInfo.is_data_larger_than_buffer: bool

プロパティー：GenTL BUFFER_INFO_DATA_LARGER_THAN_BUFFER情報

Getter

戻り値を返します。

戻り値の型

bool

is_image_present

PyStStreamBufferInfo.is_image_present: bool

プロパティー：GenTL BUFFER_INFO_IMAGEPRESENT情報。パケットロストなどが発生し不完全な状態でも、画像のサイズやフォーマット情報が揃っている場合はTrueが返されます。 完全な状態の画像のみを使用したい場合は、is_incomplete と併用してください。

Getter

戻り値を返します。

戻り値の型

bool.

is_incomplete

PyStStreamBufferInfo.is_incomplete: bool

プロパティー：GenTL BUFFER_INFO_IS_INCOMPLETE情報

Getter

戻り値を返します。

戻り値の型

bool

is_new_data

PyStStreamBufferInfo.is_new_data: bool

プロパティー：GenTL BUFFER_INFO_NEW_DATA情報

Getter

戻り値を返します。

戻り値の型

bool

is_queued

PyStStreamBufferInfo.is_queued: bool

プロパティー：GenTL BUFFER_INFO_IS_QUEUED情報

Getter

戻り値を返します。

戻り値の型

bool

offset_x

PyStStreamBufferInfo.offset_x: int

プロパティー：GenTL BUFFER_INFO_XOFFSET情報

Getter

戻り値を返します。

戻り値の型

int

offset_y

PyStStreamBufferInfo.offset_y: int

プロパティー：GenTL BUFFER_INFO_YOFFSET情報

Getter

戻り値を返します。

戻り値の型

int

padding_x

PyStStreamBufferInfo.padding_x: int

プロパティー：GenTL BUFFER_INFO_XPADDING情報

Getter

戻り値を返します。

戻り値の型

int

padding_y

PyStStreamBufferInfo.padding_y: int

プロパティー：GenTL BUFFER_INFO_YPADDING情報

Getter

戻り値を返します。

戻り値の型

int

payload_type

PyStStreamBufferInfo.payload_type: ETLPayloadTypeInfoID

プロパティー：GenTL BUFFER_INFO_PAYLOADTYPE情報

Getter

戻り値を返します。

戻り値の型

ETLPayloadTypeInfoID

pixel_endianness

PyStStreamBufferInfo.pixel_endianness: ETLPixelEndiannessID

プロパティー：GenTL BUFFER_INFO_PIXEL_ENDIANESS情報

Getter

戻り値を返します。

戻り値の型

ETLPixelEndiannessID

pixel_format

PyStStreamBufferInfo.pixel_format: EStPixelFormatNamingConvention

プロパティー：GenTL BUFFER_INFO_PIXELFORMAT情報

Getter

戻り値を返します。

戻り値の型

EStPixelFormatNamingConvention

pixel_format_namespace

PyStStreamBufferInfo.pixel_format_namespace: ETLPixelFormatNamespaceID

プロパティー：GenTL BUFFER_INFO_PIXELFORMAT_NAMESPACE情報

Getter

戻り値を返します。

戻り値の型

ETLPixelFormatNamespaceID

size_filled

PyStStreamBufferInfo.size_filled: int

プロパティー：GenTL BUFFER_INFO_SIZE_FILLED情報

Getter

戻り値を返します。

戻り値の型

int

timestamp

PyStStreamBufferInfo.timestamp: int

プロパティー：GenTL BUFFER_INFO_TIMESTAMP情報

Getter

戻り値を返します。

戻り値の型

int

timestamp_ns

PyStStreamBufferInfo.timestamp_ns: int

プロパティー：GenTL BUFFER_INFO_TIMESTAMP_NS情報

Getter

戻り値を返します。

戻り値の型

int

tl_type

PyStStreamBufferInfo.tl_type: str

プロパティー：GenTL BUFFER_INFO_TLTYPE情報

Getter

戻り値を返します。

戻り値の型

str

width

PyStStreamBufferInfo.width: int

プロパティー：GenTL BUFFER_INFO_WIDTH情報

Getter

戻り値を返します。

戻り値の型

int

Port

PyStPort

class stapipy.PyStPort

ポートクラス

info

PyStPort.info: PyStPortInfo

プロパティー：ポート情報

Getter

ポート情報が返されます。

戻り値の型

PyStPortInfo

nodemap

PyStPort.nodemap: PyNodeMap

プロパティー：ノードマップ

Getter

ノードマップが返されます。

戻り値の型

PyNodeMap

save_xml_file(self, unicode filename)

メモリーへ保存された設定情報をファイルへ保存します。

パラメータ

filename (str) -- 保存先のファイル名

url_count

PyStPort.url_count: int

プロパティー：このポートの利用可能なURLの数

Getter

戻り値を返します。

戻り値の型

int

url_index

PyStPort.url_index: int

プロパティー：ポートURLインディックスの設定値

Getter

戻り値を返します。

Setter

値を設定します。

戻り値の型

int

url_info

PyStPort.url_info: PyStPortURLInfo

プロパティー：ポートURL情報

Getter

ポートURL情報が返されます。

戻り値の型

PyStPortURLInfo

xml_filename

PyStPort.xml_filename: str

プロパティー：XMLファイル名

Getter

戻り値を返します。

戻り値の型

str

PyStPortInfo

class stapipy.PyStPortInfo

ポート情報クラス

is_access_na

PyStPortInfo.is_access_na: bool

プロパティー：GenTL PORT_INFO_ACCESS_NA情報

Getter

戻り値を返します。

戻り値の型

bool

is_access_ni

PyStPortInfo.is_access_ni: bool

プロパティー：GenTL PORT_INFO_ACCESS_NI情報

Getter

戻り値を返します。

戻り値の型

bool

is_access_read

PyStPortInfo.is_access_read: bool

プロパティー：GenTL PORT_INFO_ACCESS_READ情報

Getter

戻り値を返します。

戻り値の型

bool

is_access_write

PyStPortInfo.is_access_write: bool

プロパティー：GenTL PORT_INFO_ACCESS_WRITE情報

Getter

戻り値を返します。

戻り値の型

bool

is_big_endian

PyStPortInfo.is_big_endian: bool

プロパティー：GenTL PORT_INFO_BIG_ENDIAN情報

Getter

戻り値を返します。

戻り値の型

bool

is_little_endian

PyStPortInfo.is_little_endian: bool

プロパティー：GenTL PORT_INFO_LITTLE_ENDIAN情報

Getter

戻り値を返します。

戻り値の型

bool

model

PyStPortInfo.model: str

プロパティー：GenTL PORT_INFO_MODEL情報

Getter

戻り値を返します。

戻り値の型

str

module

PyStPortInfo.module: str

プロパティー：GenTL PORT_INFO_MODULE情報

Getter

戻り値を返します。

戻り値の型

str

port_id

PyStPortInfo.port_id: str

プロパティー：GenTL PORT_INFO_ID情報

Getter

戻り値を返します。

戻り値の型

str

port_name

PyStPortInfo.port_name: str

プロパティー：GenTL PORT_INFO_PORTNAME情報

Getter

戻り値を返します。

戻り値の型

str

tl_type

PyStPortInfo.tl_type: str

プロパティー：GenTL PORT_INFO_TLTYPE情報

Getter

戻り値を返します。

戻り値の型

str

vendor

PyStPortInfo.vendor: str

プロパティー：GenTL PORT_INFO_VENDOR情報

Getter

戻り値を返します。

戻り値の型

str

version

PyStPortInfo.version: str

プロパティー：GenTL PORT_INFO_VERSION情報

Getter

戻り値を返します。

戻り値の型

str

PyStPortURLInfo

class stapipy.PyStPortURLInfo

ポートURL情報クラス

file_register_address

PyStPortURLInfo.file_register_address: int

プロパティー：GenTL URL_INFO_FILE_REGISTER_ADDRESS情報

Getter

戻り値を返します。

戻り値の型

int

file_ver_major

PyStPortURLInfo.file_ver_major: int

プロパティー：GenTL URL_INFO_FILE_VER_MAJOR情報

Getter

戻り値を返します。

戻り値の型

int

file_ver_minor

PyStPortURLInfo.file_ver_minor: int

プロパティー：GenTL URL_INFO_FILE_VER_MINOR情報

Getter

戻り値を返します。

戻り値の型

int

file_ver_subminor

PyStPortURLInfo.file_ver_subminor: int

プロパティー：GenTL URL_INFO_FILE_VER_SUBMINOR情報

Getter

戻り値を返します。

戻り値の型

int

filename

PyStPortURLInfo.filename: str

プロパティー：GenTL URL_INFO_FILENAME情報

Getter

戻り値を返します。

戻り値の型

str

filesize

PyStPortURLInfo.filesize: int

プロパティー：GenTL URL_INFO_FILE_SIZE情報

Getter

戻り値を返します。

戻り値の型

int

schema_ver_major

PyStPortURLInfo.schema_ver_major: int

プロパティー：GenTL URL_INFO_SCHEMA_VER_MAJOR情報

Getter

戻り値を返します。

戻り値の型

int

schema_ver_minor

PyStPortURLInfo.schema_ver_minor: int

プロパティー：GenTL URL_INFO_SCHEMA_VER_MINOR情報

Getter

戻り値を返します。

戻り値の型

int

scheme

PyStPortURLInfo.scheme: ETLURLSchemeID

プロパティー：GenTL URL_INFO_SCHEME情報

Getter

戻り値を返します。

戻り値の型

ETLURLSchemeID

sha1_hash

PyStPortURLInfo.sha1_hash: bytes

プロパティー：GenTL URL_INFO_FILE_SHA1_HASH情報

Getter

戻り値を返します。

戻り値の型

bytes

url

PyStPortURLInfo.url: str

プロパティー：GenTL URL_INFO_URL情報

Getter

戻り値を返します。

戻り値の型

str