VolumeDataContext

Summary

The VolumeDataContext class represents an initialized volume dataset on the server created by various data loading functions in the ServerContext class. The details of the volume dataset are provided via the VOLUME_DATA_PARAMS class. The histogram of the volume dataset is available through the VolumeDataContext.

o	GetHistogram

GetID

o	GetVolumeDataParams

o	ReleaseSessionResources

o	DecRef (C++)

Initialization and Usage

C++ uses IServerContext interface to create the IVolumeDataContact object when loading in a dataset. To reduce client-server communication, it is advised to always request a locally cached copy of the parameters if it exists. Once the IVolumeDataContact is no longer needed, its resources should be released.

Provide example in C++ for using this class.

Java uses the hdrcServerContext class to create the hdrcVolumeDataContext object when loading in a dataset. To reduce client-server communication, it is advised to always request a locally cached copy of the parameters if it exists. Once the hdvrVolumeDataContext object is no longer needed, its resources should be released.

Is there any time you should NOT attempt to use a cached copy? Why isn't this always done?

// us the hdrcServerContext to load a dataset to create the hdrcVolumeDataContext

hdrcServerContext hdrcServer = new hdrcServerContext("192.168.1.4", "6778");

hdrcVolumeDataContext hdrcVolume = hdrcServer.loadDicomDirectory("datasetDirectory");

// obtain the VOLUME_DATA_PARAMS; true indicates that it should attempt to use the locally cached copy

// before requesting it from the server

VOLUME_DATA_PARAMS vdp = hdrcVolume.getVolumeDataParams(true);

...........

// once the dataset is no longer in use by the application, be sure to release the resources.

hdrcVolume.releaseSessionResources();

Methods

IVolumeDataContext::GetHistogram()

C++

virtual signed int IVolumeDataContext::GetHistogram ( h_uint32 * hist ) [pure virtual]

Fills an array with the number of voxels in the dataset with the specified HU+1024 value.

Parameters:

hist	Allocated integer array of size 4096 to get results.

Returns:: int

#MERGE Merge/hdvr_cpp_x.html

EXTRA REFERENCE... WHY DIFFERENT FROM JAVA? WHAT IS NID?

com.fovia.hdrc.hdrcVolumeDataContext.getHistogram()

Java/.NET

int com.fovia.hdrc.hdrcVolumeDataContext.getHistogram ( int histogram[] ) throws IOException

Fills an array with the number of voxels in the dataset with the specified HU+1024 value.

Parameters

histogram Allocated integer array of size 4096 to get results.

Returns: int

Referenced by com.fovia.hdrc.hdrcVolumeDataContext.getHistogram().

int com.fovia.hdrc.hdrcVolumeDataContext.getHistogram ( long histogram[] ) throws IOException

Placeholder for getHistogram()

References com.fovia.hdrc.hdrcVolumeDataContext.getHistogram().

IVolumeDataContext::GetID()

C++

virtual signed int IVolumeDataContext::GetID ( h_int64 * id ) [pure virtual]

Integer that represents the server side object that contains the volume data.

com.fovia.hdrc.hdrcVolumeDataContext.getID()

Java/.NET

long com.fovia.hdrc.hdrcVolumeDataContext.getId ( )

Integer that represents the server side object that contains the volume data.

Returns

IVolumeDataContext::GetVolumeDataParams()

C++

virtual signed int IVolumeDataContext::GetVolumeDataParams ( VOLUME_DATA_PARAMS * vdp )

pure virtual

Returns information about the volume data in question.

com.fovia.hdrc.hdrcVolumeDataContext.getVolumeDataParams()

Java/.NET

VOLUME_DATA_PARAMS com.fovia.hdrc.hdrcVolumeDataContext.getVolumeDataParams ( ) throws IOException

Returns information about the volume data in question.

Returns: VOLUME_DATA_PARAMS - null if the call fails.

Exceptions

IOException

Referenced by com.fovia.hdrc.hdrcVolumeDataContext.getVolumeDataParams().

VOLUME_DATA_PARAMS com.fovia.hdrc.hdrcVolumeDataContext.getVolumeDataParams ( boolean bUseCached ) throws IOException

Placeholder for getVolumeDataParams()

References com.fovia.hdrc.hdrcVolumeDataContext.getVolumeDataParams().

IVolumeDataContext::ReleaseSessionResources()

C++

virtual signed int IVolumeDataContext::ReleaseSessionResources ( )

pure virtual

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

hdrcVolumeDataContext.releaseSessionResources()

Java/.NET

long com.fovia.hdrc.hdrcVolumeDataContext.releaseSessionResources ( ) throws IOException

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

Returns: long - 0 if successful.

Exceptions

IOException

IVolumeDataContext::DecRef

C++

virtual signed int IVolumeDataContext::DecRef ( )

pure virtual

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

Implements IRoot.

Doxygen Links

Complete details of member variables and class names are available in the source level documentation available from these links to Doxygen.

C++	IVolumeDataContext
Java / .NET	hdrcVolumeDataContext