sitkImageSeriesReader.h

Go to the documentation of this file.

/*=========================================================================
*
*  Copyright NumFOCUS
*
*  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 sitkImageSeriesReader_h
#define sitkImageSeriesReader_h
 
#include "sitkMacro.h"
#include "sitkImage.h"
#include "sitkImageReaderBase.h"
#include "sitkMemberFunctionFactory.h"
 
namespace itk::simple {
 
    class SITKIO_EXPORT ImageSeriesReader
      : public ImageReaderBase
    {
    public:
      using Self = ImageSeriesReader;
 
      ~ImageSeriesReader() override;
 
      ImageSeriesReader();
 
      std::string ToString() const override;
 
      std::string GetName() const override { return std::string("ImageSeriesReader"); }
 
 
      SITK_RETURN_SELF_TYPE_HEADER SetMetaDataDictionaryArrayUpdate ( bool metaDataDictionaryArrayUpdate )
      { this->m_MetaDataDictionaryArrayUpdate = metaDataDictionaryArrayUpdate; return *this; }
      bool GetMetaDataDictionaryArrayUpdate() { return this->m_MetaDataDictionaryArrayUpdate; }
 
 
      SITK_RETURN_SELF_TYPE_HEADER MetaDataDictionaryArrayUpdateOn() { return this->SetMetaDataDictionaryArrayUpdate(true); }
      SITK_RETURN_SELF_TYPE_HEADER MetaDataDictionaryArrayUpdateOff() { return this->SetMetaDataDictionaryArrayUpdate(false); }
 
 
      static std::vector<std::string> GetGDCMSeriesFileNames( const std::string &directory,
                                                              const std::string &seriesID = "",
                                                              bool useSeriesDetails = false,
                                                              bool recursive = false,
                                                              bool loadSequences = false );
 
      static std::vector<std::string> GetGDCMSeriesIDs( const std::string &directory,
                                                        bool useSeriesDetails = false );
 
      SITK_RETURN_SELF_TYPE_HEADER SetFileNames ( const std::vector<std::string> &fileNames );
      const std::vector<std::string> &GetFileNames() const;
 
      Image Execute() override;
 
      std::vector<std::string> GetMetaDataKeys( unsigned int slice ) const { return this->m_pfGetMetaDataKeys(slice); }
 
      bool HasMetaDataKey( unsigned int slice, const std::string &key ) const { return this->m_pfHasMetaDataKey(slice, key); }
 
      std::string GetMetaData( unsigned int slice, const std::string &key ) const { return this->m_pfGetMetaData(slice, key); }
 
 
    protected:
 
      template <class TImageType> Image ExecuteInternal ( itk::ImageIOBase * );
 
    private:
 
      // function pointer type
      typedef Image (Self::*MemberFunctionType)( itk::ImageIOBase * );
 
      // friend to get access to executeInternal member
      friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
      std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
 
 
      std::function<std::vector<std::string>(int)> m_pfGetMetaDataKeys;
      std::function<bool(int, const std::string &)> m_pfHasMetaDataKey;
      std::function<std::string(int, const std::string &)> m_pfGetMetaData;
 
      // Holder of process object for active measurements
      itk::ProcessObject *m_Filter;
 
 
      std::vector<std::string> m_FileNames;
 
      bool m_MetaDataDictionaryArrayUpdate;
    };
 
  SITKIO_EXPORT Image ReadImage ( const std::vector<std::string> &fileNames,
                                  PixelIDValueEnum outputPixelType=sitkUnknown,
                                  const std::string &imageIO="");
  }
 
#endif