acapy

acapy package (Python bindings for AVALDATA AcapLib2 )

Index

• Installation
• Dependencies
• LICENSE
• AcaPy Class
• CameraControl Class
• GraphicsBox Class
• Changelog

Installation

pip install acapy

Dependencies

LICENSE

BSD 3-Clause License

Copyright (c) 2024, AVALDATA
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

AcaPy Class

AcapLib2のPythonラッパークラスです。

Examples

Snap sample

sキーの入力ごとに、画像１枚を取得します。

qキーの入力でプログラムを終了します。

連続で画像取り込みを行う場合はGrab sampleを参照ください。

import sys

import cv2      # OpenCV
import acapy    # AcaPy

# ----------------------------------------------------------------
# AcaPyクラスのインスタンス
capture = acapy.AcaPy()

if capture.is_opened is False:
    # 画像入力ボードが見つからないときは終了
    print("Board or Camera not recognized.")
    capture.dispose()
    sys.exit(0)

# iniファイル（ボード設定ファイル）の読込、AcapLib2のiniファイルと共通です。
# iniファイルは実際に使用するカメラ用のファイルを指定してください。
ret = capture.load_inifile("./AreaSensor_mono.ini")
if ret == 0:
    # iniファイルの読込に失敗したとき(ファイルが見つからない、ファイルの設定が異なるなど)
    print("Load inifile error")
    capture.dispose()
    sys.exit(0)

# ----------------------------------------------------------------
# 画像取込

# 画像表示ウィンドウ作成(sキー入力:Snap, qキー入力:終了)
WINDOW_TITLE = "AcaPy Sample [\"s\"=snap,\"q\"=quit]"
cv2.namedWindow(WINDOW_TITLE, cv2.WINDOW_NORMAL)

while True:
    # キー入力
    key = cv2.waitKey(1) & 0xFF

    if key == ord('s'):
        # snap(画像１枚の取得)
        print("[snap]")
        ret, frame = capture.snap()
        if ret == acapy.AcaPy.OK:
            cv2.imshow(WINDOW_TITLE, frame)

    elif key == ord('q') or key == 27: # q もしくは escキーで終了
        # quit
        print("[quit]")
        break

capture.dispose() # AcaPyクラスのリソースの解放
cv2.destroyAllWindows()

Grab sample

gキーの入力で画像の連続取込(Grab)を開始／停止します。

qキーの入力でプログラムを終了します。

import sys

import cv2      # OpenCV
import acapy    # AcaPy

# ----------------------------------------------------------------
# AcaPyクラスのインスタンス
capture = acapy.AcaPy()

if capture.is_opened is False:
    # 画像入力ボードが見つからないときは終了
    print("Board or Camera not recognized.")
    capture.dispose()
    sys.exit(0)

# iniファイル（ボード設定ファイル）の読込、AcapLib2のiniファイルと共通です。
ret = capture.load_inifile("./AreaSensor_mono.ini")
if ret == 0:
    # iniファイルの読込に失敗したとき(ファイルが見つからない、ファイルの設定が異なるなど)
    print("Load inifile error")
    capture.dispose()
    sys.exit(0)

# 画像表示ウィンドウ作成(sキー入力:Snap, gキー入力:Grab, qキー入力:終了)
WINDOW_TITLE = "AcaPy Sample [\"g\"=grab,\"q\"=quit]"
cv2.namedWindow(WINDOW_TITLE, cv2.WINDOW_NORMAL)

# ----------------------------------------------------------------
# 画像取込
while True:
    # 前回取得した画像の次の画像から今回までの画像を取得
    ret, frames, count, frame_no = capture.read_frames()

    if frames is not None:
        # 最新の画像を表示
        print(f"[grab] FrameNo={frame_no}, count={count}, error_info={ret}")
        cv2.imshow (WINDOW_TITLE, frames[count - 1] )

    # キー入力
    key = cv2.waitKey(1) & 0xFF

    if key == ord('g'):
        # grab(連続画像取得)
        if capture.is_grab is True:
            # grab中のときはgrabを停止する
            capture.grab_stop()
            print("[grab stop]")

        else:
            # grab中でないときはGrabを開始する
            capture.grab_start()
            print("[grab start]")

    elif key == ord('q') or key == 27: # q もしくは escキーで終了
        if capture.is_grab is True:
            # grab中のときはgrabを停止する
            capture.grab_stop()
            print("[grab stop]")
        break
        
capture.dispose() # AcaPyクラスのリソースの解放
cv2.destroyAllWindows()

GigE sample

AVALDATA製のGigEカメラを使ってAcaPyで画像を撮影するサンプルです。 ※GigEカメラを使用する際は、ファイアウォールを無効にするか、ファイアウォールによるアプリケーションの許可を行ってください

import sys

import cv2      # OpenCV
import acapy    # AcaPy

# -------------------------------------------------------
# GigEカメラ一覧の取得
cameras = acapy.AcaPy.get_camera_list()
print(cameras)
# [('169.254.7.41', 1, 'ABA-001IR-GE', 1234568790), ('169.254.7.42', 1, 'ABA-001IR-GE', 1234568791)]

if len(cameras) < 1:
    # カメラがみつからなかったとき
    print("No Camera")
    sys.exit(0)

# -------------------------------------------------------
# AcaPyクラスのGigEカメラを指定したインスタンス
capture = acapy.AcaPy(cameras[0])       # GigEカメラを最初に見つけたカメラ
#capture = acapy.AcaPy('169.254.7.41')  # 固定IP指定のとき

# -------------------------------------------------------
# カメラ設定例
camera = capture.camera_control         # CameraControlクラスオブジェクトの取得
print(camera.get_camera_category_feature_text())    # カメラ設定値一覧の取得、表示
_, width, _ = camera.get_value('Width') # カメラの幅の画素数の取得
camera.set_value('Width', 640)          # カメラの幅の画素数の設定

# -------------------------------------------------------
# AcaPyクラス設定例（カメラの設定に合わせて取込サイズを設定する）
capture.width = 640     # 取込画像の幅を合わせる
capture.reflect_param() # 設定値の反映

# -------------------------------------------------------
# Snap（カメラ画像１枚の取得）
ret, frame = capture.snap()
# 画像表示
cv2.imshow("Image", frame)

cv2.waitKey()

Constructors

ボード番号（もしくはIPアドレス）、チャンネル番号を指定して、画像入力ボードをオープンします。 実際にボードがオープン出来たかどうかは、is_openedプロパティで確認してください。

def __init__(self, board_id: Union[int, str, tuple]=0, ch: int = 1, debug_print: bool = True):

パラメータ

Properties

プロパティの値は、値を設定後、reflect_param()メソッドを実行すると設定が画像入力ボードに反映されます。 reflect_param()メソッドを実行し忘れた場合、grab_start()メソッド内でreflect_param()メソッドが実行されます。

※設定値の詳細は、下記のプロパティとAcapLib2の設定IDとの対応表示を参考にAcapLib2のマニュアル「SDK-AcapLib2 Library Manual for Windows(OM15018*).pdf」を参照願います。

Methods

---

bgr2rgbスタティックメソッド

カラー画像のとき、カラーデータのRGBの並びをB,G,RからR,G,Bへ入れ替えます。 モノクロ画像のときは、そのままの画像が返されます。

def bgr2rgb(bgr_image : np.ndarray) -> np.ndarray:

パラメータ

戻り値

rgb_image

---

count_resetメソッド

FVAL/LVAL/外部トリガ/CC カウント回数及び、外部トリガ間隔カウンタ1～4 のカウンタをリセットしま す。

def count_reset(self) -> bool:

戻り値

ret

---

cxp_link_resetメソッド

対象のポートに接続されているカメラに対し、カメラ接続確立(再初期化)を行います。 ※カメラ設定はデフォルトに戻りますので、LinkSpeed 等カメラ設定を再度実施する必要があります。

def cxp_link_reset(self) -> int:

戻り値

ret

---

disposeメソッド

AcaPyクラス内部のリソースを解放します。

dispose()メソッドを実施後、インスタンスしたクラスオブジェクトは使用できません。

def dispose(self):

---

get_acapy_properties_textメソッド

AcaPyクラスのプロパティ一覧および設定値の書かれたテキストを取得します。

def get_acapy_properties_text(self) -> str:

戻り値

ret

---

get_bit_assign_exメソッド

入力画像並べ替え設定を取得します。

AcapLib2のAcapGetBitAssignEx()関数相当

def get_bit_assign_ex(self) -> Tuple[int, acaplib2.BITASSIGNINFO]:

戻り値

(ret, bit_assign_info)

---

get_boardInfoスタティックメソッド

接続されているボード情報（最大16個分のデータ）をACAPBOARDINFOEX構造体で取得します。

AcapLib2のAcapGetBoardInfoEx()関数相当

def get_boardInfo() -> Tuple[int, acaplib2.ACAPBOARDINFOEX]:

戻り値

(ret, board_info)

---

get_boardInfo256スタティックメソッド

接続されているボード情報（最大256個分のデータ）をACAPBOARDINFOEX_256構造体で取得します。

AcapLib2のAcapGetBoardInfoEx256()関数相当

def get_boardInfo() -> Tuple[int, acaplib2.ACAPBOARDINFOEX_256]:

戻り値

(ret, board_info)

---

get_camera_category_feature_listメソッド

xmlリストをACL_CAM_FEATURE_INFO構造体で取得します。

AcapGetCameraCategoryFeatureList()関数相当

def get_camera_category_feature_list(self, pCategoryName : str, nOption : int) -> Tuple[int, acaplib2.ACL_CAM_FEATURE_INFO]:

パラメータ

戻り値

(ret, pList)

---

get_camera_feature_infoメソッド

カメラのFeature 情報をACL_CAM_FEATURE_INFO構造体で取得します。

AcapLib2のAcapGetCameraFeatureInfo()関数相当

def get_camera_feature_info(self, pFeatureName : str, nOption : int) -> Tuple[int, acaplib2.ACL_CAM_FEATURE_INFO]:

パラメータ

戻り値

(ret, pFeatureInfo)

---

get_camera_listスタティックメソッド

AcaPyクラスから制御可能な(GigEカメラのIPアドレス、Ch番号、カメラ名、カメラのシリアル番号)のタプルのリストを取得します。

def get_camera_list() -> List[Tuple[str, int, str, int]]:

戻り値

[(camera_ip, ch, camera_name, serial_no)]

---

get_camera_property_listメソッド

カメラのプロパティ情報をACL_CAM_PROPERTY_LIST構造体で取得します。

AcapLib2のAcapGetCameraPropertyList()関数相当

def get_camera_property_list(self, pCategoryName : str, nOption : int) -> Tuple[int, acaplib2.ACL_CAM_PROPERTY_LIST]:

パラメータ

戻り値

(ret, pPropList)

---

get_enable_board_ch_listスタティックメソッド

AcaPyクラスのインスタンスの引数に渡す事が可能なボード番号とCh番号、ボード名、ボードのシリアル番号のタプルのリストを取得します。

def get_enable_board_ch_list(includes_camera : bool = True) -> List[Tuple[int, int, str, int]]:

パラメータ

戻り値

[(board_id, ch, board_name, serial_no)]

---

get_encoderメソッド

エンコーダ設定値を取得します。

AcapLib2のAcapGetEncoder()関数相当

def get_encoder(self) -> Tuple[int, int, int, int, int, int, int, int, int, int]:

戻り値

(ret, enc_enable, enc_mode, enc_start, enc_phase, enc_direction, z_phase_enable, compare1, compare2, comp2_count)

---

get_encoder_abs_multipointメソッド

絶対カウント・マルチポイント値を取得します。

def get_encoder_abs_multipoint(self, point_no : int) -> Tuple[int, int]:

パラメータ

戻り値

(ret, abs_count)

---

get_external_triggerメソッド

外部トリガの設定を取得します。

AcapLib2のAcapGetExternalTrigger()関数相当

def get_external_trigger(self) -> Tuple[int, int, int, int, int, int]:

戻り値

(ret, exp_trg_en, ext_trg_mode, ext_trg_dly, ext_trg_chatter, timeout)

---

get_frame_noメソッド

入力フレームの情報を取得します。

AcapLib2のAcapGetFrameNo()関数相当

def get_frame_no(self) -> Tuple[int, int, int , int]:

戻り値

(ret, frame_no, line, index)

---

get_gpoutメソッド

GPOUTの状態を取得します。

AcapLib2のAcapGetGPOut()関数相当

def get_gpout(self) -> Tuple[int, int]:

戻り値

(ret, dwOutputLevel)

---

get_image_dataメソッド

リングバッファのIndex番号(0, 1, 2...)を指定し、画像データを取得します。

def get_image_data(self, index : int) -> Union[np.ndarray, None]:

パラメータ

戻り値

image

---

get_infoメソッド

設定IDを指定して、設定値を取得します。

AcapLib2のAcapGetInfo()関数相当

def get_info(self, value_id : int, mem_num : int = 0) -> Tuple[int, int]:

パラメータ

戻り値

(ret, value)

---

get_last_errorメソッド

最後に発生したエラー情報を取得します。

AcapLib2のAcapGetLastErrorCode()関数相当

def get_last_error(self, error_reset : bool = False) -> acaplib2.ACAPERRORINFO:

パラメータ

戻り値

error_info

---

get_last_error_exメソッド

最後に発生したエラー情報を取得します。

AcapLib2のAcapGetLastErrorCodeEx()関数相当

def get_last_error_ex(self, bErrReset : bool) -> acaplib2.ACAPERRORINFOEX:

パラメータ

戻り値

error_info_ex

---

get_line_triggerメソッド

ライントリガの設定を取得します。

AcapLib2のAcapGetLineTrigger()関数相当

def get_line_trigger(self) -> Tuple[int, int, int, int]:

戻り値

(ret, exp_cycle, exposure, exp_pol)

---

get_shutter_triggerメソッド

シャッタトリガの設定を取得します。

AcapLib2のAcapGetShutterTrigger()関数相当

def get_shutter_trigger(self) -> Tuple[int, int, int, int, int, int]:

戻り値

(ret, exp_cycle, exposure, exp_pol, exp_unit, cc_sel)

---

get_strobeメソッド

ストロボの設定を取得します。

AcapLib2のAcapGetStrobe()関数相当

def get_strobe(self) -> Tuple[int, int, int, int]:

戻り値

(ret, strobe_en, strobe_delay, strobe_time)

---

grab_abortメソッド

撮影中の画像（フレーム）取込の完了を待たずに画像入力を停止します。

AcapLib2のAcapGrabAbort()関数相当

def grab_abort(self) -> int:

戻り値

ret

---

grab_startメソッド

画像入力を開始します。

grab_start()メソッドを実行したら、必ずgrab_stop()メソッド、もしくはgrab_abort()メソッドで画像入力を停止させてください。

AcapLib2のAcapGrabStart()関数相当

def grab_start(self, input_num : int = 0) -> int:

パラメータ

戻り値

ret

---

grab_stopメソッド

撮影中の画像（フレーム）取込の完了を待ってから画像入力を停止します。

grab_start()メソッドで取込枚数(input_num)を指定したときは、枚数分の取込完了を待ちます。

AcapLib2のAcapGrabStop()関数相当

def grab_stop(self) -> int:

戻り値

ret

---

hex_to_ip_addressスタティックメソッド

16進数表記のIPアドレスをドット区切りのIPアドレスの文字列へ変換します。

def hex_to_ip_address(hex_value:int) -> str:

パラメータ

戻り値

ip_address

備考

16進数で表記されたIPアドレスを8ビット(2文字分)ごとの10進数の数値に変換し、ドット区切りの文字列へ変換します。

（例）

hex_value = 0xA9FEFAC0のとき

0xA9FEFAC0 → A9.FE.FA.C0 → 169.254.250.192　より

ip_address = '169.254.250.192'

---

ip_address_to_hexスタティックメソッド

IPアドレスの文字列を16進数表記へ変換します。

def ip_address_to_hex(ip_address:str) -> int:

パラメータ

戻り値

hex_value

備考

IPアドレスの各値（4つ）をそれぞれ16進数に変換し、つなげて16進数の値へ変換します。

（例）

ip_address = '169.254.250.192'のとき

169.254.250.192 → A9.FE.FA.C0 → 0xA9FEFAC0

hex_value = 0xA9FEFAC0

---

load_inifileメソッド

ボード設定ファイル（iniファイル）を読込ます。

AcapLib2のAcapSelectFile()関数相当

def load_inifile(self, inifilename : str) -> int:

パラメータ

戻り値

ret

---

opt_link_resetメソッド

Opt-C:Link ボードに対してリンクリセット(再初期化)を行います。

def opt_link_reset(self) -> bool:

戻り値

ret

---

print_last_errorメソッド

最後に発生したエラー情報をコマンドラインに表示します。

def print_last_error(self) -> acaplib2.ACAPERRORINFOEX:

戻り値

error_info

---

readメソッド

grab_startメソッドを実行後、grab_startメソッドを実行するまでの間で実行し、現在の画像データを１フレーム分取得します。

def read(self, copy : bool = False, wait_frame : bool = True) -> Tuple[int, Union[np.ndarray, None], int, int]:

パラメータ

戻り値

(ret, frame, frame_no, line)

---

read_framesメソッド

grab_startメソッドを実行後、grab_stopメソッドを実行するまでの間で実行し、前回取得したフレームの次のフレームから現在取得したフレームまでの画像データをリストで取得します。

カメラのフレームレートが速い場合、取得したフレーム画像が上書きされる場合があります。 その場合、mem_numプロパティの値（リングバッファの画像面数）を大きくしてください。

def read_frames(self, copy : bool = False, wait_frame : bool = True) -> Tuple[int, Union[List[np.ndarray], None], int, int]:

パラメータ

戻り値

(ret, frames, count, frame_no)

---

reflect_paramメソッド

プロパティで設定した値を画像入力ボードに反映します。

AcapLib2のAcapReflectParam()関数相当

def reflect_param(self, force_execution : bool = False) -> int:

パラメータ

戻り値

ret

---

regist_device_alm_callbackメソッド

デバイスアラーム割り込み(ACL_INT_DEVICE_ALM)イベントのコールバック関数を登録します。

登録した関数はサブスレッドで呼び出されます。

device_alm_funcに None を指定すると、コールバック関数の登録は解除されます。

def regist_device_alm_callback(self, device_alm_func):

パラメータ

サンプル

import acapy    # AcaPy

def capture_device_alm(capture, alarm_status):
    '''ACL_INT_DEVICE_ALMのコールバック関数

    Parameters
    ----------
    capture : AcaPy class
        コールバック元のAcaPyクラスオブジェクト
    alarm_status : int
        アラームの内容  
        BIT3 サーマルシャットダウンアラーム
        BIT2 FAN 回転数アラーム
        BIT1 FPGA 温度アラーム
        BIT0 基板周辺温度アラーム
    '''
    # DeviceAlarmがあったときに発生
    print(f"[device_alm callback] board_id={capture.board_id}, ch={capture.ch}, alarm_status={alarm_status}")

# AcaPyクラスのインスタンス
cap = acapy.AcaPy()
# DeviceAlarmのコールバック関数を登録
cap.regist_device_alm_callback(capture_device_alm)

---

regist_frame_end_callbackメソッド

１フレーム入力完了割り込み(ACL_INT_FRAMEEND)イベントのコールバック関数を登録します。

登録した関数はサブスレッドで呼び出されます。

frame_end_funcに None を指定すると、コールバック関数の登録は解除されます。

def regist_frame_end_callback(self, frame_end_func, frame_copy_flag: bool=False):

パラメータ

サンプル

import acapy    # AcaPy

def capture_frame_end(capture, frames, count, total_frame_count, error_info):
    '''ACL_INT_FRAMEENDのコールバック関数

    Parameters
    ----------
    capture : AcaPy class
        コールバック元のAcaPyクラスオブジェクト
    frames : List[ndarray]
        前回の次のフレームから今回のフレームまでの画像データのリスト
    count : int
        リストに格納されたフレームの枚数
    total_frame_count : int
        今回まで取得した全フレーム枚数
    error_info : int
        エラー情報。1のときエラーなし、負のとき上書きされたフレーム枚数
    '''
    # 各フレーム画像の取込が完了したときに発生
    # error_infoの値が負のときは、フレーム画像の上書きが発生しています。
    # 　-> AcaPyクラスのリングバッファの面数(mem_numプロパティの値)を多くしてください。
    print(f"[frame_end callback] board_id={capture.board_id}, ch={capture.ch}, FrameNo={total_frame_count}, count={count}, error_info={error_info}")

# AcaPyクラスのインスタンス
cap = acapy.AcaPy()
# FrameEndのコールバック関数を登録
cap.regist_frame_end_callback(capture_frame_end)

---

regist_grab_end_callbackメソッド

入力終了割り込み(ACL_INT_GRABEND)イベントのコールバック関数を登録します。

登録した関数はサブスレッドで呼び出されます。

grab_end_funcに None を指定すると、コールバック関数の登録は解除されます。

def regist_grab_end_callback(self, grab_end_func):

パラメータ

サンプル

import acapy    # AcaPy

def capture_grab_end(capture):
    '''ACL_INT_GRABENDのコールバック関数

    Parameters
    ----------
    capture : AcaPy class
        コールバック元のAcaPyクラスオブジェクト
    '''
    # grab_start()メソッドで枚数指定分の画像取込が完了したときに発生
    print(f"[grab_end callback] board_id={capture.board_id}, ch={capture.ch}")

# AcaPyクラスのインスタンス
cap = acapy.AcaPy()
# GrabEndのコールバック関数を登録
cap.regist_grab_end_callback(capture_grab_end)

---

regist_gpin_callbackメソッド

GPIN 割り込み (ACL_INT_GPIN)イベントのコールバック関数を登録します。

登録した関数はサブスレッドで呼び出されます。

gpin_funcに None を指定すると、コールバック関数の登録は解除されます。

def regist_gpin_callback(self, gpin_func):

パラメータ

サンプル

import acapy    # AcaPy

def capture_gpin(capture, gpin_polarity):
    '''ACL_INT_GPINのコールバック関数

    Parameters
    ----------
    capture : AcaPy class
        コールバック元のAcaPyクラスオブジェクト
    gpin_polarity : int
        GPINのレベル
    '''
    # GPINの入力があったときに発生
    print(f"[gpin callback] board_id={capture.board_id}, ch={capture.ch}, gpin_polarity={gpin_polarity}")

# AcaPyクラスのインスタンス
cap = acapy.AcaPy()
# GPINのコールバック関数を登録
cap.regist_gpin_callback(capture_gpin)

---

regist_overwrite_callbackメソッド

バッファオーバーフロー(リングバッファのメモリが１周以上したことによる画像データの上書き)イベントのコールバック関数を登録します。

登録した関数はサブスレッドで呼び出されます。

overwrite_funcに None を指定すると、コールバック関数の登録は解除されます。

def regist_overwrite_callback(self, overwrite_func):

パラメータ

サンプル

import acapy    # AcaPy

def capture_overwrite(capture, count, total_frame_count, overwrite_count):
    '''オーバーライトのコールバック関数

    Parameters
    ----------
    capture : AcaPy class
        コールバック元のAcaPyクラスオブジェクト
    count : int
        前回から今回まで取得した画像の枚数
    total_frame_count : int
        取込開始から取得した画像の総枚数
    overwrite_count : int
        上書きされた画像の枚数
    '''
    # Overwrite(画像データの上書き)が発生したときに発生
    print(f"[overwrite callback] board_id={capture.board_id}, ch={capture.ch}")

# AcaPyクラスのインスタンス
cap = acapy.AcaPy()
# Overwrite(画像データの上書き発生)のコールバック関数を登録
cap.regist_overwrite_callback(capture_overwrite)

---

regist_timeout_callbackメソッド

タイムアウト(ACL_INT_TIMEOUT)イベントのコールバック関数を登録します。

登録した関数はサブスレッドで呼び出されます。

timeout_funcに None を指定すると、コールバック関数の登録は解除されます。

def regist_timeout_callback(self, timeout_func):

パラメータ

サンプル

import acapy    # AcaPy

def capture_timeout(capture):
    '''ACL_INT_TIMEOUTのコールバック関数

    Parameters
    ----------
    capture : AcaPy class
        コールバック元のAcaPyクラスオブジェクト
    '''
    # Timeoutがあったときに発生
    print(f"[timeout callback] board_id={capture.board_id}, ch={capture.ch}")

# AcaPyクラスのインスタンス
cap = acapy.AcaPy()
# Timeoutのコールバック関数を登録
cap.regist_timeout_callback(capture_timeout)

---

releaseメソッド

AcaPyクラス内部のリソースを解放します。

dispose()メソッドと同等です。

def release(self):

---

save_inifileメソッド

ボードに設定されている値をiniファイルに保存します。

AcapLib2のAcapSelectFile()関数相当

def save_inifile(self, inifilename : str) -> int:

パラメータ

戻り値

ret

---

serial_closeメソッド

シリアル通信のポートをクローズします。

AcapLib2のAcapSerialClose()関数相当

def serial_close(self) -> int:

戻り値

ret

---

serial_get_parameterメソッド

シリアル通信の設定を取得します。 serial_open()メソッドにてシリアルポートをオープン後に行ってください。

AcapLib2のAcapSerialGetParameter()関数相当

def serial_get_parameter(self) -> Tuple[int, int, int, int, int, int]:

戻り値

(ret, baud_rate, data_bit, parity, stop_bit, flow)

---

serial_openメソッド

シリアル通信のポートをオープンします。

AcapLib2のAcapSerialOpen()関数、AcapSerialSetParameter()関数相当

def serial_open(self, baud_rate : int = 9600, data_bit : int = 8, parity : int = 0, stop_bit : int = 0, flow : int = 0) -> int:

パラメータ

戻り値

ret

---

serial_readメソッド

シリアル通信コマンドの受信を行います。 受信はデータが空になるか、stop_bit、タイムアウトになるまで行われます。

AcapLib2のAcapSerialRead()関数相当

def serial_read(self, asc : bool = True, time_out : int = 100, buffer_size : int = 511, end_str : Union[str, None] = None) -> Tuple[int, str, int]:

パラメータ

戻り値

(ret, read_command, read_bytes)

---

serial_writeメソッド

指定した文字コードでコマンドの書込み(送信)を行います。 AcapLib2のAcapSerialWrite()関数相当

def serial_write(self, write_command : str, asc : bool = True, start_str : str = ””, end_str : str = "\r") -> int:

パラメータ

戻り値

ret

---

set_bit_assign_exメソッド

シリアル通信の設定を取得します。

AcapLib2のAcapSetBitAssignEx()関数相当

def set_bit_assign_ex(self, bit_assign_info : acaplib2.BITASSIGNINFO) -> int:

パラメータ

戻り値

ret

---

set_encoderメソッド

エンコーダの設定を行います。 AcapLib2のAcapSetEncoder()関数相当

def set_encoder(self, enc_enable : int, enc_mode : int, enc_start : int, enc_phase : int, enc_direction : int, z_phase_enable : int, compare1 : int, compare2 : int) -> int:

パラメータ

戻り値

ret

---

set_encoder_abs_multipointメソッド

絶対カウントマルチポイントの値を設定します。

def set_encoder_abs_multipoint(self, point_no : int, abs_count : int) -> int:

パラメータ

戻り値

ret

---

set_external_triggerメソッド

外部トリガの種別、検出方法などを設定します。 AcapLib2のAcapSetExternalTrigger()関数相当

def set_external_trigger(self, exp_trg_en : int, ext_trg_mode : int, ext_trg_dly : int, ext_trg_chatter : int, timeout : int) -> int:

パラメータ

戻り値

ret

---

set_gpoutメソッド

GPOUT ピンの出力を制御します。 AcapLib2のAcapSetGPOut()関数相当

 def set_gpout(self, output_level : int) -> int:

パラメータ

戻り値

ret

---

set_infoメソッド

設定IDを指定して、設定値を設定します。 プロパティに同様の設定値がある場合は設定しないでください。

AcapLib2のAcapSetInfo()関数相当

def set_info(self, value_id : int, value : int, mem_num : int = -1) -> int:

パラメータ

戻り値

ret

---

set_line_triggerメソッド

ラインセンサへ出力するCC 信号の周期・幅を設定します。 AcapLib2のAcapSetLineTrigger()関数相当

def set_line_trigger(self, exp_cycle : int, exposure : int, exp_pol : int) -> int:

パラメータ

戻り値

ret

---

set_power_supplyメソッド

カメラへの電源供給を制御します。

def set_power_supply(self, value : int, wait_time : int = 6000) -> int:

パラメータ

戻り値

ret

---

set_shutter_triggerメソッド

エリアセンサシャッタトリガを設定します。

AcapLib2のAcapSetShutterTrigger()関数相当

def set_shutter_trigger(self, exp_cycle : int, exposure : int, exp_pol : int, exp_unit : int, cc_sel : int) -> int:

パラメータ

戻り値

ret

---

set_strobeメソッド

ストロボを設定します。

AcapLib2のAcapSetStrobe()関数相当

def set_strobe(self, strobe_en : int, strobe_delay : int, strobe_time : int) -> int:

パラメータ

戻り値

ret

---

snapメソッド

画像を１枚取込みます。

高速に連続取込する場合は、grabをお使い下さい。（参照：Snap sample）

regist_frame_end_callback()メソッドにより、コールバック関数が登録されている場合、戻り値で取得した画像データ(frame)はNoneになるため、登録したコールバック関数内にて画像データを取得してください。

def snap(self, copy : bool = False) -> Tuple[int, Union[np.ndarray, None]]:

パラメータ

戻り値

(ret, frame)

---

wait_frame_endメソッド

１フレーム分の画像取込完了を待ちます。

AcapLib2のAcapWaitEvent()関数のACL_INT_FRAMEEND相当

def wait_frame_end(self, timeout : int = -1) -> int:

パラメータ

戻り値

ret

---

wait_grab_endメソッド

画像入力終了割り込みを待ちます。

AcapLib2のAcapWaitEvent()関数のACL_INT_GRABEND相当

def wait_grab_end(self, timeout : int = -1) -> int:

パラメータ

戻り値

ret

---

wait_grab_startメソッド

画像入力開始割り込みを待ちます。

AcapLib2のAcapWaitEvent()関数のACL_INT_GRABSTART相当

def wait_grab_start(self, timeout : int = -1) -> int:

パラメータ

戻り値

ret

---

wait_gpinメソッド

GPIN 割り込みを待ちます。

AcapLib2のAcapWaitEvent()関数のACL_INT_GPIN相当

def wait_gpin(self, timeout : int = -1) -> int:

パラメータ

戻り値

ret

---

Structure

---

ACAPERRORINFOEX構造体

拡張エラー情報

メンバー

---

ACL_BUFF_INFO_DIVIDE構造体

バッファ分割DMA設定

メンバー

---

ACL_BUFF_INFO_RESIZE構造体

サイズ違い DMA設定

メンバー

---

ACL_BUFF_INFO_ROI構造体

サイズ違い DMA設定

メンバー

---

ACL_CAM_FEATURE_INFO構造体

カメラ設定値情報

メンバー

---

ACL_CAM_FEATURE_LIST構造体

カメラ設定値構造(リスト)情報

メンバー

---

ACL_CAM_PROPERTY_LIST構造体

カメラ設定値配列情報

メンバー

---

CameraControl Class

カメラパラメータの取得／設定用クラスです。

AcaPy Ver.1.1.0において、CoaXPressカメラのみの対応となります。

Examples

AcaPyクラスのインスタンスからCameraControlクラスをインスタンスし、AcaPyクラスオブジェクトで接続されているカメラに対して、カメラの設定を行います。

import sys

import acapy    # AcaPyクラス
from acapy import cameracontrol as cam # カメラ設定用

# **************************************************************
# AcaPyクラスのインスタンス(ボードの設定を行う)
# **************************************************************
capture = acapy.AcaPy()

if capture.is_opened is False:
    # 画像入力ボードが見つからないときは終了
    capture.dispose()
    print("Board or Camera not recognized.")
    sys.exit(0)

# iniファイル（ボード設定ファイル）の読込、AcapLib2のiniファイルと共通です。
# iniファイルは実際に使用するカメラ用のファイルを指定してください。
ret = capture.load_inifile("./AreaSensor_mono.ini")

# ボードの設定例（AcaPyクラスのプロパティで値を設定）
capture.width = 640
capture.height = 480

# プロパティの値を設定したときは、reflect_param()メソッドの実行が必要になります。
capture.reflect_param() 

# ボードの設定をiniファイルに保存
capture.save_inifile("./AreaSensor_mono_save.ini")

# ボードの設定値の取得例（AcaPyクラスのプロパティで値を取得）
capture_width = capture.width   # 画像の幅
capture_height = capture.height # 画像の高さ
capture_camera_bit = capture.camera_bit # 画像のビット数

print("-------------------------------------------------")
# 取込む画像情報を表示
print(f"Capture Image Info: {capture_width} x {capture_height} x {capture_camera_bit}bit")
print("[Capture properties]")
# ボードに設定されている値一覧を表示
print(capture.get_acapy_properties_text())

# **************************************************************
# CameraControlクラスのインスタンス(カメラの設定を行う)
# **************************************************************
# AcaPyクラスオブジェクトからCameraControl用クラスをインスタンスする
camera = cam.CameraControl(capture)

# カメラの設定例（set_value(設定値の文字列, 値)を指定して設定）
ret = camera.set_value('Width', 640)
ret = camera.set_value('Height', 480)
# Commandの実行例(set_value(設定値の文字列))、設定値のカメラへの保存例
#ret = camera.set_value('UserSetSave')

# カメラ設定値の取得例（get_value(設定値の文字列)を実行して取得）
ret, camera_width, value_info = camera.get_value('Width')
ret, camera_height, value_info = camera.get_value('Height')
ret, camera_pixelformat, value_info = camera.get_value('PixelFormat')

print("-------------------------------------------------")
# カメラの画像情報を表示
print(f"Camera Image Info: {camera_width} x {camera_height} x {camera_pixelformat}")
print("[Camera setting]")

# カメラに設定されている値一覧を表示
print(camera.get_camera_category_feature_text())

# **************************************************************
# 画像の取込
# **************************************************************
ret, img = capture.snap()
if ret == acapy.AcaPy.OK:
    # 画像が取得できたとき
    print(img)

capture.dispose() # AcaPyクラスのリソースの解放

---

Constructors

AcaPyクラスのインスタンスからCameraControlクラスをインスタンスします。

def __init__(self, acapy_obj : acapy.AcaPy, visibility : Visibility = Visibility.Invisible, serial_read_wait_time : float = 0):

パラメータ

---

Properties

---

Methods

---

get_camera_category_feature_textメソッド

カメラに設定されている値一覧のテキストを取得します。

def get_camera_category_feature_text(self, visibility : Visibility = None, description_enabled : bool = False) -> str:

パラメータ

戻り値

ret

---

get_camera_feature_listメソッド

カメラに設定されている値一覧をリストで取得します。

def get_camera_feature_list(self, visibility : Visibility = None) -> List[ValueInfo]:

パラメータ

戻り値

ret

---

get_valueメソッド

カメラから値を取得します。

def get_value(self, value_name : str) -> Tuple[bool, Union[int, float, str, bool, None], Union[ValueInfo, None]]:

パラメータ

戻り値

(ret, value, value_info)

---

set_valueメソッド

カメラに値を設定します。

設定値が Command の場合、value_nameのみを指定してください。(valueは指定しない)

def set_value(self, value_name : str, value : Union[int, float, str, bool, None] = None) -> bool:

パラメータ

戻り値

ret

---

serial_readメソッド

シリアル通信コマンドの受信を行います。 受信はデータが空になるまで、stop_bitになるまで、タイムアウトになるまで行われます。

AcapLib2のAcapSerialRead()関数相当

def serial_read(self, asc : bool = True, time_out : int = 100, buffer_size : int = 511, end_str : Union[str, None] = None) -> Tuple[int, str, int]:

パラメータ

戻り値

(ret, read_command, read_bytes)

---

serial_writeメソッド

指定した文字コードでコマンドの書込み(送信)を行います。 AcapLib2のAcapSerialWrite()関数相当

def serial_write(self, write_command : str, asc : bool = True, start_str : Union[str, None] = None, end_str : Union[str, None] = "\r") -> int:

パラメータ

戻り値

ret

---

Enum

---

AccessMode列挙型

設定値のアクセスモードを設定します。

フィールド

---

FeatureType列挙型

カメラ設定値の種類を設定します。

フィールド

---

Visibility列挙型

カメラ設定のユーザーレベル（表示レベル）を設定します。

フィールド

---

Dataclass

ValueInfo class

設定値情報

---

GraphicsBox Class

tkinterのCanvasクラスを継承した、tkinter用画像表示ウィジェットとなります。

Constructors

---

Properties

Methods

---

dest_to_src_xyメソッド

表示している画像のウィジェット上の座標（ウィジェットの左上が原点）から、画像の座標へ変換します。

def dest_to_src_xy(self, xy : Tuple[float, float]) -> Tuple[float, float]:

パラメータ

戻り値

(x, y)

---

draw_imageメソッド

画像データをウィジェットに表示します。 表示可能なのは8bit,24bit,32bitの画像のみとなります。

def draw_image(self, image : Union[Image.Image, np.ndarray])　-> int:

パラメータ

戻り値

id

---

redraw_imageメソッド

画像を再描画します。

def redraw_image(self):

---

reset_transformメソッド

クラス内部で使用している画像表示用アフィン変換行列をセット（単位行列にする）します。 リセット後に画像を表示すると、画像はウィジェットの左上に等倍（倍率が１）で表示されます。

def reset_transform(self):

---

scale_atメソッド

指定した座標（ウィジェットの座標）を中心に画像を拡大縮小します。

def scale_at(self, scale:float, cx:float, cy:float):

パラメータ

---

scale_transformメソッド

原点（ウィジェットの左上）を中心に画像を拡大縮小します。

def scale_transform(self, scale:float):

パラメータ

---

src_to_dest_xyメソッド

表示している画像上の座標から、ウィジェット上の座標へ変換します。

def src_to_dest_xy(self, xy : Tuple[float, float]) -> Tuple[float, float]:

パラメータ

戻り値

(x, y)

---

translateメソッド

画像の表示位置を指定した大きさ（ウィジェット上の距離）で平行移動します。

def translate(self, offset_x : float, offset_y : float):

パラメータ

---

zoom_fitメソッド

画像全体がウィジェット全体に表示されるように表示位置、倍率を調整します。

def zoom_fit(self, image_width : int, image_height : int):

パラメータ

---

Changelog

Ver.1.2.0

【主な変更内容】

• AcapLib2のバージョンアップ(Ver.8.3.0)に伴うAVALDATA社製GigEカメラ対応の修正

【acapy変更点】

• 下記、メソッドの追加 get_camera_list(), release(), get_boardInfo256(), hex_to_ip_address(), ip_address_to_hex()

• 下記、メソッドの変更

  __init__(), get_enable_board_ch_list()

• 下記、プロパティの追加 camera_control

• 下記、プロパティの変更

  tap_arrange_x_size

• 追加／修正

  • AcaPyクラスのインスタンス時にget_enable_board_ch_list(), get_camera_list()で取得したタプルを指定し、インスタンスできるように追加
  • AcaPyクラスのインスタンス時にIPアドレスの文字列を指定し、固定IPでGigEカメラを指定できるように追加
  • AcaPyクラスのインスタンス時に"GigE"の文字列を指定すると最初にみつけたGigEカメラを指定できるように追加
  • AcaPyクラスのインスタンス時にボード一覧の取得をAcapGetBoardInfoEx()からAcapGetBoardInfoEx256()に変更
  • AcaPyクラスのインスタンス時にCameraControlクラスをインスタンス。 クラスオブジェクトはcamera_controlプロパティにて取得
  • widthプロパティ設定時にtap_arrange_x_sizeプロパティにも同じ値を設定 tap_arrange_x_sizeプロパティに独自の値を設定する場合は、width → tap_arrange_x_sizeの順で設定すること

• バグ修正

  • get_enable_board_ch_list()メソッドのボード名（pBoardName）が取得できていないバグを修正

【GraphicsBox変更点】

• プロパティ名の修正 profile_hight を profile_height に修正

---

Ver.1.1.0

【主な変更内容】

• AcapLib2のバージョンアップ(Ver.8.2.0)に伴うCoaXPressボード対応の修正
• コールバック関数の対応

【acapy変更点】

• 関数名の変更 ・refrect_param() から reflect_param() へ変更

• 下記、メソッドの追加

  get_bit_assign_ex(), get_camera_category_feature_list(), get_camera_feature_info(), get_camera_property_list(), get_last_error_ex(), get_acapy_properties_text(), regist_frame_end_callback(), regist_grab_end_callback(), regist_gpin_callback(), regist_overwrite_callback(), regist_timeout_callback(), regist_device_alm_callback(), get_enable_board_ch_list(), set_bit_assign_ex(), dispose()

• 以下、メソッドの削除

  print_acapy_values()

• 下記、構造体の追加

  ACL_CAM_FEATURE_INFO, ACL_CAM_PROPERTY_LIST, ACL_CAM_FEATURE_LIST, ACAPERRORINFOEX

• 以下、プロパティの追加

  connection_num, data_mask_ex, debug_print_enabled, encoder_rlt_all_count, encoder_rlt_count, external_trigger_polarity, fan_rpm, port_a_assign, port_b_assign, port_c_assign, port_d_assign, port_e_assign, port_f_assign, port_g_assign, port_h_assign, port_i_assign, port_j_assign, serial_read_wait_time, tag, alarm_status, cxp_camlink_timeout, cxp_bdlink_timeout, freq_d, freq_e, freq_f, freq_g, freq_h, freq_opt1, freq_opt2, freq_opt3, freq_opt4, freq_opt5, freq_opt6, freq_opt7, freq_opt8, freq_ttl3, freq_ttl4, freq_ttl5, freq_ttl6, freq_ttl7, freq_ttl8, tap_direction9, tap_direction10, cxp_phy_error_count, frame_no, line_no

• 以下、プロパティの削除

  cxp_acquision_start_address, cxp_acquision_start_value, cxp_acquision_stop_address, cxp_acquision_stop_value

• バグ修正

  ・read_frames()メソッドにおいて、grab_start()メソッドの初回起動時に不要なoverwriteのワーニングが発生してしまうのを修正

【cameracontrolクラスの新規追加】

カメラパラメータの取得／設定用クラスの新規追加 本バージョン（Ver.1.1.0）においては、CoaXPressカメラのみ対応

【graphicsbox変更点】

ソースコード上のワーニング修正

【acaplib2(AcapLib2関数定義ファイル)変更点】

• CoaXPressボードにてカメラパラメータの取得／設定をサポート

• 下記、関数の追加

  AcapSerialWriteBinary(), AcapSerialReadBinary(), AcapGetCameraCategoryFeatureList() AcapGetCameraFeatureInfo(), AcapGetCameraPropertyList(), AcapGetLastErrorCodeEx() AcapRegistCallback()

• 下記、構造体の追加

  ACL_CAM_FEATURE_INFO, ACL_CAM_PROPERTY_LIST, ACL_CAM_FEATURE_LIST, ACAPERRORINFOEX

• 下記、定数の追加

  ACL_PORT_A_ASSIGN, ACL_PORT_B_ASSIGN, ACL_PORT_C_ASSIGN, ACL_PORT_D_ASSIGN, ACL_PORT_E_ASSIGN, ACL_PORT_F_ASSIGN, ACL_PORT_G_ASSIGN, ACL_PORT_H_ASSIGN, ACL_PORT_I_ASSIGN, ACL_PORT_J_ASSIGN, ACL_DATA_MASK_EX, ACL_EXT_POL, ACL_DATA_MASK_EX, ACL_CXP_ACQUISITION_CONTROL, ACL_EXT_POL, ACL_CXP_CONNECTION_NUM, ACL_CXP_TAPGEOMETRY, ACL_CXP_STREAM1_ID, ACL_CXP_STREAM2_ID, ACL_CXP_STREAM3_ID, ACL_CXP_STREAM4_ID, ACL_CXP_STREAM5_ID, ACL_CXP_STREAM6_ID, ACL_CXP_CAMLINK_TIMEOUT, ACL_CXP_BDLINK_TIMEOUT, ACL_ALM_THERMAL, ACL_ALM_FAN, ACL_ALM_FPGA_TEMP, ACL_ALM_BOARD_TEMP ACL_CXP_TAPGEOMETRY_1X_1Y, ACL_CXP_TAPGEOMETRY_1X_2YE_SINGLE, ACL_CXP_TAPGEOMETRY_1X_2YE_MULTI, ACL_FREQ_E, ACL_FREQ_F, ACL_FREQ_G, ACL_FREQ_H, ACL_ALARM_STATUS, ACL_FAN_RPM, ACL_INT_DEVICE_ALM, ACL_3300_INTERNAL_GEN_LIBRARY_ERROR, ACL_GET_CAMERA_ACCESS_ERROR, ACL_CAMERA_ACCESS_ERROR, ACL_NOT_SUPPORT_ERROR, ACL_3400_ERROR_ID, ACL_36124_ERROR_ID, ACL_3666_ERROR_ID, ACL_36121_ERROR_ID, ACL_BD_ERR_K_CODE_CAL, ACL_BD_ERR_STREAM_SIZE, ACL_BD_ERR_DP_END, ACL_BD_ERR_DP_START, ACL_BD_ERR_DP_DUP, ACL_BD_ERR_PACKET_LOSS, ACL_BD_ERR_CMD_ACK_FIFO_O, ACL_BD_ERR_IMD_FIFO_U, ACL_BD_ERR_IMD_FIFO_O, ACL_BD_ERR_IMH_FIFO_U, ACL_BD_ERR_IMH_FIFO_O, ACL_BD_ERR_STREAM_FIFO_O, ACL_BD_ERR_DISPARITY, ACL_BD_ERR_8B10B_CODE, ACL_BD_ERR_STRAM_CRC, ACL_BD_ERR_ACK_CRC, ACL_BD_ERR_ENC_LINE, ACL_BD_ERR_ENC, ACL_BD_ERR_FRAME, ACL_BD_ERR_LINE, ACL_BD_ERR_SCAN, ACL_CXP_PHY_ERROR_COUNT, ACL_FRAME_NO, ACL_LINE_NO

---

Ver.1.0.0

初版