mitkTrackedBscanOoCData Class Reference

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

#include <mitkTrackedBscanOoCData.h>

Inherits mitkTrackedBscanData.

Inheritance diagram for mitkTrackedBscanOoCData:

[legend]Collaboration diagram for mitkTrackedBscanOoCData:

[legend]List of all members.

Public Member Functions
virtual void	PrintSelf (ostream &os)
virtual void	Initialize ()
virtual int	GetDataObjectType () const
void *	GetData ()
void *	GetSliceData (int sliceIdx)
bool	WriteSliceData (int sliceIdx, void const *src)
bool	Allocate ()
virtual unsigned long long	GetActualMemorySize () const
void	SetBufferedSliceNum (unsigned int n)
unsigned int	GetBufferedSliceNum ()
void	SetPathOfDiskBuffer (char const *path)
char const *	GetPathOfDiskBuffer ()
virtual void	ShallowCopy (mitkDataObject *src)
virtual void	DeepCopy (mitkDataObject *src)

---

Detailed Description

mitkTrackedBscanOoCData - a concrete class encapsulating Raw Data.

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

Note: If the mitkTrackedBscanOoCData object was generated by a mitkTrackedBscanOoCDataReader 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 mitkTrackedBscanOoCData object by yourself, please remember to compute the TTOC matrix, volume size and voxel size and set them to the mitkTrackedBscanOoCData object, and use SetPredetermined(true) to notify the mitkTrackedBscanOoCData 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

bool mitkTrackedBscanOoCData::Allocate (   )  [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. Implements mitkTrackedBscanData.

virtual void mitkTrackedBscanOoCData::DeepCopy (  mitkDataObject *  src  )  [virtual]

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

virtual unsigned long long mitkTrackedBscanOoCData::GetActualMemorySize (   )  const [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 mitkTrackedBscanData.

unsigned int mitkTrackedBscanOoCData::GetBufferedSliceNum (   )  [inline]

Get the number of buffered slice in memory. Returns: Return the number of buffered slice.

void* mitkTrackedBscanOoCData::GetData (   )  [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. Implements mitkTrackedBscanData.

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

Return the data object type. Returns: Always return MITK_VOLUME Reimplemented from mitkTrackedBscanData.

char const* mitkTrackedBscanOoCData::GetPathOfDiskBuffer (   )

Get the full path of the disk buffer which contains all the slices of the volume. Returns: Return the full path of the disk buffer.

void* mitkTrackedBscanOoCData::GetSliceData (  int  sliceIdx  )  [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. Implements mitkTrackedBscanData.

virtual void mitkTrackedBscanOoCData::Initialize (   )  [virtual]

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

virtual void mitkTrackedBscanOoCData::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 mitkTrackedBscanData.

void mitkTrackedBscanOoCData::SetBufferedSliceNum (  unsigned int  n  )  [inline]

Set the number of buffered slice in memory. Parameters: n  the number of buffered slice Note: When calling this function, the buffer size is also calculated by (slice size) * (slice number), so it is unnecessary to call SetMemoryBufferSize() again.

void mitkTrackedBscanOoCData::SetPathOfDiskBuffer (  char const *  path  )

Set the full path of the disk buffer to contain all the slices of the volume. Parameters: path  the full path of the disk buffer

virtual void mitkTrackedBscanOoCData::ShallowCopy (  mitkDataObject *  src  )  [virtual]

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

bool mitkTrackedBscanOoCData::WriteSliceData (  int  sliceIdx, void const *  src )  [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(). Implements mitkTrackedBscanData.

---

The documentation for this class was generated from the following file:

• mitkTrackedBscanOoCData.h

---