Variables
Properties of 4-State Kix Code

Variables

bool Code4StateKixInverted
 Code is inverted (white on black) / not inverted.
 
short Code4StateKixLSB
 Sets the Position of the "low significant bit" of the 4-State Kix Postal code in the image.
 
short Code4StateKixMaxDigits
 Maximum number of the 4-State Kix code words.
 
short Code4StateKixMinDigits
 Minimum number of the 4-State Kix code words.
 
bool Code4StateKixMirror
 Code is mirrored/not mirrored.
 
short Code4StateKixQuietzone
 Quiet zone in module width.
 
short Code4StateKixThreshold
 Digitalisation threshold.
 

Detailed Description

Variable Documentation

bool Code4StateKixInverted

Code is inverted (white on black) / not inverted.

The property inverted sets the current status of the inverted flag of the 4-State Kix Postal code. TRUE means that the grey values of the code are inverted (white code on black background). FALSE ignores it (black code on white background).

Parameters
[in,out]Code4StateKixInvertedCode is inverted (white on black)/not inverted.
Returns
Status of inverted flag.
short Code4StateKixLSB

Sets the Position of the "low significant bit" of the 4-State Kix Postal code in the image.

The property lsb "low significant bit" can be CVC_BC_LSB_LEFT, CVC_BC_LSB_BOTTOM, CVC_BC_LSB_RIGHT or CVC_BC_LSB_TOP. If the lsb is not correct (for example CVC_BC_LSB_LEFT and CVC_BC_LSB_RIGHT are interchanged) the code interpretation is another. Default lsb = CVC_BC_LSB_LEFT.

Parameters
[in,out]Code4StateKixLSBSet the position of the "low significant bit" in the code.
Returns
Position of "low significant bit".
short Code4StateKixMaxDigits

Maximum number of the 4-State Kix code words.

The property maxDigits sets the maximum number of code words composing the 4-State Kix Postal code.

Parameters
[in,out]Code4StateKixMaxDigitsSet the maximum number of code words.
Returns
Maximum number of code words.
short Code4StateKixMinDigits

Minimum number of the 4-State Kix code words.

The property minDigits sets the minimum number of code words composing the 4-State Kix Postal code.

Parameters
[in,out]Code4StateKixMinDigitsSet the minimum number of code words.
Returns
Minimum number of code words.
bool Code4StateKixMirror

Code is mirrored/not mirrored.

The property mirror sets the current status of the mirror flag of the 4-State Kix Postal code. TRUE means that the code is mirrored. FALSE stands for the non-mirrored code image.

Parameters
[in,out]Code4StateKixMirrorCode is mirrored/not mirrored.
Returns
Status of mirror flag.
short Code4StateKixQuietzone

Quiet zone in module width.

The property quietzone sets the quiet zone in module width of the 4-State Kix Postal code.

Parameters
[in,out]Code4StateKixQuietzoneSet the quiet zone in module width.
Returns
quiet zone in module width.
short Code4StateKixThreshold

Digitalisation threshold.

The property threshold sets the current digitalisation threshold in % ranging from 0 to 100.

Parameters
[in,out]Code4StateKixThresholdSet the digitalisation threshold of the code.
Returns
Digitalisation threshold.