itkGDCMSeriesFileNames.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkGDCMSeriesFileNames.h,v $
  Language:  C++
  Date:      $Date: 2007-08-24 13:35:59 $
  Version:   $Revision: 1.17 $

  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 __itkGDCMSeriesFileNames_h
#define __itkGDCMSeriesFileNames_h

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

namespace itk
{

typedef std::vector<std::string> FilenamesContainer;
typedef std::vector<std::string> SerieUIDContainer;
class ITK_EXPORT GDCMSeriesFileNames : public Object
{
public:
  typedef GDCMSeriesFileNames     Self;
  typedef Object                  Superclass;
  typedef SmartPointer<Self>      Pointer;

  itkNewMacro(Self);

  itkTypeMacro(GDCMSeriesFileNames, Object);

  /* -------- Define the API for GDCMSeriesFileNames ----------- */

  void SetInputDirectory (const char * name);

  void SetInputDirectory (std::string const &name);

  void SetDirectory (std::string const &name)
    {
    SetInputDirectory(name);
    }

  const FilenamesContainer &GetInputFileNames ();

  void SetOutputDirectory (std::string const &name)
    {
    m_OutputDirectory = name;
    this->Modified();
    }

  const FilenamesContainer &GetOutputFileNames ();

  const FilenamesContainer &GetFileNames(const std::string serie);

  const SerieUIDContainer &GetSeriesUIDs();

  itkSetMacro(Recursive, bool);
  itkGetMacro(Recursive, bool);
  itkBooleanMacro(Recursive);

  void SetUseSeriesDetails( bool useSeriesDetails)
    {
    m_UseSeriesDetails = useSeriesDetails;
    m_SerieHelper->SetUseSeriesDetails( m_UseSeriesDetails );
    m_SerieHelper->CreateDefaultUniqueSeriesIdentifier();
    }

  bool GetUseSeriesDetails( void )
    {
    return m_UseSeriesDetails;
    }

  gdcm::SerieHelper * GetSeriesHelper( void )
    {
    return m_SerieHelper;
    }

  void AddSeriesRestriction(const std::string & tag)
    {
    m_SerieHelper->AddRestriction( tag );
    }


  itkSetMacro(LoadSequences, bool);
  itkGetMacro(LoadSequences, bool);
  itkBooleanMacro(LoadSequences);

  itkSetMacro(LoadPrivateTags, bool);
  itkGetMacro(LoadPrivateTags, bool);
  itkBooleanMacro(LoadPrivateTags);

protected:
  GDCMSeriesFileNames();
  ~GDCMSeriesFileNames();
  void PrintSelf(std::ostream& os, Indent indent) const;
  
private:
  GDCMSeriesFileNames(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
  
  std::string m_InputDirectory;

  std::string m_OutputDirectory;

  FilenamesContainer  m_InputFileNames;
  FilenamesContainer  m_OutputFileNames;

  gdcm::SerieHelper *m_SerieHelper;

  SerieUIDContainer m_SeriesUIDs;

  bool m_UseSeriesDetails;
  bool m_Recursive;
  bool m_LoadSequences;
  bool m_LoadPrivateTags;

};

} //namespace ITK

#endif // __itkGDCMSeriesFileNames_h