ColourClusteringModes
ColourClusteringModes
controls the process of colour categorization. It consists of one or more modes, each mode representing a different way to implement the categorization.
Candidate Mode List
- CCM_GENERAL_HSV
- CCM_AUTO
CCM_GENERAL_HSV
This mode clusters the colours using the general algorithm based on HSV (hue, saturation, value). This mode has the following arguments for further customization.
CCM_AUTO
Lets the library choose a mode automatically. Not supported yet.
Setting Methods
As PublicRuntimeSettings
Member
ColourClusteringModes
can be set dynamically during runtime as a member of FurtherModes
, which is a member of PublicRuntimeSettings
struct, it is an array with 8 ColourClusteringMode
Enumeration items.
Code Snippet in C++
//...other codes
PublicRuntimeSettings* pSettings = new PublicRuntimeSettings;
int errorCode = reader->GetRuntimeSettings(pSettings);
pSettings->colourClusteringModes[0] = CCM_GENERAL_HSV;
reader->UpdateRuntimeSettings(pSettings);
reader->SetModeArgument("ColourClusteringModes", 0, "Sensitivity", "1");
delete pSettings;
//...other codes
Remarks
GetModeArgument
and SetModeArgument
need to be called for getting and setting Arguments
.
See Also
FurtherModes:
C | C++ | .NET | Java | Java-Android | Objective-C & SwiftPublicRuntimeSettings:
JavaScript | C | C++ | .NET | Python | Java | Java-Android | Objective-C & SwiftColourClusteringMode:
JavaScript | C | C++ | .NET | Python | Java | Java-Android | Objective-C & SwiftGetModeArgument:
JavaScript | C | C++ | .NET | Python | Java | Java-Android | Objective-C & SwiftSetModeArgument:
JavaScript | C | C++ | .NET | Python | Java | Java-Android | Objective-C & Swift
As JSON Parameter
ColourClusteringModes
as a JSON parameter is a JSON Object array. Each JSON object is defined as below.
Key Name | Key Value | Description |
---|---|---|
Mode | Any one in Candidate Mode List as string | (Required) Specifies a mode for colour categorization. |
Sensitivity | A number from value range of Sensitivity | (Optional) Sets the Argument Sensitivity. |
LibraryFileName | A string from value range of LibraryFileName | (Optional) Sets the Argument LibraryFileName. |
LibraryParameters | A string from value range of LibraryParameters | (Optional) Sets the Argument LibraryParameters. |
JSON Parameter Example
{
"ColourClusteringModes": [
{
"Mode": "CCM_GENERAL_HSV",
"Sensitivity": 1
},
{
"Mode": "CCM_GENERAL_HSV",
"Sensitivity": 9
}
]
}
Candidate Argument List
Sensitivity
Sets the sensitivity used for colour categorization. A bigger value means less colours will be clustered as the same colour.
Value Type | Value Range | Default Value | Valid For |
---|---|---|---|
int | [1, 9] | 5 | CCM_GENERAL_HSV |
LibraryFileName
Sets the file name of the library to load dynamically.
Value Type | Value Range | Default Value | Valid For |
---|---|---|---|
string | A string value representing file name. | ”” | All modes |
Remarks
The library must be in the same place with Dynamsoft Barcode Reader Library.
LibraryParameters
Sets the parameters passed to the library to load dynamically.
Value Type | Value Range | Default Value | Valid For |
---|---|---|---|
string | A string value representing parameters. | ”” | All modes |