cmtk::Study Class Reference [cmtkIO Library]

Class for parameters of a general imaging study. More...

#include <cmtkStudy.h>

Inheritance diagram for cmtk::Study:

Collaboration diagram for cmtk::Study:

List of all members.

Public Types
typedef SmartPointer< Study >	SmartPtr
	Smart pointer to Study.
Public Member Functions
	Study ()
	Default constructor.
	Study (const char *fileSystemPath, const char *name=NULL)
	Constructor: Construct study from image file.
virtual	~Study ()
	Destructor.
virtual void	UpdateFromVolume ()
	Update from volume data, possibly after the data has been changed.
virtual bool	ReadVolume (const bool reRead=false, const char *orientation=NULL)
	Read volume data.
const char *	SetMakeName (const char *name=NULL, const int suffix=0)
	Set study name; create name if no name given.
virtual void	CopyColormap (const Study *other)
	Copy colormap information from another study object.
void	SetFromLabelMap (const SegmentationLabelMap &lblMap)
	Get colormap from label list.
const SegmentationLabelMap &	GetUserLabelMap () const
	Get user-defined label map.
Static Public Member Functions
static Study *	Read (const char *path)
	Static study reader function.
Private Member Functions
	cmtkGetSetMacroString (FileSystemPath)
	Path of this study in the file system.
	cmtkGetSetMacroString (Name)
	Short, memorable name assigned to this study.
	cmtkGetSetMacroString (Description)
	Textual description of study file type.
	cmtkGetSetMacroString (Modality)
	Textual description of study file type.
	cmtkGetSetMacro (UniformVolume::SmartPtr, Volume)
	Volume data associated with this study.
	cmtkGetSetMacro (LandmarkList::SmartPtr, LandmarkList)
	Landmark list.
	cmtkGetSetMacro3Array (Types::Coordinate, Calibration)
	Voxel dimensions of the volume image.
	cmtkGetSetMacro (Types::DataItem, MinimumValue)
	Minimum value.
	cmtkGetSetMacro (Types::DataItem, MaximumValue)
	Maximum value.
	cmtkGetSetMacro (bool, Padding)
	Pixel padding value.
	cmtkGetSetMacro (Types::DataItem, PaddingValue)
	Pixel padding value.
	cmtkGetSetMacro (bool, HaveUserColorMap)
	Flag for user-defined colormap.
	cmtkGetSetMacro (char, StandardColormap)
	Index of colormap.
	cmtkGetSetMacro (bool, ReverseColormap)
	Is colormap reversed?
	cmtkGetSetMacro (Types::DataItem, Black)
	Value corresponding to "black".
	cmtkGetSetMacro (Types::DataItem, White)
	Value corresponding to "white".
	cmtkGetSetMacro (double, Gamma)
	Gamma value.
	cmtkGetSetMacro (unsigned int, DisplayedImageIndex)
	Index of currently displayed image.
	cmtkGetSetMacro (unsigned int, ZoomFactor)
	Displayed image zoom.
	cmtkGetSetMacro (int, SliceNormal)
	Slice normal coordinate axis.
Private Attributes
DataGrid::IndexType	m_Dims
	Voxel dimensions of the volume image.
SegmentationLabelMap	UserLabelMap
	User-defined label and colormap.

---

Detailed Description

Class for parameters of a general imaging study.

Definition at line 75 of file cmtkStudy.h.

---

Member Typedef Documentation

typedef SmartPointer<Study> cmtk::Study::SmartPtr

Smart pointer to Study.

Definition at line 142 of file cmtkStudy.h.

---

Member Function Documentation

cmtk::Study::cmtkGetSetMacro	(	UniformVolume::SmartPtr	,
		Volume
	)		[private]

Volume data associated with this study.

cmtk::Study::cmtkGetSetMacro	(	Types::DataItem	,
		MinimumValue
	)		[private]

Minimum value.

cmtk::Study::cmtkGetSetMacro	(	Types::DataItem	,
		MaximumValue
	)		[private]

Maximum value.

cmtk::Study::cmtkGetSetMacro	(	Types::DataItem	,
		White
	)		[private]

Value corresponding to "white".

cmtk::Study::cmtkGetSetMacro	(	double	,
		Gamma
	)		[private]

Gamma value.

cmtk::Study::cmtkGetSetMacro	(	unsigned	int,
		DisplayedImageIndex
	)		[private]

Index of currently displayed image.

cmtk::Study::cmtkGetSetMacro	(	unsigned	int,
		ZoomFactor
	)		[private]

Displayed image zoom.

cmtk::Study::cmtkGetSetMacro	(	bool	,
		Padding
	)		[private]

Pixel padding value.

cmtk::Study::cmtkGetSetMacro	(	int	,
		SliceNormal
	)		[private]

Slice normal coordinate axis.

cmtk::Study::cmtkGetSetMacro	(	Types::DataItem	,
		PaddingValue
	)		[private]

Pixel padding value.

cmtk::Study::cmtkGetSetMacro	(	LandmarkList::SmartPtr	,
		LandmarkList
	)		[private]

Landmark list.

cmtk::Study::cmtkGetSetMacro	(	bool	,
		HaveUserColorMap
	)		[private]

Flag for user-defined colormap.

cmtk::Study::cmtkGetSetMacro	(	char	,
		StandardColormap
	)		[private]

Index of colormap.

cmtk::Study::cmtkGetSetMacro	(	bool	,
		ReverseColormap
	)		[private]

Is colormap reversed?

cmtk::Study::cmtkGetSetMacro	(	Types::DataItem	,
		Black
	)		[private]

Value corresponding to "black".

cmtk::Study::cmtkGetSetMacro3Array	(	Types::Coordinate	,
		Calibration
	)		[private]

Voxel dimensions of the volume image.

cmtk::Study::cmtkGetSetMacroString

(

Modality

)

[private]

Textual description of study file type.

cmtk::Study::cmtkGetSetMacroString

(

FileSystemPath

)

[private]

Path of this study in the file system.

cmtk::Study::cmtkGetSetMacroString

(

Name

)

[private]

Short, memorable name assigned to this study.

cmtk::Study::cmtkGetSetMacroString

(

Description

)

[private]

Textual description of study file type.

const SegmentationLabelMap& cmtk::Study::GetUserLabelMap

(

)

const [inline]

Get user-defined label map.

Definition at line 188 of file cmtkStudy.h.

Referenced by cmtk::Colormap::SetFromStudy().

void cmtk::Study::SetFromLabelMap

(

const SegmentationLabelMap &

lblMap )

[inline]

Get colormap from label list.

Definition at line 181 of file cmtkStudy.h.

---

Member Data Documentation

DataGrid::IndexType cmtk::Study::m_Dims [private]

Voxel dimensions of the volume image.

Definition at line 96 of file cmtkStudy.h.

Referenced by ReadVolume().

SegmentationLabelMap cmtk::Study::UserLabelMap [private]

User-defined label and colormap.

Definition at line 195 of file cmtkStudy.h.

---

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

• libs/IO/cmtkStudy.h
• libs/IO/cmtkStudy.cxx