CogOCVMaxParagraphIterator MethodsCognex VisionPro 9.5

The CogOCVMaxParagraphIterator type exposes the following members.

Methods

  NameDescription
Public methodAreConfusable(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.
Public methodAreConfusable(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).
Public methodCopy 
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.
Public methodCopy(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.
Public methodCreateLineIterator
Return a newly created line iterator corresponding to the initial line position of this paragraph.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetAlphabetCharacterKeys
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.
Public methodGetAlphabetCharacters
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.
Public methodGetConfusion(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.
Public methodGetConfusion(Int32, Int32)
Get the computed confusion between the specified search character key and the specified alphabet character key.
Public methodGetConfusionAlphabetCharacterKeys
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.
Public methodGetConfusionAlphabetCharacters
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.
Public methodGetConfusionSearchCharacterKeys
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.
Public methodGetConfusionSearchCharacters
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.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetNextLineOrigin
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.
Public methodGetNextParagraphOrigin
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.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMoveToNext
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.
Public methodMoveToPosition
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.
Public methodMoveToPrevious
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.
Public methodSetAlphabet 
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.
Public methodSetAlphabet( 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.
Public methodSetAlphabet(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.
Public methodSetAlphabet(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.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Top
See Also