ZmGetCorrectionValue


機能

補正値を取得します。

書式

Ret = ZmGetCorrectionValue ( Id , ChannelNo , Type , CorrectionValue1 , CorrectionValue1 , Format )

引数

Id [ VB.NET: Short ] [ C, C++: short ] [ C#: short ] [ Python: ctypes.c_short ]
ZmInitで取得したデバイスIDを指定します。

ChannelNo [ VB.NET: UShort ] [ C, C++: unsigned short ] [ C#: ushort ] [ Python: ctypes.c_ushort ]
チャネル番号を指定します。

Type  [ VB.NET: UShort ] [ C, C++: unsigned short ] [ C#: ushort ] [ Python: ctypes.c_ushort ]
補正タイプを設定します。

定義


[Dec]

意味

ZM_CORRECTION_TYPE_OPEN

0

補正タイプオープン

ZM_CORRECTION_TYPE_SHORT

1

補正タイプショート

CorrectionValue1 [ VB.NET: Single ] [ C, C++: float * ] [ C#: out float ] [ Python: ctypes.POINTER(ctypes.c_float) ]
補正値1を格納する変数アドレスを指定します。

CorrectionValue2 [ VB.NET: Single ] [ C, C++: float * ] [ C#: out float ] [ Python: ctypes.POINTER(ctypes.c_float) ]
補正値1を格納する変数アドレスを指定します。

Format  [ VB.NET: UShort ] [ C, C++: unsigned short ] [ C#: ushort ] [ Python: ctypes.c_ushort ]
補正値フォーマットを指定します。

Type

定義


[Dec]

意味

オープンの場合

ZM_CORRECTION_FORMAT_OPEN_GB

1

G,B

ショートの場合

ZM_CORRECTION_FORMAT_SHORT_RX

1

Rs,X

戻り値

Ret [ VB.NET: Integer ] [ C, C++: long ] [ C#: int ] [ Python: ctypes.c_long ]

定義

戻り値
[Dec]

内容

ZM_ERR_SUCCESS

0

正常終了

ZM_ERR_SYS_CHANNEL_NO

20100

チャネル番号が設定可能範囲外です。

ZM_ERR_SYS_TYPE

20108

補正タイプが設定可能範囲外です

その他のエラー(参照:エラーコード詳細

初期値

補正値1(CorrectionValue1) = 0
補正値2(CorrectionValue2) = 0

説明

補正値を取得します。
補正値はチャネル毎に取得します。

補正値は現在の測定条件で設定されます。
測定条件を変更された際には再度補正値を設定してください。

補正値は保持していますので、一度設定した測定条件では再度設定の必要はありません。

補正についての詳細は用語集「補正」をご参照ください。

使用例

ChannelNo = 1が「0:補正タイプオープン」かつ「補正値フォーマットを1:G,B」の時の、補正値1、および補正値2を取得します。

VB.NET

Dim Ret As Integer

Dim CorrectionValue1 As Single

Dim CorrectionValue2 As Single

Ret = ZmGetCorrectionValue ( Id , 1 , 0 , CorrectionValue1 , CorrectionValue2 , 1 )
 

C, C++

long Ret;
float CorrectionValue1;

float CorrectionValue2;

Ret = ZmGetCorrectionValue ( Id , 1 , 0 , &CorrectionValue1 , &CorrectionValue2 , 1 );
 

C#

int Ret;

float CorrectionValue1;
float CorrectionValue2;

Ret = zm.GetCorrectionValue ( Id , 1 , 0 , out CorrectionValue1 , out CorrectionValue2 , 1 );
 

Python

Ret = ctypes.c_long()

CorrectionValue1 = ctypes.c_float()
CorrectionValue2 = ctypes.c_float()

Ret.value = czm.ZmGetCorrectionValue ( Id , 1 , 0 , ctypes.byref(CorrectionValue1) , ctypes.byref(CorrectionValue2) , 1 )
 

関連項目

ZmCorrection ZmGetCorrectionEnable ZmSetCorrectionEnable ZmSetCorrectionValue