Geometry_chooser Class Reference

The Geometry_chooser class provides a convenient method for choosing the right output geometry for a function. More...

#include <geometry_chooser.h>

Public Member Functions
	Geometry_chooser ()
	~Geometry_chooser ()
Inputs
void	set_reference_image (const char *image_fn)
	Set the reference image. The geometry will be from the specified filename.
template<class T >
void	set_reference_image (const T &image)
	Set the reference image as an ITK image.
void	set_compare_image (const char *image_fn)
	Set the compare image. The image will be loaded from the specified filename.
void	set_compare_image (const UCharImageType::Pointer image)
	Set the compare image as an ITK image.
void	set_compare_image (const FloatImageType::Pointer image)
void	set_fixed_image (const char *image_fn)
	Set the fixed image. The image will be loaded from the specified filename.
void	set_fixed_image (const std::string &image_fn)
template<class T >
void	set_fixed_image (const T &image)
	Set the fixed image as an ITK image.
void	set_fixed_image (const Plm_image_header pih)
	Set the fixed image as a Plm_image_header.
void	set_dim (const plm_long dim[3])
	Set the image dimension (number of voxels) manually.
void	set_origin (const float origin[3])
	Set the image origin manually.
void	set_spacing (const float spacing[3])
	Set the image spacing manually.
void	set_direction_cosines (const Direction_cosines &direction_cosines)
	Set the image direction cosines manually.
Outputs
const Plm_image_header *	get_geometry ()
	Return the best fitting geometry.

Public Attributes
Geometry_chooser_private *	d_ptr

Detailed Description

The Geometry_chooser class provides a convenient method for choosing the right output geometry for a function.

The output geometry is selected based on preferential selection from a set of possible inputs which might or might not be available. In order of preference, the geometry is set according to:

• Manual setting of dim, origin, spacing, direction_cosines
• Copying the geometry from a specific image (called the "fixed image")
• Setting the geometry from an input image (called the "reference image")

In the last case, the geometry can be expanded to also include the union of the regions spanned by another image (called the "compare image")

Constructor & Destructor Documentation

Geometry_chooser()

Geometry_chooser::Geometry_chooser

(

)

~Geometry_chooser()

Geometry_chooser::~Geometry_chooser

(

)

Member Function Documentation

get_geometry()

const Plm_image_header * Geometry_chooser::get_geometry

(

)

Return the best fitting geometry.

set_compare_image() [1/3]

void Geometry_chooser::set_compare_image

(

const char *

image_fn

)

Set the compare image. The image will be loaded from the specified filename.

set_compare_image() [2/3]

void Geometry_chooser::set_compare_image

(

const FloatImageType::Pointer

image

)

set_compare_image() [3/3]

void Geometry_chooser::set_compare_image

(

const UCharImageType::Pointer

image

)

Set the compare image as an ITK image.

set_dim()

void Geometry_chooser::set_dim

(

const plm_long

dim[3]

)

Set the image dimension (number of voxels) manually.

set_direction_cosines()

void Geometry_chooser::set_direction_cosines

(

const Direction_cosines &

direction_cosines

)

Set the image direction cosines manually.

set_fixed_image() [1/4]

void Geometry_chooser::set_fixed_image

(

const char *

image_fn

)

Set the fixed image. The image will be loaded from the specified filename.

set_fixed_image() [2/4]

void Geometry_chooser::set_fixed_image

(

const Plm_image_header

pih

)

Set the fixed image as a Plm_image_header.

set_fixed_image() [3/4]

void Geometry_chooser::set_fixed_image

(

const std::string &

image_fn

)

set_fixed_image() [4/4]

template<class T >

void Geometry_chooser::set_fixed_image

(

const T &

image

)

Set the fixed image as an ITK image.

set_origin()

void Geometry_chooser::set_origin

(

const float

origin[3]

)

Set the image origin manually.

set_reference_image() [1/2]

void Geometry_chooser::set_reference_image

(

const char *

image_fn

)

Set the reference image. The geometry will be from the specified filename.

set_reference_image() [2/2]

template<class T >

void Geometry_chooser::set_reference_image

(

const T &

image

)

Set the reference image as an ITK image.

set_spacing()

void Geometry_chooser::set_spacing

(

const float

spacing[3]

)

Set the image spacing manually.

Member Data Documentation

d_ptr

Geometry_chooser_private* Geometry_chooser::d_ptr

---

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

• src/util/geometry_chooser.h
• src/util/geometry_chooser.cxx