This class encapsulates the run time parameters used by Execute(CogImage8Grey, ICogRegion, CogOCVMaxRunParams).
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.Implementation CogSerializableChangedEventBase
Cognex.VisionPro.OCVMax CogOCVMaxRunParams
Namespace: Cognex.VisionPro.OCVMax
Assembly: Cognex.VisionPro.OCVMax (in Cognex.VisionPro.OCVMax.dll) Version: 73.0.0.0
Syntax
The CogOCVMaxRunParams type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogOCVMaxRunParams | |
| CogOCVMaxRunParams(CogOCVMaxRunParams) | |
 | CogOCVMaxRunParams(SerializationInfo, StreamingContext) |
Methods
| Name | Description | |
|---|---|---|
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
| Dispose | |
| Dispose(Boolean) | |
| Equals | (Inherited from Object.) |
| Finalize | (Overrides Object Finalize .) |
| GetAttributes |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetCharacterCount(CogOCVMaxLineIterator) | Gets the number of characters in the specified line of the specified paragraph of this object's internal arrangement description. |
| GetCharacterCount(Int32, Int32) | Gets the number of characters in the specified line of the specified paragraph of this object's internal arrangement description. |
| GetClassName |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetComponentName |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetConfidenceThreshold(Int32) | Gets the confidence threshold for the specified paragraph. |
| GetConfidenceThreshold(CogOCVMaxParagraphIterator) | Gets the confidence threshold for the specified paragraph. |
| GetConfusionThreshold(Int32) | Gets the confusion threshold for the specified paragraph. |
| GetConfusionThreshold(CogOCVMaxParagraphIterator) | Gets the confusion threshold for the specified paragraph. |
| GetConverter |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetDefaultEvent |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetDefaultProperty |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetEditor |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetEvents |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetEvents( Attribute ) |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetKeysetCharacterKeys(CogOCVMaxCharacterIterator) | Gets an array of integers that correspond to the key set for the specified character position within the specified line within the specified paragraph. Each element of this array is the key value of a character that may occur at this position. |
| GetKeysetCharacterKeys(Int32, Int32, Int32) | Gets an array of integers that correspond to the key set for the specified character position within the specified line within the specified paragraph. Each element of this array is the key value of a character that may occur at this position. |
| GetKeysetCharacters(CogOCVMaxCharacterIterator) | Gets a string that corresponds to the key set for the specified character position within the specified line within the specified paragraph. Each individual character in this string may occur at this position. |
| GetKeysetCharacters(Int32, Int32, Int32) | Gets a string that corresponds to the key set for the specified character position within the specified line within the specified paragraph. Each individual character in this string may occur at this position. |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| GetLineCount(Int32) | Gets the number of lines in the specified paragraph of this object's internal arrangement description. |
| GetLineCount(CogOCVMaxParagraphIterator) | Gets the number of lines in the specified paragraph of this object's internal arrangement description. |
| GetObjectData | (Overrides CogSerializableObjectBase GetObjectData(SerializationInfo, StreamingContext).) |
| GetParagraphCount | Gets the number of paragraphs described by this run parameters object. |
| GetProperties |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetProperties( Attribute ) |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetPropertyOwner |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetVerificationType(CogOCVMaxCharacterIterator) | Gets the type of verification to be performed on the specified character position. |
| GetVerificationType(Int32, Int32, Int32) | Gets the type of verification to be performed on the specified character position. |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
| OnChanged(Int64) |
This method should be called internally whenever the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
| OnChanged(CogChangedEventArgs) |
This method may be called internally whenever a derived object's state
may have changed and the derived object expresses this change via a
derived CogChangedEventArgs class.
(Inherited from CogSerializableChangedEventBase.) |
| ResumeAndRaiseChangedEvent |
Re-enables raising of the Changed event after SuspendChangedEvent
has been called, and raises the Changed event if the
ChangedEventSuspended count is reduced to zero and any changes were
made while events were suspended. Must be called once for each call to
SuspendChangedEvent.
(Inherited from CogSerializableChangedEventBase.) |
| SetArrangementFromPattern | Copies the arrangement from the specified pattern into this run parameters object. |
| SetConfidenceThreshold(Int32, Double) | Sets the confidence threshold for the specified paragraph. |
| SetConfidenceThreshold(CogOCVMaxParagraphIterator, Double) | Sets the confidence threshold for the specified paragraph. |
| SetConfusionThreshold(Int32, Double) | Sets the confusion threshold for the specified paragraph. |
| SetConfusionThreshold(CogOCVMaxParagraphIterator, Double) | Sets the confusion threshold for the specified paragraph. |
| SetKeyset(CogOCVMaxCharacterIterator, Int32 ) | Sets the key set for the specified character position within the specified line within the specified paragraph. |
| SetKeyset(CogOCVMaxCharacterIterator, String) | Sets the key set for the specified character position within the specified line within the specified paragraph. |
| SetKeyset(Int32, Int32, Int32, Int32 ) | Sets the key set for the specified character position within the specified line within the specified paragraph. |
| SetKeyset(Int32, Int32, Int32, String) | Sets the key set for the specified character position within the specified line within the specified paragraph. |
| SetVerificationType(CogOCVMaxCharacterIterator, CogOCVMaxVerificationTypeConstants) | Sets the type of verification to be performed on the specified character position. |
| SetVerificationType(Int32, Int32, Int32, CogOCVMaxVerificationTypeConstants) | Sets the type of verification to be performed on the specified character position. |
| SuspendChangedEvent |
Temporarily suspends the raising of the Changed event. May be called
more than once, and a corresponding call to ResumeAndRaiseChangedEvent
must be made for each call to SuspendChangedEvent.
(Inherited from CogSerializableChangedEventBase.) |
| ToString | (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
  | SfComputePoses | This bit will be set in the EventArgs of a Changed event every time the value returned by ComputePoses may have changed. |
| SfEarlyAcceptThreshold | This bit will be set in the EventArgs of a Changed event every time the value returned by EarlyAcceptThreshold may have changed. |
| SfEarlyFailThreshold | This bit will be set in the EventArgs of a Changed event every time the value returned by EarlyFailThreshold may have changed. |
| SfGetCharacterCount | This bit will be set in the EventArgs of a Changed event every time the value returned by GetCharacterCount may have changed. |
| SfGetConfidenceThreshold | This bit will be set in the EventArgs of a Changed event every time the value returned by GetConfidenceThreshold may have changed. |
| SfGetConfusionThreshold | This bit will be set in the EventArgs of a Changed event every time the value returned by GetConfusionThreshold may have changed. |
| SfGetKeysetCharacterKeys | This bit will be set in the EventArgs of a Changed event every time the value returned by GetKeysetCharacterKeys may have changed. |
| SfGetLineCount | This bit will be set in the EventArgs of a Changed event every time the value returned by GetLineCount may have changed. |
| SfGetParagraphCount | This bit will be set in the EventArgs of a Changed event every time the value returned by GetParagraphCount may have changed. |
| SfGetVerificationType | This bit will be set in the EventArgs of a Changed event every time the value returned by GetVerificationType may have changed. |
| SfImageSearchParams | This bit will be set in the EventArgs of a Changed event every time the value returned by ImageSearchParams may have changed. |
| SfKeySearchParams | This bit will be set in the EventArgs of a Changed event every time the value returned by KeySearchParams may have changed. |
 | SfNextSf | |
| SfRegionMode | This bit will be set in the EventArgs of a Changed event every time the value returned by RegionMode may have changed. |
| SfRunPose | This bit will be set in the EventArgs of a Changed event every time the value returned by RunPose may have changed. |
| SfStartPoseSearchParams | This bit will be set in the EventArgs of a Changed event every time the value returned by StartPoseSearchParams may have changed. |
| SfTimeout | This bit will be set in the EventArgs of a Changed event every time the value returned by Timeout may have changed. |
| SfTimeoutEnabled | This bit will be set in the EventArgs of a Changed event every time the value returned by TimeoutEnabled may have changed. |
Properties
| Name | Description | |
|---|---|---|
 | ChangedEventSuspended |
If nonzero, indicates that the raising of the Changed event has been
suspended. This value is incremented when SuspendChangedEvent is called
and decremented when ResumeAndRaiseChangedEvent is called.
(Inherited from CogSerializableChangedEventBase.) |
| ComputePoses | Gets or sets the result poses to be computed. |
| EarlyAcceptThreshold | Gets or sets the threshold for early acceptance of a potential line match as the true instance of the line in the image. |
| EarlyFailThreshold | Gets or sets the threshold for early failure of a potential line match as the true instance of the line in the image. |
| HasChanged | (Inherited from CogSerializableChangedEventBase.) |
| ImageSearchParams | Gets or sets the search parameters used for pattern alignment in the image. |
| KeySearchParams | Gets or sets the search parameters used for alignment of each keyset relative to its neighbor. |
| RegionMode | Gets or sets how the pRegion parameter to Execute(CogImage8Grey, ICogRegion, CogOCVMaxRunParams) is applied to the input image. |
| RunPose | When this property is not NULL, the search process assumes that the strings will be found very close to this pose. |
| StartPoseSearchParams | Gets or sets the search parameters used for pattern alignment in the image when a run pose is being used. |
| StateFlags |
Returns the complete set of state flags supported on this object. The
flags may be indexed by name as shown in the following C# code snippet:
if (changedObject.StateFlags["Color"] & eventArgs.StateFlags) { ... }
(Inherited from CogSerializableChangedEventBase.) |
| Timeout | Gets or sets the maximum amount of time in milliseconds that execution of tuning can take. |
| TimeoutEnabled | Gets or sets whether the pattern is allowed to time out when executing or tuning with these run parameters. |
Events
| Name | Description | |
|---|---|---|
 | Changed |
This event is raised when one or more parts of the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
See Also