CogSearchMaxPattern ZoneScale Property Cognex VisionPro 9.21 SR1
Gets or sets the zone configuration for the uniform scale degree of freedom used when training pattern templates. This property is ignored if TrainMode is EvaluateDOFsAtRuntime.

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

public CogSearchMaxZoneScale ZoneScale { get; set; }

Property Value

Type: CogSearchMaxZoneScale
The zone configuration for the uniform scale degree of freedom. Default value is a default constructed CogSearchMaxZoneScale.
Events

Event TypeReason
ICogChangedEvent Changed

Fires when this property changes.

The following state flags may be affected:

  • SfZoneScale
  • SfTrained
  • SfGetTrainedPatternImage
  • SfGetTrainedPatternImageMask
Exceptions

ExceptionCondition
ArgumentNullException Thrown when you attempt to set this to NULL.
ObjectDisposedException Thrown if this CogSearchMaxPattern object has already been disposed.
Remarks

An CogSearchMaxZoneScale object describing the uniform scale degree of freedom. Uniform scale is a scale change where the x-scale equals the y-scale.

Any value you specify for the uniform scale degree of freedom is multiplied by the values specified for ZoneScaleX and ZoneScaleY to produce the overall search space (if you specify a zone) or nominal value (if you specify a nominal value).

Note Changing this property causes this CogSearchMaxPattern to become untrained.

Note This CogSearchMaxPattern will sink changed events for the CogSearchMaxZoneScale that you supply. Whenever the CogSearchMaxZoneScale changes, this CogSearchMaxPattern will become untrained.

See Also