ZmGetCorrectionValue

Function

Get the correction value.

Format

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

Parameters

Id [ VB.NET： Short ] [ C, C++： short ] [ C#： short ] [ Python： ctypes.c_short ]
Specify the device ID retrieved from ZmInit.

ChannelNo [ VB.NET： UShort ] [ C, C++： unsigned short ] [ C#： ushort ] [ Python： ctypes.c_ushort ]
Specify the channel number.

Type [ VB.NET： UShort ] [ C, C++： unsigned short ] [ C#： ushort ] [ Python： ctypes.c_ushort ]
Specify the correction type.

Definition	Value [Dec]	Description
ZM_CORRECTION_TYPE_OPEN	0	Correction type Open
ZM_CORRECTION_TYPE_SHORT	1	Correction type Short

CorrectionValue1 [ VB.NET： Single ] [ C, C++： float * ] [ C#： out float ] [ Python： ctypes.POINTER(ctypes.c_float) ]
Specify the variable address for storing the correction value 1.

CorrectionValue2 [ VB.NET： Single ] [ C, C++： float * ] [ C#： out float ] [ Python： ctypes.POINTER(ctypes.c_float) ]
Specify the variable address for storing the correction value 2.

Format [ VB.NET： UShort ] [ C, C++： unsigned short ] [ C#： ushort ] [ Python： ctypes.c_ushort ]
Specify the correction value format.

Type	Definition	Value [Dec]	Description
Open	ZM_CORRECTION_FORMAT_OPEN_GB	1	G,B
Short	ZM_CORRECTION_FORMAT_SHORT_RX	1	Rs,X

Return Value

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

Definition	Value [Dec]	Description
ZM_ERR_SUCCESS	0	Normality completion
ZM_ERR_SYS_CHANNEL_NO	20100	Channel No is out of the settable range.
ZM_ERR_SYS_TYPE	20108	Type is out of the settable range.

The others (See also: Details of Error Code)

Initial Value

Correction value 1(CorrectionValue1) = 0
Correction value 2(CorrectionValue2) = 0

Remarks

Get the correction value.
Correction value is gotten for each channel.

The correction value is set based on the current conditions for the correction.
If the conditions for the correction are changed, please set the correction value again.

The correction value is retained, so once the conditions for the correction have been set, there is no need to set correction value again.

For details about correction, please refer to the glossary "Correction".

Example

Get the Correction value 1 and Correction value 2, when ChannelNo = 1 is "0 : Correction type Open" and correction value format is "1 : G,B".

VB.NET	Dim Ret As Integer Dim CorrectionValue1 As Single Dim CorrectionValue2 As Single Ret = ZmSetCorrectionValue ( Id , 1 , 0 , CorrectionValue1 , CorrectionValue2 , 1 )
C, C++	long Ret; float CorrectionValue1; float CorrectionValue2; Ret = ZmSetCorrectionValue ( Id , 1 , 0 , &CorrectionValue1 , &CorrectionValue2 , 1 );
C#	int Ret; float CorrectionValue1; float CorrectionValue2; Ret = zm.SetCorrectionValue ( 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 )