DPS_RuntimeSettings Struct Reference

Public Attributes
int	barcodeFormatIds
int	barcodeFormatIds_2
int	functionalMode
float	previewImgScaleRatio
float	resultImgScaleRatio
int	stitchingAccuracyLevel
int	ifExistDuplicateCode
int	maxThreadNumber
int	frameBufferSize
int	maxMemorySize
int	inputSourceMode
int	scanPathMode
int	previousFrameOverlapRegion [8]
int	nextFrameOverlapRegion [8]
int	isVistaImgValid
int	ifAllowImgSegmentation
int	previewImgCoverage
char	reserved [52]

Detailed Description

Defines a struct to configure the panorama settings. These settings control the panorama stitching process such as the scale ratio of preview images.

Member Data Documentation

barcodeFormatIds

int DPS_RuntimeSettings::barcodeFormatIds

Sets the formats of the barcode in BarcodeFormat group 1 to be read. Barcode formats in BarcodeFormat group 1 can be combined.

Value range:

A combined value of DPS_BarcodeFormat Enumeration items

Default value:

DPS_BF_ALL

Remarks:

If the barcode type(s) are certain, specifying the barcode type(s) to be read will speed up the recognition process. The barcode format our library search for is composed of BarcodeFormat group 1 and BarcodeFormat group 2, so you need to specify the barcode format in group 1 and group 2 individually.

See also

DPS_BarcodeFormat, DPS_BarcodeFormat_2

barcodeFormatIds_2

int DPS_RuntimeSettings::barcodeFormatIds_2

Sets the formats of the barcode in BarcodeFormat group 2 to be read. Barcode formats in BarcodeFormat group 2 can be combined.

Value range:

A combined value of DPS_BarcodeFormat_2 Enumeration items

Default value:

DPS_BF2_NULL

Remarks:

If the barcode type(s) are certain, specifying the barcode type(s) to be read will speed up the recognition process. The barcode format our library search for is composed of BarcodeFormat group 1 and BarcodeFormat group 2, so you need to specify the barcode format in group 1 and group 2 individually.

See also

DPS_BarcodeFormat, DPS_BarcodeFormat_2

frameBufferSize

int DPS_RuntimeSettings::frameBufferSize

Sets the frame buffer size stored in the panorama program.

Value range:

[20, 10000]

Default value:

100

Remarks:

To control the momery usage, the max number of frame buffer storage is concurrently limited to one hundred by default.

functionalMode

int DPS_RuntimeSettings::functionalMode

Sets the functional mode to Panorama mode(0) or Overlap mode(1).

Value range:

0 or 1

Default value:

0

Remarks:

0: Panorama mode. 1: Overlap mode.

ifAllowImgSegmentation

int DPS_RuntimeSettings::ifAllowImgSegmentation

Sets whether the segmented image is allowed

Value range:

[0,1]

Default value:

1

Remarks:

To deal with completely failed stitching between two stitched images, 0 means stop immediately, meanwhile 1 means continue to stitch and return several result images in the end.
This parameter is invalid in Overlap mode.

ifExistDuplicateCode

int DPS_RuntimeSettings::ifExistDuplicateCode

Sets whether duplicate codes exist.

Value range:

0 or 1

Default value:

1

inputSourceMode

int DPS_RuntimeSettings::inputSourceMode

Sets the incoming way of frames when appending.

Value range:

0 or 1

Default value:

1

Remarks:

0:input frames from files. 1:input frames from video streams.
The value is fixed at 0 in Overlap mode.

isVistaImgValid

int DPS_RuntimeSettings::isVistaImgValid

Sets whether the special mode for images captured from different distances is valid

Value range:

[0,1]

Default value:

0

Remarks:

This parameter is invalid in Overlap mode.

maxMemorySize

int DPS_RuntimeSettings::maxMemorySize

Sets the max memory size used by the Panorama program.

Value range:

(0, 0x7fffffff]

Default value:

1024

Remarks:

To avoid memory overflow, the max memory size is limited to 1024 MB by default.

maxThreadNumber

int DPS_RuntimeSettings::maxThreadNumber

Sets the max number of thread used for the panorama program.

Value range:

(0, 30]

Default value:

15

Remarks:

To keep a balance between speed and quality, the library concurrently runs fifteen independent threads for Panorama by default.

nextFrameOverlapRegion

int DPS_RuntimeSettings::nextFrameOverlapRegion[8]

Sets the overlap region of next frame.

Value range:

[0, 7fffffff]

Default value:

{0, 0, 0, 0 ,0 ,0 ,0 ,0}

Remarks:

Used with previousFrameOverlapRegion to set the overlap region of two adjacent frames.
This parameter is invalid in Overlap mode.

previewImgCoverage

int DPS_RuntimeSettings::previewImgCoverage

Sets the size ratio of preview image to original frame

Value range:

(0,7fffffff]

Default value:

3

Remarks:

To focus on recent frames, the size ratio of preview image to original frame is set to 3 by default.
Full preview image can also be displayed by setting to 1.
This parameter is invalid in Overlap mode.

previewImgScaleRatio

float DPS_RuntimeSettings::previewImgScaleRatio

Sets the scale ratio of preview images.

Value range:

(0, 1]

Default value:

0.5

Remarks:

When result call back function is not setted and resultImgScaleRatio is more than 0, this parameter will be covered by resultImgScaleRatio in the start function.
The value is fixed at 1 in Overlap mode.

previousFrameOverlapRegion

int DPS_RuntimeSettings::previousFrameOverlapRegion[8]

Sets the overlap region of the previous frame.

Value range:

[0, 7fffffff]

Default value:

{0, 0, 0, 0 ,0 ,0 ,0 ,0}

Remarks:

Used with nextFrameOverlapRegion to set the overlap region of two adjacent frames.
This parameter is invalid in Overlap mode.

reserved

char DPS_RuntimeSettings::reserved[52]

Reserved memory for struct. The length of this array indicates the size of the memory reserved for this struct.

resultImgScaleRatio

float DPS_RuntimeSettings::resultImgScaleRatio

Sets the scale ratio of result images.

Value range:

[0, 1]

Default value:

0

Remarks:

When you call the function GetFinalResults(DPS_GetFinalResults) with the default value 0, the scale ratio of final result image is equal to preview image.
The value is fixed at 0 in Overlap mode.

scanPathMode

int DPS_RuntimeSettings::scanPathMode

Sets the camera moving route. 0 means moving the camera in one way or an "L" way, 1 means moving the camera in a circle.

Value range:

0 or 1

Default value:

0

Remarks:

The value is fixed at 0 in Overlap mode.

stitchingAccuracyLevel

int DPS_RuntimeSettings::stitchingAccuracyLevel

Sets the stitching accuracy level to precise(9) level or standard(0) level.

Value range:

[0, 9]

Default value:

5

Remarks:

0: standard level. 9: precise level. Higher level result in higher stitching success rate and more accurate in stitching results.
8: special level. Only available in Overlap mode.