namespace yav class DisplacementField3D : public GeneralFormat, public Owner<Inrimage>, public Pointed<DisplacementField3D>, public Client

class for reel or voxel transformation

Inheritance:

Public Classes

enum	FIELD_MODE transformation can be real or voxel REAL reel VOXEL voxel

Public Methods

virtual void	dying (const ObjectPointer<Inrimage> &) an image owned by this 3D displacement field is being destroyed: destroy the displacement field
void	VoxelToReal (void) throw(DisplacementField3D::InvalidDisplacementField3DMode) transform a voxel DisplacementField3D into a real DisplacementField3D
void	RealToVoxel (float vx, float vy, float vz) throw(DisplacementField3D::InvalidDisplacementField3DMode, Inrimage::InvalidVoxelSize) transform a real DisplacementField3D into a voxel DisplacementField3D
Inrimage::WORD_TYPE	getType (void) const get the type of the image of deplacement
float	getVX () const throw(DisplacementField3D::InvalidDisplacementField3DMode) get transfo image voxel size in x dimension in case of VOXEL type
float	getVY () const throw(DisplacementField3D::InvalidDisplacementField3DMode) get transfo image voxel size in y dimension in case of VOXEL type
float	getVZ () const throw(DisplacementField3D::InvalidDisplacementField3DMode) get transfo image voxel size in z dimension in case of VOXEL type
void	setVX (float) throw(DisplacementField3D::InvalidDisplacementField3DMode) set transfo image voxel size in x dimension in case of VOXEL type
void	setVY (float) throw(DisplacementField3D::InvalidDisplacementField3DMode) set transfo image voxel size in y dimension in case of VOXEL type
void	setVZ (float) throw(DisplacementField3D::InvalidDisplacementField3DMode) set transfo image voxel size in z dimension in case of VOXEL type
void	readInrNames (GFInput &input) throw(InvalidDisplacementField3DImagesNb) general format read function for Inrimage names module
void	skipInrNames (GFInput &input) general format skip function for Inrimage names module
void	writeInrNames (GFOutput &output) general format write function for Inrimage names module

Public

Constructors DisplacementField3D ( FIELD_MODE m, Inrimage *imx, Inrimage *imy, Inrimage *imz, float vx=1, float vy=1, float vz=1 ) throw(DisplacementField3DMismatchType, DisplacementField3DMismatchSize, DisplacementField3DMismatchVoxelSize) create a transformation depending on its mode The images of the deformation are needed : 2 in 2D and 3 in 3D In case of VOXEL mode, size of voxel is needed DisplacementField3D ( const char *filename ) throw(GeneralFormat::FileNotFound, Inrimage::ImageNotFound, InvalidDisplacementField3DImagesNb, DisplacementField3DMismatchType, DisplacementField3DMismatchSize ) build a new Displacement Field

destructor ~DisplacementField3D () destroys any 3D inrimage

Protected Fields

TclString	filename 3D FIELD file name
FIELD_MODE	mode mode of the transformation
ObjectPointer <Inrimage> *	inrx x, y and z deformation images pointers on deformation image
Inrimage::WORD_TYPE	type type of the images of deformation
float	vx size of the voxels in case of voxel type transformation

Private Methods

void	initGeneralFormat (void) constructors common code for I/O routines

Private

class

Exception classes : public Exception

class Exception classes : public Exception

enum FIELD_MODE

transformation can be real or voxel

REAL

reel

VOXEL

voxel

Constructors

DisplacementField3D( FIELD_MODE m, Inrimage *imx, Inrimage *imy, Inrimage *imz, float vx=1, float vy=1, float vz=1 ) throw(DisplacementField3DMismatchType, DisplacementField3DMismatchSize, DisplacementField3DMismatchVoxelSize)

create a transformation depending on its mode The images of the deformation are needed : 2 in 2D and 3 in 3D In case of VOXEL mode, size of voxel is needed

DisplacementField3D( const char *filename ) throw(GeneralFormat::FileNotFound, Inrimage::ImageNotFound, InvalidDisplacementField3DImagesNb, DisplacementField3DMismatchType, DisplacementField3DMismatchSize )

build a new Displacement Field

Throws:

ImageNotFound

Parameters:

filename - 3D field displacement file name

destructor

~DisplacementField3D()

destroys any 3D inrimage

virtual void dying(const ObjectPointer<Inrimage> &)

an image owned by this 3D displacement field is being destroyed: destroy the displacement field

Parameters:

obj - element before destruction

void VoxelToReal(void) throw(DisplacementField3D::InvalidDisplacementField3DMode)

transform a voxel DisplacementField3D into a real DisplacementField3D

void RealToVoxel(float vx, float vy, float vz) throw(DisplacementField3D::InvalidDisplacementField3DMode, Inrimage::InvalidVoxelSize)

transform a real DisplacementField3D into a voxel DisplacementField3D

Inrimage::WORD_TYPE getType(void) const

get the type of the image of deplacement

float getVX() const throw(DisplacementField3D::InvalidDisplacementField3DMode)

get transfo image voxel size in x dimension in case of VOXEL type

float getVY() const throw(DisplacementField3D::InvalidDisplacementField3DMode)

get transfo image voxel size in y dimension in case of VOXEL type

float getVZ() const throw(DisplacementField3D::InvalidDisplacementField3DMode)

get transfo image voxel size in z dimension in case of VOXEL type

void setVX(float) throw(DisplacementField3D::InvalidDisplacementField3DMode)

set transfo image voxel size in x dimension in case of VOXEL type

void setVY(float) throw(DisplacementField3D::InvalidDisplacementField3DMode)

set transfo image voxel size in y dimension in case of VOXEL type

void setVZ(float) throw(DisplacementField3D::InvalidDisplacementField3DMode)

set transfo image voxel size in z dimension in case of VOXEL type

void readInrNames(GFInput &input) throw(InvalidDisplacementField3DImagesNb)

general format read function for Inrimage names module

void skipInrNames(GFInput &input)

general format skip function for Inrimage names module

void writeInrNames(GFOutput &output)

general format write function for Inrimage names module

TclString filename

3D FIELD file name

FIELD_MODE mode

mode of the transformation

ObjectPointer <Inrimage> * inrx

x, y and z deformation images pointers on deformation image

Inrimage::WORD_TYPE type

type of the images of deformation

float vx

size of the voxels in case of voxel type transformation

void initGeneralFormat(void)

constructors common code for I/O routines

alphabetic index hierarchy of classes

this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de