cmtk::TypedStreamStudylist Class Reference [cmtkIO Library]

Studylist with typedstream file system interface. More...

#include <cmtkTypedStreamStudylist.h>

Collaboration diagram for cmtk::TypedStreamStudylist:

List of all members.

Public Types
typedef SmartPointer < TypedStreamStudylist >	SmartPtr
	Smart pointer to TypedStreamStudylist.
Public Member Functions
	TypedStreamStudylist ()
	Default conctructor.
	~TypedStreamStudylist ()
	Destructor.
	TypedStreamStudylist (const char *studylistpath)
	Read constructor.
bool	Read (const char *studylistpath)
	Read object from disk.
AffineXform::SmartPtr &	GetAffineXform ()
	Return affine transformation as stored in the studylist.
WarpXform::SmartPtr &	GetWarpXform ()
	Return local deformation as stored in the studylist.
const char *	GetStudyPath (const int index) const
	Return study path.
const char *	GetReferenceStudyPath () const
	Return reference study path.
const char *	GetFloatingStudyPath (const int floatingIndex=0) const
	Return floating study path.
Static Public Member Functions
static void	Write (const char *path, const char *referenceStudy, const char *floatingStudy, const Xform *xform)
	Create studylist archive.
Private Member Functions
void	Clear ()
	Initialize all internal data structures.
Private Attributes
char *	StudyPath [2]
	The names of the two studies referenced in the studylist.
int	ReferenceStudyIndex
	Index of the reference study among the studies in this list (from 0).
AffineXform::SmartPtr	m_AffineXform
	Pointer to the affine transformation of this studylist.
WarpXform::SmartPtr	m_WarpXform
	Pointer to the local deformation of this studylist.

---

Detailed Description

Studylist with typedstream file system interface.

This class provides the necessary functions to read studylist objects from typedstream archives.

Definition at line 54 of file cmtkTypedStreamStudylist.h.

---

Member Typedef Documentation

typedef SmartPointer<TypedStreamStudylist> cmtk::TypedStreamStudylist::SmartPtr

Smart pointer to TypedStreamStudylist.

Definition at line 58 of file cmtkTypedStreamStudylist.h.

---

Constructor & Destructor Documentation

cmtk::TypedStreamStudylist::TypedStreamStudylist

(

const char *

studylistpath )

[inline]

Read constructor.

Parameters:

studylistpath

The typedstream archive to read the object from.

Definition at line 68 of file cmtkTypedStreamStudylist.h.

---

Member Function Documentation

AffineXform::SmartPtr& cmtk::TypedStreamStudylist::GetAffineXform

(

)

[inline]

Return affine transformation as stored in the studylist.

Definition at line 78 of file cmtkTypedStreamStudylist.h.

Referenced by cmtk::XformIO::Read().

const char* cmtk::TypedStreamStudylist::GetFloatingStudyPath

(

const int

floatingIndex = 0 )

const [inline]

Return floating study path.

Definition at line 102 of file cmtkTypedStreamStudylist.h.

References NULL.

const char* cmtk::TypedStreamStudylist::GetReferenceStudyPath

(

)

const [inline]

Return reference study path.

Definition at line 96 of file cmtkTypedStreamStudylist.h.

const char* cmtk::TypedStreamStudylist::GetStudyPath

(

const int

index )

const [inline]

Return study path.

Definition at line 90 of file cmtkTypedStreamStudylist.h.

WarpXform::SmartPtr& cmtk::TypedStreamStudylist::GetWarpXform

(

)

[inline]

Return local deformation as stored in the studylist.

Definition at line 84 of file cmtkTypedStreamStudylist.h.

Referenced by cmtk::XformIO::Read().

---

Member Data Documentation

AffineXform::SmartPtr cmtk::TypedStreamStudylist::m_AffineXform [private]

Pointer to the affine transformation of this studylist.

Definition at line 124 of file cmtkTypedStreamStudylist.h.

WarpXform::SmartPtr cmtk::TypedStreamStudylist::m_WarpXform [private]

Pointer to the local deformation of this studylist.

Definition at line 127 of file cmtkTypedStreamStudylist.h.

int cmtk::TypedStreamStudylist::ReferenceStudyIndex [private]

Index of the reference study among the studies in this list (from 0).

Definition at line 121 of file cmtkTypedStreamStudylist.h.

char* cmtk::TypedStreamStudylist::StudyPath[2] [private]

The names of the two studies referenced in the studylist.

Definition at line 118 of file cmtkTypedStreamStudylist.h.

---

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

• libs/IO/cmtkTypedStreamStudylist.h
• libs/IO/cmtkTypedStreamStudylist.cxx