#include <itkDCMTKFileReader.h>

Collaboration diagram for itk::DCMTKFileReader:

Public Types
using	Self = DCMTKFileReader

Public Member Functions
	DCMTKFileReader ()=default

int	GetElementLO (const unsigned short group, const unsigned short element, std::string &target, const bool throwException=true) const

int	GetElementLO (const unsigned short group, const unsigned short element, std::vector< std::string > &target, const bool throwException=true) const

const std::string &	GetFileName () const

void	LoadFile ()

void	SetFileName (const std::string &fileName)

	~DCMTKFileReader ()

std::string	m_FileName

DcmFileFormat *	m_DFile { nullptr }

DcmDataset *	m_Dataset { nullptr }

E_TransferSyntax	m_Xfer { EXS_Unknown }

Sint32	m_FrameCount { 0 }

long	m_FileNumber { -1L }

template<typename TType >
int	GetElementDS (const unsigned short group, const unsigned short element, unsigned short count, TType *target, const bool throwException=true) const

template<typename TType >
int	GetElementDSorOB (const unsigned short group, const unsigned short element, TType &target, const bool throwException=true) const

int	GetElementDS (const unsigned short group, const unsigned short element, std::string &target, const bool throwException=true) const

int	GetElementFD (const unsigned short group, const unsigned short element, double &target, const bool throwException=true) const

int	GetElementFD (const unsigned short group, const unsigned short element, int count, double *target, const bool throwException=true) const

int	GetElementFL (const unsigned short group, const unsigned short element, float &target, const bool throwException=true) const

int	GetElementFLorOB (const unsigned short group, const unsigned short element, float &target, const bool throwException=true) const

int	GetElementUS (const unsigned short group, const unsigned short element, unsigned short &target, const bool throwException=true) const

int	GetElementUS (const unsigned short group, const unsigned short element, unsigned short *&target, const bool throwException=true) const

int	GetElementCS (const unsigned short group, const unsigned short element, std::string &target, const bool throwException=true) const

int	GetElementPN (const unsigned short group, const unsigned short element, std::string &target, const bool throwException=true) const

int	GetElementIS (const unsigned short group, const unsigned short element, ::itk::int32_t &target, const bool throwException=true) const

int	GetElementSL (const unsigned short group, const unsigned short element, ::itk::int32_t &target, const bool throwException=true) const

int	GetElementISorOB (const unsigned short group, const unsigned short element, ::itk::int32_t &target, const bool throwException=true) const

int	GetElementCSorOB (const unsigned short group, const unsigned short element, std::string &target, const bool throwException=true) const

int	GetElementOB (const unsigned short group, const unsigned short element, std::string &target, const bool throwException=true) const

int	GetElementSQ (const unsigned short group, unsigned short entry, DCMTKSequence &sequence, const bool throwException=true) const

int	GetElementUI (const unsigned short group, unsigned short entry, std::string &target, const bool throwException=true) const

int	GetElementDA (const unsigned short group, const unsigned short element, std::string &target, const bool throwException=true) const

int	GetElementTM (const unsigned short group, const unsigned short element, std::string &target, const bool throwException=true) const

int	GetDirCosines (vnl_vector< double > &dir1, vnl_vector< double > &dir2, vnl_vector< double > &dir3) const

int	GetDirCosArray (double *const dircos) const

int	GetFrameCount () const

int	GetSlopeIntercept (double &slope, double &intercept) const

int	GetDimensions (unsigned short &rows, unsigned short &columns) const

IOComponentEnum	GetImageDataType () const

IOPixelEnum	GetImagePixelType () const

int	GetSpacing (double *const spacing) const

int	GetOrigin (double *const origin) const

bool	HasPixelData () const

E_TransferSyntax	GetTransferSyntax () const

long	GetFileNumber () const

static void	AddDictEntry (DcmDictEntry *entry)

static bool	CanReadFile (const std::string &filename)

static bool	IsImageFile (const std::string &filename)

Detailed Description

Definition at line 244 of file itkDCMTKFileReader.h.

Member Typedef Documentation

◆ Self

using itk::DCMTKFileReader::Self = DCMTKFileReader

Definition at line 247 of file itkDCMTKFileReader.h.

Constructor & Destructor Documentation

◆ DCMTKFileReader()

itk::DCMTKFileReader::DCMTKFileReader ( )

default

◆ ~DCMTKFileReader()

itk::DCMTKFileReader::~DCMTKFileReader ( )

Member Function Documentation

◆ AddDictEntry()

static void itk::DCMTKFileReader::AddDictEntry ( DcmDictEntry * entry )

static

Get an array of data values, as contained in a DICOM DecimalString Item

◆ CanReadFile()

static bool itk::DCMTKFileReader::CanReadFile ( const std::string & filename )

static

Get an array of data values, as contained in a DICOM DecimalString Item

◆ GetDimensions()

int itk::DCMTKFileReader::GetDimensions	(	unsigned short &	rows,
		unsigned short &	columns
	)		const

Get an array of data values, as contained in a DICOM DecimalString Item

◆ GetDirCosArray()

int itk::DCMTKFileReader::GetDirCosArray ( double *const dircos ) const

Get an array of data values, as contained in a DICOM DecimalString Item

◆ GetDirCosines()

int itk::DCMTKFileReader::GetDirCosines	(	vnl_vector< double > &	dir1,
		vnl_vector< double > &	dir2,
		vnl_vector< double > &	dir3
	)		const

Get an array of data values, as contained in a DICOM DecimalString Item

◆ GetElementCS()

int itk::DCMTKFileReader::GetElementCS	(	const unsigned short	group,
		const unsigned short	element,
		std::string &	target,
		const bool	throwException = `true`
	)		const

Get a DecimalString Item as a single string

◆ GetElementCSorOB()

int itk::DCMTKFileReader::GetElementCSorOB	(	const unsigned short	group,
		const unsigned short	element,
		std::string &	target,
		const bool	throwException = `true`
	)		const

Get an array of data values, as contained in a DICOM DecimalString Item

◆ GetElementDA()

int itk::DCMTKFileReader::GetElementDA	(	const unsigned short	group,
		const unsigned short	element,
		std::string &	target,
		const bool	throwException = `true`
	)		const

Get an array of data values, as contained in a DICOM DecimalString Item

◆ GetElementDS() [1/2]

int itk::DCMTKFileReader::GetElementDS	(	const unsigned short	group,
		const unsigned short	element,
		std::string &	target,
		const bool	throwException = `true`
	)		const

Get a DecimalString Item as a single string

◆ GetElementDS() [2/2]

template<typename TType >

int itk::DCMTKFileReader::GetElementDS	(	const unsigned short	group,
		const unsigned short	element,
		unsigned short	count,
		TType *	target,
		const bool	throwException = `true`
	)		const

inline

Get an array of data values, as contained in a DICOM DecimalString Item

Definition at line 277 of file itkDCMTKFileReader.h.

References DCMTKExceptionOrErrorReturn.

◆ GetElementDSorOB()

template<typename TType >

int itk::DCMTKFileReader::GetElementDSorOB	(	const unsigned short	group,
		const unsigned short	element,
		TType &	target,
		const bool	throwException = `true`
	)		const

inline

Get an array of data values, as contained in a DICOM DecimalString Item

Definition at line 316 of file itkDCMTKFileReader.h.

References DCMTKExceptionOrErrorReturn, itk::ByteSwapper< T >::SwapFromSystemToBigEndian(), and itk::ByteSwapper< T >::SwapFromSystemToLittleEndian().

◆ GetElementFD() [1/2]

int itk::DCMTKFileReader::GetElementFD	(	const unsigned short	group,
		const unsigned short	element,
		double &	target,
		const bool	throwException = `true`
	)		const

Get an array of data values, as contained in a DICOM DecimalString Item

◆ GetElementFD() [2/2]

int itk::DCMTKFileReader::GetElementFD	(	const unsigned short	group,
		const unsigned short	element,
		int	count,
		double *	target,
		const bool	throwException = `true`
	)		const

Get an array of data values, as contained in a DICOM DecimalString Item

◆ GetElementFL()

int itk::DCMTKFileReader::GetElementFL	(	const unsigned short	group,
		const unsigned short	element,
		float &	target,
		const bool	throwException = `true`
	)		const

Get an array of data values, as contained in a DICOM DecimalString Item

◆ GetElementFLorOB()

int itk::DCMTKFileReader::GetElementFLorOB	(	const unsigned short	group,
		const unsigned short	element,
		float &	target,
		const bool	throwException = `true`
	)		const

Get an array of data values, as contained in a DICOM DecimalString Item

◆ GetElementIS()

int itk::DCMTKFileReader::GetElementIS	(	const unsigned short	group,
		const unsigned short	element,
		::itk::int32_t &	target,
		const bool	throwException = `true`
	)		const

get an IS (Integer String Item

◆ GetElementISorOB()

int itk::DCMTKFileReader::GetElementISorOB	(	const unsigned short	group,
		const unsigned short	element,
		::itk::int32_t &	target,
		const bool	throwException = `true`
	)		const

Get an array of data values, as contained in a DICOM DecimalString Item

◆ GetElementLO() [1/2]

int itk::DCMTKFileReader::GetElementLO	(	const unsigned short	group,
		const unsigned short	element,
		std::string &	target,
		const bool	throwException = `true`
	)		const

◆ GetElementLO() [2/2]

int itk::DCMTKFileReader::GetElementLO	(	const unsigned short	group,
		const unsigned short	element,
		std::vector< std::string > &	target,
		const bool	throwException = `true`
	)		const

◆ GetElementOB()

int itk::DCMTKFileReader::GetElementOB	(	const unsigned short	group,
		const unsigned short	element,
		std::string &	target,
		const bool	throwException = `true`
	)		const

get an OB OtherByte Item

◆ GetElementPN()

int itk::DCMTKFileReader::GetElementPN	(	const unsigned short	group,
		const unsigned short	element,
		std::string &	target,
		const bool	throwException = `true`
	)		const

Get a PersonName Item as a single string

◆ GetElementSL()

int itk::DCMTKFileReader::GetElementSL	(	const unsigned short	group,
		const unsigned short	element,
		::itk::int32_t &	target,
		const bool	throwException = `true`
	)		const

Get an array of data values, as contained in a DICOM DecimalString Item

◆ GetElementSQ()

int itk::DCMTKFileReader::GetElementSQ	(	const unsigned short	group,
		unsigned short	entry,
		DCMTKSequence &	sequence,
		const bool	throwException = `true`
	)		const

Get an array of data values, as contained in a DICOM DecimalString Item

◆ GetElementTM()

int itk::DCMTKFileReader::GetElementTM	(	const unsigned short	group,
		const unsigned short	element,
		std::string &	target,
		const bool	throwException = `true`
	)		const

Get an array of data values, as contained in a DICOM DecimalString Item

◆ GetElementUI()

int itk::DCMTKFileReader::GetElementUI	(	const unsigned short	group,
		unsigned short	entry,
		std::string &	target,
		const bool	throwException = `true`
	)		const

Get an array of data values, as contained in a DICOM DecimalString Item

◆ GetElementUS() [1/2]

int itk::DCMTKFileReader::GetElementUS	(	const unsigned short	group,
		const unsigned short	element,
		unsigned short &	target,
		const bool	throwException = `true`
	)		const

Get an array of data values, as contained in a DICOM DecimalString Item

◆ GetElementUS() [2/2]

int itk::DCMTKFileReader::GetElementUS	(	const unsigned short	group,
		const unsigned short	element,
		unsigned short *&	target,
		const bool	throwException = `true`
	)		const

Get an array of data values, as contained in a DICOM DecimalString Item

◆ GetFileName()

const std::string& itk::DCMTKFileReader::GetFileName ( ) const

◆ GetFileNumber()

long itk::DCMTKFileReader::GetFileNumber ( ) const

Get an array of data values, as contained in a DICOM DecimalString Item

◆ GetFrameCount()

int itk::DCMTKFileReader::GetFrameCount ( ) const

Get an array of data values, as contained in a DICOM DecimalString Item

◆ GetImageDataType()

IOComponentEnum itk::DCMTKFileReader::GetImageDataType ( ) const

Get an array of data values, as contained in a DICOM DecimalString Item

◆ GetImagePixelType()

IOPixelEnum itk::DCMTKFileReader::GetImagePixelType ( ) const

Get an array of data values, as contained in a DICOM DecimalString Item

◆ GetOrigin()

int itk::DCMTKFileReader::GetOrigin ( double *const origin ) const

Get an array of data values, as contained in a DICOM DecimalString Item

◆ GetSlopeIntercept()

int itk::DCMTKFileReader::GetSlopeIntercept	(	double &	slope,
		double &	intercept
	)		const

Get an array of data values, as contained in a DICOM DecimalString Item

◆ GetSpacing()

int itk::DCMTKFileReader::GetSpacing ( double *const spacing ) const

Get an array of data values, as contained in a DICOM DecimalString Item

◆ GetTransferSyntax()

E_TransferSyntax itk::DCMTKFileReader::GetTransferSyntax ( ) const

Get an array of data values, as contained in a DICOM DecimalString Item

◆ HasPixelData()

bool itk::DCMTKFileReader::HasPixelData ( ) const

Get an array of data values, as contained in a DICOM DecimalString Item

◆ IsImageFile()

static bool itk::DCMTKFileReader::IsImageFile ( const std::string & filename )

static

Get an array of data values, as contained in a DICOM DecimalString Item

◆ LoadFile()

void itk::DCMTKFileReader::LoadFile ( )

◆ SetFileName()

void itk::DCMTKFileReader::SetFileName ( const std::string & fileName )

Member Data Documentation

◆ m_Dataset

DcmDataset* itk::DCMTKFileReader::m_Dataset { nullptr }

private

Get an array of data values, as contained in a DICOM DecimalString Item

Definition at line 507 of file itkDCMTKFileReader.h.

◆ m_DFile

DcmFileFormat* itk::DCMTKFileReader::m_DFile { nullptr }

private

Get an array of data values, as contained in a DICOM DecimalString Item

Definition at line 506 of file itkDCMTKFileReader.h.

◆ m_FileName

std::string itk::DCMTKFileReader::m_FileName

private

Get an array of data values, as contained in a DICOM DecimalString Item

Definition at line 505 of file itkDCMTKFileReader.h.

◆ m_FileNumber

long itk::DCMTKFileReader::m_FileNumber { -1L }

private

Get an array of data values, as contained in a DICOM DecimalString Item

Definition at line 510 of file itkDCMTKFileReader.h.

◆ m_FrameCount

Sint32 itk::DCMTKFileReader::m_FrameCount { 0 }

private

Get an array of data values, as contained in a DICOM DecimalString Item

Definition at line 509 of file itkDCMTKFileReader.h.

◆ m_Xfer

E_TransferSyntax itk::DCMTKFileReader::m_Xfer { EXS_Unknown }

private

Get an array of data values, as contained in a DICOM DecimalString Item

Definition at line 508 of file itkDCMTKFileReader.h.

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

itkDCMTKFileReader.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ Self

Constructor & Destructor Documentation

◆ DCMTKFileReader()

◆ ~DCMTKFileReader()

Member Function Documentation

◆ AddDictEntry()

◆ CanReadFile()

◆ GetDimensions()

◆ GetDirCosArray()

◆ GetDirCosines()

◆ GetElementCS()

◆ GetElementCSorOB()

◆ GetElementDA()

◆ GetElementDS() [1/2]

◆ GetElementDS() [2/2]

◆ GetElementDSorOB()

◆ GetElementFD() [1/2]

◆ GetElementFD() [2/2]

◆ GetElementFL()

◆ GetElementFLorOB()

◆ GetElementIS()

◆ GetElementISorOB()

◆ GetElementLO() [1/2]

◆ GetElementLO() [2/2]

◆ GetElementOB()

◆ GetElementPN()

◆ GetElementSL()

◆ GetElementSQ()

◆ GetElementTM()

◆ GetElementUI()

◆ GetElementUS() [1/2]

◆ GetElementUS() [2/2]

◆ GetFileName()

◆ GetFileNumber()

◆ GetFrameCount()

◆ GetImageDataType()

◆ GetImagePixelType()

◆ GetOrigin()

◆ GetSlopeIntercept()

◆ GetSpacing()

◆ GetTransferSyntax()

◆ HasPixelData()

◆ IsImageFile()

◆ LoadFile()

◆ SetFileName()

Member Data Documentation

◆ m_Dataset

◆ m_DFile

◆ m_FileName

◆ m_FileNumber

◆ m_FrameCount

◆ m_Xfer