基本関数とクラス

一般的な関数

initialize

stapipy.initialize()

StApiライブラリを初期化します。

他のStApi関数を呼び出す前に、この関数を呼び出してStApiライブラリを初期化してください。

terminate

stapipy.terminate()

StApiライブラリの終了処理を行います。

この関数を呼び出すとStApiライブラリのリソースは解放されます。

get_version

stapipy.get_version(bool as_text=True)

実行中のStApiのバージョンを取得します。戻り値の型は整数の場合は、ビット31-24:メジャーバージョン, ビット23-16:マイナーバージョン, ビット15-0:サブマイナーバージョン

パラメータ

as_text (bool) -- 設定値がTrue場合は、戻り値の型はstrタイプ、False場合は戻り値の型はintタイプ

戻り値

実行中のStApiのバージョンを取得します。

戻り値の型

as_text がTrue場合はstr、as_text がFalse場合はint

create_system

stapipy.create_system(system_vendor=EStSystemVendor.Default, interface_type=EStInterfaceType.All) PyStSystem

GenTLシステムモジュールをオープンし、PyStSystemオブジェクトを取得します。

パラメータ
  • system_vendor (EStSystemVendor) -- 使用するGenTLモジュールを指定します。

  • interface_type (EStInterfaceType) -- 使用するインターフェイスを指定します。複数のインターフェイスを使用する場合は論理和を指定します。

戻り値

GenTLシステムモジュール

戻り値の型

PyStSystem

get_pixel_format_info

stapipy.get_pixel_format_info(pixelformat) PyStPixelFormatInfo

引数に対するピクセルフォーマット情報クラスを取得します。

パラメータ

pixelformat (EStPixelFormatNamingConvention or str) -- ピクセルフォーマット値

戻り値

ピクセルフォーマット情報クラスのオブジェクト

戻り値の型

PyStPixelFormatInfo

get_pixel_component_info

stapipy.get_pixel_component_info(pixelcomponent) PyStPixelComponentInfo

引数に対するピクセル構成要素クラスを取得します。

パラメータ

pixelcomponent (EStPixelComponent) -- ピクセル構成要素値

戻り値

ピクセル構成要素情報クラスのオブジェクト

戻り値の型

PyStPixelComponentInfo

create_featurebag

stapipy.create_featurebag() PyStFeatureBag

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

戻り値

PyStFeatureBagクラスのオブジェクト

戻り値の型

PyStFeatureBag

Common Exception

PyStError

class stapipy.PyStError(message)

ベースクラス: Exception

このクラスはStApiとGenICamによって発生した例外を伝播します。

例:

try:
    # code
except PyStError as st_error:
    print(st_error)
except Exception as other_exception:
    print(other_exception)

Exception のみをキャッチして例外の種類をチェックすることも可能です。

例:

try:
    # code
except Exception as exception:
    print(type(exception), exception)

Common Classes

PyStFeatureBag

class stapipy.PyStFeatureBag

ベースクラス: object

GenApiノード(設定情報)保持クラス

load(self, PyNodeMap nodemap, bool verify=True)

メモリーへ保存された設定情報をノードマップへ反映します。

パラメータ
  • nodemap (PyNodeMap) -- 反映先のノードマップ

  • verify (bool) -- 設定反映後に読み込み確認(ベリファイ)を行う場合は True を指定します。

release(self) void

PyStFeatureBagリソースを解放します。

save_to_file(self, unicode filename)

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

パラメータ

filename (str) -- ファイル名

save_to_string(self) unicode

メモリーへ保存された設定情報を文字列として取得します。

戻り値

設定名と設定値を含んだ文字列

戻り値の型

str

store_file_to_bag(self, unicode filename)

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

パラメータ

filename (str) -- 設定ファイル名

store_nodemap_to_bag(self, PyNodeMap nodemap, int max_num_persist=-1) int64_t

指定したノードマップの設定情報をメモリーへ退避します。

パラメータ
  • nodemap (PyNodeMap) -- ノードマップ

  • max_num_presist (int) -- メモリーへ退避する項目数の最大値を指定します (-1を指定すると無制限になります)

戻り値

退避された項目数

戻り値の型

int

store_string_to_bag(self, unicode features)

文字列で指定された設定情報をメモリーへ登録します。

パラメータ

features (str) -- 設定名と設定値を含んだ文字列

PyStImage

stapipy.PyStImage の中のいくつかのメソッドはStApi C/C++と異なります。詳細はメソッドの説明をお読みください。

class stapipy.PyStImage

ベースクラス: object

画像オブジェクト

clear_component_data(self, pixelcomponent)

指定したコンポーネントのデータをクリアします。

パラメータ

pixelcomponent (EStPixelComponent) -- クリアするコンポーネントを指定

clone(self) PyStImage

画像オブジェクトをコピーします。ディープコピーを行います。

戻り値

コピーされた画像オブジェクト

戻り値の型

PyStImage

static create_buffer(width, height, pixel_format, initialize_memory=EStMemoryInitialization.DoNothing)

与えられたパラメータから画像バッファを生成するための静的メソッド。生成したバッファを持つ画像オブジェクトを返します。

パラメータ
戻り値

生成された画像オブジェクト

戻り値の型

PyStImage

static create_from_data(image_width, image_height, image_pixel_format, image_data=None)

データ(bytearray型)から画像オブジェクトを生成するための静的メソッド。 画像データはコピーされます。

パラメータ
  • image_width (int) -- 幅

  • image_height (int) -- 高さ

  • image_pixel_format (EStPixelFormatNamingConvention) -- ピクセルフォーマット

  • image_data (bytearray) -- 画像データ (サイズは必要なメモリサイズと一致する必要があります)

戻り値

生成された画像オブジェクト

戻り値の型

PyStImage

export_component_data(self, pixelcomponent) PyStImage

指定したコンポーネントのデータをモノクロ画像データとして取り出します。

パラメータ

pixelcomponent (EStPixelComponent) -- 取り出し元コンポーネントを指定

戻り値

取り出されるモノクロ画像

戻り値の型

PyStImage

get_image_data(self)

raw画像データを取得します。

戻り値

raw画像データ

戻り値の型

memoryview

get_pixel_component_value(self, size_t pos_x, size_t pos_y) PyStPixelComponentValue

指定した位置のピクセル構成要素を取得します。

パラメータ
  • pos_x (int) -- 横方向の位置

  • pos_y (int) -- 縦方向の位置

戻り値

ピクセル構成要素

戻り値の型

PyStPixelComponentValue

get_roi_image(self, size_t pos_x, size_t pos_y, size_t width, size_t height) PyStImage

切り取った画像オブジェクトを取得します。画像データはコピーされます。

パラメータ
  • pos_x (int) -- 横方向の位置

  • pos_y (int) -- 縦方向の位置

  • width (int) -- 切り取った画像の横サイズ

  • height (int) -- 切り取った画像の縦サイズ

戻り値

切り取った画像オブジェクト

戻り値の型

PyStImage

height

PyStImage.height: int

プロパティー:画像の縦サイズ

Getter

戻り値を返します。

戻り値の型

int

import_component_data(self, pixelcomponent, PyStImage image)

モノクロ画像データを指定したコンポーネントのデータとして取り込みます。

パラメータ
  • pixelcomponent (EStPixelComponent) -- 取り込み先コンポーネントを指定

  • image (PyStImage) -- 取り込まれるモノクロ画像を指定

is_releasable

PyStImage.is_releasable: bool

プロパティー:使用中のリソースを解放できるかどうかを示すフラグ。コピーした画像の場合はTrueを返します。

Getter

戻り値を返します。

戻り値の型

bool

is_same_image(self, PyStImage image) bool

保持されている画像データが一致するかどうかをチェックします。

パラメータ

image (PyStImage) -- 比較する画像オブジェクト

戻り値

一致する場合はTrue、一致しない場合はFalseを返します。

戻り値の型

bool

line_pitch

PyStImage.line_pitch: int

プロパティー:画像のラインピッチ(1ライン当たりのバイト数)

Getter

戻り値を返します。

戻り値の型

int

pixel_format

PyStImage.pixel_format: EStPixelFormatNamingConvention

プロパティー:画像のピクセルフォーマット

Getter

戻り値を返します。

戻り値の型

EStPixelFormatNamingConvention

plane_pitch

PyStImage.plane_pitch: int

プロパティー:画像のプレーンピッチ(1プレーン当たりのバイト数)

Getter

戻り値を返します。

戻り値の型

int

release(self)

解放が可能な場合は、画像リソースを解放します。

store_computed_image(self, operation_type, pixel_format, PyStImage image1, PyStImage image2)

演算した画像を格納します。

パラメータ
  • operation_type (EStOperationType) -- 演算のタイプを指定します。

  • pixel_format (EStPixelFormatNamingConvention) -- 出力画像のピクセルフォーマットを指定します。

  • image1 (PyStImage) -- 入力画像1の画像オブジェクト

  • image2 (PyStImage) -- 入力画像2の画像オブジェクト

width

PyStImage.width: int

プロパティー:画像の横サイズ

Getter

戻り値を返します。

戻り値の型

int

PyStPixelComponentInfo

class stapipy.PyStPixelComponentInfo

ベースクラス: object

ピクセル構成要素情報クラス

bit_count

PyStPixelComponentInfo.bit_count: int

プロパティー:構成要素のビット数

Getter

戻り値を返します。

戻り値の型

int

name

PyStPixelComponentInfo.name: str

プロパティー:構成要素の名前

Getter

戻り値を返します。

戻り値の型

str

value

PyStPixelComponentInfo.value: EStPixelComponent

プロパティー:ピクセルコンポーネント値

Getter

戻り値を返します。

戻り値の型

EStPixelComponent

PyStPixelComponentValue

class stapipy.PyStPixelComponentValue

ベースクラス: object

ピクセル構成要素クラス

count

PyStPixelComponentValue.count: int

プロパティー:ピクセル構成要素数

Getter

戻り値を返します。

戻り値の型

int

get_pixel_component(self, size_t index)

ピクセル構成要素値を取得します。

パラメータ

index (int) -- 構成要素のインディックス値

戻り値

ピクセル構成要素値

戻り値の型

EStPixelComponent

get_value(self, size_t index) int64_t

画素値を取得します。

パラメータ

index (int) -- 構成要素のインディックス値

戻り値

画素値

戻り値の型

int

get_value_f(self, size_t index) double

画素値を取得します。

パラメータ

index (int) -- 構成要素のインディックス値

戻り値

画素値

戻り値の型

float

PyStPixelFormatInfo

class stapipy.PyStPixelFormatInfo

ベースクラス: object

ピクセルフォーマット情報クラス

description

PyStPixelFormatInfo.description: str

プロパティー:ピクセルフォーマットの詳細

Getter

戻り値を返します。

戻り値の型

str

each_component_total_bit_count

PyStPixelFormatInfo.each_component_total_bit_count: int

プロパティー:構成要素ごとの全体のビット数

Getter

戻り値を返します。

戻り値の型

int

each_component_valid_bit_count

PyStPixelFormatInfo.each_component_valid_bit_count: int

プロパティー:構成要素ごとの有効なビット数

Getter

戻り値を返します。

戻り値の型

int

each_pixel_total_bit_count

PyStPixelFormatInfo.each_pixel_total_bit_count: int

プロパティー:ピクセルごとの合計ビット数

Getter

戻り値を返します。

戻り値の型

int

each_pixel_total_component_count

PyStPixelFormatInfo.each_pixel_total_component_count: int

プロパティー:ピクセルごとの構成要素の数

Getter

戻り値を返します。

戻り値の型

int

get_pixel_color_filter(self, int pos_x=0, int pos_y=0)

指定した位置のカラーフィルターを取得します。(ベイヤー配列画像時のみ有効な値が取得されます)

パラメータ
  • pos_x (int) -- 横方向の位置

  • pos_y (int) -- 縦方向の位置

戻り値

カラーフィルター値

戻り値の型

EStPixelColorFilter

is_bayer

PyStPixelFormatInfo.is_bayer: bool

プロパティー:ベイヤー配列画像かどうかを示すフラグ

Getter

戻り値を返します。

戻り値の型

bool

is_color

PyStPixelFormatInfo.is_color: bool

プロパティー:カラー画像かどうかを示すフラグ

Getter

戻り値を返します。

戻り値の型

bool

is_compressed

PyStPixelFormatInfo.is_compressed: bool

プロパティー:圧縮された画像かどうかを示すフラグ

Getter

戻り値を返します。

戻り値の型

bool

is_mono

PyStPixelFormatInfo.is_mono: bool

プロパティー:モノクロ画像かどうかを示すフラグ

Getter

戻り値を返します。

戻り値の型

bool

is_polarization

PyStPixelFormatInfo.is_polarization: bool

プロパティー:偏光画像かどうかを示すフラグ

Getter

戻り値を返します。

戻り値の型

bool

name

PyStPixelFormatInfo.name: str

プロパティー:ピクセルフォーマット名

Getter

戻り値を返します。

戻り値の型

str

order_of_polarized_filters

PyStPixelFormatInfo.order_of_polarized_filters: EStOrderOfPolarizedFilters

プロパティー:偏光フィルターの順番

Getter

戻り値を返します。

戻り値の型

EStOrderOfPolarizedFilters

pixel_increment_x

PyStPixelFormatInfo.pixel_increment_x: int

プロパティー:横方向の画像の最小単位

Getter

戻り値を返します。

戻り値の型

int

pixel_increment_y

PyStPixelFormatInfo.pixel_increment_y: int

プロパティー:縦方向の画像の最小単位

Getter

戻り値を返します。

戻り値の型

int

plane_count

PyStPixelFormatInfo.plane_count: int

プロパティー:プレーン数

Getter

戻り値を返します。

戻り値の型

int

value

PyStPixelFormatInfo.value: EStPixelFormatNamingConvention

プロパティー:ピクセルフォーマット値

Getter

戻り値を返します。

戻り値の型

EStPixelFormatNamingConvention

PyStRegisteredCallback

class stapipy.PyStRegisteredCallback(callback_func=None, user_data=None)

ベースクラス: object

登録されたコールバック情報クラス

callback_type

PyStRegisteredCallback.callback_type: EStCallbackType

プロパティー:StApiからトリガーされたコールバックタイプ。GenApiからのトリガーの場合、Noneを返します。

Getter

コールバックタイプを返します。

戻り値の型

EStCallbackType

data

プロパティー:コールバックデータ(コールバックタイプによって返されるデータは異なります)

Getter

コールバックデータを返します。

戻り値の型

dict

error

プロパティー:コールバックがトリガーされた原因はエラーの場合、tuple型のデータ(int型エラーコードとstr型説明文)が返されます。エラーが無ければ、(None, None)が返されます。

Getter

エラーコード(int型)と説明文(str型)、または(None, None)が返されます。

戻り値の型

tuple of (int, str) or (None, None)

is_released

PyStRegisteredCallback.is_released: bool

プロパティー:コールバックのリソースが解放されたかどうかを示すフラグ

Getter

コールバックのリソースが解放された場合は、Trueを返します。

戻り値の型

bool

module

プロパティー:トリガーソースのStApiクラスオブジェクト。トリガーソースがGenApiノードである場合、Noneを返します。

Getter

StApiクラスのオブジェクト またはNoneが返されます。

戻り値の型

PyStSystem or PyStInterface or PyStDevice or PyStDataStream or PyStStreamBuffer or PyStVideoFiler or None

node

プロパティー:GenApiからのトリガーソースノード。StApiからのトリガーの場合、Noneを返します。

Getter

トリガーソースノード、またはNoneが返されます。

戻り値の型

PyNode or None

pause(self, value) bool

一時的にコールバックのトリガーを停止します。

パラメータ

value (bool) -- 停止する場合はTrueを設定します。

戻り値

処理が成功した場合、Trueを返します。

戻り値の型

bool

release(self)

コールバックのリソースを解放します。リソースを解放するとコールバックは機能しません。