Dynamsoft Panorama - API Reference
Public Attributes | List of all members
Dynamsoft.Panorama.DPS_RuntimeSettings Struct Reference

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

Public Attributes

int barcodeFormatIds
 Sets the formats of the barcode in BarcodeFormat group 1 to be read. Barcode formats in BarcodeFormat group 1 can be combined. More...
 
int barcodeFormatIds_2
 Sets the formats of the barcode in BarcodeFormat group 2 to be read. Barcode formats in BarcodeFormat group 2 can be combined. More...
 
int functionalMode
 Sets the functional mode to Panorama mode(0) or Overlap mode(1). More...
 
float previewImgScaleRatio
 Sets the scale ratio of preview images. More...
 
float resultImgScaleRatio
 Sets the scale ratio of result images. More...
 
int stitchingAccuracyLevel
 Sets the stitching accuracy level to precise(9) level or standard(0) level.Not supported yet. More...
 
int ifExistDuplicateCode
 Sets whether duplicate codes exist. More...
 
int maxThreadNumber
 Sets the max number of thread used for the panorama program. More...
 
int frameBufferSize
 Sets the frame buffer size stored in the panorama program. More...
 
int maxMemorySize
 Sets the max memory size used by the Panorama program. More...
 
int inputSourceMode
 Sets the incoming way of frames when appending. More...
 
int 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. More...
 
int [] previousFrameOverlapRegion
 Sets the overlap region of the previous frame. More...
 
int [] nextFrameOverlapRegion
 Sets the overlap region of the next frame. More...
 
string reserved
 Reserved memory for struct. The length of this array indicates the size of the memory reserved for this struct. More...
 

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 Dynamsoft.Panorama.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 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.

◆ barcodeFormatIds_2

int Dynamsoft.Panorama.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 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.

◆ frameBufferSize

int Dynamsoft.Panorama.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 Dynamsoft.Panorama.DPS_RuntimeSettings.functionalMode

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

Value range:
[0, 1]
Default value:
0
Remarks:
0: Panorama mode. 1: Overlap mode.

◆ ifExistDuplicateCode

int Dynamsoft.Panorama.DPS_RuntimeSettings.ifExistDuplicateCode

Sets whether duplicate codes exist.

Value range:
1 or 0
Default value:
1

◆ inputSourceMode

int Dynamsoft.Panorama.DPS_RuntimeSettings.inputSourceMode

Sets the incoming way of frames when appending.

Value range:
[0, 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.

◆ maxMemorySize

int Dynamsoft.Panorama.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 Dynamsoft.Panorama.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 [] Dynamsoft.Panorama.DPS_RuntimeSettings.nextFrameOverlapRegion

Sets the overlap region of the 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.

◆ previewImgScaleRatio

float Dynamsoft.Panorama.DPS_RuntimeSettings.previewImgScaleRatio

Sets the scale ratio of preview images.

Value range:
(0, 1]
Default value:
0.5
Remarks:
The value is fixed at 1 in Overlap mode.

◆ previousFrameOverlapRegion

int [] Dynamsoft.Panorama.DPS_RuntimeSettings.previousFrameOverlapRegion

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

string Dynamsoft.Panorama.DPS_RuntimeSettings.reserved

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

◆ resultImgScaleRatio

float Dynamsoft.Panorama.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 Dynamsoft.Panorama.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, 1]
Default value:
0
Remarks:
The value is fixed at 0 in Overlap mode.

◆ stitchingAccuracyLevel

int Dynamsoft.Panorama.DPS_RuntimeSettings.stitchingAccuracyLevel

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

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. This parameter is not supported in this version.