|
VecRCpline Class Function Manual |
|
|
VecRCpline Class Function Manual |
Purpose
To get a value of an element at a particular index in a Vector. The return result is a VecIndx object.
The first element index is 0, and the last one is n-1, where n is no of total elements.
Class
VecRCpline
Usage
{VecIndx} ret = object({int} argm1)
argm1 = index number
Example:
|
->v = VecRCpline() ->v.load("line.txt") ->print v |
See also (class function)
init
Purpose
To increase the maximum size of the vector by a given number.
Class
VecRCpline
Usage
{void} object.EXTEND({int} argm1)
argm1 = number of elements wanted to extend
Example:
|
->v = VecRCpline(5) ->v.maxsize() ->v.maxsize() |
See also (class function)
maxsize, truncate
Purpose
To find in a particular poly-line, a VecIndx object, in a vector. Two poly-line objects are the same if their ID number are the same, thus content of poly-lines plays no roll.
The return result is an index of the vector, if found, otherwise it returns -1.
Class
VecRCpline
Usage
{int} ret = object.FIND({VecIndx} argm1)
argm1 = a poly-line wanted to find
Example:
|
->print v ->pline1.id() = 1
->v.find(pline1) |
See also (class function)
Purpose
To initialize a vector object.
Please be aware that once the vector is initialized, it is still empty. Only its maximum number of element in the vector is declared. Use function "pushback" to insert element into a vector.
Class
VecRCpline
Usage
{void} object.INIT({int} argm1)
argm1 = number of maximum elements in the vector
Example:
|
->v = VecRCpline() ->v.init(500) -> |
See also (class function)
pushback
Purpose
To get the last poly-line from the vector.
Class
VecRCpline
Usage
{VecIndx} ret = object.LAST()
Example:
|
->print v |
See also (class function)
Purpose
To read data from an ASCII file and stored in a VecRCpline object.
If file name extension is omitted, the function will add default extensions to the files. The default extension of an ASCII data file is ".txt".
Unless the path name is given in the file names, the function will search for the files in the current working directory, defined by command "set path".
It is important to make sure that the poly-line ID appears right before the data. Each data line has exactly 2 fields, the first is for row number and the second is for column number. All of them are separated by at least one blank, a white space, ASCII 32.
It is possible to have a comment line in the data file, by inserting a slash sign, "/", in front of a line. Comment lines will not be read by the function.
The following is an example of 3 poly-lines stored in a file.
|
Class
VecRCpline
Usage
{void} object.LOAD({String} argm1)
argm1 = data filename (default extension is ".txt")
Example:
|
->v = VecRCpline() ->v.load("my_data") -> |
See also (class function)
save
Purpose
To report the maximum number of row and column in the vector by searching through all poly-lines in the vector.
Class
VecRCpline
Usage
{Pt2D} ret = object.MAX()
Example:
|
->max_rc = v.max() ->print max_rc |
See also (class function)
min
Purpose
To report the maximum size of the vector. This is the maximum number of elements that can be stored in the vector.
Class
VecRCpline
Usage
{int} ret = object.MAXSIZE()
Example:
|
->v = VecRCpline(5) ->v.maxsize() |
See also (class function)
size, truncate, extend
Purpose
To report the minimum number of row and column in the vector by searching through all poly-lines in the vector.
Class
VecRCpline
Usage
{Pt2D} ret = object.MIN()
Example:
|
->min_rc = v.min() ->print min_rc |
See also (class function)
max
Purpose
To insert a poly-line, a VecIndx object in a vector object. A new element will be insert at the last available index in the vector.
Suppose the vector has already 4 element in it, when a new element is inserted, the size is updated to 5 and the new element is stored at index number 4. The first element index is 0, and the last one is n-1, where n is no of total elements.
Class
VecRCpline
Usage
{void} object.PUSHBACK({VecIndx} argm1)
argm1 = poly-line being inserted
Example:
|
->print pline1 ->v.pushback(pline1) ->print v |
See also (class function)
init
Purpose
To find in a particular poly-line, a VecIndx object, in a vector. Two poly-line objects are the same if their ID number are the same, thus content of poly-lines plays no roll.
This function expects that the content of the vector is already sorted, or otherwise it will not work correctly.
It performs a binary searching which is much faster than using the function "find".
The return result is an index of the vector, if found, otherwise it returns -1.
Class
VecRCpline
Usage
{int} ret = object.QFIND({VecIndx} argm1)
argm1 = poly-line wanted to find
Example:- see class function "find"
|
-> |
See also (class function)
find
Purpose
To empty the content of the vector.
This function can be used to reset the vector very quick. It simply sets the size of the vector to zero. It does not do any memory initialization.
Class
VecRCpline
Usage
{void} object.REMALL()
Example:
|
->print v ->print v -> |
See also (class function)
remove
Purpose
To remove an element at a particular index out of the vector.
This function replaces the content at the required index with the last element, and simply reduces the size of the vector by 1.
Class
VecRCpline
Usage
{void} object.REMOVE({int} argm1)
argm1 = index at which the element being removed
Example:
|
->v = VecRCpline() ->v.load("line.txt") ->print v ->print v |
See also (class function)
remall
Purpose
To remove poly-lines that have the number of points less than a specified number of points.
This function is applicable for poly-lines that come directly from an edge image, where connected pixels create a line. Lines that are too short due to having few number of pixels can be deleted by this function.
Class
VecRCpline
Usage
{VecRCpline} ret = object.REMSALT()
Example:
|
->print v ->print v1 |
See also (class function)
smooth
Purpose
To reverse the order of the content of the vector. The last poly-line becomes the first element and the first poly-line becomes the last element of the vector.
Class
VecRCpline
Usage
{VecRCpline} ret = object.REVERSE()
Example:
|
->v = VecRCpline() ->v.load("line.txt") ->print v ->print v1 |
See also (class function)
remall, remove
Purpose
To save as ASCII format. Each block in the output file represents an element, a poly-line, in the vector.
if a file name extension is not given, the function assumes an extension of ".txt".
if a path name is not include in the specified file name, the function will search in the current data path, set by command "set path".
Class
VecRCpline
Usage
{void} object.SAVE({String} argm1)
argm1 = output file name
Example:
|
->v.save("my_data") |
See also (class function)
load
Purpose
To report the current size of the vector. This is the current number of elements in the vector.
Class
VecRCpline
Usage
{int} ret = object.SIZE()
Example:
|
->v = VecRCpline(5) ->v.size() |
See also (class function)
maxsize, truncate, extend
Purpose
To smooth all poly-lines in the vector.
The algorithm used here is Douglas-Peucker.
The user is required to provide a tolerant distance, which is used to determine whether a vertex will be include in the smooth version of the line. A vertex is discarded if the distance from it to the line is less than the given tolerance.
Class
VecRCpline
Usage
{VecRCpline} ret = object.SMOOTH({double} argm1)
argm1 = tolerant distance (in pixel unit)
Example:
|
->print v ->print v1 |
See also (class function)
Purpose
To sort poly-lines in a vector. Poly-lines are sorted from minimum to maximum according to their ID.
Class
VecRCpline
Usage
{VecRCpline} ret = object.SORT()
Example:
|
->v2 =
v1.sort() |
See also (class function)
qfind
Purpose
To trim out all the empty space of the current vector.
Suppose a vector has 5 elements in it, and its max size is 500, once it is trimmed, the max size is reduced to 5. This function does a new memory initialization.
Class
VecRCpline
Usage
{void} object.TRUNCATE()
argm1 = number of elements wanted to extend
Example:
|
->v = VecRCpline(5) ->v.maxsize() ->v.maxsize() |
See also (class function)
maxsize, extend
Purpose
To get the last poly-line from the vector, as well as remove it from the vector. Hence the size of the vector, the calling object, gets reduced by 1.
Class
VecRCpline
Usage
{VecIndx} ret = object.UNSTACK()
Example:
|
->print v ->print pline1 2 -> |
See also (class function)
Purpose
To extract a portion of a vector, specified by a starting index and ending index.
Class
VecRCpline
Usage
{VecRCpline} ret = object.WINDOW({int} argm1,{int} argm2)
argm1 = start index at which the element being extracted
argm2 = ending index at which the element being extracted
Example:
|
->print v ->print v1 |
See also (class function)
last, unstack