v24.9.6861

最初にお読みください


この書類およびサンプルコードは浜松ホトニクス株式会社(以下HPK)の内部文書であり、DCAM-APIを使ってホストソフトウエアソフトウエアを作成するユーザーの要求で開示されます。
上記目的に従い、所有者はこの書類およびサンプルコードに対してライセンス/転送などの権利を有しません。
この書類に基づいて開発されたソフトウエアを使って発生するいかなる損害もユーザーの責任となります。
この書類には技術的または記述上の誤りが含まれる可能性がありますが、HPKはそれらに伴う損害を補償しません。
HPKはこの書類に含まれる情報が更新された場合に通知は行いません。
ブランド名ならびに製品名は商標または登録商標です。
HPKの許可無く、本書類の一部または全部の複製/翻訳/意訳を認めません。

このチャプターの先頭へ戻る


概要


この書類は浜松ホトニクス社製 Flat Panel Sensor でサポートされるパラメータを Property でどのように操作するかを説明します。 この書類は DCAM-API ならびに SDK について基本的な知識がある事を前提に書かれています。 DCAM-API ならびに SDK の概念や関数についての使い方は別書類をご参照ください。

このチャプターの先頭へ戻る


Scan Mode

Fine Mode (1x1 Mode)
DCAM_IDPROP_SENSORMODE
R/W
MODE
DCAMPROP_SENSORMODE__AREA
DCAM_IDPROP_BINNING
R/W
MODE
DCAMPROP_BINNING__1
Fast Mode (2x2 Mode)
DCAM_IDPROP_SENSORMODE
R/W
MODE
DCAMPROP_SENSORMODE__AREA
DCAM_IDPROP_BINNING
R/W
MODE
DCAMPROP_BINNING__2
4x4 Mode
DCAM_IDPROP_SENSORMODE
R/W
MODE
DCAMPROP_SENSORMODE__AREA
DCAM_IDPROP_BINNING
R/W
MODE
DCAMPROP_BINNING__4
Panoramic Mode
DCAM_IDPROP_SENSORMODE
R/W
MODE
DCAMPROP_SENSORMODE__PANORAMIC
DCAM_IDPROP_BINNING
R/W
MODE
DCAMPROP_BINNING__1
DCAM_IDPROP_SENSORMODE_PANORAMICSTARTV
R/W
LONG
n 設定範囲についてはチャプター"Camera Info"をご参照ください。
Rectangular binning Panoramic Mode (Rtbin Panoramic Mode)
DCAM_IDPROP_SENSORMODE
R/W
MODE
DCAMPROP_SENSORMODE__PANORAMIC
DCAM_IDPROP_BINNING
R/W
MODE
DCAMPROP_BINNING__1_2
DCAM_IDPROP_SENSORMODE_PANORAMICSTARTV
R/W
LONG
n 設定範囲についてはチャプター"Camera Info"をご参照ください。
Partial Mode
DCAM_IDPROP_SENSORMODE
R/W
MODE
DCAMPROP_SENSORMODE__PARTIALAREA
DCAM_IDPROP_BINNING
R/W
MODE
DCAMPROP_BINNING__2
1x2 Mode
DCAM_IDPROP_SENSORMODE
R/W
MODE
DCAMPROP_SENSORMODE__AREA
DCAM_IDPROP_BINNING
R/W
MODE
DCAMPROP_BINNING__1_2
2x4 Mode
DCAM_IDPROP_SENSORMODE
R/W
MODE
DCAMPROP_SENSORMODE__AREA
DCAM_IDPROP_BINNING
R/W
MODE
DCAMPROP_BINNING__2_4

このチャプターの先頭へ戻る


Trigger Mode

Internal Trigger Mode
DCAM_IDPROP_TRIGGERSOURCE
R/W
MODE
DCAMPROP_TRIGGERSOURCE__INTERNAL
DCAM_IDPROP_EXPOSURETIME
R/W
REAL
Exposuretime(sec) 設定範囲については個別のデータシートをご参照ください。
External Trigger Mode
DCAM_IDPROP_TRIGGERSOURCE
R/W
MODE
DCAMPROP_TRIGGERSOURCE__EXTERNAL

このチャプターの先頭へ戻る


Flexible Partial Mode

一部のカメラにはFlexible Partial Mode(以下FPM)が搭載されています。この機能に対応しているカメラについては"Camera Info"をご参照ください。 DCAMには標準でSUBARRAYMODEが存在しており、FPMはその機能を使用したものです。 そのためFPMの設定方法自体はSUBARRAYMODEと変わりません。 具体的にはSUBARRAYMODEの設定をすることでFPMに対応しているカメラではFPMとして、非対応のカメラではSUBARRAYMODEとして動作します。 SUBARRAYMODEの詳細な使用方法については"property_reference.html"をご参照ください。 FPMとSUBARRAYMODEの違いはどの段階で画像の切り出しが行われるかという点です。 FPMの場合はカメラが蓄積電荷を読み出す段階でエリア選択を行います。 SUBARRAYMODEの場合はカメラから画像データを受け取ってからDCAMが選択エリアでの切り出しを行います。 このため、FPMではVSIZEに応じてフレームレートの上限が変動します(フレームレートの計算式はカメラ個別のデータシートをご参照ください)が、SUBARRAYMODEではVSIZEを変えてもフレームレートの上限は変わりません。
Flexible Partial Mode
DCAM_IDPROP_SUBARRAYMODE
R/W
MODE
DCAMPROP_SUBARRAYMODE__OFF (default)
DCAMPROP_SUBARRAYMODE__ON
DCAM_IDPROP_SUBARRAYHSIZE
R/W
LONG
n 設定範囲についてはチャプター"Camera Info"をご参照ください。1x1/1x2Modeの場合は8の倍数で、2x2/2x4/4x4Modeの場合は16の倍数で設定してください。
DCAM_IDPROP_SUBARRAYVSIZE
R/W
LONG
n 設定範囲についてはチャプター"Camera Info"をご参照ください。1x2/2x2Modeの場合は2の倍数で、2x4/4x4Modeの場合は4の倍数で設定してください。
DCAM_IDPROP_SUBARRAYHPOS
R/W
LONG
n 設定範囲についてはチャプター"Camera Info"をご参照ください。1x1/1x2/4x4Modeの場合は8の倍数で、2x2/2x4Modeの場合は16の倍数で設定してください。
DCAM_IDPROP_SUBARRAYVPOS
R/W
LONG
n 設定範囲についてはチャプター"Camera Info"をご参照ください。1x2/2x2Modeの場合は2の倍数で、2x4Modeの場合は4の倍数で、4x4Modeの場合は16の倍数で設定してください。

このチャプターの先頭へ戻る


Selectable Gain Mode

C14406DK-81、C14408DK-50、C14409DK-52にはGain切替モードが搭載されています。 GainはDCAM_IDPROP_CONTRASTGAINで設定してください。 各Gainは原則、High=0, Middle=1, Low=2 となっており、デフォルトはHigh Gainモードになっています。詳細は個別のデータシートをご参照ください。
Selectable Gain Mode
DCAM_IDPROP_CONTRASTGAIN
R/W
MODE
0 to 2 High Gain = 0(Default), Middle Gain = 1, Low Gain = 2

このチャプターの先頭へ戻る


Device Buffer Mode

一部のカメラにはDevice Buffer Modeが搭載されています。 この機能はデフォルトでは無効となっています。これを有効にすると、画像はカメラ内部のバッファメモリに保持され、途中フレームの取りこぼしが発生した場合、撮影終了後に自動的にメモリから再転送を行います。 なお撮影中の再転送には対応しておりません。 この機能はSNAPモードでのみ有効でSEQUENCEモードでは使用できませんので、必ずdcamcap_start()関数の引数としてDCAMCAP_START_SNAPを指定してください。 SNAPSHOTにした場合、DCAMWAIT_CAPEVENT_CYCLEEND発行後にフレームを再転送します。 SNAPSHOTEXにした場合、DCAMWAIT_CAPEVENT_CYCLEEND発行前(取得指定枚数前に撮影が停止した場合)でも、dcamcap_stop()時点までの取りこぼしフレームを再転送します。 SNAPSHOTは互換性のために残しているモードのため、特に理由がない限りSNAPSHOTEXを使用してください。 注意点として、バッファメモリの最大保持フレーム数には上限があります。 そのため、dcambuf_alloc()関数の引数として指定されたframecountの値がDCAM_IDPROP_DEVICEBUFFER_FRAMECOUNTMAXの値以下、もしくはdcambuf_attach()関数使用時はDCAMBUF_ATTACH 構造体で指定するbuffercountの値以下である必要があります。 FRAMECOUNTMAXの値は各カメラの有効画素サイズによって異なります。 詳細は"Camera Info"をご参照ください。 また、Device Buffer Modeについては"property_reference.html"にも説明があるのでそちらも合わせてご参照ください。
Device Buffer Mode
DCAM_IDPROP_DEVICEBUFFER_MODE
R/W
MODE
DCAMPROP_DEVICEBUFFER_MODE_THRU (disable:defalt)
DCAMPROP_DEVICEBUFFER_MODE_SNAPSHOT (enable)
DCAMPROP_DEVICEBUFFER_MODE_SNAPSHOTEX (enable)
DCAM_IDPROP_DEVICEBUFFER_FRAMECOUNTMAX
R/O
LONG
n カメラ毎の数値についてはチャプター"Camera Info"をご参照ください。

このチャプターの先頭へ戻る


Primary Buffer


この機能でPCのインターフェースドライバで確保するリングバッファの使用量を設定することができます。 リングバッファの使用量を増やすことでロストフレームの発生を抑制できる可能性があります。 PRIMARYBUFFER_TOTALBYTESで指定する際はByte単位で、PRIMARYBUFFER_TOTALBYTES_MBで指定する際はMByte単位となっています。 PRIMARYBUFFER_TOTALBYTESは互換性のために残しているモードのため、特に理由がない限りPRIMARYBUFFER_TOTALBYTES_MBを使用してください。 なお、PRIMARYBUFFER_TOTALBYTES(_MB )を無指定 or 0 に設定した場合、Defaultの値(フレーム100枚分のバッファ)を確保します。 Primary BufferはPC上のメモリを使用するため、必要以上に割り当てないようにしてください。PCのパフォーマンスに影響する可能性があります。
Product DCAM_IDPROP_PRIMARYBUFFER_TOTALBYTES DCAM_IDPROP_PRIMARYBUFFER_TOTALBYTES_MB
R/W LONG R/W LONG
C10500D-43 0 to 2000000000 0 to (2000 or 50% of PC memory(MB))
C10502D-43
C10900D-40
C10901D-40
C12902D-40
C12903D-40
C14400DK-41
C14401DK-41
C14406DK-81
C10500D-70 0 to (8191 × Value of DCAM_IDPROP_IMAGE_FRAMEBYTES) *Up to 2000000000 0 to (8191 × Value of DCAM_IDPROP_IMAGE_FRAMEBYTES/1000000)
C12504D-56
C10502D-70
C12505D-56
C14400DK-51
C14400DK-52
C14408DK-50
C14409DK-52
C16401SK-51

このチャプターの先頭へ戻る


Camera Info


Flexible Partial Mode 非搭載カメラ
Scan mode ( A:available N/A:not available ) PANORAMICSTARTV value range
Product Fine(1x1) Fast(2x2) Panoramic Rtbin Panoramic Partial
C10500D-43 N/A N/A N/A N/A N/A N/A
C10500D-70 N/A N/A A A N/A N/A
C12504D-56 N/A N/A A A N/A N/A
C10502D-43 N/A N/A N/A N/A N/A N/A
C10502D-70 N/A N/A A A N/A N/A
C10505D-56 N/A N/A A A N/A N/A
C10900D-40 A A A N/A A 0 to 1160
C10901D-40 A A A N/A N/A N/A
C12902D-40 A A A A N/A 0 to 938
C12903D-40 A A A A N/A 0 to 1152
C14408DK-50 A A N/A N/A N/A N/A

Flexible Partial Mode 搭載カメラ
1x1 Mode 2x2 Mode 4x4 Mode 1x2 Mode 2x4 Mode
Horizontal Vertical Horizontal Vertical Horizontal Vertical Horizontal Vertical Horizontal Vertical
Product Size Position Size Position Size Position Size Position Size Position Size Position Size Position Size Position Size Position Size Position
C14400DK-41/51/52 8 to 1328 0 to 1320 1 to 1308 0 to 1307 16 to 1328 0 to 1312 2 to 1308 0 to 1306 N/A N/A N/A N/A 8 to 1328 0 to 1320 2 to 1308 0 to 1306 16 to 1328 0 to 1312 4 to 1308 0 to 1304
C14401DK-41 8 to 2192 0 to 2184 1 to 1776 0 to 1775 16 to 2192 0 to 2176 2 to 1776 0 to 1774 N/A N/A N/A N/A 8 to 2192 0 to 2184 2 to 1776 0 to 1774 16 to 2192 0 to 2176 4 to 1776 0 to 1772
C14406DK-81 4 to 3072 0 to 3068 1 to 3072 0 to 3068 8 to 3072 0 to 3064 2 to 3072 0 to 3064 16 to 3072 0 to 3056 8 to 3072 0 to 3056 N/A N/A N/A N/A N/A N/A N/A N/A
C14409DK-52 8 to 2000 0 to 1992 1 to 1392 0 to 1391 16 to 2000 0 to 1984 2 to 1392 0 to 1390 N/A N/A N/A N/A 8 to 2000 0 to 1992 2 to 1392 0 to 1390 N/A N/A N/A N/A
C16401SK-51 8 to 1272 0 to 1264 1 to 1104 0 to 1103 16 to 1272 0 to 1256 2 to 1104 0 to 1102 N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A

注記:
Scanモードが変わった場合でも設定できる値の範囲は変わりません。例えば、2x2モードでH:400、V:320を実現しようする場合は、HSIZE:800、VSIZE:640で設定します。 設定の際はPOSとSIZEの値の合計がカメラの有効画素数を超えないようにしてください。


Device Buffer Mode 搭載カメラのFRAMECOUNTMAX値
Product Binning mode
1x1 2x2 1x2 2x4
C10500D-70 2925 N/A 5851 N/A
C12504D-56 4208 N/A 8407 N/A
C10502D-70 1940 N/A 3878 N/A
C12505D-56 2792 N/A 5585 N/A
C14400DK-51* 149 to 15863 598 to 15863 299 to 15863 1196 to 15863
C14400DK-52* 304 to 32247 1216 to 32247 608 to 32247 2433 to 32247
C14408DK-50 33 to 15863 135 to 15863 N/A N/A
C14409DK-52* 189 to 32247 792 to 32247 379 to 32247 N/A
C16401SK-51* 185 to 15863 740 to 15863 N/A N/A
*FPMで画像サイズを縮小すると、バッファメモリに保持できる枚数は増加します。

このチャプターの先頭へ戻る