VolumePixelView Class Reference
[Views]

The interface for all views of 3 dimensional pixel datasets. More...

#include <volume_pixel_view.h>

Inherits PixelView.

Inherited by MetaVolumePixelView, SlicePixelView, and SpatialPixelView.

Inheritance diagram for VolumePixelView:

[legend]Collaboration diagram for VolumePixelView:

[legend]List of all members.

Public Member Functions
	VolumePixelView (view_type type)
virtual	~VolumePixelView ()
virtual void	setDataset (dataset_pointer_type dataset) throw (NullPointerException, InvalidCastException)
void	setSecondDataset (dataset_pointer_type second_dataset) throw (NullPointerException, InvalidCastException)
void	unsetSecondDataset ()
dataset_key_type	getDatasetKey () const
dataset_key_type	getSecondDatasetKey () const
void	lockWithDataset (dataset_key_type dataset_key)
void	unlockFromDataset (dataset_key_type dataset_key)
bool	isLockedWithDataset (dataset_key_type dataset_key)
volume_pixel_dataset_pointer_type	getVolumeDataset ()
dataset_position_type const &	getCurrentFocusPoint () const
virtual double	getMinPixelValue () const
virtual double	getMaxPixelValue () const
virtual void	setIntensity (double window, double level) throw (NullPointerException)
virtual double	getIntensityWindow () const
virtual double	getIntensityLevel () const
void	setTransformationMatrix (matrix_type const &matrix)
matrix_type	getTransformationMatrix () const
void	setOffsetVector (offset_vector_type const &offset)
virtual offset_vector_type	getOffsetVector () const
virtual unsigned char	getNumBytesPerPixel () const
Protected Member Functions
	VolumePixelView (VolumePixelView const &src)
Protected Attributes
volume_pixel_dataset_pointer_type	volume_dataset_
	The dataset of this view.
volume_pixel_dataset_pointer_type	second_volume_dataset_
dataset_position_type	current_focus_point_
	The current focus point within the dataset of this view.

---

Detailed Description

The interface for all views of 3 dimensional pixel datasets.

Author:

Tobias Gross (tobias.gross@imedgine.org)

Christian Koerner (christian.koerner@imedgine.org)

Alexander Lex (alexander.lex@imedgine.org)

Marc Streit (marc.streit@imedgine.org)

Martin Reininger (martin.reininger@imedgine.org)

Definition at line 36 of file volume_pixel_view.h.

---

Constructor & Destructor Documentation

VolumePixelView (  view_type  type  )

Constructor Definition at line 20 of file volume_pixel_view.cpp.

~VolumePixelView (   )  [virtual]

Destructor Definition at line 40 of file volume_pixel_view.cpp.

VolumePixelView (  VolumePixelView const &  src  )  [protected]

Copy constructor Definition at line 30 of file volume_pixel_view.cpp.

---

Member Function Documentation

dataset_position_type const & getCurrentFocusPoint (   )  const

Return the current focus position within the dataset Returns: The current focus point Definition at line 209 of file volume_pixel_view.cpp. References VolumePixelView::current_focus_point_.

dataset_key_type getDatasetKey (   )  const [virtual]

Get the key of the dataset or an empty string if it is not set. Returns: The key of the second dataset or "" Implements PixelView. Definition at line 139 of file volume_pixel_view.cpp. References VolumePixelView::volume_dataset_. Referenced by ImedgineSliceViewer::buildPopupMenu(), and ImedgineSliceViewer::updateDatasetStatusInfo().

double getIntensityLevel (   )  const [virtual]

Returns the intensity level of the dataset displayed Returns: The intensity level Implements PixelView. Definition at line 242 of file volume_pixel_view.cpp. References VolumePixelView::volume_dataset_. Referenced by MetaVolumePixelDataViewer::intensityWindowChanged().

double getIntensityWindow (   )  const [virtual]

Returns the intensity window of the dataset displayed Returns: The intensity window Implements PixelView. Definition at line 231 of file volume_pixel_view.cpp. References VolumePixelView::volume_dataset_. Referenced by MetaVolumePixelDataViewer::intensityLevelChanged().

double getMaxPixelValue (   )  const [virtual]

Return the maximum pixel value of the dataset. Returns: The maximum pixel value of the dataset. Implements PixelView. Definition at line 323 of file volume_pixel_view.cpp. References VolumePixelView::volume_dataset_. Referenced by ImedgineSliceViewer::ImedgineSliceViewer().

double getMinPixelValue (   )  const [virtual]

Return the mimimum pixel value of the dataset. Returns: The mimimum pixel value of the dataset. Implements PixelView. Definition at line 312 of file volume_pixel_view.cpp. References VolumePixelView::volume_dataset_. Referenced by ImedgineSliceViewer::ImedgineSliceViewer().

unsigned char getNumBytesPerPixel (   )  const [virtual]

Returns the bytes per pixel in the image Returns: The number of bytes per pixel Definition at line 301 of file volume_pixel_view.cpp. References VolumePixelView::volume_dataset_.

offset_vector_type getOffsetVector (   )  const [virtual]

Returns the current offset vector Definition at line 277 of file volume_pixel_view.cpp. References VolumePixelView::volume_dataset_.

dataset_key_type getSecondDatasetKey (   )  const

Get the key of the second dataset or an empty string if it is not set. Returns: The key of the second dataset or "" Definition at line 153 of file volume_pixel_view.cpp. References VolumePixelView::second_volume_dataset_. Referenced by ImedgineSliceViewer::buildPopupMenu(), ImedgineSliceViewer::menuSelection(), and ImedgineSliceViewer::updateDatasetStatusInfo().

matrix_type getTransformationMatrix (   )  const

Returns the current transformation matrix Definition at line 266 of file volume_pixel_view.cpp. References VolumePixelView::volume_dataset_.

volume_pixel_dataset_pointer_type getVolumeDataset (   )

Get the dataset that the view shows Returns: A pointer to the requested dataset Definition at line 202 of file volume_pixel_view.cpp. References VolumePixelView::volume_dataset_.

bool isLockedWithDataset (  dataset_key_type  dataset_key  )

Tells if the internal dataset is locked with the given dataset. Parameters: dataset_key  The key of the dataset Definition at line 189 of file volume_pixel_view.cpp. References DataViewMediator::areDatasetsLocked(), View::data_view_mediator_, and VolumePixelView::volume_dataset_. Here is the call graph for this function:

void lockWithDataset (  dataset_key_type  dataset_key  )

Lock the dataset with the dataset associated with the given dataset key. The consequence is that both datasets get informed about changes to the other dataset. Parameters: dataset_key  The key of the dataset to lock the internal dataset with Definition at line 167 of file volume_pixel_view.cpp. References View::data_view_mediator_, DataViewMediator::lockDatasets(), and VolumePixelView::volume_dataset_. Here is the call graph for this function:

void setDataset (  dataset_pointer_type  dataset  )  throw (NullPointerException, InvalidCastException) [virtual]

Set the dataset that the view shows Parameters: dataset  A pointer to the dataset to set Reimplemented from View. Reimplemented in SlicePixelView, and SpatialPixelView. Definition at line 46 of file volume_pixel_view.cpp. Referenced by SpatialPixelView::setDataset(), and SlicePixelView::setDataset().

void setIntensity (  double  window, double  level )  throw (NullPointerException) [virtual]

Set the intensity within the dataset by specifying the pixel value level and window Parameters: window  The intensity window level  The intensity level Implements PixelView. Definition at line 216 of file volume_pixel_view.cpp. Referenced by MetaVolumePixelDataViewer::intensityLevelChanged(), and MetaVolumePixelDataViewer::intensityWindowChanged().

void setOffsetVector (  offset_vector_type const &  offset  )

Sets the 3 dimensional offset vector of the affine transform slices are subjected to (If not explicitly specified there is no offset) Parameters: offset  The 3 dimensional offset vector Definition at line 288 of file volume_pixel_view.cpp. References VolumePixelView::volume_dataset_. Referenced by MetaVolumePixelDataViewer::affineTransformationMatrixChanged(), and MetaVolumePixelDataViewer::resetAffineTransformationMatrix().

void setSecondDataset (  dataset_pointer_type  second_dataset  )  throw (NullPointerException, InvalidCastException)

Set the second dataset that the hybrid view uses Parameters: dataset  A pointer to the dataset to set Reimplemented in SlicePixelView. Definition at line 76 of file volume_pixel_view.cpp. Referenced by SlicePixelView::setSecondDataset().

void setTransformationMatrix (  matrix_type const &  matrix  )

Sets the 3x3 transformation matrix of the affine transform slices are subjected to (If not explicitly specified the identity matrix is used) Parameters: matrix  The 3x3 transformation matrix Definition at line 253 of file volume_pixel_view.cpp. References VolumePixelView::volume_dataset_. Referenced by MetaVolumePixelDataViewer::affineTransformationMatrixChanged(), and MetaVolumePixelDataViewer::resetAffineTransformationMatrix().

void unlockFromDataset (  dataset_key_type  dataset_key  )

Unlock the internal dataset from the dataset associated with the given dataset key. The datasets won't get informed about changes to the other dataset anymore. Parameters: dataset_key  The key of the dataset to unlock the internal dataset from Definition at line 178 of file volume_pixel_view.cpp. References View::data_view_mediator_, DataViewMediator::unlockDatasets(), and VolumePixelView::volume_dataset_. Here is the call graph for this function:

void unsetSecondDataset (   )

Unset the second dataset that the hybrid view uses Reimplemented in SlicePixelView. Definition at line 128 of file volume_pixel_view.cpp. References VolumePixelView::second_volume_dataset_, and View::updateView(). Referenced by SlicePixelView::unsetSecondDataset(). Here is the call graph for this function:

---

Member Data Documentation

volume_pixel_dataset_pointer_type second_volume_dataset_ [protected]

The second dataset the view. This variable is only set if a hybrid view is wanted. Definition at line 222 of file volume_pixel_view.h. Referenced by VolumePixelView::getSecondDatasetKey(), YZSliceView::getSecondSliceResolution(), XZSliceView::getSecondSliceResolution(), XYSliceView::getSecondSliceResolution(), SlicePixelView::onDatasetDeletion(), VolumePixelView::unsetSecondDataset(), YZSliceView::updateView(), XZSliceView::updateView(), and XYSliceView::updateView().

---

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

• imedgine/src/viewer/volume_pixel_view.h
• imedgine/src/viewer/volume_pixel_view.cpp

---