Decreases the reference count on this object by 1. If the reference count reaches 0, the object is deallocated.

Implements IRoot.

Gets the colorization map that is applied to the dataset and returns it in the variable at address pBuffer. All returned buffers are allocated using pAlloc. Each slice of colorization information is a separate zLib compressed buffer.

See also:

SetColorizationEnabled() for a description of this segmentation technique.

Parameters:

pBuffer	The address of a DATABYTE ** that is an array of pointers to zLib compressed colorization information. The array of pointers as well as the actual zLib compressed slice buffers are all allocated using pAlloc.
bufCount	The address of an h_int32 that is the number of DATABYTE * returned into pBuffer.
bufSizes	The address of an array of h_int32 that describe the compressed size of each slice descriptor in pBuffer. This array is allocated using pAlloc
pAlloc	The allocator to use for allocating the returned colorization information.

Returns an integer that represents the server side object that contains the octree.

Returns an array that contains a zLib compressed buffer. This buffer, when decompressed, will have one bit for every 2x2x2 subvolume in the volume if the segmentation granularity is SEG_GRAN_2X2X2 or one bit for every voxel in the dataset if the segmentation granularity is SEG_GRAN_1X1X1. In SEG_GRAN_2X2X2, a bit value of 1 will turn off that sub-volume. In SEG_GRAN_2X2X2, that bit will turn off the voxel if it was segmented using bMultiTF=H_FALSE, otherwise it will show the second transfer function.

In SEG_GRAN_2X2X2, the uncompressed buffer will be ((width*height*depth)/(2*2*2))/8 bytes in size. In SEG_GRAN_1X1X1, the uncompressed buffer will be (width*height*depth)/8 bytes in size.

Segmentation types:

If the segmentation granularity is 2x2x2, then the only method of segmentation available is toggling 2x2x2 voxel sub-volumes on and off.

If the segmentation granularity is 1x1x1, any of three segmentation techniques may be applied at once in a single scene:

• On/Off - When applying segmentations, setting bMultiTF to H_FALSE will turn off 2x2x2 sub-volumes that are completely set to bit value 1. If a 2x2x2 subvolume is partially set to 1, then the parts that are set to 1 will be rendered using the second transfer function. The parts set to 0 are rendered using the first transfer function. Using this, one can apply 1x1x1 on/off segmentation by setting the second transfer function to have identical colors as the first and zero opacity (COLORED_POINT::y2). Alternatively, one could have an opaque second transfer function and the layer between on and off will be displayed using the second transfer function (albeit at 2x2x2 granularity).

• Two Transfer Functions - When applying segmentations, setting bMultiTF to H_TRUE will apply the second transfer function to all voxels whose segmentation buffer bit is 1. Otherwise, the first transfer function is used. The data values in COLORED_POINT used by the first transfer function are pt.x, pt.y, c and lighting1. The data values in COLORED_POINT used by the second transfer function are pt.x, y2, c2 and lighting2.

• Colorization - Replaces COLORED_POINT::c and COLORED_POINT::c2 with one of up to 255 different colors. All COLORED_POINTs on the transfer function are replaced by the color specified by the colorization state for that voxel. See SetColorizationEnabled() for more information about this technique.

As mentioned above, all three techniques can be applied simultaneously. For example, imagine a segmentatio of the heart that is as follows: On/Off segmentation is used to remove the ribs, lungs and other unrelated anatomy. Two transfer functions are applied such that the body of the hearth is semi-transparent and the three great vessels of the heart are highly opaque. Colorization is applied such that each of the three vessels are visualized using a different color (which is cross-correlated in some user interface list).

Parameters:

pBuffer	The address of the DATABYTE* to receive the buffer.
size	The address of an h_int32 to receive the size of the buffer.
pAlloc	The allocator to use for creating the buffer

Increases the reference count on this object by 1. You do not need to call this after an object is first created. It is 1 by default.

Implements IRoot.

bVal gets H_TRUE if the dataset is segmented, H_FALSE otherwise.

Parameters:

bVal	Gets H_TRUE if the dataset is segmented, H_FALSE otherwise.

Call this function if you wish to free server resources before disconnecting.

Sets the current colorization index for free hand cut and region growing segmentation functions. Positive values are indices into the array you pass into SetColorizationColors(). -1 will use the second transfer function instead of these colors.

Parameters:

idx	The current colorization index to use for segmentation.

Sets an array of colors to use for solid color highlighting. SetColorizationActiveIndex() will choose the color to use in segmentation functions. SetColorizationEnabled() must be set to H_TRUE before calling these functions.

Parameters:

numColors	The number of colors in the parameter colors.
colors	A array of colors to set for colorization mapping.

Enables or disables solid color highlighting for this octree/volume data pair. Enabling this feature will consume x*y*z bytes of memory (50% of the dataset size). Note that this technique is only available if the segmentation granularity is set to 1x1x1 using IVolumeSegmentationContext::SetGranularity().

Colorization is a segmentation technique where you can replace ALL of the color values on a transfer function with a single color defined by SetColorizationColors(). This technique can coexist with the two transfer function technique described in GetSegmentationMap(). The colors are all replaced. This includes colors in the first and the second transfer function.

Implementation-wise, the segmentation state for colorization is specified by a single byte per voxel. A byte value of 0 indicates that the colors on the first or second transfer function should be used as is. 1-255 will map into index 0-254 in the array of colors passed into SetColorizationColors(). To avoid requiring large contiguous buffers, each slice has its own segmentation state as a separate buffer. To avoid sending too much data across a TCP/IP channel, each buffer is zLib compressed and may be decompressed by the client using this open library if required.

Parameters:

val	H_TRUE if you wish to enable colorization. H_FALSE otherwise.
vd	The volume data that this octree is attached to.

Sets the colorization on the dataset to the state contained in pBuffer. pBuffer should be an array of zLib compressed buffers representing the state of a slice per buffer.

See also:

SetColorizationEnabled() for a description of this segmentation technique.

Parameters:

pBuffer	An array of pointers to buffers that each contain a zLib compressed buffer representing the state of a slice per buffer.
bufSize	An array of h_int32 that each describe the length of the buffer for each slice description in pBuffer.

Applies a segmentation map retreived by either manual creation or GetSegmentationMap() to the dataset. See GetSegmentationMap() for details about this buffer. Note that the behavior of this function is undefined for a target dataset that is of different dimensions than the source.

Parameters:

pBuffer	The zLib compressed buffer to use for segmenting this dataset.
size	The size of pBuffer in bytes.

See GetSegmentationMap for more details.

Parameters:

pBuffer	The zLib compressed buffer to use for segmenting this dataset.
size	The size of pBuffer in bytes.
bMultiTF	H_TRUE if we're segmenting for two transfer functions, H_FALSE if we're segmenting for on/off segmentation.

Used for bookkeeping on segmentation state. Since segmentation can use a decent chunk of memory, it's nice to know when we really have to persist it.

Parameters:

bVal	H_TRUE if the volume has been segmented, H_FALSE otherwise.

Update the octree after any operation that makes it invalid. The supported modes are indicated in the ENUM_UPDATE_MODE. The server will ignore the crop box as of now

Parameters:

mode	A octree update mode to indicate how the octree should be regenerated, as indicated in the ENUM_UPDATE_MODE
cbp	Indicate crop box params to update octree for only for a certain section. Currently this is not supported