Fovia's Java Client/Server API
Public Member Functions | Public Attributes | List of all members
com.fovia.hdrcsrv.VOLUME_DATA_PARAMS Class Reference

Public Member Functions

VECTOR3L getDimention ()
 
int getOrganization ()
 
MATRIX44D getOrientation ()
 
MATRIX44D getOrientationUser ()
 
VECTOR3D getSpacing ()
 
CROP_BOX_PARAMS getVoi ()
 
void read (hdrcSerializer ser) throws IOException
 
void setDimention (VECTOR3L dim)
 
void setOrganization (int org)
 
void setOrientation (MATRIX44D m)
 
void setOrientationUser (MATRIX44D m)
 
void setSpacing (VECTOR3D spa)
 
void setVoi (CROP_BOX_PARAMS voi)
 

Public Attributes

int BitsPerPixel
 
int cbSize
 
long DataOffset
 
int DataType
 
VECTOR3L Dimension = new VECTOR3L()
 
int HighBit
 
int Organization
 
MATRIX44D Orientation = new MATRIX44D()
 
MATRIX44D OrientationUser = new MATRIX44D()
 
int RelevantBits
 
int Reserved
 
VECTOR3D Spacing = new VECTOR3D()
 
int Tag
 
CROP_BOX_PARAMS Voi = new CROP_BOX_PARAMS()
 

Detailed Description

Structure that provides information about an hdrcVolumeDataContext.

Member Data Documentation

int com.fovia.hdrcsrv.VOLUME_DATA_PARAMS.BitsPerPixel

Number of actual stored bits per pixel. This must be 16. For example, if this is a dataset with 16 bits reserved for each pixel, but only contains values from 0-4095, this value should be 16 because that's how many bits are stored for a pixel.

int com.fovia.hdrcsrv.VOLUME_DATA_PARAMS.cbSize

Structure size.

long com.fovia.hdrcsrv.VOLUME_DATA_PARAMS.DataOffset

Reserved for future use.

int com.fovia.hdrcsrv.VOLUME_DATA_PARAMS.DataType

Flags describing the pixel presentation of the data. Currently, only DT_SIGNED is supported.

VECTOR3L com.fovia.hdrcsrv.VOLUME_DATA_PARAMS.Dimension = new VECTOR3L()

Volume data dimensions. X is the width of each slice. Y is the height of each slice. Z is the number of slices.

Referenced by com.fovia.hdrc.hdrcRenderControl.adjustZoomForEntireVolume(), and com.fovia.hdrc.utils.hdrc3DHelpers.getVolumeBoxPoints().

int com.fovia.hdrcsrv.VOLUME_DATA_PARAMS.HighBit

Bit which corrosponds to the highest relevant bit. This must be RelevantBits-1.

int com.fovia.hdrcsrv.VOLUME_DATA_PARAMS.Organization

Volume data organization. This must be DO_SLICE.

MATRIX44D com.fovia.hdrcsrv.VOLUME_DATA_PARAMS.Orientation = new MATRIX44D()

This structure establishes the volume's location in volume coordinates. As defined in RENDER_PARAMS::Transform, the X vector describes the direction from left to right for every slice. The Y vector describes the direction from top to bottom for every slice. The Z vector is the direction from the first slice to the last slice (and if you use the Fovia dataset loaders, the length of that vector is the distance from the first slice to the last slice). The offset vector is currently ignored. Instead, the exact center of the volume is used at the origin.

MATRIX44D com.fovia.hdrcsrv.VOLUME_DATA_PARAMS.OrientationUser = new MATRIX44D()

User defined orientation. If you set this when defining a dataset, you can call GetVolumeDataParams() and get this value back. Otherwise, the SDK will ignore this.

int com.fovia.hdrcsrv.VOLUME_DATA_PARAMS.RelevantBits

Number of relevant bits per pixel. For RT_THIN_* rendering types, this number can be from 2-16. For all other rendering types, 10-15 are the supported values. For example, if this is a dataset with 16 bits reserved for each pixel, but only contains values from 0-4095, this value should be 12 because 0-4095 fits in 12 bits.

int com.fovia.hdrcsrv.VOLUME_DATA_PARAMS.Reserved

Reserved for future use.

VECTOR3D com.fovia.hdrcsrv.VOLUME_DATA_PARAMS.Spacing = new VECTOR3D()

Spacing between voxels for each axis. Note that currently, the X and Y spacing are expected to be identical and are treated as such internally.

Referenced by com.fovia.hdrc.hdrcRenderControl.adjustZoomForEntireVolume(), com.fovia.hdrc.utils.hdrc3DHelpers.renderImageLoc2VolumeCoordinates(), and com.fovia.hdrc.hdrcBlendedRenderControl.setParamsForAll().

int com.fovia.hdrcsrv.VOLUME_DATA_PARAMS.Tag

User defined value. If you set this when defining a dataset, you can call getVolumeDataParams() and get this value back. Otherwise, the SDK will ignore this.

CROP_BOX_PARAMS com.fovia.hdrcsrv.VOLUME_DATA_PARAMS.Voi = new CROP_BOX_PARAMS()
Deprecated:
If you wish to crop the volume, use RENDER_PARAMS::CutPlanes.