Variables
Properties of CodeGrading2D

Variables

short Grading2Dangle_of_distortion
 This property contains the angle of distortion in degree multiplied with a factor of 10.
 
short Grading2Daxial_nonuniformity
 The property contains the axial nonuniformity multiplied with a factor of 100.
 
short Grading2Dcode_out_of_aoi
 This flag will be set if parts of the code are outside the area of interest while calculating the QR grading results.
 
short Grading2Dcode_quiet_zone_out_of_aoi
 This flag will be set if parts of the code's quiet zone are outside the area of interest while calculating the QR grading results.
 
short Grading2Dglobal_threshold
 Global threshold found during grading.
 
short Grading2Dgrade_axial_nonuniformity
 This property contains the axial nonuniformity multiplied with a factor of 100.
 
short Grading2Dgrade_fixed_pattern_damage
 This property contains the fixed pattern damage grade (ranging from 0 to 4).
 
short Grading2Dgrade_format_information
 This property contains the format information grade (ranging from 0 to 4).
 
short Grading2Dgrade_grid_nonuniformity
 This property contains the grade of the grid nonuniformity (ranging from 0 to 4).
 
short Grading2Dgrade_modulation
 This property contains the modulation grade (ranging from 0 to 4).
 
short Grading2Dgrade_print_growth
 This property contains the grade of the print growth (ranging from 0 to 4).
 
short Grading2Dgrade_reference_decode
 The property indicates if the decoding algorithm was able to decode the code.
 
short Grading2Dgrade_reflectance_margin
 Result of the calculation of the reflectance margin.
 
short Grading2Dgrade_symbol_contrast
 This property contains the grade of the symbol contrast (ranging from 0 to 4).
 
short Grading2Dgrade_unused_error_correction
 The property contains the grade of the unused error correction (ranging from 0 to 4).
 
short Grading2Dgrade_version_information
 This property contains the version information grade (ranging from 0 to 4).
 
short Grading2Dgrid_nonuniformity
 This property contains the grade of the grid nonuniformity (ranging from 0 to 4).
 
short Grading2Dprint_growth
 This property contains the print growth multiplied with a factor of 100.
 
short Grading2Dr_max
 Maximum contrast found during grading.
 
short Grading2Dr_min
 Minimum contrast found during grading.
 
short Grading2Dscan_grade
 The property contains the "scan grade" which is the lowest of the property grades achieved above.
 
short Grading2Dsubgrade_a1
 This is one of the sub grades on which the calculation of the fixed pattern damage grade is based.
 
short Grading2Dsubgrade_a2
 This is one of the sub grades on which the calculation of the fixed pattern damage grade is based.
 
short Grading2Dsubgrade_a3
 This is one of the sub grades on which the calculation of the fixed pattern damage grade is based.
 
short Grading2Dsubgrade_b1
 This is one of the sub grades on which the calculation of the fixed pattern damage grade is based.
 
short Grading2Dsubgrade_b2
 This is one of the sub grades on which the calculation of the fixed pattern damage grade is based.
 
short Grading2Dsubgrade_c
 This is one of the sub grades on which the calculation of the fixed pattern damage grade is based.
 
short Grading2Dsymbol_contrast
 This property contains the symbol contrast in %.
 
short Grading2Dunused_error_correction
 This property contains the grade of the unused error correction (ranging from 0 to 4).
 

Detailed Description

Variable Documentation

short Grading2Dangle_of_distortion

This property contains the angle of distortion in degree multiplied with a factor of 10.

If the angle of distortion is inactive angle of distortion will be 0.

Attention
This property is only used with Code Grading.
Parameters
[out]Grading2Dangle_of_distortionGet the angle of distortion of the code.
Returns
Angle of distortion in degree.
short Grading2Daxial_nonuniformity

The property contains the axial nonuniformity multiplied with a factor of 100.

If the axial nonuniformity is not active the axial nonuniformity will be 0.

Attention
This property is only used with Code Grading.
Parameters
[out]Grading2Daxial_nonuniformityGet the axial nonuniformity of the code.
Returns
Axial nonuniformity.
short Grading2Dcode_out_of_aoi

This flag will be set if parts of the code are outside the area of interest while calculating the QR grading results.

Attention
This property is only used with QR Code Grading.
Parameters
[out]Grading2Dcode_out_of_aoiRetrieves the status of the code outside the aoi.
Returns
Status flag for code out of aoi.
short Grading2Dcode_quiet_zone_out_of_aoi

This flag will be set if parts of the code's quiet zone are outside the area of interest while calculating the QR grading results.

Attention
This property is only used with QR Code Grading.
Parameters
[out]Grading2Dcode_quiet_zone_out_of_aoiRetrieves the status of the quiet zone outside the aoi.
Returns
Status flag for quiet zone out of aoi.
short Grading2Dglobal_threshold

Global threshold found during grading.

Attention
This property is only used with QR Code Grading.
Parameters
[out]Grading2Dglobal_thresholdGet the global threshold found during grading.
Returns
Global contrast.
short Grading2Dgrade_axial_nonuniformity

This property contains the axial nonuniformity multiplied with a factor of 100.

If the axial nonuniformity is not active the axial_nonuniformity will be 0.

Attention
This property is only used with Code Grading.
Parameters
[out]Grading2Dgrade_axial_nonuniformityGet the grade of the axial nonuniformity.
Returns
Grade of the axial nonuniformity.
short Grading2Dgrade_fixed_pattern_damage

This property contains the fixed pattern damage grade (ranging from 0 to 4).

If the fixed pattern damage grading is not active the grading result is -1. The fixed pattern damage grade is based on the results stored in subgrade_a1, subgrade_a2, subgrade_a3, subgrade_b1, subgrade_b2 and subgrade_c.

Attention
This property is only used with QR Code Grading.
Parameters
[out]Grading2Dgrade_fixed_pattern_damageGet the fixed pattern damage grade of the code.
Returns
Fixed pattern damage grade.
short Grading2Dgrade_format_information

This property contains the format information grade (ranging from 0 to 4).

If the format information grading is not active the grading result is -1.

Attention
This property is only used with QR Code Grading.
Parameters
[out]Grading2Dgrade_format_informationGet the format information grade of the code.
Returns
Format information grade.
short Grading2Dgrade_grid_nonuniformity

This property contains the grade of the grid nonuniformity (ranging from 0 to 4).

If the grid nonuniformity is not active the grading is -1.

Attention
This property is only used with Code Grading.
Parameters
[out]Grading2Dgrade_grid_nonuniformityGet the grade of the grid nonuniformity.
Returns
Grade of the grid nonuniformity.
short Grading2Dgrade_modulation

This property contains the modulation grade (ranging from 0 to 4).

If the modulation grading is not active the grading result is -1.

Attention
This property is only used with QR Code Grading.
Parameters
[out]Grading2Dgrade_modulationGet the modulation grade of the code.
Returns
Modulation grade.
short Grading2Dgrade_print_growth

This property contains the grade of the print growth (ranging from 0 to 4).

If the print growth is not active the grading is -1.

Attention
This property is only used with Code Grading.
Parameters
[out]Grading2Dgrade_print_growthGet the grade of the print growth.
Returns
Print growth.
short Grading2Dgrade_reference_decode

The property indicates if the decoding algorithm was able to decode the code.

If it achieves a valid decode, the decode grade is 4, otherwise it is 0.

Attention
This property is only used with Code Grading.
Parameters
[out]Grading2Dgrade_reference_decodeRetrieve the status of the reference decoding.
Returns
Status of reference decoding.
short Grading2Dgrade_reflectance_margin

Result of the calculation of the reflectance margin.

Parameters
[out]Grading2Dgrade_reflectance_marginGet the reflectance margin.
Returns
Reflectance margin.
short Grading2Dgrade_symbol_contrast

This property contains the grade of the symbol contrast (ranging from 0 to 4).

If the symbol contrast is not active the grade is -1.

Attention
This property is only used with Code Grading.
Parameters
[out]Grading2Dgrade_symbol_contrastGet the grade of the symbol contrast.
Returns
Grade of the symbol contrast.
short Grading2Dgrade_unused_error_correction

The property contains the grade of the unused error correction (ranging from 0 to 4).

If the unused error correction is not active the grading is -1.

Attention
This property is only used with Code Grading.
Parameters
[out]Grading2Dgrade_unused_error_correctionGet the grade of the unused error correction.
Returns
Unused error correction in %.
short Grading2Dgrade_version_information

This property contains the version information grade (ranging from 0 to 4).

If the version information grading is not active the grading result is -1.

Attention
This property is only used with QR Code Grading.
Parameters
[out]Grading2Dgrade_version_informationGet the version information grade of the code.
Returns
Version information grade.
short Grading2Dgrid_nonuniformity

This property contains the grade of the grid nonuniformity (ranging from 0 to 4).

If the grid nonuniformity is not active the grading is -1.

Attention
This property is only used with Code Grading.
Parameters
[out]Grading2Dgrid_nonuniformityGet the grid nonuniformity of the code.
Returns
Grid nonuniformity.
short Grading2Dprint_growth

This property contains the print growth multiplied with a factor of 100.

If the print growth is inactive print growth will be 0.

Attention
This property is only used with Code Grading.
Parameters
[out]Grading2Dprint_growthGet the print growth of the code.
Returns
Print growth grade.
short Grading2Dr_max

Maximum contrast found during grading.

Attention
This property is only used with QR Code Grading.
Parameters
[out]Grading2Dr_maxGet the maximum contrast found during grading.
Returns
Maximum contrast.
short Grading2Dr_min

Minimum contrast found during grading.

Attention
This property is only used with QR Code Grading.
Parameters
[out]Grading2Dr_minGet the minimum contrast found during grading.
Returns
Minimum contrast.
short Grading2Dscan_grade

The property contains the "scan grade" which is the lowest of the property grades achieved above.

Only active grades will not incur in the result of the scan grade.

Attention
This property is only used with Code Grading.
Parameters
[out]Grading2Dscan_gradeGet the scan grade of the code.
Returns
Scan grade.
short Grading2Dsubgrade_a1

This is one of the sub grades on which the calculation of the fixed pattern damage grade is based.

Attention
This property is only used with QR Code Grading.
Parameters
[out]Grading2Dsubgrade_a1Get the value of the specified sub grade.
Returns
Sub grade for fixed pattern damage grade.
short Grading2Dsubgrade_a2

This is one of the sub grades on which the calculation of the fixed pattern damage grade is based.

Attention
This property is only used with QR Code Grading.
Parameters
[out]Grading2Dsubgrade_a2Get the value of the specified sub grade.
Returns
Sub grade for fixed pattern damage grade.
short Grading2Dsubgrade_a3

This is one of the sub grades on which the calculation of the fixed pattern damage grade is based.

Attention
This property is only used with QR Code Grading.
Parameters
[out]Grading2Dsubgrade_a3Get the value of the specified sub grade.
Returns
Sub grade for fixed pattern damage grade.
short Grading2Dsubgrade_b1

This is one of the sub grades on which the calculation of the fixed pattern damage grade is based.

Attention
This property is only used with QR Code Grading.
Parameters
[out]Grading2Dsubgrade_b1Get the value of the specified sub grade.
Returns
Sub grade for fixed pattern damage grade.
short Grading2Dsubgrade_b2

This is one of the sub grades on which the calculation of the fixed pattern damage grade is based.

Attention
This property is only used with QR Code Grading.
Parameters
[out]Grading2Dsubgrade_b2Get the value of the specified sub grade.
Returns
Sub grade for fixed pattern damage grade.
short Grading2Dsubgrade_c

This is one of the sub grades on which the calculation of the fixed pattern damage grade is based.

Attention
This property is only used with QR Code Grading.
Parameters
[out]Grading2Dsubgrade_cGet the value of the specified sub grade.
Returns
Sub grade for fixed pattern damage grade.
short Grading2Dsymbol_contrast

This property contains the symbol contrast in %.

If the symbol contrast is not active the symbol contrast will be 0.

Attention
This property is only used with Code Grading.
Parameters
[out]Grading2Dsymbol_contrastGet the symbol contrast of the code.
Returns
Symbol contrast.
short Grading2Dunused_error_correction

This property contains the grade of the unused error correction (ranging from 0 to 4).

If the unused error correction is not active the grading is -1.

Attention
This property is only used with Code Grading.
Parameters
[out]Grading2Dunused_error_correctionGet the grade of the unused error correction.
Returns
Grade of the unused error correction.