itkDICOMSeriesFileNames.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkDICOMSeriesFileNames.h,v $
  Language:  C++
  Date:      $Date: 2009-07-28 22:12:11 $
  Version:   $Revision: 1.15 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkDICOMSeriesFileNames_h
#define __itkDICOMSeriesFileNames_h

#ifdef _MSC_VER
#pragma warning ( disable : 4786 )
#endif

#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkExceptionObject.h"
#include <vector>

#include "DICOMParser.h"
#include "DICOMAppHelper.h"

namespace itk
{

class ITK_EXPORT DICOMSeriesFileNames : public Object
{
public:
  typedef DICOMSeriesFileNames    Self;
  typedef Object                  Superclass;
  typedef SmartPointer<Self>      Pointer;

  itkNewMacro(Self);

  itkTypeMacro(DICOMSeriesFileNames, Object);

  /* -------- Define the API for DICOMSeriesFileNames ----------- */

  void SetDirectory(const std::string& dir)
    {
    if (m_Directory != dir)
      {
      m_Directory = dir;
      this->Modified();

      // Clear the SeriesUIDs and FileNames
      m_SeriesUIDs.clear();
      m_FileNames.clear();
      m_AppHelper.Clear();
      }

    // Keep track of when the directory name was set so we can
    // compare it when the directory was last scanned. We set this
    // modified time each time SetDirectory() is called. This allows
    // a call to SetDirectory() to force a directory to be rescanned
    // the next time GetFileNames() or GetSeriesUIDs() is called.
    m_DirectorySetTime.Modified();
    }

  itkGetStringMacro(Directory);

  itkSetMacro(Ascending, bool);
  itkGetConstMacro(Ascending, bool);
  itkBooleanMacro(Ascending);

  typedef std::vector<std::string>    FileNamesArrayType;

  const FileNamesArrayType & GetSeriesUIDs(bool recursive = false);

  const FileNamesArrayType & GetSeriesDescriptions(){return m_SeriesDescriptions;}
  const FileNamesArrayType & GetSeriesBodyParts(){return m_BodyParts;}
  const FileNamesArrayType & GetSeriesScanOptions(){return m_ScanOptions;}

  const FileNamesArrayType & GetFileNames (bool recursive = false);

  const FileNamesArrayType & GetFileNames (const std::string& seriesUID,
                                                bool recursive = false);

  typedef enum {SortByImageNumber, SortBySliceLocation, SortByImagePositionPatient} FileNameSortingOrderType;
  itkSetEnumMacro(FileNameSortingOrder, FileNameSortingOrderType);
  itkGetEnumMacro(FileNameSortingOrder, FileNameSortingOrderType);
  void SetFileNameSortingOrderToSortByImageNumber()
    { this->SetFileNameSortingOrder(SortByImageNumber); }
  void SetFileNameSortingOrderToSortBySliceLocation()
    { this->SetFileNameSortingOrder(SortBySliceLocation); }
  void SetFileNameSortingOrderToSortByImagePositionPatient()
    { this->SetFileNameSortingOrder(SortByImagePositionPatient); }

  std::string GetFileName(const std::string& instanceUID);


protected:
  DICOMSeriesFileNames();
  ~DICOMSeriesFileNames() {};
  void PrintSelf(std::ostream& os, Indent indent) const;
  
private:
  DICOMSeriesFileNames(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
  
  int CanReadFile(const char* fname);
  void RecurseDirectory( std::string directory, FileNamesArrayType &filenames);

  itkdicomparser::DICOMParser    m_Parser;
  itkdicomparser::DICOMAppHelper m_AppHelper;

  bool                     m_Ascending;
  std::string              m_Directory;
  FileNamesArrayType       m_FileNames;
  FileNamesArrayType       m_SeriesUIDs;
  FileNamesArrayType       m_SeriesDescriptions;
  FileNamesArrayType       m_BodyParts;
  FileNamesArrayType       m_ScanOptions;

  FileNameSortingOrderType m_FileNameSortingOrder;

  TimeStamp                m_DirectorySetTime;
  TimeStamp                m_DirectoryScanTime;
};

} //namespace ITK

#endif // __itkDICOMSeriesFileNames_h