OneByteVolumePixelDataset Class Reference
[Datasets]

Pixel datasets with 3 dimensions and an internal pixel type of size one byte. More...

#include <one_byte_volume_pixel_dataset.h>

Inherits VolumePixelDataset.

Inheritance diagram for OneByteVolumePixelDataset:

[legend]Collaboration diagram for OneByteVolumePixelDataset:

[legend]List of all members.

Public Types
typedef volume_type	type
Public Member Functions
	OneByteVolumePixelDataset (dataset_key_type dataset_key, volume_pointer_type volume=0)
virtual	~OneByteVolumePixelDataset ()
virtual external_data_pointer_type	getData () const throw (NullPointerException)
void	setDataset (volume_pointer_type dataset)
const_volume_pointer_type	getDataset () const
volume_pointer_type	getDataset ()
virtual void	setIntensity (double window, double level)
double	getIntensityWindow () const throw (NullPointerException)
double	getIntensityLevel () const throw (NullPointerException)
external_data_pointer_type	getSliceXY (index_type z_index) throw (NullPointerException, IndexOutOfBoundsException)
external_data_pointer_type	getSliceXZ (index_type y_index) throw (NullPointerException, IndexOutOfBoundsException)
external_data_pointer_type	getSliceYZ (index_type x_index) throw (NullPointerException, IndexOutOfBoundsException)
dataset_pointer_type	getImageXY (index_type z_index, dataset_key_type image_key) throw (NullPointerException, IndexOutOfBoundsException)
dataset_pointer_type	getImageXZ (index_type y_index, dataset_key_type image_key) throw (NullPointerException, IndexOutOfBoundsException)
dataset_pointer_type	getImageYZ (index_type x_index, dataset_key_type image_key) throw (NullPointerException, IndexOutOfBoundsException)
Protected Types
typedef one_byte_volume_type	volume_type
typedef one_byte_volume_pointer_type	volume_pointer_type
typedef const_one_byte_volume_pointer_type	const_volume_pointer_type
typedef const_one_byte_volume_iterator_type	const_volume_iterator_type
typedef one_byte_image_type	image_type
typedef one_byte_pixel_type	pixel_type
typedef volume_type::RegionType	region_type
typedef volume_type::SizeType	region_size_type
typedef volume_type::IndexType	region_index_type
typedef itk::ResampleImageFilter< volume_type, volume_type, double >	resampling_filter_type
typedef itk::ExtractImageFilter< volume_type, image_type >	slice_extractor_type
typedef itk::ExtractImageFilter< volume_type, image_type >	image_extractor_type
typedef itk::IntensityWindowingImageFilter< volume_type, external_volume_type >	volume_intensity_filter_type
typedef itk::IntensityWindowingImageFilter< image_type, external_image_type >	image_intensity_filter_type
Protected Member Functions
	OneByteVolumePixelDataset (OneByteVolumePixelDataset const &src)
void	setDatasetInternal (volume_pointer_type dataset)
Protected Attributes
one_byte_volume_pointer_type	dataset_
resampling_filter_type::Pointer	resampling_filter_
slice_extractor_type::Pointer	slice_extractor_
image_extractor_type::Pointer	image_extractor_
volume_intensity_filter_type::Pointer	volume_intensity_filter_
image_intensity_filter_type::Pointer	image_intensity_filter_
region_type	xy_region_to_extract_
region_type	xz_region_to_extract_
region_type	yz_region_to_extract_

---

Detailed Description

Pixel datasets with 3 dimensions and an internal pixel type of size one byte.

The implementation of the VolumePixelDataset interface for 3 dimensional voxel datasets with an internal pixel storage size of one byte

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)

See also:

Dataset

Definition at line 55 of file one_byte_volume_pixel_dataset.h.

---

Member Typedef Documentation

typedef const_one_byte_volume_iterator_type const_volume_iterator_type [protected]

The type for a read-only iterator through the volume Definition at line 77 of file one_byte_volume_pixel_dataset.h.

typedef const_one_byte_volume_pointer_type const_volume_pointer_type [protected]

The type for a read-only pointer to the volume Definition at line 72 of file one_byte_volume_pixel_dataset.h.

typedef itk::ExtractImageFilter<volume_type, image_type> image_extractor_type [protected]

The type for the image extractor Definition at line 259 of file one_byte_volume_pixel_dataset.h.

typedef itk::IntensityWindowingImageFilter<image_type, external_image_type> image_intensity_filter_type [protected]

The type for the intensity mapper in 2 dimensional datasets Definition at line 271 of file one_byte_volume_pixel_dataset.h.

typedef one_byte_image_type image_type [protected]

The type for an sub-image of the volume Definition at line 82 of file one_byte_volume_pixel_dataset.h.

typedef one_byte_pixel_type pixel_type [protected]

The type used to store one pixel Definition at line 87 of file one_byte_volume_pixel_dataset.h.

typedef volume_type::IndexType region_index_type [protected]

The type for a x,y,z-position within the volume Definition at line 244 of file one_byte_volume_pixel_dataset.h.

typedef volume_type::SizeType region_size_type [protected]

The type for a x,y,z-size of a region within the volume Definition at line 239 of file one_byte_volume_pixel_dataset.h.

typedef volume_type::RegionType region_type [protected]

The type for a region (size and origin) within the volume Definition at line 234 of file one_byte_volume_pixel_dataset.h.

typedef itk::ResampleImageFilter<volume_type, volume_type, double> resampling_filter_type [protected]

The type for the slice extractor Definition at line 249 of file one_byte_volume_pixel_dataset.h.

typedef itk::ExtractImageFilter<volume_type, image_type> slice_extractor_type [protected]

The type for the slice extractor Definition at line 254 of file one_byte_volume_pixel_dataset.h.

typedef volume_type type

The type of the dataset for external scoping Definition at line 94 of file one_byte_volume_pixel_dataset.h.

typedef itk::IntensityWindowingImageFilter<volume_type, external_volume_type> volume_intensity_filter_type [protected]

The type for the intensity mapper in 3 dimensional datasets Definition at line 265 of file one_byte_volume_pixel_dataset.h.

typedef one_byte_volume_pointer_type volume_pointer_type [protected]

The type for a pointer to the volume Definition at line 67 of file one_byte_volume_pixel_dataset.h.

typedef one_byte_volume_type volume_type [protected]

The type for the volume Definition at line 62 of file one_byte_volume_pixel_dataset.h.

---

Constructor & Destructor Documentation

OneByteVolumePixelDataset (  dataset_key_type  dataset_key, volume_pointer_type  volume = 0 )

Constructor Parameters: dataset_key  The unique key of the dataset dataset  The volume dataset to manage Definition at line 23 of file one_byte_volume_pixel_dataset.cpp. References OneByteVolumePixelDataset::resampling_filter_, and VolumePixelDataset::transform_.

~OneByteVolumePixelDataset (   )  [virtual]

Destructor Definition at line 57 of file one_byte_volume_pixel_dataset.cpp.

OneByteVolumePixelDataset (  OneByteVolumePixelDataset const &  src  )  [protected]

Copy constructor Definition at line 43 of file one_byte_volume_pixel_dataset.cpp. References OneByteVolumePixelDataset::resampling_filter_, and VolumePixelDataset::transform_.

---

Member Function Documentation

external_data_pointer_type getData (   )  const throw (NullPointerException) [virtual]

Returns a pointer to the raw data held by the dataset. Returns: A pointer to the dataset Implements PixelDataset. Definition at line 63 of file one_byte_volume_pixel_dataset.cpp. References OneByteVolumePixelDataset::dataset_.

OneByteVolumePixelDataset::volume_pointer_type getDataset (   )

Returns a pointer to the dataset internally managed. Returns: A pointer to the dataset Definition at line 174 of file one_byte_volume_pixel_dataset.cpp. References OneByteVolumePixelDataset::dataset_.

OneByteVolumePixelDataset::const_volume_pointer_type getDataset (   )  const

Returns a read-only pointer to the volume dataset internally managed. Returns: A read-only pointer to the volume dataset Definition at line 166 of file one_byte_volume_pixel_dataset.cpp. References OneByteVolumePixelDataset::dataset_.

dataset_pointer_type getImageXY (  index_type  z_index, dataset_key_type  image_key )  throw (NullPointerException, IndexOutOfBoundsException) [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 Implements VolumePixelDataset. Definition at line 324 of file one_byte_volume_pixel_dataset.cpp.

dataset_pointer_type getImageXZ (  index_type  y_index, dataset_key_type  image_key )  throw (NullPointerException, IndexOutOfBoundsException) [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 Implements VolumePixelDataset. Definition at line 355 of file one_byte_volume_pixel_dataset.cpp.

dataset_pointer_type getImageYZ (  index_type  x_index, dataset_key_type  image_key )  throw (NullPointerException, IndexOutOfBoundsException) [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 Implements VolumePixelDataset. Definition at line 386 of file one_byte_volume_pixel_dataset.cpp.

double getIntensityLevel (   )  const throw (NullPointerException) [virtual]

Return the intensity level of the dataset. Returns: The intensity level (pixel value in the center of the window) Implements PixelDataset. Definition at line 233 of file one_byte_volume_pixel_dataset.cpp. References OneByteVolumePixelDataset::image_intensity_filter_.

double getIntensityWindow (   )  const throw (NullPointerException) [virtual]

Return the intensity window of the dataset. Returns: The intensity window (pixel value range) Implements PixelDataset. Definition at line 221 of file one_byte_volume_pixel_dataset.cpp. References OneByteVolumePixelDataset::image_intensity_filter_.

external_data_pointer_type getSliceXY (  index_type  z_index  )  throw (NullPointerException, IndexOutOfBoundsException) [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 Implements VolumePixelDataset. Definition at line 245 of file one_byte_volume_pixel_dataset.cpp.

external_data_pointer_type getSliceXZ (  index_type  y_index  )  throw (NullPointerException, IndexOutOfBoundsException) [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 Implements VolumePixelDataset. Definition at line 272 of file one_byte_volume_pixel_dataset.cpp.

external_data_pointer_type getSliceYZ (  index_type  x_index  )  throw (NullPointerException, IndexOutOfBoundsException) [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 slcie Implements VolumePixelDataset. Definition at line 298 of file one_byte_volume_pixel_dataset.cpp.

void setDataset (  volume_pointer_type  dataset  )

Sets the volume dataset to manage. Parameters: dataset  The volume dataset to manage Definition at line 82 of file one_byte_volume_pixel_dataset.cpp. References Dataset::is_dirty_, and OneByteVolumePixelDataset::setDatasetInternal(). Here is the call graph for this function:

void setDatasetInternal (  volume_pointer_type  dataset  )  [protected]

Sets the image dataset internally Parameters: dataset  The image dataset to manage Definition at line 90 of file one_byte_volume_pixel_dataset.cpp. References OneByteVolumePixelDataset::dataset_, Dataset::is_data_set_, PixelDataset::max_pixel_value_, and PixelDataset::min_pixel_value_. Referenced by OneByteVolumePixelDataset::setDataset().

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

Set the intensity window and level for the dataset. Parameters: window  The window (pixel value range) to set level  The level (pixel value in the center of the window) to set Implements PixelDataset. Definition at line 182 of file one_byte_volume_pixel_dataset.cpp. References OneByteVolumePixelDataset::image_intensity_filter_, and OneByteVolumePixelDataset::volume_intensity_filter_.

---

Member Data Documentation

one_byte_volume_pointer_type dataset_ [protected]

The dataset used to store and access the image data Definition at line 289 of file one_byte_volume_pixel_dataset.h. Referenced by OneByteVolumePixelDataset::getData(), OneByteVolumePixelDataset::getDataset(), and OneByteVolumePixelDataset::setDatasetInternal().

image_extractor_type::Pointer image_extractor_ [protected]

The filter extracting sub-images from the volume Definition at line 304 of file one_byte_volume_pixel_dataset.h.

image_intensity_filter_type::Pointer image_intensity_filter_ [protected]

The filter adapting the intensity of a slice to a given level and window Definition at line 314 of file one_byte_volume_pixel_dataset.h. Referenced by OneByteVolumePixelDataset::getIntensityLevel(), OneByteVolumePixelDataset::getIntensityWindow(), and OneByteVolumePixelDataset::setIntensity().

resampling_filter_type::Pointer resampling_filter_ [protected]

The dataset used to store and access the image data Definition at line 294 of file one_byte_volume_pixel_dataset.h. Referenced by OneByteVolumePixelDataset::OneByteVolumePixelDataset().

slice_extractor_type::Pointer slice_extractor_ [protected]

The filter extracting single slices from the volume Definition at line 299 of file one_byte_volume_pixel_dataset.h.

volume_intensity_filter_type::Pointer volume_intensity_filter_ [protected]

The intensity filter for the whole volume Definition at line 309 of file one_byte_volume_pixel_dataset.h. Referenced by OneByteVolumePixelDataset::setIntensity().

region_type xy_region_to_extract_ [protected]

The region used by the slice extractor for getting x-y slices Definition at line 319 of file one_byte_volume_pixel_dataset.h.

region_type xz_region_to_extract_ [protected]

The region used by the slice extractor for getting x-z slices Definition at line 324 of file one_byte_volume_pixel_dataset.h.

region_type yz_region_to_extract_ [protected]

The region used by the slice extractor for getting y-z slices Definition at line 329 of file one_byte_volume_pixel_dataset.h.

---

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

• imedgine/src/datasets/one_byte_volume_pixel_dataset.h
• imedgine/src/datasets/one_byte_volume_pixel_dataset.cpp

---