mitkTrackedBscanICData Class Reference

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

#include <mitkTrackedBscanICData.h>

Inherits mitkTrackedBscanData.

Inheritance diagram for mitkTrackedBscanICData:

[legend]Collaboration diagram for mitkTrackedBscanICData:

[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
virtual void	ShallowCopy (mitkDataObject *src)
virtual void	DeepCopy (mitkDataObject *src)

---

Detailed Description

mitkTrackedBscanICData - a concrete class encapsulating Raw Data.

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

Note: If the mitkTrackedBscanICData object was generated by a mitkTrackedBscanICDataReader 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 mitkTrackedBscanICData object by yourself, please remember to compute the TTOC matrix, volume size and voxel size and set them to the mitkTrackedBscanICData object, and use SetPredetermined(true) to notify the mitkTrackedBscanICData 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 mitkTrackedBscanICData::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 mitkTrackedBscanICData::DeepCopy (  mitkDataObject *  src  )  [virtual]

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

virtual unsigned long long mitkTrackedBscanICData::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.

void* mitkTrackedBscanICData::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 mitkTrackedBscanICData::GetDataObjectType (   )  const [inline, virtual]

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

void* mitkTrackedBscanICData::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 mitkTrackedBscanICData::Initialize (   )  [virtual]

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

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

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

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

bool mitkTrackedBscanICData::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:

• mitkTrackedBscanICData.h

---