Library overview

ContRap class overview

Class index

Class CvMat
Class CvPoint
Class CvScalar
Class CvVideoGrabber
Class FILE
Class GLLine
Class GLPlane
Class GLPoint
Class GLPrimitive
Class GLScene
Class GLSphere
Class GLVertex
Class IplImage
Class List
Class Primitive2D
Class QColor
Class QImage
Class QPoint
Class QPointF
Class QRect
Class QRectF
Class QSize
Class QSizeF
Class QString
Class QWidget
Class QtCanvas
Class QtFileDialog
Class QtGLViewer
Class QtImageViewer
Class QtLineEdit
Class QtPlayer
Class QtPushButton
Class QtSlider
Class QtTimer
Class QwtImplicitCurve
Class QwtPlotCurve
Class QwtPlotSpectrogram
Class QwtPlotWidget
Class String
Class Test
Class TestClass
Class XMLDataPool
Class ex
Class lmatrix_t
Class lvector_t
Class matrix
Class numeric
Class operator
Class std::vector

Class CvMat

Here you will find all the class functions of 'CvMat'.

CvMat(filename:String):CvMat: Loads an OpenCV matrix from file with a header element-wise
CvMat(filename:String,rows:int,columns:int,format:String):CvMat: Loads an OpenCV matrix from file element-wise
CvMat(data:List):CvMat: Creates a CvMat instance from a list of numbers
CvMat(points:std::vector<CvPoint2D32f>):CvMat: Creates a matrix from a vector of points
CvMat(rows:int,columns:int,format:String):CvMat: Creates a new OpenCV matrix from size
append(matrix:CvMat,other:CvMat):CvMat: Appends a matrix to the end of the first matrix
columns(matrix:CvMat):int: Returns the column number of an OpenCV matrix
operator*(left:CvMat,right:CvMat):CvMat: Multiplies two OpenCV matrices
operator+(left:CvMat,right:CvMat):CvMat: Adds two OpenCV matrices
operator[](matrix:CvMat,row:int,column:int): Returns an element of the matrix
operator^(matrix:CvMat,power:):CvMat: Powers an OpenCV matrix
put(matrix:CvMat,source:CvMat,row:int,column:int):void: Puts an OpenCV matrix into the given matrix at the given position
rows(matrix:CvMat):int: Returns the row number of an OpenCV matrix
save(matrix:CvMat,filename:String,header:bool):void: Writes an OpenCV matrix to a file

Class CvPoint

Here you will find all the class functions of 'CvPoint'.

CvPoint(x:int,y:int):CvPoint: Creates a CvPoint instance from two integers
x(point:CvPoint):int: Returns a reference to the X-coordinate of a CvPoint
y(point:CvPoint):int: Returns a reference to the Y-coordinate of a CvPoint

Class CvScalar

Here you will find all the class functions of 'CvScalar'.

CvScalar(value:double):CvScalar: Creates a CvScalar from a gray value amount
CvScalar(r:double,g:double,b:double,alpha:double):CvScalar: Creates a CvScalar from a list of color entries

Class CvVideoGrabber

Here you will find all the class functions of 'CvVideoGrabber'.

CvVideoGrabber(camera:int):CvVideoGrabber: Creates an empty uninitialized grabber
grab(self:CvVideoGrabber):IplImage: Grabs an image from the camera
init(self:CvVideoGrabber,camera:int):void: Initializes the camera driver
setExposure(self:CvVideoGrabber,value:int):void: Sets the exposure of the device
setGain(self:CvVideoGrabber,value:int):void: Sets the shutter value
setResolution(self:CvVideoGrabber,width:int,height:int):void: Sets the resolution of the image
stop(self:CvVideoGrabber):void: Stops capturing from the camera

Class FILE

Here you will find all the class functions of 'FILE'.

FILE(filename:String,mode:String):FILE: Opens a file for the given mode
close(file:FILE):void: Closes the file descriptor
read(file:FILE):String: Reads a string from a file
write(file:FILE,text:String):void: Writes a string to a file

Class GLLine

Here you will find all the class functions of 'GLLine'.

GLLine(start:GLVertex,end:GLVertex):GLLine: Creates a new line primitive from its coordinates
GLLine(a:GLVertex,b:GLVertex,c:GLVertex):GLTriangle: Creates a triangle primitive from three points

Class GLPlane

Here you will find all the class functions of 'GLPlane'.

GLPlane(x:GLVertex,n:GLVertex,w:double):GLPlane: Creates a new plane primitive from its coordinates

Class GLPoint

Here you will find all the class functions of 'GLPoint'.

GLPoint(p:GLVertex):GLPoint: Creates a new point primitive from its coordinates

Class GLPrimitive

Here you will find all the class functions of 'GLPrimitive'.

move(primitive:GLPrimitive,position:GLVertex):void: Moves a primitive
setColor(primitive:GLPrimitive,color:QRgb):void: Sets the color of a primitive

Class GLScene

Here you will find all the class functions of 'GLScene'.

add(scene:GLScene,primitive:GLPrimitive):void: Removes a primitive from the OpenGL scene

Class GLSphere

Here you will find all the class functions of 'GLSphere'.

GLSphere(x:GLVertex,r:double):GLSphere: Creates a new sphere primitive from its coordinates

Class GLVertex

Here you will find all the class functions of 'GLVertex'.

GLVertex(x:double,y:double,z:double):GLVertex: Creates a new vertex from its coordinates

Class IplImage

Here you will find all the class functions of 'IplImage'.

IplImage(image:QImage):IplImage: Converts a QImage to an IplImage
IplImage(filename:String):IplImage: Loads an image using the OpenCV image loader
IplImage(width:int,height:int,channels:int):IplImage: Creates an IplImage from width and height
height(image:IplImage):int: Returns the height of an OpenCV image
line(image:IplImage,start:CvPoint,end:CvPoint,channel:int):std::vector<double>: Returns an array of double values, which form a line and a given channel in the image
resize(image:IplImage,width:int,height:int):IplImage: Resizes an image to the given size
save(image:IplImage,filename:String):void: Saves an image using the OpenCV image save function
set(image:IplImage,x:int,y:int,scalar:CvScalar):void: Sets the scalar value of a pixel at the given position
set(image:IplImage,x:int,y:int,value:double):void: Sets the scalar value of a pixel at the given position
width(image:IplImage):int: Returns the width of an OpenCV image

Class List

Here you will find all the class functions of 'List'.

List(value:matrix):List: Returns all the elements of the given column matirx in a list
List(size:int,entry:):List: Creates a list with empty entries
operator->(value:List,list:List):List: Appends a list at the beginning of the list by modifying the list
operator<-(list:List,value:List):List: Appends a list at the end of the list by modifying the list
operator<<(list:List,value:):List: Appends an element at the end of the list by modifying the list
operator>>(value:,list:List):List: Appends an element at the beginning of the list by modifying the list
operator[](list:List,index:int): Provides access to a list element
set(list:List,index:int,entry:):List: Sets a value of the list
size(value:List):int: Returns the size of a list

Class Primitive2D

Here you will find all the class functions of 'Primitive2D'.

Primitive2D(matrix:CvMat):Primitive2D: Converts a matrix to a list of point primitives
Primitive2D(sequence:CvSeq):Primitive2D: Converts a vector of points to primitives
Primitive2D(points:std::vector<CvPoint2D32f>):Primitive2D: Converts a vector of points to primitives

Class QColor

Here you will find all the class functions of 'QColor'.

QColor(color:String):QColor: Creates a QColor instance from a string with the color name
QColor(r:int,g:int,b:int):QColor: Converts integer values to a QColor instance

Class QImage

Here you will find all the class functions of 'QImage'.

QImage(image:IplImage):QImage: Converts an IplImage to a QImage
QImage(filename:String):QImage: Loads an image from the disk
QImage(width:int,height:int):QImage: Creates a new QImage class instance
drawLine(image:QImage,start:QPoint,end:QPoint,color:QColor):void: Draws a line segment into a QImage
get(image:QImage,x:int,y:int):QRgb: Returns an image pixel
height(image:QImage):int: Returns the height of an image
save(image:QImage,file_name:String):void: Saves the image to the disk
scale(image:QImage,width:int,height:int):QImage: Scales a QImage to the given size
set(image:QImage,x:int,y:int,color:QRgb):void: Sets an image pixel
show(image:QImage):void: Shows an QImage in a widget
width(image:QImage):int: Returns the width of an image

Class QPoint

Here you will find all the class functions of 'QPoint'.

QPoint(x:int,y:int):QPoint: Creates a QPoint instance from two integers
x(point:QPoint):int: Provides modifying access to the X-coordinate of the point
y(point:QPoint):int: Provides modifying access to the Y-coordinate of the point

Class QPointF

Here you will find all the class functions of 'QPointF'.

QPointF(list:List):QPointF: Creates a QPointF instance from a list
QPointF(x:double,y:double):QPointF: Creates a QPointF instance from two floats
x(point:QPointF):double: Provides modifying access to the X-coordinate of the point
y(point:QPointF):double: Provides modifying access to the Y-coordinate of the point

Class QRect

Here you will find all the class functions of 'QRect'.

QRect():QRect: Creates an empty QRect instance
QRect(x:int,y:int,width:int,height:int):QRect: Creates a QRect instance from integers
height(rect:QRect):double: Provides access to the height of the rectangle
set(rect:QRectF,x:double,y:double,width:double,height:double):void: Modifies a QRect instance from floats
width(rect:QRect):double: Provides access to the width of the rectangle
x(rect:QRect):double: Provides access to the X-coordinate of the rectangle
y(rect:QRect):double: Provides access to the Y-coordinate of the rectangle

Class QRectF

Here you will find all the class functions of 'QRectF'.

QRectF():QRectF: Creates an empty QRectF instance
QRectF(list:List):QRectF: Creates a QRectF instance from a list of four floating point numbers
QRectF(x:double,y:double,width:double,height:double):QRectF: Creates a QRectF instance from a list of four doubles
height(rect:QRectF):double: Provides access to the height of the rectangle
set(rect:QRectF,x:double,y:double,width:double,height:double):void: Modifies a QRectF instance from floats
width(rect:QRectF):double: Provides access to the width of the rectangle
x(rect:QRectF):double: Provides access to the X-coordinate of the rectangle
y(rect:QRectF):double: Provides access to the Y-coordinate of the rectangle

Class QSize

Here you will find all the class functions of 'QSize'.

QSize(width:int,height:int):QSize: Creates a new size from width and height

Class QSizeF

Here you will find all the class functions of 'QSizeF'.

QSizeF(width:double,height:double):QSizeF: Creates a new floating point size from width and height

Class QString

Here you will find all the class functions of 'QString'.

QString(value:String):QString: Creates a QString from a string

Class QWidget

Here you will find all the class functions of 'QWidget'.

attach(widget:QWidget,status:bool):void: Changes the status of the widget
fullscreen(widget:QWidget,status:bool):void: Sets the widgets full screen mode
resize(widget:QWidget,width:int,height:int):void: Changes the size of a widget
show(widget:QWidget,status:bool):void: Changes a visibility status of a widget

Class QtCanvas

Here you will find all the class functions of 'QtCanvas'.

QtCanvas():QtCanvas: Creates a new empty QtCanvas instance
addCoordinates(canvas:QtCanvas,position:QPointF,range:QRectF):void: Adds a coordinate axis to the canvas
addImage(canvas:QtCanvas,image:,position:QPointF):void: Adds an image observer to the canvas
add(canvas:QtCanvas,image:QImage,position:QPointF):void: Adds an image to the canvas
add(canvas:QtCanvas,container:Container2D):void: Adds primitives to the canvas
lines(canvas:QtCanvas):Container2D: Returns the lines of the canvas
points(canvas:QtCanvas):Container2D: Returns the points of the canvas
remove(canvas:QtCanvas,type:int):void: Removes primitives from the canvas
setRange(canvas:QtCanvas,range:QRectF):void: Sets the range of the canvas
update(canvas:QtCanvas):void: Updates the canvas

Class QtFileDialog

Here you will find all the class functions of 'QtFileDialog'.

QtFileDialog():QtFileDialog: Constructs a new file dialog
changed(self:QtFileDialog,command:):void: Performs an action when the file name in the dialog has been changed
file(self:QtFileDialog):String: Returns the name of the selected file

Class QtGLViewer

Here you will find all the class functions of 'QtGLViewer'.

QtGLViewer():QtGLViewer: Creates a new OpenGL viewer
add(self:QtGLViewer,primitive:GLPrimitive):void: Adds a primitive to the scene
remove(self:QtGLViewer,primitive:GLPrimitive):void: Removes an item from the top level scene of the widget
reset(self:QtGLViewer):void: Clears the primitives inside the viewer

Class QtImageViewer

Here you will find all the class functions of 'QtImageViewer'.

QtImageViewer(options:List):QtImageViewer: Constructs an image viewer with the given options
clear(self:QtImageViewer):void: Clears the external primitives
click(self:QtImageViewer,expression:):void: Defines the widget behaviour when the image is clicked
cursor(self:QtImageViewer):QPointF: Returns the cursor position
move(self:QtImageViewer,expression:):void: Defines the widget behaviour when the cursor moves over the image
setImage(self:QtImageViewer,image:QImage):void: Sets the image to view
setPrimitive(self:QtImageViewer,primitive:Primitive2D):void: Sets external primitives to draw

Class QtLineEdit

Here you will find all the class functions of 'QtLineEdit'.

QtLineEdit():QtLineEdit: Creates a new line edito widget
setText(self:QtLineEdit,text:String):void: Sets the text of the editor
text(self:QtLineEdit):QString: Returns the text of the widget

Class QtPlayer

Here you will find all the class functions of 'QtPlayer'.

changed(self:QtPlayer,expression:):void: Sets the expression which should be evaluated if the player value has changed

Class QtPushButton

Here you will find all the class functions of 'QtPushButton'.

QtPushButton(text:String,expression:):QtPushButton
pressed(self:QtPushButton,expression:):void: Calls an expression when the button is pressed
setText(self:QtPushButton,text:String):void: Sets the text of the button

Class QtSlider

Here you will find all the class functions of 'QtSlider'.

QtSlider():QtSlider
change(self:QtSlider,expression:):void: Sets the expression which should be evaluated if the slider value has changed
position(self:QtSlider):int: Returns the slider value
setRange(self:QtSlider,min:int,max:int):void: Sets the range of the slider
set(self:QtSlider,value:int):void: Sets the slider value

Class QtTimer

Here you will find all the class functions of 'QtTimer'.

QtTimer(command:):QtTimer: Creates a timer without starting it
QtTimer(time:int,command:):QtTimer: Creates a timer and starts it with the given timeout period
start(timer:QtTimer,time:int):void: Starts a timer which executes a command on timeout
stop(timer:QtTimer):void: Stops the timer

Class QwtImplicitCurve

Here you will find all the class functions of 'QwtImplicitCurve'.

QwtImplicitCurve(expression:):QwtImplicitCurve: Creates a raster data from an expression

Class QwtPlotCurve

Here you will find all the class functions of 'QwtPlotCurve'.

QwtPlotCurve():QwtPlotCurve: Creates a new empty plot curve
QwtPlotCurve(start:QPointF,end:QPointF):QwtPlotCurve: Creates a new simple line plot curve
QwtPlotCurve(plot:QwtPlot):QwtPlotCurve: Creates a new empty plot curve
QwtPlotCurve(data:QwtData):QwtPlotCurve: Creates a new plot curve with given data
attach(curve:QwtPlotCurve,plot:QwtPlot):void: Attaches a curve to the widget
detach(curve:QwtPlotCurve):void: Attaches a curve to the widget
setData(curve:QwtPlotCurve,data:QwtData):QwtPlotCurve: Creates a new plot curve with given data
setData(curve:QwtPlotCurve,data:std::vector<double>):QwtPlotCurve: Creates a new plot curve with given data

Class QwtPlotSpectrogram

Here you will find all the class functions of 'QwtPlotSpectrogram'.

QwtPlotSpectrogram():QwtPlotSpectrogram: Creates a new plot spectrogram
QwtPlotSpectrogram(data:QwtRasterData):QwtPlotSpectrogram: Creates a new plot spectrogram with given data
QwtPlotSpectrogram(plot:QwtPlot):QwtPlotSpectrogram: Creates a new plot spectrogram attached to the given plot
QwtPlotSpectrogram(expression:):QwtPlotSpectrogram: Creates a new plot spectrogram with a given implicit function
attach(spectrogram:QwtPlotSpectrogram,plot:QwtPlot):void: Attaches a curve to the widget
detach(spectrogram:QwtPlotSpectrogram):void: Attaches a curve to the widget
setData(spectrogram:QwtPlotSpectrogram,data:QwtRasterData):void: Creates a new plot curve with given data

Class QwtPlotWidget

Here you will find all the class functions of 'QwtPlotWidget'.

QwtPlotWidget(options:List):QwtPlotWidget: Creates a new empty plot
add(plot:QwtPlotWidget,item:QwtPlotItem):QwtPlotItem: Adds a plot item to the plot
add(plot:QwtPlotWidget,spectrogram:QwtPlotSpectrogram):QwtPlotSpectrogram: Adds a spectrogram to the plot
add(plot:QwtPlotWidget,curve:QwtPlotCurve):QwtPlotCurve: Adds a curve to the plot
clear(plot:QwtPlotWidget):void: Clears the plot

Class String

Here you will find all the class functions of 'String'.

String(value:QString):String: Creates a String from a QString
String(value:std::string):String: Constructs a string from a standard string
String(value:double):String: Constructs a string from a floating point number
String(value:int):String: Constructs a string from an integer
split(value:String,delimiter:String):List: Splits a string in a list of strings

Class Test

Here you will find all the class functions of 'Test'.

Test(test:String):Test: Constructor of the class
set(self:Test,value:String):void: Setter method of the class

Class TestClass

Here you will find all the class functions of 'TestClass'.

TestClass(value:String):TestClass: Creates a class instance
get(self:TestClass):String: A getter method

Class XMLDataPool

Here you will find all the class functions of 'XMLDataPool'.

XMLDataPool():XMLDataPool: Creates an XML data pool from scratch
XMLDataPool(text:String):XMLDataPool: Creates an XML data pool from an XML string
getBool(pool:XMLDataPool,key:String):bool: Returns a boolean value associated with the given address
getDouble(pool:XMLDataPool,key:String):double: Returns a double value associated with the given address
getInt(pool:XMLDataPool,key:String):int: Returns a int value associated with the given address
load(pool:XMLDataPool,filename:String):XMLDataPool: Loads an XML data pool from file
load(filename:String):XMLDataPool: Loads an XML data pool from file
operator[](pool:XMLDataPool,key:String):String: Returns a string with the text value associated with the given address
operator[](pool:XMLDataPool,key:String,attribute:String):String: Returns an attribute associated with the given address and attribute name
save(pool:XMLDataPool,filename:String):void: Saves an XML data pool to a file
set(pool:XMLDataPool,key:String,value:String):void: Sets the value of the given key
set(pool:XMLDataPool,key:String,attribute:String,value:String):void: Sets the value of the given attribute

Class ex

Here you will find all the class functions of 'ex'.

ex(value:numeric):ex: Creates a GiNaC expression from a numeric object
ex(value:matrix):ex: Returns an element of the given matrix of dimension 1x1
ex(identifier:Identifier):ex: Creates a GiNaC expression from an identifier
export(value:ex): Converts an expression to a regular ContRap object
operator[](value:ex,element:int):ex: Provides access to a subexpression
size(value:ex):int: Returns the numer of operands in an expression
symbols(expression:ex):lst: Returns the list of symbols in the expression

Class lmatrix_t

Here you will find all the class functions of 'lmatrix_t'.

column(matrix:lmatrix_t,column:int):lvector_t: Returns a column of the given matrix
lmatrix_t(vector:lvector_t):lmatrix_t: Converts the vector into the column matrix represenation
lmatrix_t(data:List):lmatrix_t: Creates a LAPACK matrix from a list of rows
lmatrix_t(rows:int,columns:int):lmatrix_t: Creates a LAPACK zero matrix with given row and column number
operator*(A:lmatrix_t,B:lmatrix_t):lmatrix_t: LAPACK matrix multiplication operator
operator*(A:lmatrix_t,b:double):lmatrix_t: Matrix multiplication operator
operator*(a:double,B:lmatrix_t):lmatrix_t: Matrix multiplication operator
operator+(A:lmatrix_t,B:lmatrix_t):lmatrix_t: LAPACK matrix addition operator
operator-(A:lmatrix_t):lmatrix_t: Matrix algebraic negation operator
operator/(A:lmatrix_t,b:double):lmatrix_t: Matrix multiplication operator
operator[](matrix:lmatrix_t,row:int,column:int):double: Accesses the elements of a matrix
operator^(matrix:lmatrix_t,power:int):lmatrix_t: Power operator for LAPACK matrices
row(matrix:lmatrix_t,row:int):lvector_t: Returns a row of the given matrix

Class lvector_t

Here you will find all the class functions of 'lvector_t'.

lvector_t(data:List):lvector_t: Creates a LAPACK vector from a list of rows
norm(vector:lvector_t):double: Computes the Euclidean norm of a vector
operator-(vector:lvector_t):lvector_t: Vector algebraic negation operator-
operator[](vector:lvector_t,element:int):double: Accesses an element of a vector
operator|(left:lvector_t,right:lvector_t):double: Computes the standard Euclidean scalar product of two vectors

Class matrix

Here you will find all the class functions of 'matrix'.

column(value:matrix,column:int):matrix: Returns a column of the given matrix
matrix(data:List):matrix: Creates a matrix from a list of data
matrix(rows:int,columns:int):matrix: Creates a matrix from its dimensions
operator*(left:matrix,right:matrix):matrix: Multiplies two matrices
operator*(left:matrix,right:ex):matrix: Multiplies a matrix with a scalar
operator*(left:ex,right:matrix):matrix: Multiplies a matrix with a scalar
operator+(left:matrix,right:matrix):matrix: Adds two matrices
operator-(value:matrix):matrix: Negates a matrix
operator/(left:matrix,right:ex):matrix: Divides a matrix by a scalar
operator[](value:matrix,row:int):ex: Returns an element of the given column matrix
operator[](value:matrix,row:int,column:int):ex: Returns an element of the given matrix
operator^(left:matrix,power:ex):matrix: Matrix power
operator^(left:matrix,power:Identifier):matrix: Matrix power with identifiers
operator^(left:matrix,power:int):matrix: Matrix numeric power
row(value:matrix,row:int):matrix: Returns a row of the given matrix
submatrix(value:matrix,row:int,column:int,rows:int,columns:int):matrix: Returns a sub-matrix of the given matrix starting a the given position with given dimensions

Class numeric

Here you will find all the class functions of 'numeric'.

numeric(value:ex):numeric: Converts an expression to a numeric object
operator>(left:numeric,right:numeric):bool: Comparison operator

Class operator

Here you will find all the class functions of 'operator'.

=(pixel:QtPixelRef,value:QtPixelRef):void: Sets a pixel value at a given image position
=(pixel:QtPixelRef,value:QRgb):void: Sets a pixel value at a given image position

Class std::vector

Here you will find all the class functions of 'std::vector'.

add(vector:std::vector<QImage>,element:QImage):QImage: Adds an entry to the vector by copying the contents
clear(vector:std::vector<QImage>):void: Clears the vector