VolumePixelDataset Class Reference
[Datasets]

Pixel datasets with 3 dimensions. More...

#include <volume_pixel_dataset.h>

Inherits PixelDataset.

Inherited by FourByteVolumePixelDataset, OneByteVolumePixelDataset, and TwoByteVolumePixelDataset.

Inheritance diagram for VolumePixelDataset:

[legend]Collaboration diagram for VolumePixelDataset:

[legend]List of all members.


Public Member Functions
	VolumePixelDataset (dataset_type type, dataset_key_type dataset_key, unsigned char num_bytes_per_pixel)
virtual	~VolumePixelDataset ()
void	setTransformationMatrix (matrix_type const &matrix)
void	setOffsetVector (offset_vector_type const &offset)
virtual external_data_pointer_type	getSliceXY (index_type z_index)=0 throw (NullPointerException, IndexOutOfBoundsException)
virtual external_data_pointer_type	getSliceXZ (index_type y_index)=0 throw (NullPointerException, IndexOutOfBoundsException)
virtual external_data_pointer_type	getSliceYZ (index_type x_index)=0 throw (NullPointerException, IndexOutOfBoundsException)
virtual dataset_pointer_type	getImageXY (index_type z_index, dataset_key_type image_key)=0 throw (NullPointerException, IndexOutOfBoundsException)
virtual dataset_pointer_type	getImageXZ (index_type y_index, dataset_key_type image_key)=0 throw (NullPointerException, IndexOutOfBoundsException)
virtual dataset_pointer_type	getImageYZ (index_type x_index, dataset_key_type image_key)=0 throw (NullPointerException, IndexOutOfBoundsException)
void	setRegionsOfInterestForSliceXY (index_type z_index, std::vector< region_of_interest_type > const &regions_of_interest) throw (IndexOutOfBoundsException)
void	setRegionsOfInterestForSliceXZ (index_type y_index, std::vector< region_of_interest_type > const &regions_of_interest) throw (IndexOutOfBoundsException)
void	setRegionsOfInterestForSliceYZ (index_type x_index, std::vector< region_of_interest_type > const &regions_of_interest) throw (IndexOutOfBoundsException)
std::vector< region_of_interest_type > const &	getRegionsOfInterestForSliceXY (index_type z_index) const throw (IndexOutOfBoundsException)
std::vector< region_of_interest_type > const &	getRegionsOfInterestForSliceXZ (index_type y_index) const throw (IndexOutOfBoundsException)
std::vector< region_of_interest_type > const &	getRegionsOfInterestForSliceYZ (index_type x_index) const throw (IndexOutOfBoundsException)
Protected Types
typedef external_image_type	slice_type
typedef itk::AffineTransform< double, 3 >	transform_type
Protected Member Functions
	VolumePixelDataset (VolumePixelDataset const &src)
VolumePixelDataset &	operator= (VolumePixelDataset const &)
Protected Attributes
transform_type::Pointer	transform_
std::vector< std::vector< region_of_interest_type > >	xy_slice_rois_
std::vector< std::vector< region_of_interest_type > >	xz_slice_rois_
std::vector< std::vector< region_of_interest_type > >	yz_slice_rois_

Detailed Description

Pixel datasets with 3 dimensions.

The implementation of the PixelDataset interface for 3 dimensional voxel 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 49 of file volume_pixel_dataset.h.

Member Typedef Documentation

typedef external_image_type slice_type [protected]

The target type for slice extractions
Definition at line 228 of file volume_pixel_dataset.h.

typedef itk::AffineTransform<double, 3> transform_type [protected]

The type for the slice extractor
Definition at line 233 of file volume_pixel_dataset.h.

Constructor & Destructor Documentation

VolumePixelDataset ( dataset_type type,

dataset_key_type dataset_key,

unsigned char num_bytes_per_pixel

)

Constructor
Parameters:

type the type of dataset

num_bytes_per_pixel The number of bytes used to store one pixel

Definition at line 24 of file volume_pixel_dataset.cpp.

~VolumePixelDataset ( ) [virtual]

Destructor
Definition at line 44 of file volume_pixel_dataset.cpp.

VolumePixelDataset ( VolumePixelDataset const & src ) [protected]

Copy constructor
Definition at line 36 of file volume_pixel_dataset.cpp.

Member Function Documentation

virtual dataset_pointer_type getImageXY ( index_type z_index,

dataset_key_type image_key

) throw (NullPointerException, IndexOutOfBoundsException) [pure virtual]

Return the image extending in x and y dimension at a given z index of the dataset.
Parameters:

z_index The z index of the requested image

image_key The unique key for the newly created image dataset

Returns:
A pointer to the requested image dataset

Implemented in FourByteVolumePixelDataset, OneByteVolumePixelDataset, and TwoByteVolumePixelDataset.

virtual dataset_pointer_type getImageXZ ( index_type y_index,

dataset_key_type image_key

) throw (NullPointerException, IndexOutOfBoundsException) [pure virtual]

Return the image extending in x and z dimension at a given y index of the dataset.
Parameters:

y_index The y index of the requested image

image_key The unique key for the newly created image dataset

Returns:
A pointer to the requested image dataset

Implemented in FourByteVolumePixelDataset, OneByteVolumePixelDataset, and TwoByteVolumePixelDataset.

virtual dataset_pointer_type getImageYZ ( index_type x_index,

dataset_key_type image_key

) throw (NullPointerException, IndexOutOfBoundsException) [pure virtual]

Return the image extending in y and z dimension at a given x index of the dataset.
Parameters:

x_index The x index of the requested image

image_key The unique key for the newly created image dataset

Returns:
A pointer to the requested image dataset

Implemented in FourByteVolumePixelDataset, OneByteVolumePixelDataset, and TwoByteVolumePixelDataset.

std::vector< region_of_interest_type > const & getRegionsOfInterestForSliceXY ( index_type z_index ) const throw (IndexOutOfBoundsException)

Returns the regions of interest for the XY slice at the given index position
Parameters:

z_index The z index of the slice

Definition at line 131 of file volume_pixel_dataset.cpp.
References Z_DIMENSION.

std::vector< region_of_interest_type > const & getRegionsOfInterestForSliceXZ ( index_type y_index ) const throw (IndexOutOfBoundsException)

Returns the regions of interest for the XZ slice at the given index position
Parameters:

y_index The y index of the slice

Definition at line 146 of file volume_pixel_dataset.cpp.
References Y_DIMENSION.

std::vector< region_of_interest_type > const & getRegionsOfInterestForSliceYZ ( index_type x_index ) const throw (IndexOutOfBoundsException)

Returns the regions of interest for the YZ slice at the given index position
Parameters:

x_index The x index of the slice

Definition at line 161 of file volume_pixel_dataset.cpp.
References X_DIMENSION.

virtual external_data_pointer_type getSliceXY ( index_type z_index ) throw (NullPointerException, IndexOutOfBoundsException) [pure virtual]

Return the slice extending in x and y dimension at a given z index of the dataset.
Parameters:

z_index The z index of the requested slice

Returns:
A pointer to the requested slice

Implemented in FourByteVolumePixelDataset, OneByteVolumePixelDataset, and TwoByteVolumePixelDataset.

virtual external_data_pointer_type getSliceXZ ( index_type y_index ) throw (NullPointerException, IndexOutOfBoundsException) [pure virtual]

Return the slice extending in x and z dimension at a given y index of the dataset.
Parameters:

y_index The y index of the requested slice

Returns:
A pointer to the requested slice

Implemented in FourByteVolumePixelDataset, OneByteVolumePixelDataset, and TwoByteVolumePixelDataset.

virtual external_data_pointer_type getSliceYZ ( index_type x_index ) throw (NullPointerException, IndexOutOfBoundsException) [pure virtual]

Return the slice extending in y and z dimension at a given x index of the dataset.
Parameters:

x_index The x index of the requested slice

Returns:
A pointer to the requested slice

Implemented in FourByteVolumePixelDataset, OneByteVolumePixelDataset, and TwoByteVolumePixelDataset.

VolumePixelDataset& operator= ( VolumePixelDataset const & ) [inline, protected]

Assignment operator
Definition at line 223 of file volume_pixel_dataset.h.

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

Reimplemented from PixelDataset.
Definition at line 68 of file volume_pixel_dataset.cpp.
References PixelDataset::setOffsetVector(), and VolumePixelDataset::transform_.
Here is the call graph for this function:

void setRegionsOfInterestForSliceXY ( index_type z_index,

std::vector< region_of_interest_type > const & regions_of_interest

) throw (IndexOutOfBoundsException)

Store the regions of interest for the XY slice at the given index position
Parameters:

z_index The z index of the slice

Definition at line 88 of file volume_pixel_dataset.cpp.
References Z_DIMENSION.

void setRegionsOfInterestForSliceXZ ( index_type y_index,

std::vector< region_of_interest_type > const & regions_of_interest

) throw (IndexOutOfBoundsException)

Store the regions of interest for the XZ slice at the given index position
Parameters:

y_index The y index of the slice

Definition at line 102 of file volume_pixel_dataset.cpp.
References Y_DIMENSION.

void setRegionsOfInterestForSliceYZ ( index_type x_index,

std::vector< region_of_interest_type > const & regions_of_interest

) throw (IndexOutOfBoundsException)

Store the regions of interest for the YZ slice at the given index position
Parameters:

x_index The x index of the slice

Definition at line 116 of file volume_pixel_dataset.cpp.
References X_DIMENSION.

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

Reimplemented from PixelDataset.
Definition at line 50 of file volume_pixel_dataset.cpp.
References PixelDataset::setTransformationMatrix().
Here is the call graph for this function:

Member Data Documentation

transform_type::Pointer transform_ [protected]

The transform used by the resampling filter
Definition at line 238 of file volume_pixel_dataset.h.
Referenced by FourByteVolumePixelDataset::FourByteVolumePixelDataset(), OneByteVolumePixelDataset::OneByteVolumePixelDataset(), VolumePixelDataset::setOffsetVector(), and TwoByteVolumePixelDataset::TwoByteVolumePixelDataset().

std::vector<std::vector<region_of_interest_type> > xy_slice_rois_ [protected]

The regions of interest for the XY slices
Definition at line 243 of file volume_pixel_dataset.h.

std::vector<std::vector<region_of_interest_type> > xz_slice_rois_ [protected]

The regions of interest for the XZ slices
Definition at line 248 of file volume_pixel_dataset.h.

std::vector<std::vector<region_of_interest_type> > yz_slice_rois_ [protected]

The regions of interest for the YZ slices
Definition at line 253 of file volume_pixel_dataset.h.

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

imedgine/src/datasets/volume_pixel_dataset.h
imedgine/src/datasets/volume_pixel_dataset.cpp

Generated on Sun Aug 13 18:20:03 2006 for iMEDgine by

1.4.6

VolumePixelDataset Class Reference [Datasets]

Public Member Functions

Protected Types