CogSearchMaxPattern.CompressionQuality Property

CogSearchMaxPattern CompressionQuality Property

Cognex VisionPro 9.22

Gets or sets the CompressionQuality which specifies how much the lossy compression algorithm will compress the trained image model. This value is ignored if compression mode is not lossy.

Namespace: Cognex.VisionPro.SearchMax
Assembly: Cognex.VisionPro.SearchMax (in Cognex.VisionPro.SearchMax.dll) Version: 87.0.0.0

Syntax

C++

Copy to Clipboard Print

public double CompressionQuality { get; set; }

public double CompressionQuality { get; set; }

Public Property CompressionQuality As Double 
	Get 
	Set

Public Property CompressionQuality As Double 
	Get 
	Set

public:
property double CompressionQuality {
	double get ();
	void set (double value);
}

public:
property double CompressionQuality {
	double get ();
	void set (double value);
}

Property Value

Type: Double
A value greater than 0.0 and less than or equal to 1.0. Default is 0.95.

Events

Event Type	Reason
ICogChangedEvent Changed	Fires when this property changes. The following state flags may be affected: SfCompressionQuality SfTrained SfGetTrainedPatternImage SfGetTrainedPatternImageMask

Event Type

Reason

ICogChangedEvent Changed

Fires when this property changes.

The following state flags may be affected:

SfCompressionQuality
SfTrained
SfGetTrainedPatternImage
SfGetTrainedPatternImageMask

Exceptions

Exception	Condition
ArgumentOutOfRangeException	Thrown if set to > 1.0 or <= 0.
ObjectDisposedException	Thrown if this CogSearchMaxPattern object has already been disposed.

Remarks

Note This is an advanced parameter and should be left as the default.

Note Values less than approximately 0.5 are probably too extreme for most applications and are likely to miss instances of the model in runtime images.

Note Changing this property causes this CogSearchMaxPattern to become untrained.