itkImageFileReader.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef __itkImageFileReader_h
#define __itkImageFileReader_h

#include "itkImageIOBase.h"
#include "itkImageSource.h"
#include "itkMacro.h"
#include "itkImageRegion.h"
#include "itkDefaultConvertPixelTraits.h"
#include "itkSimpleDataObjectDecorator.h"

namespace itk
{
class ITK_ABI_EXPORT ImageFileReaderException:public ExceptionObject
{
public:
  itkTypeMacro(ImageFileReaderException, ExceptionObject);

  ImageFileReaderException(const char *file, unsigned int line,
                           const char *message = "Error in IO",
                           const char *loc = "Unknown"):
    ExceptionObject(file, line, message, loc)
  {}

  ImageFileReaderException(const std::string & file, unsigned int line,
                           const char *message = "Error in IO",
                           const char *loc = "Unknown"):
    ExceptionObject(file, line, message, loc)
  {}

  virtual ~ImageFileReaderException() throw( )
  {}
};

template< class TOutputImage,
          class ConvertPixelTraits = DefaultConvertPixelTraits<
            typename TOutputImage::IOPixelType > >
class ITK_EXPORT ImageFileReader:public ImageSource< TOutputImage >
{
public:
  typedef ImageFileReader             Self;
  typedef ImageSource< TOutputImage > Superclass;
  typedef SmartPointer< Self >        Pointer;

  itkNewMacro(Self);

  itkTypeMacro(ImageFileReader, ImageSource);

  typedef typename TOutputImage::SizeType SizeType;

  typedef typename TOutputImage::IndexType IndexType;

  typedef typename TOutputImage::RegionType ImageRegionType;

  typedef typename TOutputImage::InternalPixelType OutputImagePixelType;

  itkSetGetDecoratedInputMacro(FileName, std::string);

  void  SetImageIO(ImageIOBase *imageIO);
  itkGetModifiableObjectMacro(ImageIO, ImageIOBase);

  virtual void GenerateOutputInformation(void);

  virtual void EnlargeOutputRequestedRegion(DataObject *output);

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

protected:
  ImageFileReader();
  ~ImageFileReader();
  void PrintSelf(std::ostream & os, Indent indent) const;

  void DoConvertBuffer(void *buffer, size_t numberOfPixels);

  void TestFileExistanceAndReadability();

  virtual void GenerateData();

  ImageIOBase::Pointer m_ImageIO;

  bool m_UserSpecifiedImageIO; // keep track whether the
                               // ImageIO is user specified

  bool m_UseStreaming;

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

  std::string m_ExceptionMessage;

  // The region that the ImageIO class will return when we ask to
  // produce the requested region.
  ImageIORegion m_ActualIORegion;
};
} //namespace ITK

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkImageFileReader.hxx"
#endif

#ifdef ITK_IO_FACTORY_REGISTER_MANAGER
#include "itkImageIOFactoryRegisterManager.h"
#endif

#endif // __itkImageFileReader_h