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"
#include "sitkProcessObjectDeleter.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");
  }
 

  void
  SetMetaDataDictionaryArrayUpdate(bool metaDataDictionaryArrayUpdate)
  {
    this->m_MetaDataDictionaryArrayUpdate = metaDataDictionaryArrayUpdate;
  }
  bool
  GetMetaDataDictionaryArrayUpdate()
  {
    return this->m_MetaDataDictionaryArrayUpdate;
  }
 

  void
  MetaDataDictionaryArrayUpdateOn()
  {
    return this->SetMetaDataDictionaryArrayUpdate(true);
  }
  void
  MetaDataDictionaryArrayUpdateOff()
  {
    return this->SetMetaDataDictionaryArrayUpdate(false);
  }
 

  static std::vector<PathType>
  GetGDCMSeriesFileNames(const PathType &    directory,
                         const std::string & seriesID = "",
                         bool                useSeriesDetails = false,
                         bool                recursive = false,
                         bool                loadSequences = false,
                         bool                failOnAmbiguousOrdering = true);

  static std::vector<std::string>
  GetGDCMSeriesIDs(const PathType & directory, bool useSeriesDetails = false);
 
  void
  SetFileNames(const std::vector<PathType> & fileNames);
  const std::vector<PathType> &
  GetFileNames() const;

  void
  SetSpacingWarningRelThreshold(double spacingWarningRelThreshold);
  double
  GetSpacingWarningRelThreshold() const;

  void
  SetForceOrthogonalDirection(bool forceOrthogonalDirection);
  bool
  GetForceOrthogonalDirection() const;
  void
  ForceOrthogonalDirectionOn();
  void
  ForceOrthogonalDirectionOff();

  void
  SetReverseOrder(bool reverseOrder);
  bool
  GetReverseOrder() const;
  void
  ReverseOrderOn();
  void
  ReverseOrderOff();
 
  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>;
  static const detail::MemberFunctionFactory<MemberFunctionType> &
  GetMemberFunctionFactory();
 
 
  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 a process object for active measurements
  std::unique_ptr<itk::ProcessObject, ProcessObjectDeleter> m_Filter;
 
 
  std::vector<PathType> m_FileNames;
 
  double m_SpacingWarningRelThreshold{ 1e-4 };
 
  bool m_MetaDataDictionaryArrayUpdate{ false };
 
  bool m_ForceOrthogonalDirection{ true };
 
  bool m_ReverseOrder{ false };
};

SITKIO_EXPORT Image
ReadImage(const std::vector<PathType> & fileNames,
          PixelIDValueEnum              outputPixelType = sitkUnknown,
          const std::string &           imageIO = "");
} // namespace itk::simple
 
#endif