itkImageSeriesReader.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
 *
 *         https://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 itkImageSeriesReader_h
#define itkImageSeriesReader_h
#include "ITKIOImageBaseExport.h"
 
#include "itkSize.h"
#include <vector>
#include <string>
#include "itkMetaDataDictionary.h"
#include "itkImageFileReader.h"
 
namespace itk
{
 
template <typename TOutputImage>
class ITK_TEMPLATE_EXPORT ImageSeriesReader : public ImageSource<TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ImageSeriesReader);

  using Self = ImageSeriesReader;
  using Superclass = ImageSource<TOutputImage>;
  using Pointer = SmartPointer<Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ImageSeriesReader);

  using SizeType = typename TOutputImage::SizeType;

  using IndexType = typename TOutputImage::IndexType;

  using ImageRegionType = typename TOutputImage::RegionType;

  using OutputImagePixelType = typename TOutputImage::PixelType;

  using DictionaryType = MetaDataDictionary;
  using DictionaryRawPointer = MetaDataDictionary *;
  using DictionaryArrayType = std::vector<DictionaryRawPointer>;
  using DictionaryArrayRawPointer = const DictionaryArrayType *;
 
  using FileNamesContainer = std::vector<std::string>;

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


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

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

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

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

  itkSetObjectMacro(ImageIO, ImageIOBase);
  itkGetModifiableObjectMacro(ImageIO, ImageIOBase);

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

  void
  GenerateOutputInformation() override;

  void
  EnlargeOutputRequestedRegion(DataObject * output) override;

  [[nodiscard]] DictionaryArrayRawPointer
  GetMetaDataDictionaryArray() const;

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

  itkSetMacro(SpacingWarningRelThreshold, double);
  itkGetConstMacro(SpacingWarningRelThreshold, double);
protected:
  ImageSeriesReader()
    : m_ImageIO(nullptr)
 
  {}
  ~ImageSeriesReader() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  GenerateData() override;

  ImageIOBase::Pointer m_ImageIO{};

  bool m_ReverseOrder{ false };

  bool m_ForceOrthogonalDirection{ true };

  FileNamesContainer m_FileNames{};

  unsigned int m_NumberOfDimensionsInImage{ 0 };
 
  bool m_UseStreaming{ true };
 
  bool m_SpacingDefined{ false };
 
  double m_SpacingWarningRelThreshold{ 1e-4 };
 
private:
  using ReaderType = ImageFileReader<TOutputImage>;
 
  int
  ComputeMovingDimensionIndex(ReaderType * reader);

  DictionaryArrayType m_MetaDataDictionaryArray{};

  std::vector<MetaDataDictionary> m_InternalMetaDataDictionaries{};

  TimeStamp m_MetaDataDictionaryArrayMTime{};

  bool m_MetaDataDictionaryArrayUpdate{ true };
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkImageSeriesReader.hxx"
#endif
 
#endif // itkImageSeriesReader_h