This class provides easy access to paragraph-level properties and methods of the CogOCVMaxPattern object. With this class you can navigate amongst all of the paragraphs within the arrangement. You may NOT directly construct this object. Instead, use the CreateParagraphIterator method on the top level CogOCVMaxPattern object. Also note that this class can not be persisted.
Inheritance Hierarchy
Cognex.VisionPro.OCVMax CogOCVMaxParagraphIterator
Namespace: Cognex.VisionPro.OCVMax
Assembly: Cognex.VisionPro.OCVMax (in Cognex.VisionPro.OCVMax.dll) Version: 73.0.0.0
Syntax
The CogOCVMaxParagraphIterator type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | AreConfusable(Char, Char) | If the computed confusion score between the specified search character and the specified alphabet character is below the confusion threshold for this paragraph, then return false (i.e. this pair is NOT considered confusable). Otherwise return true (i.e. this pair IS considered confusable). This method assumes that the character keys in the associated font correspond to Unicode code point values. |
| AreConfusable(Int32, Int32) | If the computed confusion score between the specified search character key and the specified alphabet character key is below the confusion threshold for this paragraph, then return false (i.e. this pair is NOT considered confusable). Otherwise return true (i.e. this pair IS considered confusable). |
| Copy | Return a newly created paragraph iterator that is functionally identical to this one - it will have the same paragraph position within the same enclosing CogOCVMaxPattern object. |
| Copy(Int32) | Return a newly created paragraph iterator corresponding to the specified paragraph position within the same enclosing CogOCVMaxPattern object as this paragraph iterator. The argument is a positional offset from the current paragraph position, so a value of zero will yield a new paragraph iterator that is functionally identical to this one. |
| CreateLineIterator | Return a newly created line iterator corresponding to the initial line position of this paragraph. |
| Equals | (Inherited from Object.) |
 | Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetAlphabetCharacterKeys | Provide a list of every character key within the current font that may, either correctly or incorrectly, be observed within this paragraph. Confusion will be computed for every unique searched character versus this set of character keys. Note that if this list is empty, then EVERY character in the font will be used. |
| GetAlphabetCharacters | Provide a list of every character within the current font that may, either correctly or incorrectly, be observed within this paragraph. Confusion will be computed for every unique searched character versus this set of characters. Note that if this list is empty, then EVERY character in the font will be used. |
| GetConfusion(Char, Char) | Get the computed confusion between the specified search character and the specified alphabet character. This method assumes that the character keys in the associated font correspond to Unicode code point values. |
| GetConfusion(Int32, Int32) | Get the computed confusion between the specified search character key and the specified alphabet character key. |
| GetConfusionAlphabetCharacterKeys | Get the confusion alphabet character keys. This is the same as the alphabet keys for this paragraph. These character keys form one dimension of the confusion matrix for this paragraph. |
| GetConfusionAlphabetCharacters | Get the confusion alphabet characters. This is the same as the alphabet for this paragraph. These characters form one dimension of the confusion matrix for this paragraph. Note that this method assumes that the character keys in the associated font correspond to Unicode code point values. |
| GetConfusionSearchCharacterKeys | Get the confusion search character keys. This is the set of unique character keys that make up the text in this paragraph - the character keys for which we are searching. These character keys form one dimension of the confusion matrix for this paragraph. |
| GetConfusionSearchCharacters | Get the confusion search characters. This is the set of unique characters that make up the text in this paragraph - the characters for which we are searching. These characters form one dimension of the confusion matrix for this paragraph. Note that this method assumes that the character keys in the associated font correspond to Unicode code point values. |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetNextLineOrigin | Get the expected location, in paragraph coordinates, of the line after the last line in this paragraph. That is, if you were to append a line to this paragraph, this is where it would go. |
| GetNextParagraphOrigin | Get the expected location, in paragraph coordinates, of the next paragraph after this one. This will be located so that the first line in each paragraph is aligned (vertically) and the second paragraph will not overwrite the first (that is, the second paragraph will be positioned horizontally beyond the end of the longest line in the first paragraph. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MoveToNext | Move the paragraph iterator to the next paragraph position within the containing CogOCVMaxPattern object. If the iterator is already at the end position before this call, MoveToNext generates an exception. You may wish to check the IsEnd property before calling MoveToNext in order to avoid errors. |
| MoveToPosition | Move the paragraph iterator to the specified position within the containing CogOCVMaxPattern object. If the argument is zero, move to the first paragraph position in the CogOCVMaxPattern object. If the argument is -1, move to the end paragraph position in the CogOCVMaxPattern object. An exception is generated if the argument is not valid. |
| MoveToPrevious | Move the paragraph iterator to the previous paragraph position within the containing CogOCVMaxPattern object. If the iterator is already at the initial position before this call, MoveToPrevious generates an exception. You may wish to check the IsFirst property before calling MoveToPrevious in order to avoid errors. |
| SetAlphabet | Set the list of every character within the current font that may, either correctly or incorrectly, be observed within this paragraph to be EVERY character available in the font. Confusion will be computed for every unique searched character versus this set of characters. |
| SetAlphabet( Int32 ) | Set the list of every character within the current font that may, either correctly or incorrectly, be observed within this paragraph. Specifically, set the list to correspond to those characters whose keys are in the supplied array of System::Int32. If this array has no elements, then the resulting empty alphabet list will be interpreted to mean use all available characters. |
| SetAlphabet(String) | Set the list of every character within the current font that may, either correctly or incorrectly, be observed within this paragraph. Specifically, set the list to correspond to those characters in the supplied string argument. If the string argument is an empty string, the resulting empty alphabet list will be interpreted as meaning use all available characters. This method assumes that the character keys in the associated font are Unicode code point values. |
| SetAlphabet(CogOCVMaxCharacterTypeConstants) | Set the list of every character within the current font that may, either correctly or incorrectly, be observed within this paragraph. Specifically, set the list to correspond to those characters in the current font that match the categories specified by input bitfield. Categories include DecimalDigitNumber, LowercaseLetter, UppercaseLetter, All, and None. Note that the empty alphabet list created via the None setting will be interpreted as meaning use all available characters. This method assumes that the character keys in the associated font are Unicode code point values. |
| ToString | (Inherited from Object.) |
Properties
| Name | Description | |
|---|---|---|
 | ConfusionThreshold | Get or set the confusion threshold for this paragraph. Every paragraph builds a confusion matrix when it is trained. This two dimensional array has one dimension with as many elements as there are unique keys to be searched for within this paragraph - we will call these the search keys. The other dimension has as many elements as there are in the (current) alphabet - we will call these the alphabet keys. For any combination of search key and alphabet key there is an associated confusion value. That value indicates how confusable the two keys are, with values near one being very confusable (e.g. '5' and 'S') and values near zero being not confusable (e.g. '5' and '1'). The ConfusionThreshold property specifies the value below which other keys are not considered by the operator for confusion purposes. So, with a ConfusionThreshold of zero, all keys will be tried. |
| Font | Get or set the font for this paragraph. |
| FontRenderParams | Get or set the font render parameters for this paragraph. |
| IsEnd | Whether or not this iterator is positioned past the last paragraph in the containing CogOCVMaxPattern object. |
| IsFirst | Whether or not this paragraph position is the initial paragraph position within the containing CogOCVMaxPattern object. |
| IsInvalid | Whether or not this iterator is NOT positioned at a valid paragraph. If true, attempting to access paragraph-level properties or methods will produce an error. |
| LineCount | The number of lines currently contained in the paragraph referenced by this iterator. |
| Origin | Get or set the origin for this paragraph. |
| Pattern | |
| Polarity | Get or set the polarity for this paragraph. |
| Pose | Get or set the pose for this paragraph. |
| Position | Indicates the relative position of this paragraph within the CogOCVMaxPattern object. Numbering is zero based, so a value of zero indicates that this paragraph is the initial paragraph of the CogOCVMaxPattern object. |
| TuneParams | Get or set the tune parameters for this paragraph. |
See Also