mitk::DICOMImageFrameInfo Class Reference

Describes a frame within a DICOM file. More...

#include <mitkDICOMImageFrameInfo.h>

Inheritance diagram for mitk::DICOMImageFrameInfo:

Collaboration diagram for mitk::DICOMImageFrameInfo:

Public Member Functions
	mitkClassMacroItkParent (DICOMImageFrameInfo, itk::LightObject)
	mitkNewMacro1Param (DICOMImageFrameInfo, const std::string &)
	mitkNewMacro2Param (DICOMImageFrameInfo, const std::string &, unsigned int)
bool	operator== (const DICOMImageFrameInfo &other) const
	Equality comparison based on filename and frame number. More...

Static Public Member Functions
static Pointer	New ()

Public Attributes
const std::string	Filename
	Absolute filename of the DICOM file. More...
const unsigned int	FrameNo
	Frame number within the file, starting with 0. More...

Protected Member Functions
	DICOMImageFrameInfo (const std::string &filename="", unsigned int frameNo=0)

Detailed Description

Describes a frame within a DICOM file.

This is a minimal data structure to describe a single frame (think of DICOM multi-frame classes) within a DICOM file. To be used by DICOMFileReaders and as part of DICOMImageBlockDescriptor.

Definition at line 31 of file mitkDICOMImageFrameInfo.h.

Constructor & Destructor Documentation

DICOMImageFrameInfo()

mitk::DICOMImageFrameInfo::DICOMImageFrameInfo ( const std::string &  filename = "", unsigned int  frameNo = 0  )

protected

Member Function Documentation

mitkClassMacroItkParent()

mitk::DICOMImageFrameInfo::mitkClassMacroItkParent	(	DICOMImageFrameInfo	,
		itk::LightObject
	)

mitkNewMacro1Param()

mitk::DICOMImageFrameInfo::mitkNewMacro1Param	(	DICOMImageFrameInfo	,
		const std::string &
	)

mitkNewMacro2Param()

mitk::DICOMImageFrameInfo::mitkNewMacro2Param	(	DICOMImageFrameInfo	,
		const std::string &	,
		unsigned int
	)

New()

static Pointer mitk::DICOMImageFrameInfo::New ( )

static

operator==()

bool mitk::DICOMImageFrameInfo::operator==

(

const DICOMImageFrameInfo &

other

)

const

Equality comparison based on filename and frame number.

Parameters

[in]

other

The frame info to compare with.

Returns

true if filename and frame number match.

Member Data Documentation

Filename

const std::string mitk::DICOMImageFrameInfo::Filename

Absolute filename of the DICOM file.

Definition at line 35 of file mitkDICOMImageFrameInfo.h.

FrameNo

const unsigned int mitk::DICOMImageFrameInfo::FrameNo

Frame number within the file, starting with 0.

Definition at line 36 of file mitkDICOMImageFrameInfo.h.

---

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

• mitkDICOMImageFrameInfo.h