sitkImageFileReader.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 sitkImageFileReader_h
#define sitkImageFileReader_h

#include "sitkMacro.h"
#include "sitkImage.h"
#include "sitkImageReaderBase.h"
#include "sitkMemberFunctionFactory.h"


namespace itk {

  class MetaDataDictionary;

  namespace simple {

    class SITKIO_EXPORT ImageFileReader
      : public ImageReaderBase
    {
    public:
      typedef ImageFileReader Self;

      virtual ~ImageFileReader();

      ImageFileReader();

      virtual std::string ToString() const;

      virtual std::string GetName() const { return std::string("ImageFileReader"); }

      SITK_RETURN_SELF_TYPE_HEADER SetFileName ( const std::string &fn );
      std::string GetFileName() const;

      Image Execute();

      // Interface methods to access image file's meta-data and image
      // information after calling Execute or after calling
      // MetaDataRead, which does not load the bulk pixel data.

      void ReadImageInformation(void);

      PixelIDValueEnum GetPixelID( void ) const;
      PixelIDValueType GetPixelIDValue( void ) const;
      unsigned int GetDimension( void ) const;
      unsigned int GetNumberOfComponents( void ) const;
      const std::vector<double> &GetOrigin( void ) const;
      const std::vector<double> &GetSpacing( void ) const;
      const std::vector<double> &GetDirection() const;
      const std::vector<uint64_t> &GetSize( void ) const;
      /* @} */

      std::vector<std::string> GetMetaDataKeys( void ) const;

      bool HasMetaDataKey( const std::string &key ) const;

      std::string GetMetaData( const std::string &key ) const;


      SITK_RETURN_SELF_TYPE_HEADER SetExtractSize( const std::vector<unsigned int> &size);
      const std::vector<unsigned int> &GetExtractSize( ) const;


      SITK_RETURN_SELF_TYPE_HEADER SetExtractIndex( const std::vector<int> &index );
      const std::vector<int> &GetExtractIndex(  ) const;

    protected:

      template <class TImageType> Image ExecuteInternal ( itk::ImageIOBase * );

      void UpdateImageInformationFromImageIO( const itk::ImageIOBase* iobase );

    private:

      // Internal method used implement extracting a region from the reader
      template <class TImageType, class TInternalImageType>
        Image ExecuteExtract( TInternalImageType * itkImage );

      // function pointer type
      typedef Image (Self::*MemberFunctionType)( itk::ImageIOBase * );

      // friend to get access to executeInternal member
      friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
      nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;


      nsstd::function<std::vector<std::string>()> m_pfGetMetaDataKeys;
      nsstd::function<bool(const std::string &)> m_pfHasMetaDataKey;
      nsstd::function<std::string(const std::string &)> m_pfGetMetaData;

      std::string m_FileName;

      nsstd::auto_ptr<MetaDataDictionary> m_MetaDataDictionary;

      PixelIDValueEnum     m_PixelType;
      unsigned int         m_Dimension;
      unsigned int         m_NumberOfComponents;
      std::vector<double>  m_Direction;
      std::vector<double>  m_Origin;
      std::vector<double>  m_Spacing;

      std::vector<uint64_t> m_Size;

      std::vector<unsigned int> m_ExtractSize;
      std::vector<int>          m_ExtractIndex;
    };

  SITKIO_EXPORT Image ReadImage ( const std::string &filename,
                                  PixelIDValueEnum outputPixelType = sitkUnknown,
                                  const std::string &imageIO = "");
  }
}

#endif