The Linux Manuals (man pages) document is an important part of Linux documents. Linux Manuals are organized as several sections. Each section has a group of commands for a specific area in Linux usage, administration or development.
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…
vpCreateMinMaxOctree, vpMinMaxOctreeThreshold, vpDestroyMinMaxOctree – create/destroy a min-max octree for optimized rendering Synopsis #include <volpack.h> vpResult vpCreateMinMaxOctree(vpc, root_node_size, base_node_size) vpContext *vpc; int root_node_size, base_node_size; vpResult vpMinMaxOctreeThreshold(vpc, param_num, range) vpContext *vpc; int param_num, range; vpResult vpDestroyMinMaxOctree(vpc) vpContext *vpc; Arguments vpc VolPack context from vpCreateContext. root_node_size Number of voxels per side in the top level (largest nodes) of…
vpCreateContext, vpDestroyContext – create/destroy a rendering context Synopsis #include <volpack.h> vpContext * vpCreateContext() void vpDestroyContext(vpc) vpContext *vpc; Arguments vpc VolPack context from vpCreateContext. Description vpCreateContext returns a handle for a new rendering context. It contains default values for most of the rendering parameters. vpDestroyContext destroys a rendering context and frees the associated memory. Only data…
vpClassifyVolume, vpDestroyClassifiedVolume – create/destroy a preclassified volume for fast rendering Synopsis #include <volpack.h> vpResult vpClassifyVolume(vpc) vpContext *vpc; vpResult vpDestroyClassifyVolume(vpc) vpContext *vpc; Arguments vpc VolPack context from vpCreateContext. Description vpClassifyVolume is used to compute a preclassified volume for the fast rendering algorithm. The preclassified volume is an internal data structure optimized for rendering speed. vpClassifyVolume should…
vpClassifyScanline – incrementally create a preclassified volume from scanlines of scalar data Synopsis #include <volpack.h> vpResult vpClassifyScanline(vpc, voxels) vpContext *vpc; void *voxels; Arguments vpc VolPack context from vpCreateContext. voxels 1D array of voxel data. Description vpClassifyScanline is used to incrementally compute a preclassified volume by classifying one scanline of voxels and storing the result in…
vpClassifyScalars – create a preclassified volume from scalar data Synopsis #include <volpack.h> vpResult vpClassifyScalars(vpc, scalar_data, length, scalar_field, gradient_field, norm_field) vpContext *vpc; unsigned char *scalars; int size; int scalar_field, gradient_field, norm_field; Arguments vpc VolPack context from vpCreateContext. scalar_data A 3D array containing one 8-bit scalar value for each voxel in the volume. length Size of scalar_data…
vpBruteForceRender – render using a simple brute-force method Synopsis #include <volpack.h> vpResult vpBruteForceRender(vpc) vpContext *vpc; Arguments vpc VolPack context from vpCreateContext. Description This function is for debugging purposes only. It performs the same function as vpRenderRawVolume, but uses a simpler, very inefficient algorithm. The two functions should produce identical results. See Also VolPack(3), vpRenderRawVolume(3)
vpBoxFilter, vpLinearFilter, vpBicubicFilter, vpGaussianFilter – initialize a filter weight table Synopsis #include <volpack.h> vpResult vpBoxFilter(num_taps, num_phases, weights, weights_bytes) int num_taps, num_phases; float *weights; int weights_bytes; vpResult vpLinearFilter(num_taps, num_phases, weights, weights_bytes) int num_taps, num_phases; float *weights; int weights_bytes; vpResult vpBicubicFilter(b_value, c_value, num_taps, num_phases, weights, weights_bytes) double b_value, c_value; int num_taps, num_phases; float *weights; int weights_bytes; vpResult…
votequorum_trackstop – Disable callbacks notification. Synopsis #include <corosync/votequorum.h> int votequorum_trackstart(votequorum_handle_t *handle); Description The votequorum_trackstop function is used to disable callbacks notification from the votequorum API. Return Value This call returns the CS_OK value if successful, otherwise an error is returned. Errors CS_ERR_TRY_AGAIN Resource temporarily unavailable CS_ERR_INVALID_PARAM Invalid argument CS_ERR_ACCESS Permission denied CS_ERR_LIBRARY The connection failed…
votequorum_trackstart – Enable callbacks notification. Synopsis #include <corosync/votequorum.h> int votequorum_trackstart(votequorum_handle_t *handle, uint64_t context, unsigned int flags); Description The votequorum_trackstart function is used to enable callbacks notification from the votequorum API. Every time the voting configuraton changes (eg a node joins or leave the cluster) or the quorum status change or the expected votes changes, the…
votequorum_setvotes – Sets the number of votes for a node Synopsis #include <corosync/votequorum.h> int votequorum_setexpected(votequorum_handle_t handle, unsigned int nodeid, int votes); Description The votequorum_setvotes is used to change the number of votes that a node has. Note that it is not possible, using this function, to change the number of node votes such that the…
votequorum_setexpected – Sets the expected votes for the cluster Synopsis #include <corosync/votequorum.h> int votequorum_setexpected(votequorum_handle_t handle, int expected_votes); Description The votequorum_setexpected function is used to change the expected votes in the cluster. Expected votes is used to calculate quorum and should normally be the total number of votes that will exist when all the expected nodes…
votequorum_qdevice_update – Updates quorum device name Synopsis #include <corosync/votequorum.h> int votequorum_qdevice_update(votequorum_handle_t handleconst char oldname, const char newname); Description The votequorum_qdevice_update is used to change the name of the quorum device to corosync. The name of q quorum device is purely informational and has no significance to votequorum itself, but it’s useful for the name (displayed…
votequorum_qdevice_unregister – Unregisters a new quorum device Synopsis #include <corosync/votequorum.h> int votequorum_qdevice_unregister(votequorum_handle_t handle, const char *name); Description The votequorum_qdevice_unregister unregisters a quorum device. Any votes it had will be removed from the cluster. NOTE that this could make the cluster inquorate. Return Value This call returns the CS_OK value if successful, otherwise an error is…
votequorum_qdevice_register – Registers a new quorum device Synopsis #include <corosync/votequorum.h> int votequorum_qdevice_register(votequorum_handle_t handle, const char *name); Description The votequorum_qdevice_register is used to register a new quorum device. A quorum device is an external way of adding votes to a small cluster. The quorum device is, in effect, a pseudo node in the cluster that provide…
votequorum_qdevice_poll – Tells votequorum the result of the quorum device poll Synopsis #include <corosync/votequorum.h> int votequorum_qdevice_poll(votequorum_handle_t handle, const char *name, unsigned int cast_vote, votequorum_ring_id_t ring_id); Description The votequorum_qdevice_poll is called by the quorum device subsystem (not provided as part of votequorum) to tell the voting system if the quorum device is present/active or not. If…