itkImageFileReader.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 itkImageFileReader_h
#define itkImageFileReader_h
#include "itkImageFileReaderException.h"
 
#include "ITKIOImageBaseExport.h"
 
#include "itkImageIOBase.h"
#include "itkImageSource.h"
#include "itkMacro.h"
#include "itkImageRegion.h"
#include "itkDefaultConvertPixelTraits.h"
#include "itkSimpleDataObjectDecorator.h"
#include "itkDirectionAlgorithm.h"
 
namespace itk
{

template <typename TOutputImage,
          typename ConvertPixelTraits = DefaultConvertPixelTraits<typename TOutputImage::IOPixelType>>
class ITK_TEMPLATE_EXPORT ImageFileReader : public ImageSource<TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ImageFileReader);

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

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ImageFileReader);

  using SizeType = typename TOutputImage::SizeType;

  using IndexType = typename TOutputImage::IndexType;

  using ImageRegionType = typename TOutputImage::RegionType;

  using OutputImagePixelType = typename TOutputImage::InternalPixelType;

  itkSetGetDecoratedInputMacro(FileName, std::string);

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

  itkSetMacro(UseStreaming, bool);
  itkGetConstReferenceMacro(UseStreaming, bool);
  itkBooleanMacro(UseStreaming);
 
  using DirectionCollapseStrategyEnum = ExtractImageFilterEnums::DirectionCollapseStrategy;

  void
  SetDirectionCollapseToStrategy(DirectionCollapseStrategyEnum strategy);
 
  [[nodiscard]] DirectionCollapseStrategyEnum
  GetDirectionCollapseToStrategy() const
  {
    return m_DirectionCollapseStrategy;
  }
 
  void
  SetDirectionCollapseToIdentity()
  {
    this->SetDirectionCollapseToStrategy(DirectionCollapseStrategyEnum::DIRECTIONCOLLAPSETOIDENTITY);
  }
 
  void
  SetDirectionCollapseToSubmatrix()
  {
    this->SetDirectionCollapseToStrategy(DirectionCollapseStrategyEnum::DIRECTIONCOLLAPSETOSUBMATRIX);
  }
 
  void
  SetDirectionCollapseToGuess()
  {
    this->SetDirectionCollapseToStrategy(DirectionCollapseStrategyEnum::DIRECTIONCOLLAPSETOGUESS);
  }

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

  void
  DoConvertBuffer(const void * inputData, size_t numberOfPixels);

  void
  TestFileExistanceAndReadability();

  void
  GenerateOutputInformation() override;

  void
  EnlargeOutputRequestedRegion(DataObject * output) override;

  void
  GenerateData() override;
 
  ImageIOBase::Pointer m_ImageIO{};
 
  bool m_UserSpecifiedImageIO{}; // keep track whether the
                                 // ImageIO is user specified
 
  bool m_UseStreaming{};
 
private:
  DirectionCollapseStrategyEnum m_DirectionCollapseStrategy{
    DirectionCollapseStrategyEnum::DIRECTIONCOLLAPSETOIDENTITY
  };
 
  std::string m_ExceptionMessage{};
 
  // The region that the ImageIO class will return when we ask to
  // produce the requested region.
  ImageIORegion m_ActualIORegion{};
};
 

template <typename TOutputImage,
          typename ConvertPixelTraits = DefaultConvertPixelTraits<typename TOutputImage::IOPixelType>>
typename TOutputImage::Pointer
ReadImage(const std::string & filename)
{
  const auto reader = ImageFileReader<TOutputImage, ConvertPixelTraits>::New();
  reader->SetFileName(filename);
  reader->Update();
  return reader->GetOutput();
}
 
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkImageFileReader.hxx"
#endif
 
#if defined ITK_IMAGEIO_FACTORY_REGISTER_MANAGER || defined ITK_IO_FACTORY_REGISTER_MANAGER
#  include "itkImageIOFactoryRegisterManager.h"
#endif
 
#endif // itkImageFileReader_h