Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members

mitkTrackedBscanData Class Reference

mitkTrackedBscanData - a concrete class encapsulating Raw Data. More...

#include <mitkTrackedBscanData.h>

Inherits mitkRawData.

Inherited by mitkTrackedBscanICData, and mitkTrackedBscanOoCData.

Inheritance diagram for mitkTrackedBscanData:

Inheritance graph
[legend]
Collaboration diagram for mitkTrackedBscanData:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual void PrintSelf (ostream &os)
virtual void Initialize ()
virtual int GetDataObjectType () const
void SetImageWidth (int w)
int GetImageWidth ()
void SetImageHeight (int h)
int GetImageHeight ()
void SetNumberOfSlices (int s)
int GetNumberOfSlices ()
void GetVolumeDimensions (int dims[3])
void SetVolumeDimensions (int dims[3])
void GetPixelSpacings (float s[3])
void SetPixelSpacings (float s[3])
void GetVoxelSpacings (float s[3])
void SetVoxelSpacings (float s[3])
void SetNumberOfChannel (int n)
int GetNumberOfChannel ()
virtual void * GetData ()=0
virtual void * GetSliceData (int sliceIdx)=0
virtual bool WriteSliceData (int sliceIdx, void const *src)=0
bool SetRToTMatrix (int sliceIdx, mitkMatrix const *ptor)
mitkMatrix * GetRToTMatrix (int sliceIdx)
mitkMatrix * GetRToTMatrix ()
virtual bool Allocate ()=0
virtual unsigned long long GetActualMemorySize () const =0
virtual void ShallowCopy (mitkDataObject *src)=0
virtual void DeepCopy (mitkDataObject *src)=0
void SetPToRMatrix (mitkMatrix const *ptor)
mitkMatrix GetPToRMatrix ()
void SetTToCMatrix (mitkMatrix const *ttoc)
mitkMatrix GetTToCMatrix ()
void SetPredetermined (bool predet)
bool IsPredetermined ()

Detailed Description

mitkTrackedBscanData - a concrete class encapsulating Raw Data.

mitkTrackedBscanData is a concrete class encapsulating Raw Data for 3D ultrasound Reconstruction. A mitkTrackedBscanData object include a group of B-Scan Images and the relative Matrices attached to the B-Scan Images. Concrete mitk3DUSReconstructionFilter classes reconstruct mitkVolume from mitkTrackedBscanData.

Note: If the mitkTrackedBscanData object was generated by a mitkTrackedBscanDataReader object, the parameters about the reconstruction volume (TTOC matrix, volume size and voxel size) were given. Then you need not set anything to the object, just use it. BUT, If you create and set the mitkTrackedBscanData object by yourself, please remember to compute the TTOC matrix, volume size and voxel size and set them to the mitkTrackedBscanData object, and use SetPredetermined(true) to notify the mitkTrackedBscanData object you have set these parameters. If you use SetPredetermined(false) after you have set these parameters, the mitk3DUSPixelBased object will automatically compute these parameters and use the automatically computed ones for volume reconstruction. If you really want the mitk3DUSPixelBased object to compute these parameters, just use SetPredetermined(false). If you forget to use SetPredetermined(), this filter will use the default status (false), that is, the filter will compute the parameters automatically.

Member Function Documentation

virtual bool mitkTrackedBscanData::Allocate (   )  [pure virtual]
 

Allocate necessary space for holding the B-Scan data. It calculate the memory size using current Dimensions, DataType and NumberOfChannel settings. The equation is shown as follow:
Width * Height * SliceNum * sizeof(DataType) * NumberOfChannel
In addition, it calculates memory size for holding Matrices attached to B-Scans. The previous allocated data will be deleted if exists.

Returns:
If success, return the allocated memory address. Otherwise return NULL.
Warning:
The memory is deleted by destructor automatically, so clients shouldn't delete the memory return by this function.

Implemented in mitkTrackedBscanICData, and mitkTrackedBscanOoCData.

virtual void mitkTrackedBscanData::DeepCopy (  mitkDataObject *  src  )  [pure virtual]
 

Warning:
Haven't been implemented, don't call this function directly.

Implements mitkDataObject.

Implemented in mitkTrackedBscanICData, and mitkTrackedBscanOoCData.

virtual unsigned long long mitkTrackedBscanData::GetActualMemorySize (   )  const [pure virtual]
 

Return the actual memory size occupied by the B-Scan data. The unit is BYTE.

Returns:
Return the actual memory size occupied by the B-Scan data. The unit is BYTE.

Implements mitkDataObject.

Implemented in mitkTrackedBscanICData, and mitkTrackedBscanOoCData.

virtual void* mitkTrackedBscanData::GetData (   )  [pure virtual]
 

Get data pointer of the B-Scan image data (changeable).

Returns:
Return a void pointer to data.
Note:
The returned type is void *, it must be converted to some useful data type according to the return value of GetDataType().
Warning:
The memory is deleted by destructor automatically, so clients shouldn't delete the pointer returned by this function.

Implemented in mitkTrackedBscanICData, and mitkTrackedBscanOoCData.

virtual int mitkTrackedBscanData::GetDataObjectType (   )  const [inline, virtual]
 

Return the data object type.

Returns:
Always return MITK_VOLUME

Reimplemented from mitkRawData.

Reimplemented in mitkTrackedBscanICData, and mitkTrackedBscanOoCData.

int mitkTrackedBscanData::GetImageHeight (   )  [inline]
 

Get the height of the Image (dimension in y). Every image have the same size.

Returns:
Return the height of this volume, the unit is pixel.

int mitkTrackedBscanData::GetImageWidth (   )  [inline]
 

Get the width of the Image (dimension in x). Every image have the same size.

Returns:
Return the width of this volume, the unit is pixel.

int mitkTrackedBscanData::GetNumberOfChannel (   )  [inline]
 

Get the channel number of the B-Scan image.

Returns:
Return the channel number of the B-Scan image.
return 1 --- gray image
return 3 --- RGB image
return 4 --- RGBA image
Note:
Currently only support gray image.

int mitkTrackedBscanData::GetNumberOfSlices (   )  [inline]
 

Get the number of the slices/images.

Returns:
Return the number of images/slices.

void mitkTrackedBscanData::GetPixelSpacings (  float  s[3]  )  [inline]
 

Get spacing information in x, y and z axis of the B-Scan image, the unit is mm.

Parameters:
s[0] Return the spacing (mm) in two adjacent pixels in x axis.
s[1] Return the spacing (mm) in two adjacent pixels in y axis.
s[2] Return the spacing (mm) in two adjacent pixels in z axis (thick of the B-Scan).

mitkMatrix mitkTrackedBscanData::GetPToRMatrix (   )  [inline]
 

Get the calibrated transformation matrix from the B-Scan Plane coordinate system to the Receiver coordinate system.

Returns:
Return the value of the B-Scan Plane to the Receiver transformation matrix.

mitkMatrix* mitkTrackedBscanData::GetRToTMatrix (   ) 
 

Get the pointer of the transformation matrix (from the Receiver coordinate system to the Transmitter coordinate system) from the TrackedBscanData.

Returns:
Return the pointer (the first) of the Receiver to the Transmitter transformation matrix.

mitkMatrix* mitkTrackedBscanData::GetRToTMatrix (  int  sliceIdx  ) 
 

Get the pointer of the transformation matrix (from the Receiver coordinate system to the Transmitter coordinate system) from the TrackedBscanData.

Parameters:
sliceIdx the index of the slice to write (in [0, GetNumberOfSlices()-1])
Returns:
Return the pointer (the sliceIdx-th) of the Receiver to the Transmitter transformation matrix.

virtual void* mitkTrackedBscanData::GetSliceData (  int  sliceIdx  )  [pure virtual]
 

Copy slice data from the B-Scan image data to a specified memory buffer.

Parameters:
sliceIdx the index of the slice to get (in [0, GetNumberOfSlices()-1])
Returns:
Return a void pointer to data.
Note:
The returned type is void *, it must be converted to some useful data type according to the return value of GetDataType().
Warning:
The memory is deleted by destructor automatically, so clients shouldn't delete the pointer returned by this function.

Implemented in mitkTrackedBscanICData, and mitkTrackedBscanOoCData.

mitkMatrix mitkTrackedBscanData::GetTToCMatrix (   )  [inline]
 

Get the predetermined transformation matrix from the Transmitter coordinate system to the Reconstruction Volume coordinate system.

Returns:
Return the value of the Transmitter to the Reconstruction Volume transformation matrix.

void mitkTrackedBscanData::GetVolumeDimensions (  int  dims[3]  )  [inline]
 

Get the predetermined width, height and depth of the reconstructed volume.

Parameters:
dims[0] Return the predicted width of the reconstructed volume.
dims[1] Return the predicted height of the reconstructed volume.
dims[2] Return the predicted depth of the reconstructed volume.

void mitkTrackedBscanData::GetVoxelSpacings (  float  s[3]  )  [inline]
 

Get predetermined spacings in x, y and z axis of the reconstructed volume, the unit is mm.

Parameters:
s[0] Return the spacing (mm) in two adjacent voxels in x axis.
s[1] Return the spacing (mm) in two adjacent voxels in y axis.
s[2] Return the spacing (mm) in two adjacent voxels in z axis.

virtual void mitkTrackedBscanData::Initialize (   )  [virtual]
 

Delete the allocated memory (if any) and initialize to default status.

Implements mitkDataObject.

Reimplemented in mitkTrackedBscanICData, and mitkTrackedBscanOoCData.

bool mitkTrackedBscanData::IsPredetermined (   )  [inline]
 

Get predetermination status of the reconstruction volume.

Returns:
Return the predetermination status.

virtual void mitkTrackedBscanData::PrintSelf (  ostream &  os  )  [virtual]
 

Print the necessary information about this object for the debugging purpose.

Parameters:
os The specified ostream to output information.

Reimplemented from mitkRawData.

Reimplemented in mitkTrackedBscanICData, and mitkTrackedBscanOoCData.

void mitkTrackedBscanData::SetImageHeight (  int  h  )  [inline]
 

Set the height of the Image (dimension in y). Every image have the same size.

Parameters:
h The height of this volume, the unit is pixel.

void mitkTrackedBscanData::SetImageWidth (  int  w  )  [inline]
 

Set the width of the Image (dimension in x). Every image have the same size.

Parameters:
w The width of this volume, the unit is pixel.

void mitkTrackedBscanData::SetNumberOfChannel (  int  n  )  [inline]
 

Set the channel number of the B-Scan image.

Parameters:
n The channel number of the B-Scan image.
n = 1 --- gray image
n = 3 --- RGB image
n = 4 --- RGBA image
Note:
Currently only support gray image.

void mitkTrackedBscanData::SetNumberOfSlices (  int  s  ) 
 

Set the number of the slices/images.

Parameters:
s The number of images/slices.

void mitkTrackedBscanData::SetPixelSpacings (  float  s[3]  )  [inline]
 

Set spacing information in x, y and z axis of the B-Scan image, the unit is mm.

Parameters:
s[0] The spacing (mm) in two adjacent pixels in x axis.
s[1] The spacing (mm) in two adjacent pixels in y axis.
s[2] The spacing (mm) in two adjacent pixels in z axis (thick of the B-Scan).

void mitkTrackedBscanData::SetPredetermined (  bool  predet  )  [inline]
 

Set predetermination status of the reconstruction volume (default is false). The predetermination status.

void mitkTrackedBscanData::SetPToRMatrix (  mitkMatrix const *  ptor  )  [inline]
 

Set the calibrated transformation matrix from the B-Scan Plane coordinate system to the Receiver coordinate system. The pointer of the B-Scan Plane to the Receiver transformation matrix.

bool mitkTrackedBscanData::SetRToTMatrix (  int  sliceIdx,
mitkMatrix const *  ptor
) 
 

Copy the transformation matrix (from the Receiver coordinate system to the Transmitter coordinate system) from a specified mitkMatrix to the TrackedBscanData.

Parameters:
sliceIdx the index of the slice to write (in [0, GetNumberOfSlices()-1]) The pointer of the Receiver to the Transmitter transformation matrix.

void mitkTrackedBscanData::SetTToCMatrix (  mitkMatrix const *  ttoc  )  [inline]
 

Set the predetermined transformation matrix from the Transmitter coordinate system to the Reconstruction Volume coordinate system. The pointer of the Transmitter to the Reconstruction Volume transformation matrix.

void mitkTrackedBscanData::SetVolumeDimensions (  int  dims[3]  )  [inline]
 

Set the predetermined width, height and depth of the reconstructed volume.

Parameters:
dims[0] The predicted width of the reconstructed volume.
dims[1] The predicted height of the reconstructed volume.
dims[2] The predicted depth of the reconstructed volume.

void mitkTrackedBscanData::SetVoxelSpacings (  float  s[3]  )  [inline]
 

Set predetermined spacings in x, y and z axis of the reconstructed volume, the unit is mm.

Parameters:
s[0] The spacing (mm) in two adjacent voxels in x axis.
s[1] The spacing (mm) in two adjacent voxels in y axis.
s[2] The spacing (mm) in two adjacent voxels in z axis.

virtual void mitkTrackedBscanData::ShallowCopy (  mitkDataObject *  src  )  [pure virtual]
 

Warning:
Haven't been implemented, don't call this function directly.

Implements mitkDataObject.

Implemented in mitkTrackedBscanICData, and mitkTrackedBscanOoCData.

virtual bool mitkTrackedBscanData::WriteSliceData (  int  sliceIdx,
void const *  src
)  [pure virtual]
 

Copy slice data from a specified memory buffer to the B-Scan image data.

Parameters:
sliceIdx the index of the slice to write (in [0, GetNumberOfSlices()-1])
src the pointer to the source memory buffer
Returns:
Return true if successful, otherwise return false.
Note:
The size of source memory buffer should be GetWidth() * GetHeight() * GetChannelNum() * GetDataTypeSize().

Implemented in mitkTrackedBscanICData, and mitkTrackedBscanOoCData.

The documentation for this class was generated from the following file:
Generated on Tue Feb 25 15:06:47 2014 for MITK (Medical Imaging ToolKit) by  doxygen 1.4.3