ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
itk::DCMTKFileReader Class Reference

#include <itkDCMTKFileReader.h>

Detailed Description

Definition at line 244 of file itkDCMTKFileReader.h.

+ Collaboration diagram for itk::DCMTKFileReader:

Public Types

using Self = DCMTKFileReader
 

Public Member Functions

 DCMTKFileReader ()=default
 
int GetDimensions (unsigned short &rows, unsigned short &columns) const
 
int GetDirCosArray (double *const dircos) const
 
int GetDirCosines (vnl_vector< double > &dir1, vnl_vector< double > &dir2, vnl_vector< double > &dir3) const
 
int GetElementCS (const unsigned short group, const unsigned short element, std::string &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 GetElementDA (const unsigned short group, const unsigned short element, std::string &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 GetElementIS (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 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
 
int GetElementOB (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 GetElementSL (const unsigned short group, const unsigned short element, itk::int32_t &target, const bool throwException=true) const
 
int GetElementSQ (const unsigned short group, unsigned short entry, DCMTKSequence &sequence, const bool throwException=true) const
 
int GetElementTM (const unsigned short group, const unsigned short element, std::string &target, const bool throwException=true) const
 
int GetElementUI (const unsigned short group, unsigned short entry, std::string &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
 
const std::string & GetFileName () const
 
long GetFileNumber () const
 
int GetFrameCount () const
 
IOComponentEnum GetImageDataType () const
 
IOPixelEnum GetImagePixelType () const
 
int GetOrigin (double *const origin) const
 
int GetSlopeIntercept (double &slope, double &intercept) const
 
int GetSpacing (double *const spacing) const
 
E_TransferSyntax GetTransferSyntax () const
 
bool HasPixelData () const
 
void LoadFile ()
 
void SetFileName (const std::string &fileName)
 
 ~DCMTKFileReader ()
 
template<typename TType >
int GetElementDS (const unsigned short group, const unsigned short element, unsigned short count, 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
 

Static Public Member Functions

static void AddDictEntry (DcmDictEntry *entry)
 
static bool CanReadFile (const std::string &filename)
 
static bool IsImageFile (const std::string &filename)
 

Private Attributes

DcmDataset * m_Dataset { nullptr }
 
DcmFileFormat * m_DFile { nullptr }
 
std::string m_FileName
 
long m_FileNumber { -1L }
 
Sint32 m_FrameCount { 0 }
 
E_TransferSyntax m_Xfer { EXS_Unknown }
 

Member Typedef Documentation

◆ Self

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

◆ CanReadFile()

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

◆ GetDimensions()

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

◆ GetDirCosArray()

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

◆ GetDirCosines()

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

◆ 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

◆ GetElementDA()

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

◆ 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

◆ GetElementFD() [1/2]

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

Get a DecimalString Item as a single string

◆ 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 a DecimalString Item as a single string

◆ GetElementFL()

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

Get a DecimalString Item as a single string

◆ GetElementFLorOB()

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

Get a DecimalString Item as a single string

◆ 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

◆ 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

◆ GetElementSQ()

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

◆ GetElementTM()

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

◆ GetElementUI()

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

◆ GetElementUS() [1/2]

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

◆ GetElementUS() [2/2]

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

◆ GetFileName()

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

◆ GetFileNumber()

long itk::DCMTKFileReader::GetFileNumber ( ) const

◆ GetFrameCount()

int itk::DCMTKFileReader::GetFrameCount ( ) const

◆ GetImageDataType()

IOComponentEnum itk::DCMTKFileReader::GetImageDataType ( ) const

◆ GetImagePixelType()

IOPixelEnum itk::DCMTKFileReader::GetImagePixelType ( ) const

◆ GetOrigin()

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

◆ GetSlopeIntercept()

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

◆ GetSpacing()

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

◆ GetTransferSyntax()

E_TransferSyntax itk::DCMTKFileReader::GetTransferSyntax ( ) const

◆ HasPixelData()

bool itk::DCMTKFileReader::HasPixelData ( ) const

◆ IsImageFile()

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

◆ 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

Definition at line 507 of file itkDCMTKFileReader.h.

◆ m_DFile

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

Definition at line 506 of file itkDCMTKFileReader.h.

◆ m_FileName

std::string itk::DCMTKFileReader::m_FileName
private

Definition at line 505 of file itkDCMTKFileReader.h.

◆ m_FileNumber

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

Definition at line 510 of file itkDCMTKFileReader.h.

◆ m_FrameCount

Sint32 itk::DCMTKFileReader::m_FrameCount { 0 }
private

Definition at line 509 of file itkDCMTKFileReader.h.

◆ m_Xfer

E_TransferSyntax itk::DCMTKFileReader::m_Xfer { EXS_Unknown }
private

Definition at line 508 of file itkDCMTKFileReader.h.


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