Section 3: library functions
vpScale – multiply the current transformation matrix by a scaling matrix Synopsis #include <volpack.h> vpResult vpScale(vpc, sx, sy, sz) vpContext *vpc; double sxR; double syR; double szR; Arguments vpc VolPack context from vpCreateContext. sx Scale factor for the X dimension. sy Scale factor for the Y dimension. sz Scale factor for the Z dimension. Description…
vpRotate – multiply the current transformation matrix by a rotation matrix Synopsis #include <volpack.h> vpResult vpRotate(vpc, axis, degrees) vpContext *vpc; int axis; double degrees; Arguments vpc VolPack context from vpCreateContext. axis Rotation axis code (VP_X_AXIS, VP_Y_AXIS or VP_Z_AXIS). degrees Number of degrees to rotate. Description vpRotate is used to multiply the current transformation matrix by…
vpResample, vpResample2D, vpResample3D – resample an array Synopsis #include <volpack.h> vpResult vpResample(vpc, num_dimens, src_dimens, dst_dimens, src_strides, dst_strides, element_type, src_array, dst_array) vpContext *vpc; int num_dimens; int *src_dimens, *dst_dimens; int *src_strides, *dst_strides; int element_type; void *src_array, *dst_array; vpResult vpResample2D(src_array, src_x, src_y, dst_array, dst_x, dst_y, element_type, filter_type) void *src_array; int src_x, src_y; void *dst_array; int dst_x, dst_y; int…
vpRenderRawVolume, vpRenderClassifiedVolume – render a volume Synopsis #include <volpack.h> vpResult vpRenderRawVolume(vpc) vpContext *vpc; vpResult vpRenderClassifiedVolume(vpc) vpContext *vpc; Arguments vpc VolPack context from vpCreateContext. Description These routines are used to render a volume using the parameters in a rendering context. vpRenderRawVolume renders the data in the current voxel array and stores the result in the current…
vpRamp – initialize an array with a piecewise-linear ramp Synopsis #include <volpack.h> vpResult vpRamp(array, stride, num_points, ramp_x, ramp_y) float *array; int stride; int num_points; int *ramp_x; float *ramp_y; Arguments array Output array. stride Stride from one array element to the next, in bytes. num_points Number of entries in the input arrays (ramp_x and ramp_y). ramp_x…
vpOctreeMask – compute a mask representing one level of a min-max octree Synopsis #include <volpack.h> vpResult vpOctreeMask(vpc, array, array_size, max_level) vpContext *vpc; unsigned char *array; int array_size; int max_level; Arguments vpc VolPack context from vpCreateContext. array A 3D array for storing the mask. array_size Size of array in bytes. max_level Maximum octree level to descend…
vpNormalIndex, vpNormal – encode/decode a surface normal vector Synopsis #include <volpack.h> int vpNormalIndex(nx, ny, nz) double nx, ny, nz; vpResult vpNormal(n, nx_ptr, ny_ptr, nz_ptr) int n; double *nx_ptr, *ny_ptr, *nz_ptr; Arguments nx X component of surface normal vector. ny Y component of surface normal vector. nz Z component of surface normal vector. n Encoded surface…
vpMultMatrix – multiply the current transformation matrix by another matrix Synopsis #include <volpack.h> vpResult vpMultMatrix(vpc, m) vpContext *vpc; vpMatrix4 m; Arguments vpc VolPack context from vpCreateContext. m Input matrix. Description vpMultMatrix is used to multiply the current transformation matrix by an arbitrary 4-by-4 transformation matrix. Use vpCurrentMatrix to set the current transformation matrix. By default,…
vpLoadRawVolume, vpLoadMinMaxOctree, vpLoadClassifiedVolume, vpLoadContext – load volume data structures from a file Synopsis #include <volpack.h> vpResult vpLoadRawVolume(vpc, fd) vpContext *vpc; int fd; vpResult vpLoadMinMaxOctree(vpc, fd) vpContext *vpc; int fd; vpResult vpLoadClassifiedVolume(vpc, fd) vpContext *vpc; int fd; vpResult vpLoadContext(vpc, fd) vpContext *vpc; int fd; Arguments vpc VolPack context from vpCreateContext. fd File descriptor from open(2), open…
vpIdentityMatrix – load the identity matrix into the current transformation matrix Synopsis #include <volpack.h> vpResult vpIdentityMatrix(vpc) vpContext *vpc; Arguments vpc VolPack context from vpCreateContext. Description vpIdentityMatrix is used to load a 4-by-4 identity matrix into the current transformation matrix. Use vpCurrentMatrix to set the current transformation matrix. Errors The return value is always VP_OK. See…
vpGeti, vpGetd, vpGetp – get the value of an option Synopsis #include <volpack.h> vpResult vpGeti(vpc, option, iptr) vpContext *vpc; int option; int *iptr; vpResult vpGetd(vpc, option, dptr) vpContext *vpc; int option; double *dptr; vpResult vpGetp(vpc, option, pptr) vpContext *vpc; int option; void *pptr; Arguments vpc VolPack context from vpCreateContext. option Constant that specifies the option…
vpGetTimer, vpClearTimer – interval timer facility Synopsis #include <volpack.h> vpResult vpGetTimer(vpc, option, iptr) vpContext *vpc; int option; int *iptr;; vpResult vpClearTimer(vpc, option) vpContext *vpc; int option; Arguments vpc VolPack context from vpCreateContext. option Constant that specifies a particular timer. iptr Location for storing the timer value. Description These functions are used for measuring the performance…
vpGetMatrix – retrieve the contents of a transformation matrix Synopsis #include <volpack.h> vpResult vpGetMatrix(vpc, matrix_code, matrix) vpContext *vpc; int matrix_code; vpMatrix4 matrix; Arguments vpc VolPack context from vpCreateContext. matrix_code A code specifying one of the VolPack transformation matrices (VP_MODEL, VP_VIEW, VP_PROJECT or VP_SCREEN). matrix Matrix for storing the result. Description vpGetMatrix retrieves the contents of…
vpGetMaterial – get material properties Synopsis #include <volpack.h> vpResult vpGetMaterial(vpc, material, property, surface_side, r_ptr, g_ptr, b_ptr) vpContext *vpc; int material; int property; int surface_side; double *r_ptr, *g_ptr, *b_ptr; Arguments vpc VolPack context from vpCreateContext. material A constant specifying a particular material number (VP_MATERIAL0, VP_MATERIAL1, …, VP_MATERIAL5). property A constant specifying one material property (VP_AMBIENT, VP_DIFFUSE,…
vpGetLight – get lighting properties Synopsis #include <volpack.h> vpResult vpGetLight(vpc, light_num, property, n0_ptr, n1_ptr, n2_ptr) vpContext *vpc; int light_num; int property; double *n0_ptr, *n1_ptr, *n2_ptr; Arguments vpc VolPack context from vpCreateContext. light_num A constant specifying a particular light source (VP_LIGHT0, VP_LIGHT1, …, VP_LIGHT5). property A constant specifying one lighting property (VP_COLOR or VP_DIRECTION). n0_ptr, n1_ptr,…
vpGetImage – get a field of the intermediate image Synopsis #include <volpack.h> vpResult vpGetImage(vpc, image, width, height, scan_bytes, pixel_type, image_type) vpContext *vpc; void *image; int width, height; int scan_bytes; int pixel_type, image_type; Arguments vpc VolPack context from vpCreateContext. image 2D array for storing result image. width Width of array in pixels. height Height of array…
vpGetError, vpGetErrorString – retrieve error codes Synopsis #include <volpack.h> vpResult vpGetError(vpc) vpContext *vpc; char * vpGetErrorString(code) vpResult code; Arguments vpc VolPack context from vpCreateContext. code A VolPack error result code. Description These routines are used for error handling. vpGetError return the error code from the first function call that failed since the last call to…
vpExtract – extract one field from a rectangular region of a volume Synopsis #include <volpack.h> vpResult vpExtract(vpc, volume_type, x0, y0, z0, x1, y1, z1, field, dst, dst_size, dst_xstride, dst_ystride, dst_zstride) vpContext *vpc; int volume_type; int x0, y0, z0; int x1, y1, z1; int field; void *dst; int dst_size; int dst_xstride, dst_ystride, dst_zstride; Arguments vpc VolPack…
vpEnable – enable or disable options Synopsis #include <volpack.h> vpResult vpEnable(vpc, option, value) vpContext *vpc; int option; int value; Arguments vpc VolPack context from vpCreateContext. option Constant that specifies the option to be adjusted. value New value for the option (boolean: 0 or 1). Description vpEnable is used to enable or disable boolean options in…
vpCurrentMatrix – choose the current transformation matrix Synopsis #include <volpack.h> vpResult vpCurrentMatrix(vpc, option) vpContext *vpc; int option; Arguments vpc VolPack context from vpCreateContext. option A code specifying one of the VolPack transformation matrices (VP_MODEL, VP_VIEW or VP_PROJECT). Description vpCurrentMatrix is used to choose the current transformation matrix. The option parameter must be one of the…