itkImageSeriesReader.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkImageSeriesReader.h,v $
  Language:  C++
  Date:      $Date: 2010-03-29 14:54:22 $
  Version:   $Revision: 1.19 $

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

#include "itkImageSource.h"
#include "itkImageIOBase.h"
#include "itkExceptionObject.h"
#include "itkSize.h"
#include "itkImageRegion.h"
#include <vector>
#include <string>
#include "itkMetaDataDictionary.h"
#include "itkImageFileReader.h"

namespace itk
{

template <class TOutputImage>
class ITK_EXPORT ImageSeriesReader : public ImageSource<TOutputImage>
{
public:
  typedef ImageSeriesReader          Self;
  typedef ImageSource<TOutputImage>  Superclass;
  typedef SmartPointer<Self>         Pointer;

  itkNewMacro(Self);

  itkTypeMacro(ImageSeriesReader, ImageSource);

  typedef typename TOutputImage::SizeType  SizeType;

  typedef typename TOutputImage::IndexType  IndexType;

  typedef typename TOutputImage::RegionType  ImageRegionType;

  typedef typename TOutputImage::PixelType OutputImagePixelType;

  typedef MetaDataDictionary                   DictionaryType;
  typedef MetaDataDictionary *                 DictionaryRawPointer;
  typedef std::vector< DictionaryRawPointer >  DictionaryArrayType;
  typedef const DictionaryArrayType *          DictionaryArrayRawPointer;

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

  void SetFileNames (const FileNamesContainer &name)
    {
    if ( m_FileNames != name)
      {
      m_FileNames = name;
      this->Modified();
      }
    }
  const FileNamesContainer & GetFileNames() const
    {
    return m_FileNames;
    }

  void SetFileName (std::string const &name)
    {
    m_FileNames.clear();
    m_FileNames.push_back(name);
    this->Modified();
    }

  void AddFileName (std::string const &name)
    {
    m_FileNames.push_back(name);
    this->Modified();
    }

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

  itkSetObjectMacro(ImageIO,ImageIOBase);
  itkGetObjectMacro(ImageIO,ImageIOBase);

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

  virtual void GenerateOutputInformation(void);

  virtual void EnlargeOutputRequestedRegion(DataObject *output);

  DictionaryArrayRawPointer GetMetaDataDictionaryArray() const;

  itkSetMacro(UseStreaming,bool);
  itkGetConstReferenceMacro(UseStreaming,bool);
  itkBooleanMacro(UseStreaming);

protected:
  ImageSeriesReader() : m_ImageIO(0), m_ReverseOrder(false), 
    m_UseStreaming(true), m_MetaDataDictionaryArrayUpdate(true) {};
  ~ImageSeriesReader();
  void PrintSelf(std::ostream& os, Indent indent) const;
  
  virtual void GenerateData();

  ImageIOBase::Pointer m_ImageIO;

  bool m_ReverseOrder;

  FileNamesContainer m_FileNames;

  int m_NumberOfDimensionsInImage;

  DictionaryArrayType m_MetaDataDictionaryArray;

  bool m_UseStreaming;

private:
  ImageSeriesReader(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  typedef ImageFileReader<TOutputImage> ReaderType;

  int ComputeMovingDimensionIndex( ReaderType * reader );

  

  TimeStamp m_MetaDataDictionaryArrayMTime;

  bool m_MetaDataDictionaryArrayUpdate;
};

} //namespace ITK

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkImageSeriesReader.txx"
#endif

#endif // __itkImageSeriesReader_h