Computer Assited Medical Intervention Tool Kit  version 4.1
Public Member Functions | Static Public Member Functions | Static Private Member Functions | List of all members
DicomParser Class Reference
CEP Imaging » Components » DICOM

DicomParser allows one to parse a directory of DICOM files looking for studies and series. More...

#include <DicomParser.h>

Public Member Functions

 DicomParser ()=default
 
virtual ~DicomParser ()=default
 Default Destructor. More...
 

Static Public Member Functions

static double getZSpacing (const std::vector< std::string > &serieFileNames)
 Retrieve the DICOM image file Z spacing attribute (commonly known as spacing between slices) More...
 
static QList< DicomSerie * > parseDirectory (const QString &directory)
 Parse the input directory for DICOM series. More...
 

Static Private Member Functions

static QDate getAcquisitionDate (const std::vector< std::string > &serieFileNames)
 Retrieve the SERIES acquisition date. More...
 
static QTime getAcquisitionTime (const std::vector< std::string > &serieFileNames)
 Retrieve the SERIES acquisition time. More...
 
static QString getPatientName (const std::vector< std::string > &serieFileNames)
 Retrieve the patient name information from the input files. More...
 
static QString getSerieDescription (const std::vector< std::string > &serieFileNames)
 Retrieve the series description. More...
 
static QString getSerieName (const std::vector< std::string > &serieFileNames)
 Retrieve the series name. More...
 
static QString getStudyName (const std::vector< std::string > &serieFileNames)
 Retrieve the study name. More...
 
static std::vector< std::string > qtListOfStringToStd (const QList< QString > &inputList)
 Convert a QList of QString into a std list of string. More...
 
static QList< QString > stdListOfStringToQt (const std::vector< std::string > &inputList)
 Convert a simple std list of string into a QList of QString. More...
 

Detailed Description

DicomParser allows one to parse a directory of DICOM files looking for studies and series.

Note
This class is part of the model (in the MVP pattern) of the DICOM COMPONENT

Constructor & Destructor Documentation

◆ DicomParser()

DicomParser::DicomParser ( )
default

◆ ~DicomParser()

virtual DicomParser::~DicomParser ( )
virtualdefault

Default Destructor.

Member Function Documentation

◆ getAcquisitionDate()

QDate DicomParser::getAcquisitionDate ( const std::vector< std::string > &  serieFileNames)
staticprivate

Retrieve the SERIES acquisition date.

Parameters
serieFileNamesThe filenames belonging to a single series.
Returns
the acquisition date of this SERIES.

Referenced by parseDirectory().

◆ getAcquisitionTime()

QTime DicomParser::getAcquisitionTime ( const std::vector< std::string > &  serieFileNames)
staticprivate

Retrieve the SERIES acquisition time.

Parameters
serieFileNamesThe filenames belonging to a single series.
Returns
the acquisition time of this SERIES.

Referenced by parseDirectory().

◆ getPatientName()

QString DicomParser::getPatientName ( const std::vector< std::string > &  serieFileNames)
staticprivate

Retrieve the patient name information from the input files.

Parameters
serieFileNamesThe filenames belonging to a single series.
Returns
the patient name.

Referenced by parseDirectory().

◆ getSerieDescription()

QString DicomParser::getSerieDescription ( const std::vector< std::string > &  serieFileNames)
staticprivate

Retrieve the series description.

Parameters
serieFileNamesThe filenames belonging to a single series.
Returns
the series description.

Referenced by parseDirectory().

◆ getSerieName()

QString DicomParser::getSerieName ( const std::vector< std::string > &  serieFileNames)
staticprivate

Retrieve the series name.

Parameters
serieFileNamesThe filenames belonging to a single series.
Returns
the series name.

Referenced by parseDirectory().

◆ getStudyName()

QString DicomParser::getStudyName ( const std::vector< std::string > &  serieFileNames)
staticprivate

Retrieve the study name.

Parameters
serieFileNamesThe filenames belonging to a single series.
Returns
the study name.

Referenced by parseDirectory().

◆ getZSpacing()

double DicomParser::getZSpacing ( const std::vector< std::string > &  serieFileNames)
static

Retrieve the DICOM image file Z spacing attribute (commonly known as spacing between slices)

Parameters
serieFileNamesthe input DICOM image images to retrieve the Z spacing attribute from.
Returns
the Z spacing value.

References CAMITK_ERROR_ALT.

Referenced by DicomComponent::DicomComponent().

◆ parseDirectory()

QList< DicomSerie * > DicomParser::parseDirectory ( const QString &  directory)
static

Parse the input directory for DICOM series.

Parameters
directoryThe input directory to parse DICOM image files.
Returns
A list of DicomSerie, high level CamiTK object which store information of a SERIES

DEBUG

References CAMITK_TRACE_ALT, getAcquisitionDate(), getAcquisitionTime(), getPatientName(), getSerieDescription(), getSerieName(), getStudyName(), DicomSerie::setAcquisitionDate(), DicomSerie::setAcquisitionTime(), DicomSerie::setFileNames(), DicomSerie::setPatientName(), DicomSerie::setSerieDescription(), DicomSerie::setSerieName(), DicomSerie::setStdFileNames(), DicomSerie::setStudyName(), and stdListOfStringToQt().

Referenced by DicomComponentExtension::open().

◆ qtListOfStringToStd()

std::vector< std::string > DicomParser::qtListOfStringToStd ( const QList< QString > &  inputList)
staticprivate

Convert a QList of QString into a std list of string.

Parameters
inputListQList of QString to convert.
Returns
std list of string version of the input Qt list.

◆ stdListOfStringToQt()

QList< QString > DicomParser::stdListOfStringToQt ( const std::vector< std::string > &  inputList)
staticprivate

Convert a simple std list of string into a QList of QString.

Parameters
inputListstd list of string to convert.
Returns
QList of QString version of the input std list.

Referenced by parseDirectory().

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.13