text
3D VISUALIZATION SYSTEM FOR OCTAVE
About
News
Download
Documentation
Screenshots
Project page
Untitled Document
Function File: vtk_arrows3(x,y,z,nx,ny,nz, [fmt | prop,val])
Displayes oriented arrows at points defined by triplets (x,y,z). Arrows are oriented along the vectors defined by triplets (nx,ny,nz)

The optional fmt takes the form of a "line specification"; e.g. "r" would cause the arrows to be red. The optional prop,val is a property,value pair argument. Valid properties are ";Color;TipLength;TipRadius;ShaftRadius;".

Function File: vtk_axis(bool)
Right now, this can only be used to turn the axes on and off. Eventually this function should allow setting the scaling and limits of the axes.
Function File: vtk_clear
Clears all rendered actors, title, and scalar bar. Does not clear the axes or outline.
Function File: vtk_close(n)
Closes the specified vtk figure window. All structures referencing the figure window must be cleared from userspace in order for the window to close.
Function File: vtk_arrows3(x,y,z,nx,ny,nz, [fmt | prop,val])
Displayes oriented cones at points defined by triplets (x,y,z). Cones are oriented along the vectors defined by triplets (nx,ny,nz)

The optional fmt takes the form of a "line specification"; e.g. "r" would cause the arrows to be red. The optional prop,val is a property,value pair argument. Valid properties are ";Color;Height;Radius;".

Function File: vtk_contour3(x,y,z,c,[prop,val])
Displays a contour plot defined by x,y,z matrices, where x and y are typically formed by meshgrid. c is an optional matrix to give a color scale.

Optional prop,val arguments can be used to change properties of the plot. Currently, valid properties are ";NConts;".

Function File: f = vtk_figure(n)
Creates a vtk figure window and returns its information in the octave structure variable f. For figures that already exist, the figure structure for the specified figure number is returned. To get the current figure, use f = vtk_figure(0).
Function File: [color, mt, lsty] = vtk_get_line_spec(fmt)
Octaviz internal function for processing format specifications.
Function File: vtk_imshow(a)
Displays the unscaled (0-256?) data in a as an image. a may be NxM or NxMx3.
Function File: vtk_line3(x, y, z, [fmt | prop,val])

Plots 3D line segments between the specified points. The data point coordinates must be given as 3 equal size x, y, and z matrices. The optional fmt takes the form of a "line specification"; e.g. "r" would cause the lines to be plotted in color red. The optional prop,val is a property,value pair argument. Valid properties are Color, Radius, and Opacity.

Example: Knot (torus)

 vtk_line3 example
nmeridian  = 6; nlongitude = 11;
phi = 0:pi/1000:2*pi;
mu = phi * nmeridian;
x = cos(mu) .* (1 + cos(nlongitude*mu/nmeridian) / 2.0);
y = sin(mu) .* (1 + cos(nlongitude*mu/nmeridian) / 2.0);
z = sin(nlongitude*mu/nmeridian) / 2.0;
vtk_line3(x',y',z','Radius',0.05);

Function File: vtk_mesh(x,y,z,c,[prop,val])

Displays a mesh plot defined by x,y,z matrices, where x and y are typically formed by meshgrid. c is an optional matrix to give a color scale.

Optional prop,val arguments can be used to change properties of the plot. Currently, valid properties are ";BallRadius;LineRadius;Fancy;".

Example: Triaxial Teardrop

mesh example 
[u,v] = meshgrid(0.01:pi/20:pi,0:pi/20:2*pi);
x = ( 1 - cos(u) ) .* cos( u + 2*pi/3 ) .* cos( v + 2*pi/3 ) / 2;
y = ( 1 - cos(u) ) .* cos( u + 2*pi/3 ) .* cos( v - 2*pi/3 ) / 2;
z = cos( u - 2*pi/3 );
vtk_mesh(x,y,z,'Fancy',1);

Function File: vtk_meshc(x,y,z,c,[prop,val])

Displays both a mesh and contour plot defined by x,y,z matrices, where x and y are typically formed by meshgrid. c is an optional matrix to give a color scale.

Optional prop,val arguments can be used to change properties of the plot. Currently, valid properties are ";BallRadius;LineRadius;Fancy;NConts;".

Function File: vtk_plot(x, y, [fmt | prop,val])
Plots a typical scatter & line plot. x must be a vector input. y should be columns of data to plot against x. If y is omitted, x is plotted against its indices.

The optional formating arguments do nothing at the moment. More features are to be added with time.

Function File: vtk_plot3(x, y, z, [fmt | prop,val])
Plots a 3D point cloud. The data point coordinates must be given as 3 equal length x, y, and z vectors. The optional fmt takes the form of a "line specification"; e.g. "*r" would cause the points to be plotted as red spheres. The optional prop,val is a property,value pair argument. Valid properties are MarkerColor, MarkerSize, and Opacity.

Example: Everybody's favorite

coffee 
o = [30 62 19;8 21 10];
n = [31 21 11;18 42 14;55 46 17;56 25 13];
c = [5 49 15;30 50 16;42 42 15;43 29 13;18 28 12;32 6 8;63 36 15;59 60 20];
h = [23 5 7;32 0 16;37 5 0;73 36 16;69 60 20;54 62 28;57 66 12;6 59 16;1 44 22;0 49 6];
vtk_plot3(o(:,1),o(:,2),o(:,3),'MarkerSize', 8, 'MarkerColor', [1 0 0]);
vtk_plot3(n(:,1),n(:,2),n(:,3),'MarkerSize',10, 'MarkerColor', [0 0 1]);
vtk_plot3(c(:,1),c(:,2),c(:,3),'MarkerSize',10, 'MarkerColor', [0 1 0]);
vtk_plot3(h(:,1),h(:,2),h(:,3),'MarkerSize', 5, 'MarkerColor', [1 1 1]);

Function File: vtk_poly3(x, y, z, [fmt | prop,val])
Plots the specified points as a 3D polygon. The data point coordinates must be given as 3 equal length x, y, and z vectors. The optional fmt takes the form of a "line specification"; e.g. "r" would result in a red polygon. The optional prop,val is a property,value pair argument. Valid properties are currently ";Color;Opacity;".
Function File: f = vtk_polycut(t,x,y,z,c,p0,n)
This function cuts a polygon surface at a plane, leaving only the line plot of the surface in that plane. The plane is defined by the point p0 and the normal n.

This function is a bit rough and likely to change in the future.

Function File: vtk_print(filename,options)
"Prints" to a file. Default output is postscript if not specified.

options:

-ddevice
Output device, where device is one of:
ps

eps

pdf
Postscript or pdf type output
tiff

jpeg

png
Image output
rib
Renderman output
-vect
Use only vector graphic output for postscript/pdf. Default is to write 3D props as an image. Warning: incorrect polygon placement and/or huge filesize is probable with this option.
-tex
Write text to a tex file and exclude text from postscript/pdf.
-nocompress
Do not compress images in pdf and tiff output.
-qualityXX
Set jpeg quality. Default is 100.

The vtk window must be the top window on your display (i.e. unobstructed) for most of the output devices to work properly. This function now attempts to raise your vtk window to the top, but your windows manager may intercept that call (e.g. KDE). To prevent this, you should turn off so-called "Focus stealing prevention" options in your windows manager.

Function File: f = vtk_quiver3(z,u,v,w)
Plots the surface defined by z and line segments (~arrows) from the surface as defined by (u,v,w).

This function is a bit rough and likely to change in the future.

Function File: vtk_scalarbar(string)
Adds a color scalar bar to the side of a vtk figure. The input string will be the title of the scalar bar. This is a work in progress. It doesn't update automatically (although it can be called again), and only works on the last actor rendered.
Function File: vtk_surf(x,y,z,c,[prop,val])
Displays a surface plot defined by x,y,z matrices, where x and y are typically formed by meshgrid. c is an optional matrix to give a color scale.

Optional prop,val arguments can be used to change properties of the plot. Currently, valid properties are ";Opacity;Color;".

Example: Spherical harmonics

 surf example
[phi,theta] = meshgrid(0:pi/250:pi,0:pi/250:2*pi); 
m0 = 4; m1 = 3; m2 = 2; m3 = 3; m4 = 6; m5 = 2; m6 = 6; m7 = 4;
r = sin(m0*phi).^m1 + cos(m2*phi).^m3 + sin(m4*theta).^m5 + cos(m6*theta).^m7;
x = r .* sin(phi) .* cos(theta);
y = r .* cos(phi);
z = r .* sin(phi) .* sin(theta);
vtk_surf(x,y,z);

Function File: vtk_surfc(x,y,z,c,[prop,val])

Displays both a surface and contour plot defined by x,y,z matrices, where x and y are typically formed by meshgrid. c is an optional matrix to give a color scale.

Optional prop,val arguments can be used to change properties of the plot. Currently, valid properties are ";Opacity;Color;NConts;".

Function File: vtk_title(string)
Adds a title to a vtk figure.
Function File: f = vtk_trimesh(t,x,y,z,c,[prop,val])

Displays a meshplot defined by specified triangles. t gives a list of vertex indexes forming the triangles. x,y,z are vectors defining the vertices. c is a vector of color scalar values for the vertices and may be omitted. The vtk_figure object is returned in f, if desired. trimesh can be called with 2(3) or 4(5) parameters as trimesh(t,[x1 y1 z1; ...; xn, yn, zn],(c)) or trimesh(t,[x1; ...; xn],[y1; ...; yn], [z1; ...; zn],(c))

Optional prop,val arguments can be used to change properties of the plot. Currently, valid properties are ";BallRadius;LineRadius;Fancy;".

Function File: f = vtk_trisurf(t,x,y,z,c,[prop,val])
Displays a surface defined by specified triangles. t gives a list of vertex indexes forming the triangles. x,y,z are vectors defining the vertices. c is a vector of color scalar values for the vertices and may be omitted. The vtk_figure object is returned in f, if desired. trisurf can be called with 2(3) or 4(5) parameters as trisurf(t,[x1 y1 z1; ...; xn, yn, zn],(c)) or trisurf(t,[x1; ...; xn],[y1; ...; yn], [z1; ...; zn],(c))

Optional prop,val arguments can be used to change properties of the plot. Currently, valid properties are ";Opacity;Color;".

Function File: vtk_update(f)
Internal octaviz function for updating the specified figure.


This document was generated by Dragan Tubic on November, 27 2004 using texi2html