画像処理の関数とクラス¶

関数¶

create_converter¶

stapipy.create_converter(converter_type)¶

画像コンバータークラスのインスタンスを作成します。

パラメータ: converter_type (EStConverterType) -- 作成するコンバータータイプ
戻り値: コンバーターオブジェクト
戻り値の型: stapipy.PyStPixelFormatConverter or stapipy.PyStReverseConverter

create_filer¶

stapipy.create_filer(filer_type)¶

ファイラークラスのインすタスを作成します。

パラメータ: filer_type (EStFilerType) -- 作成するファイラータイプ
戻り値: ファイラーオブジェクト
戻り値の型: stapipy.PyStStillImageFiler or stapipy.PyStVideoFiler

create_filter¶

stapipy.create_filter(filter_type)¶

画像フィルタークラスのインスタンスを作成します。

パラメータ: filter_type (EStFilterType) -- 作成するフィルタータイプ
戻り値: フィルターオブジェクト
戻り値の型: stapipy.PyStBalanceRatioFilter or stapipy.PyStChromaSuppressionFilter or stapipy.PyStColorTransformationFilter or stapipy.PyStEdgeEnhancementFilter or stapipy.PyStFlatFieldCorrectionFilter or stapipy.PyStGammaCorrectionFilter or stapipy.PyStNoiseReductionFilter or stapipy.PyStSNMeasurementFilter or stapipy.PyStGraphDataFilter or stapipy.PyStImageAveragingFilter or stapipy.PyStDefectivePixelDetectionFilter or stapipy.PyStLevelAdjustmentFilter

get_filter_info¶

stapipy.get_filter_info(filter_type) → PyStFilterInfo¶

指定したフィルター情報を取得します。

パラメータ: filter_type (EStFilterType) -- フィルタータイプ
戻り値: フィルター情報クラスのオブジェクト
戻り値の型: PyStFilterInfo

コンバータークラス¶

PyStConverter¶

class stapipy.PyStConverter¶

コンバーター基本クラス

convert(self, PyStImage src) → PyStImage¶

画像変換処理を行います。

パラメータ: src (PyStImage) -- 入力画像
戻り値: 出力画像（変換後の画像オブジェクト）
戻り値の型: PyStImage

copy_settings(self, PyStConverter src)¶

コンバーターの設定値をコピーします。

パラメータ: src (PyStConverter) -- 設定のコピー元コンバーター

info¶

PyStConverter.info: PyStConverterInfo

プロパティー：コンバーター情報

Getter: 戻り値を返します。
戻り値の型: PyStConverterInfo

line_pitch_alignment¶

PyStConverter.line_pitch_alignment: int

プロパティー：画像のラインピッチ

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: int

nodemap¶

PyStConverter.nodemap: PyNodeMap

プロパティー：コンバーターのノードマップ

Getter: ノードマップを返します。
戻り値の型: PyNodeMap

PyStConverterInfo¶

class stapipy.PyStConverterInfo¶

コンバーター情報クラス

converter_name¶

PyStConverterInfo.converter_name: str

プロパティー：コンバーター名

Getter: 戻り値を返します。
戻り値の型: str

converter_type¶

PyStConverterInfo.converter_type: EStConverterType

プロパティー：コンバータータイプ

Getter: 戻り値を返します。
戻り値の型: EStConverterType

is_supported(self, pfnc) → bool¶

指定したピクセルフォーマットの変換に対応しているかを確認します。

パラメータ: pfnc (EStPixelFormatNamingConvention) -- ピクセルフォーマット
戻り値: 対応している場合、 True を返します。
戻り値の型: bool

PyStPixelFormatConverter¶

class stapipy.PyStPixelFormatConverter¶

ベースクラス: stapipy.PyStConverter

ピクセルフォーマットコンバータークラス

bayer_interpolation_method¶

PyStPixelFormatConverter.bayer_interpolation_method: EStBayerInterpolationMethod

プロパティー：ベイヤー変換処理設定

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: EStBayerInterpolationMethod

destination_pixel_format¶

PyStPixelFormatConverter.destination_pixel_format: EStPixelFormatNamingConvention

プロパティー：変換先のピクセルフォーマット値

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: EStPixelFormatNamingConvention

destination_pixel_format_node_lock¶

PyStPixelFormatConverter.destination_pixel_format_node_lock: bool

プロパティー：変換先のピクセルフォーマットノードのロック状態設定

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: bool

gamma_value¶

PyStPixelFormatConverter.gamma_value: float

プロパティー：ガンマ補正値設定

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: float

release(self)¶: リソースを解放します。

reverse_y¶

PyStPixelFormatConverter.reverse_y: bool

プロパティー：上下反転設定

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: bool

PyStReverseConverter¶

class stapipy.PyStReverseConverter¶

ベースクラス: stapipy.PyStConverter

反転回転コンバータークラス

release(self)¶: リソースを解放します。

reverse_x¶

PyStReverseConverter.reverse_x: bool

プロパティー：左右反転設定

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: bool

reverse_y¶

PyStReverseConverter.reverse_y: bool

プロパティー：上下反転設定

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: bool

rotation_mode¶

PyStReverseConverter.rotation_mode: EStRotationMode

プロパティー：回転モード

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: EStRotationMode

フィルタークラス¶

PyStFilter¶

class stapipy.PyStFilter¶

フィルター基本クラス

apply_filter(self, PyStImage input_image) → PyStImage¶

フィルター処理を実行します。GraphData以外、入力した画像は処理後の画像で上書きされます。

パラメータ: input_image (PyStImage) -- 入力画像
戻り値: フィルター処理後の画像オブジェクト
戻り値の型: PyStImage

copy_settings(self, PyStFilter src)¶

フィルターの設定値をコピーします。

パラメータ: src (PyStFilter) -- 設定のコピー元フィルター

info¶

PyStFilter.info: PyStFilterInfo

プロパティー：フィルター情報

Getter: 戻り値を返します。
戻り値の型: PyStFilterInfo

nodemap¶

PyStFilter.nodemap: PyNodeMap

プロパティー：フィルターのノードマップ

Getter: ノードマップを返します。
戻り値の型: PyNodeMap

PyStFilterInfo¶

class stapipy.PyStFilterInfo¶

フィルター情報クラス

filter_name¶

PyStFilterInfo.filter_name: str

プロパティー：フィルター名

Getter: 戻り値を返します。
戻り値の型: str

filter_type¶

PyStFilterInfo.filter_type: EStFilterType

プロパティー：フィルタータイプ

Getter: 戻り値を返します。
戻り値の型: EStFilterType

is_supported(self, pfnc) → bool¶

指定したピクセルフォーマットの変換に対応しているかを確認します。

パラメータ: pfnc (EStPixelFormatNamingConvention) -- ピクセルフォーマット
戻り値: 対応している場合、 True を返します。
戻り値の型: bool

PyStBalanceRatioFilter¶

class stapipy.PyStBalanceRatioFilter¶

ベースクラス: stapipy.PyStFilter

バランスレートフィルタークラス

balance_white_auto¶

PyStBalanceRatioFilter.balance_white_auto: EStBalanceWhiteAuto

プロパティー：オートホワイトバランス

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: EStBalanceWhiteAuto

get_balance_ratio(self, selector) → double¶

ホワイトバランスゲインの値を取得します。

パラメータ: selector (EStBalanceRatioSelector) -- 対象を指定します。
戻り値: ホワイトバランスゲインの値
戻り値の型: float

get_offset_level_after_gain(self, selector) → int32_t¶

ホワイトバランスゲイン処理後のオフセット値を取得します。

パラメータ: selector (EStBalanceRatioSelector) -- 対象を指定します。
戻り値: オフセット値。
戻り値の型: int

get_offset_level_before_gain(self, selector) → int32_t¶

ホワイトバランスゲイン処理前のオフセット値を取得します。

パラメータ: selector (EStBalanceRatioSelector) -- 対象を指定します。
戻り値: オフセット値。
戻り値の型: int

release(self)¶: フィルターオブジェクトに使用されるリソースを解放します。

set_balance_ratio(self, selector, float value)¶

ホワイトバランスゲイン値を設定します。

パラメータ

selector (EStBalanceRatioSelector) -- 対象を指定します。
value (float) -- ホワイトバランスゲイン値(0～16.0)

set_offset_level_after_gain(self, selector, int32_t value)¶

ホワイトバランスゲイン処理後のオフセット値を設定します。

パラメータ

selector (EStBalanceRatioSelector) -- 対象を指定します。
value (int) -- オフセット値。

set_offset_level_before_gain(self, selector, int32_t value)¶

ホワイトバランスゲイン処理前のオフセット値を設定します。

パラメータ

selector (EStBalanceRatioSelector) -- 対象を指定します。
value (int) -- オフセット値。

PyStChromaSuppressionFilter¶

class stapipy.PyStChromaSuppressionFilter¶

ベースクラス: stapipy.PyStFilter

クロマサプレスフィルタークラス

get_suppression_value(self, selector) → uint32_t¶

抑圧値を取得します。

パラメータ: selector (EStChromaSuppressionPartSelector) -- 設定の対象部を指定します。
戻り値: 抑圧値
戻り値の型: int

get_threshold_value(self, selector) → uint32_t¶

スレッショルド値を取得します。

パラメータ: selector (EStChromaSuppressionPartSelector) -- 設定の対象部を指定します。
戻り値: スレッショルド値
戻り値の型: int

release(self)¶: フィルターオブジェクトに使用されるリソースを解放します。

set_suppression_value(self, selector, uint32_t value)¶

抑圧値を設定します。

パラメータ

selector (EStChromaSuppressionPartSelector) -- 設定の対象部を指定します。
value (int) -- 値(0～255)

set_threshold_value(self, selector, uint32_t value)¶

スレッショルド値を設定します。

パラメータ

selector (EStChromaSuppressionPartSelector) -- 設定の対象部を指定します。
value (int) -- 値(0～255)

PyStColorTransformationFilter¶

class stapipy.PyStColorTransformationFilter¶

ベースクラス: stapipy.PyStFilter

色変換フィルタークラス

get_color_transformation_value(self, selector) → double¶

色変換行列の値を取得します。

パラメータ: selector (EStColorTransformationValueSelector) -- 対象とする行列の要素を指定します。
戻り値: 色変換行列値
戻り値の型: float

hue_correction¶

PyStColorTransformationFilter.hue_correction: float

プロパティー：色相の補正値

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: float

is_color_transformation_enabled¶

PyStColorTransformationFilter.is_color_transformation_enabled: bool

プロパティー：色変換処理の有効/無効

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: bool

release(self)¶: フィルターオブジェクトに使用されるリソースを解放します。

saturation_correction¶

PyStColorTransformationFilter.saturation_correction: float

プロパティー：彩度の補正値

Getter: 戻り値を返します。
Setter: 値を設定します (-180.0〜180.0)
戻り値の型: float

set_color_transformation_value(self, selector, double value)¶

色変換行列値を設定します。

パラメータ

selector (EStColorTransformationValueSelector) -- 対象とする行列の要素を指定します。
value (float) -- 設定値

PyStDefectivePixelDetectionFilter¶

class stapipy.PyStDefectivePixelDetectionFilter¶

ベースクラス: stapipy.PyStFilter

欠陥画素検出フィルタークラス

clear_detection_result(self)¶: 検出された欠陥ピクセル情報を削除します。

defective_pixel_detection_averaging_area¶

PyStDefectivePixelDetectionFilter.defective_pixel_detection_averaging_area: EStDefectivePixelDetectionAveragingArea

プロパティー：平均画素値を算出する際のエリア

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: EStDefectivePixelDetectionAveragingArea

get_detection_result(self) → PyStDefectivePixelDetectionResult¶

検出結果を取得します。

戻り値: 検出結果
戻り値の型: PyStDefectivePixelDetectionResult

get_threshold(self, threshold_target) → double¶

欠陥画素と判定する際の閾値を取得します。

パラメータ: threshold_target (EStDefectivePixelDetectionThresholdTarget) -- 閾値の対象を指定します。
戻り値: 最大画素値に対する比率(0.0 - 1.0)で指定された閾値を取得します。平均値からの差分が閾値よりも大きい場合、欠陥画素と判断されます。
戻り値の型: float

maximum_pixel_count¶

PyStDefectivePixelDetectionFilter.maximum_pixel_count: int

プロパティー：検出される欠陥画素の最大数(0～8192)

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: int

peripheral_area_size¶

PyStDefectivePixelDetectionFilter.peripheral_area_size: int

プロパティー：平均画素値を算出する際のエリアのサイズ(0～256)

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: int

release(self)¶: フィルターオブジェクトに使用されるリソースを解放します。

set_threshold(self, threshold_target, double value)¶

欠陥画素と判定する際の閾値を設定します。

パラメータ

threshold_target (EStDefectivePixelDetectionThresholdTarget) -- 閾値の対象を指定します。
value (float) -- 設定値

PyStDefectivePixelDetectionResult¶

class stapipy.PyStDefectivePixelDetectionResult¶

ベースクラス: object

欠陥画素検出結果クラス

detected_pixels¶

PyStDefectivePixelDetectionResult.detected_pixels: list

プロパティー：検出された結果

Getter: 戻り値を返します。
戻り値の型: list of PyStDefectivePixelInformation

detection_status¶

PyStDefectivePixelDetectionResult.detection_status: EStDefectivePixelDetectionStatus

プロパティー：検出ステータス

Getter: 戻り値を返します。
戻り値の型: EStDefectivePixelDetectionStatus

PyStDefectivePixelInformation¶

class stapipy.PyStDefectivePixelInformation¶

ベースクラス: object

画素欠陥情報クラス

delta_ratio¶

PyStDefectivePixelInformation.delta_ratio: float

プロパティー：デルタ比

Getter: 戻り値を返します。
戻り値の型: float

evaluation_value¶

PyStDefectivePixelInformation.evaluation_value: float

プロパティー：ピクセルの評価値

Getter: 戻り値を返します。
戻り値の型: float

pos_x¶

PyStDefectivePixelInformation.pos_x: int

プロパティー：横軸

Getter: 戻り値を返します。
戻り値の型: int

pos_y¶

PyStDefectivePixelInformation.pos_y: int

プロパティー：縦軸

Getter: 戻り値を返します。
戻り値の型: int

reference_value¶

PyStDefectivePixelInformation.reference_value: float

プロパティー：評価基準値

Getter: 戻り値を返します。
戻り値の型: float

PyStEdgeEnhancementFilter¶

class stapipy.PyStEdgeEnhancementFilter¶

ベースクラス: stapipy.PyStFilter

エッジ強調フィルタークラス

release(self)¶: フィルターオブジェクトに使用されるリソースを解放します。

strength¶

PyStEdgeEnhancementFilter.strength: float

プロパティー：エッジ強調フィルターの強調度

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: float

threshold¶

PyStEdgeEnhancementFilter.threshold: int

プロパティー：エッジ強調フィルター用のスレッショルド値

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: int

PyStFlatFieldCorrectionFilter¶

class stapipy.PyStFlatFieldCorrectionFilter¶

ベースクラス: stapipy.PyStFilter

フラットフィールド補正フィルタークラス

calibration_target_value¶

PyStFlatFieldCorrectionFilter.calibration_target_value: int

プロパティー：キャリブレーション時の目標値

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: int

flat_field_correction_mode¶

PyStFlatFieldCorrectionFilter.flat_field_correction_mode: EStFlatFieldCorrectionMode

プロパティー：フラットフィールド補正モード

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: EStFlatFieldCorrectionMode

is_calibration_enabled¶

PyStFlatFieldCorrectionFilter.is_calibration_enabled: bool

プロパティー：キャリブレーションの有効/無効

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: bool

release(self)¶: フィルターオブジェクトに使用されるリソースを解放します。

PyStGammaCorrectionFilter¶

class stapipy.PyStGammaCorrectionFilter¶

ベースクラス: stapipy.PyStFilter

ガンマ補正フィルタークラス

gamma_value¶

PyStGammaCorrectionFilter.gamma_value: float

プロパティー：ガンマ補正値設定

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: float

release(self)¶: フィルターオブジェクトに使用されるリソースを解放します。

PyStGraphDataFilter¶

class stapipy.PyStGraphDataFilter¶

ベースクラス: stapipy.PyStFilter

グラフデータフィルタークラス

get_list(self) → PyStGraphDataList¶

グラフデータリストを取得します。

戻り値: グラフデータリスト
戻り値の型: PyStGraphDataList

graph_data_type¶

PyStGraphDataFilter.graph_data_type: EStGraphDataType

プロパティー：グラフデータタイプ

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: EStGraphDataType

height¶

PyStGraphDataFilter.height: int

プロパティー：縦方向のサイズ

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: int

offset_x¶

PyStGraphDataFilter.offset_x: int

プロパティー：横方向のオフセット値

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: int

offset_y¶

PyStGraphDataFilter.offset_y: int

プロパティー：縦方向のオフセット値

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: int

release(self)¶: フィルターオブジェクトに使用されるリソースを解放します。

roi_mode¶

PyStGraphDataFilter.roi_mode: EStROIMode

プロパティー：ROIモード

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: EStROIMode

width¶

PyStGraphDataFilter.width: int

プロパティー：横方向のサイズ

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: int

PyStGraphDataList¶

class stapipy.PyStGraphDataList¶

ベースクラス: object

PyStGraphDataFilter で作成されたグラフデータをアクセスするためのクラス

count¶

PyStGraphDataList.count: int

プロパティー：データの数

Getter: 戻り値を返します。
戻り値の型: int

get_data_at(self, int index) → PyStGraphData¶

インデックスで指定したグラフデータを取得します。

パラメータ: index (int) -- グラフデータのインデックス値
戻り値: 指定したインデックスのグラフデータ
戻り値の型: PyStGraphData

is_save_supported(self, file_format) → bool¶

指定したファイルフォーマットがグラフデータの保存に対応しているかを確認します。

パラメータ: file_format (EStGraphDataFileFormat) -- グラフデータファイルフォーマット
戻り値: 書き込みに対応している場合、 True が返されます。
戻り値の型: bool

load(self, unicode filename)¶

グラフデータファイルをバッファへ読み込みます。バッファにあるデータは上書きされます。現在、読み込みに対応しているのはStApiRaw フォーマットのみとなります。

パラメータ: filename (str) -- 保存先のグラフデータファイル名

save(self, file_format, unicode filename)¶

グラフデータをファイルへ保存します。

パラメータ

file_format (EStGraphDataFileFormat) -- グラフデータファイルフォーマット
filename (str) -- 保存先のグラフデータファイル名

PyStGraphData¶

class stapipy.PyStGraphData¶

ベースクラス: object

PyStGraphDataList のグラフデータへアクセスするためのクラス

count¶

PyStGraphData.count: int

プロパティー：データ数

Getter: 戻り値を返します。
戻り値の型: int

get_graph_data(self)¶

グラフデータを取得します。

戻り値: グラフデータ
戻り値の型: memoryview

get_graph_info_float64(self, graph_info_type) → double¶

グラフデータ情報(float型)を取得します。

パラメータ: graph_data_info (EStGraphDataInfo) -- 取得するグラフデータ情報
戻り値: グラフデータ情報
戻り値の型: float

get_graph_info_uint32(self, graph_info_type) → uint32_t¶

グラフデータ情報(int型)を取得します。

パラメータ: graph_data_info (EStGraphDataInfo) -- 取得するグラフデータ情報
戻り値: グラフデータ情報
戻り値の型: int

graph_data_bit_size¶

PyStGraphData.graph_data_bit_size: int

プロパティー：グラフデータ値のサイズ（ビット単位）

Getter: 戻り値を返します。
戻り値の型: int

graph_data_type¶

PyStGraphData.graph_data_type: EStGraphDataType

プロパティー：グラフデータタイプ

Getter: 戻り値を返します。
戻り値の型: EStGraphDataType

PyStImageAveragingFilter¶

class stapipy.PyStImageAveragingFilter¶

ベースクラス: stapipy.PyStFilter

画像平均化フィルタークラス

clear_image_data(self)¶: 積算された画像データを消去します。

frame_count¶

PyStImageAveragingFilter.frame_count: int

プロパティー：積算された画像の数

Getter: 戻り値を返します。
戻り値の型: int

get_averaged_image(self, int each_component_bits_count=0) → PyStImage¶

平均化された画像データを取得します。

パラメータ: each_component_bits_count (int) -- 平均化された画像の個々の構成要素のビット数を指定します。0が指定されかつ入力画像のビット数が8以上の場合は、入力画像と同じビット数が使用されます。
戻り値: 平均化された画像オブジェクト
戻り値の型: PyStImage

release(self)¶: フィルターオブジェクトに使用されるリソースを解放します。

PyStLevelAdjustmentFilter¶

class stapipy.PyStLevelAdjustmentFilter¶

ベースクラス: stapipy.PyStFilter

レベル調整フィルタークラス

get_level_adjustment_correction_points(self, pixelcomponent) → list¶

レベル調整点の情報を取得します。

パラメータ: pixelcomponent (EStPixelComponent) -- 対象とするピクセル構成要素(Mono, R, G, B)
戻り値: PyStLevelAdjustPointInfoのリスト
戻り値の型: list of PyStLevelAdjustPointInfo

level_adjustment_correction_points_interpolation_mode¶

PyStLevelAdjustmentFilter.level_adjustment_correction_points_interpolation_mode: EStLevelAdjustmentCorrectionPointsInterpolationMode

プロパティー：レベル調整補正点補間モード

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: EStLevelAdjustmentCorrectionPointsInterpolationMode

level_adjustment_mode¶

PyStLevelAdjustmentFilter.level_adjustment_mode: EStLevelAdjustmentMode

プロパティー：レベル調整モード

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: EStLevelAdjustmentMode

release(self)¶: フィルターオブジェクトに使用されるリソースを解放します。

set_level_adjustment_correction_points(self, pixelcomponent, point_info_list)¶

レベル調整点の情報を設定します。

パラメータ

pixelcomponent (EStPixelComponent) -- 対象とするピクセル構成要素(Mono, R, G, B)
point_info_list -- PyStLevelAdjustPointInfoのリストまたはタプル

PyStLevelAdjustPointInfo¶

class stapipy.PyStLevelAdjustPointInfo¶

ベースクラス: object

レベル調整制御点情報クラス

input¶

PyStLevelAdjustPointInfo.input: float

制御点の入力値 (0 - 1.0)

Getter: 戻り値を返します。
戻り値の型: float

output¶

PyStLevelAdjustPointInfo.output: float

制御点の出力値 (0 - 1.0)

Getter: 戻り値を返します。
戻り値の型: float

PyStNoiseReductionFilter¶

class stapipy.PyStNoiseReductionFilter¶

ベースクラス: stapipy.PyStFilter

ノイズ軽減フィルタークラス

is_calibration_enabled¶

PyStNoiseReductionFilter.is_calibration_enabled: bool

プロパティー：キャリブレーションの有効/無効

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: bool

noise_reduction_mode¶

PyStNoiseReductionFilter.noise_reduction_mode: EStNoiseReductionMode

プロパティー：ガンマ補正値設定

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: EStNoiseReductionMode

release(self)¶: フィルターオブジェクトに使用されるリソースを解放します。

PyStSNMeasurementFilter¶

class stapipy.PyStSNMeasurementFilter¶

ベースクラス: stapipy.PyStFilter

SN測定フィルタークラス

clear_grabbed_image(self)¶: 保持している画像データを破棄します。

frame_count¶

PyStSNMeasurementFilter.frame_count: int

プロパティー：統計値算出に使用するフレーム数

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: int

height¶

PyStSNMeasurementFilter.height: int

プロパティー：縦方向のサイズ

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: int

offset_x¶

PyStSNMeasurementFilter.offset_x: int

プロパティー：横方向のオフセット値

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: int

offset_y¶

PyStSNMeasurementFilter.offset_y: int

プロパティー：縦方向のオフセット値

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: int

release(self)¶: フィルターオブジェクトに使用されるリソースを解放します。

retrieve_measurement_result(self, uint32_t timeout_ms, timeout_handling) → PyStSNMeasurementResult¶

計測結果を取得します。

パラメータ

timeout_ms (int) -- タイムアウト時間[ms]
timeout_handling (EStTimeoutHandling) -- タイムアウトへの対処

roi_mode¶

PyStSNMeasurementFilter.roi_mode: EStROIMode

プロパティー：ROIモード

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: EStROIMode

width¶

PyStSNMeasurementFilter.width: int

プロパティー：横方向のサイズ

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: int

PyStSNMeasurementResult¶

class stapipy.PyStSNMeasurementResult¶

SN測定結果クラス

component_count¶

PyStSNMeasurementResult.component_count: int

プロパティー：コンポーネントの数

Getter: 戻り値を返します。
戻り値の型: int

PyStSNMeasurementResultItem¶

class stapipy.PyStSNMeasurementResultItem¶

SN測定結果へアクセスするためのクラス
pixel_component	Type: `stapipy.EStPixelComponent`
pixel_count	Type: int
average	Type: float
temporal_standard_deviation	Type: float (全画素の平均)
frame_standard_deviation	Type: float (各フレームの平均)

例：

filter = stapi.create_filter(stapi.EStFilterType.SNMeasurement)

# Other codes: set filter setting, image grabbing, etc.
# ...

# Retrieve the measurement results.
result = filter.retrieve_measurement_result(
    timeout_ms=1000,
    timeout_handling=stapi.EStTimeoutHandling.ThrowException)

# Retrieve measurement results for each pixel component.
for pixel_component in range(result.component_count):
      result_item = result[pixel_component]
      print("Pixel component = ", result_item.pixel_component)
      print("Pixel count = ", result_item.pixel_count)
      print("Average = ", result_item.average)
      print("Temporal standard deviation = ",
          result_item.temporal_standard_deviation)
      print("Frame standard deviation = ",
          result_item.frame_standard_deviation)

ファイラークラス¶

PyStFiler¶

class stapipy.PyStFiler¶

ファイラー基本クラス

copy_settings(self, PyStFiler src)¶

ファイラー設定値をコピーします。

パラメータ: src (PyStFiler) -- 設定のコピー元ファイラー

info¶

PyStFiler.info: PyStFilerInfo

プロパティー：ファイラー情報

Getter: 戻り値を返します。
戻り値の型: PyStFilerInfo

nodemap¶

PyStFiler.nodemap: PyNodeMap

プロパティー：ファイラーのノードマップ

Getter: ノードマップを返します。
戻り値の型: PyNodeMap

PyStStillImageFiler¶

class stapipy.PyStStillImageFiler¶

ベースクラス: stapipy.PyStFiler

静止画ファイラークラス

compression_level¶

PyStStillImageFiler.compression_level: int

プロパティー：PNGファイル用の圧縮レベル

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: int

is_load_supported(self, pixel_format, file_format) → bool¶

指定したピクセルフォーマットの読み込みに対応しているかを確認します。

パラメータ

pixel_format (EStPixelFormatNamingConvention) -- 対象ピクセルフォーマット
file_format (EStStillImageFileFormat) -- 静止画ファイルフォーマット

戻り値

読み込みに対応している場合、 True が返されます。

戻り値の型

bool

is_save_supported(self, pixel_format, file_format) → bool¶

指定したピクセルフォーマットの保存に対応しているかを確認します。

パラメータ

pixel_format (EStPixelFormatNamingConvention) -- 対象ピクセルフォーマット
file_format (EStStillImageFileFormat) -- 静止画ファイルフォーマット

戻り値

書き込みに対応している場合、 True が返されます。

戻り値の型

bool

load(self, unicode filename) → PyStImage¶

静止画ファイルを画像バッファへ読み込みます。

パラメータ: filename (str) -- ファイル名
戻り値: 画像バッファ
戻り値の型: PyStImage

quality¶

PyStStillImageFiler.quality: int

プロパティー：JPEGファイルの品質設定

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: int

release(self)¶: ファイラーオブジェクトに使用されるリソースを解放します。

save(self, PyStImage image, file_format, unicode filename)¶

画像データを静止画ファイルへ保存します。

パラメータ

image (PyStImage) -- 画像バッファ
file_format (EStStillImageFileFormat) -- 静止画ファイルフォーマット
filename (str) -- ファイル名

PyStVideoFiler¶

class stapipy.PyStVideoFiler¶

ベースクラス: stapipy.PyStFiler

動画ファイラークラス

deregister_callback(self, PyStRegisteredCallback registered_cb, check_all=False)¶

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

パラメータ

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

deregister_callbacks(self, check_all=False)¶

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

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

fps¶

PyStVideoFiler.fps: float

動画ファイルのFPS

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: float

get_registered_callbacks(self, check_all=False) → list¶

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

パラメータ: check_all (bool) -- このPyStVideoFilerのコピーも含む、登録されたコールバックを取得するフラグ
戻り値: PyStRegisteredCallbackのリストまたはNone
戻り値の型: list of PyStRegisteredCallback

is_stopped¶

PyStVideoFiler.is_stopped: bool

プロパティー：動画ファイルの生成が停止しているかどうかを示すフラグ

Getter: 戻り値を返します。
戻り値の型: bool

maximum_frame_count_per_file¶

PyStVideoFiler.maximum_frame_count_per_file: int

プロパティー：1つの動画ファイルに保存する最大フレーム数

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: int

quality¶

PyStVideoFiler.quality: int

プロパティー：動画ファイルの品質設定

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: int

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

コールバック関数を登録します。ファイルオプーン、ファイルクローズ、エラーイベントの際、コールバック関数がトリガーされます。

パラメータ

callback_func -- トリガーされる関数
user_data -- ユーザデータ（オプショナル）

戻り値

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

戻り値の型

PyStRegisteredCallback

register_filename(self, unicode filename)¶

動画ファイル名を登録します。複数のファイルを予め登録しておくと、ファイルサイズやフレーム数が上限に達した際、保存中の動画ファイルがクローズされた後に、次の動画ファイルがオープンされるようになります。

パラメータ: filename (str) -- 保存先の動画ファイル名

register_image(self, PyStImage image, int frame_no)¶

動画ファイルへ保存する画像データを登録します。

パラメータ

image (PyStImage) -- 画像バッファ
frame_no (int) -- フレーム番号

release(self)¶: PyStVideoFilerのリソースを解放します。コールバック登録も解除します。

reset(self)¶: 生成中の動画ファイルをクローズし、ファイルリストおよび保存待機中の画像データをクリアします。

reverse_y¶

PyStVideoFiler.reverse_y: bool

プロパティー：上下反転設定

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: bool

video_file_compression¶

PyStVideoFiler.video_file_compression: EStVideoFileCompression

プロパティー：動画ファイル圧縮形式

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: EStVideoFileCompression

video_file_format¶

PyStVideoFiler.video_file_format: EStVideoFileFormat

プロパティー：動画ファイルフォーマット

Getter: 戻り値を返します。
Setter: 値を設定します。
戻り値の型: EStVideoFileFormat

画像処理の関数とクラス¶

関数¶

create_converter¶

create_filer¶

create_filter¶

get_filter_info¶

コンバータークラス¶

PyStConverter¶

PyStConverterInfo¶

PyStPixelFormatConverter¶

PyStReverseConverter¶

フィルタークラス¶

PyStFilter¶

PyStFilterInfo¶

PyStBalanceRatioFilter¶

PyStChromaSuppressionFilter¶

PyStColorTransformationFilter¶

PyStDefectivePixelDetectionFilter¶

PyStDefectivePixelDetectionResult¶

PyStDefectivePixelInformation¶

PyStEdgeEnhancementFilter¶

PyStFlatFieldCorrectionFilter¶

PyStGammaCorrectionFilter¶

PyStGraphDataFilter¶

PyStGraphDataList¶

PyStGraphData¶

PyStImageAveragingFilter¶

PyStLevelAdjustmentFilter¶

PyStLevelAdjustPointInfo¶

PyStNoiseReductionFilter¶

PyStSNMeasurementFilter¶

PyStSNMeasurementResult¶

PyStSNMeasurementResultItem¶

ファイラークラス¶

PyStFiler¶

PyStStillImageFiler¶

PyStVideoFiler¶

目次

前のトピックへ

次のトピックへ