eVision Python API
Loading...
Searching...
No Matches
eVision.EObjectRunsIterator Class Reference

Iterator to the runs of a coded element. More...

Public Member Functions

None __init__ (self, eVision.ECodedElement codedElement)
 Constructs an iterator to the runs of a coded element.
None __init__ (self, eVision.EObjectRunsIterator other)
 Constructs an iterator to the runs of a coded element.
None First (self)
 Rewinds to the first run of the coded element.
bool IsDone (self)
 Tests whether all the runs have been spanned.
None Next (self)
 Advance to the next run in the iterator.
int Y (self)
 Returns the ordinate (Y-coordinate) of the run the iterator is currently over.
int StartX (self)
 Returns the abscissa (X-coordinate) of the leftmost pixel of the run the iterator is currently over.
int EndX (self)
 Returns the abscissa (X-coordinate) of the rightmost pixel of the run the iterator is currently over.
int Length (self)
 Returns the lengths of the run the iterator is currently over.

Detailed Description

Iterator to the runs of a coded element.

Remarks:

This class is responsible for the sequential access to the individual runs of a coded element.

A run is defined as a maximal sequence of consecutive pixels on the same run, that all belong to the same coded element.

License(s): EasyObject

Constructor & Destructor Documentation

◆ __init__() [1/2]

None eVision.EObjectRunsIterator.__init__ ( self,
eVision.ECodedElement codedElement )

Constructs an iterator to the runs of a coded element.

Parameters
codedElementThe coded element of interest, in the case the iterator is to be constructed from a given coded element.

◆ __init__() [2/2]

None eVision.EObjectRunsIterator.__init__ ( self,
eVision.EObjectRunsIterator other )

Constructs an iterator to the runs of a coded element.

Parameters
otherThe iterator to be copied, in the case of the copy constructor.

Member Function Documentation

◆ EndX()

int eVision.EObjectRunsIterator.EndX ( self)

Returns the abscissa (X-coordinate) of the rightmost pixel of the run the iterator is currently over.

Remarks:

An exception is thrown if the iterator has reached its end. Use eVision.EObjectRunsIterator.IsDone to check this condition.

◆ First()

None eVision.EObjectRunsIterator.First ( self)

Rewinds to the first run of the coded element.

◆ IsDone()

bool eVision.EObjectRunsIterator.IsDone ( self)

Tests whether all the runs have been spanned.

◆ Length()

int eVision.EObjectRunsIterator.Length ( self)

Returns the lengths of the run the iterator is currently over.

Remarks:

An exception is thrown if the iterator has reached its end. Use eVision.EObjectRunsIterator.IsDone to check this condition.

◆ Next()

None eVision.EObjectRunsIterator.Next ( self)

Advance to the next run in the iterator.

Remarks:

An exception is thrown if the iterator has reached its end. Use eVision.EObjectRunsIterator.IsDone to check this condition.

◆ StartX()

int eVision.EObjectRunsIterator.StartX ( self)

Returns the abscissa (X-coordinate) of the leftmost pixel of the run the iterator is currently over.

Remarks:

An exception is thrown if the iterator has reached its end. Use eVision.EObjectRunsIterator.IsDone to check this condition.

◆ Y()

int eVision.EObjectRunsIterator.Y ( self)

Returns the ordinate (Y-coordinate) of the run the iterator is currently over.

Remarks:

An exception is thrown if the iterator has reached its end. Use eVision.EObjectRunsIterator.IsDone to check this condition.