sitkImageReaderBase.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 sitkImageReaderBase_h
#define sitkImageReaderBase_h
 
#include "sitkProcessObject.h"
#include "sitkPixelIDValues.h"
#include "sitkPathType.h"
#include "sitkIO.h"
 
namespace itk
{
 
// Forward declaration for pointer
class ImageIOBase;
 
template <class T>
class SmartPointer;
 
namespace simple
{

class SITKIO_EXPORT ImageReaderBase : public ProcessObject
{
public:
  using Self = ImageReaderBase;
 
  ~ImageReaderBase() override;
 
  ImageReaderBase();
 

  SITK_RETURN_SELF_TYPE_HEADER
  SetOutputPixelType(PixelIDValueEnum pixelID);
  PixelIDValueEnum
  GetOutputPixelType() const;
  /* @} */
 
  virtual Image
  Execute() = 0;
 
  std::string
  ToString() const override;

  virtual std::vector<std::string>
  GetRegisteredImageIOs() const;

  virtual SITK_RETURN_SELF_TYPE_HEADER
  SetLoadPrivateTags(bool loadPrivateTags);
  virtual bool
  GetLoadPrivateTags() const;
  virtual void
  LoadPrivateTagsOn();
  virtual void
  LoadPrivateTagsOff();
  /* @} */
 

  virtual SITK_RETURN_SELF_TYPE_HEADER
  SetImageIO(const std::string & imageio);
  virtual std::string
  GetImageIO() const;
  /* @} */

  static std::string
  GetImageIOFromFileName(const PathType & fileName);
 
protected:
  itk::SmartPointer<ImageIOBase>
  GetImageIOBase(const PathType & fileName);
 
  void
  GetPixelIDFromImageIO(const PathType & fileName, PixelIDValueType & outPixelType, unsigned int & outDimensions);
  void
  GetPixelIDFromImageIO(const itk::ImageIOBase * iobase, PixelIDValueType & outPixelType, unsigned int & outDimensions);
 
  unsigned int
  GetDimensionFromImageIO(const PathType & filename, unsigned int i);
  unsigned int
  GetDimensionFromImageIO(const itk::ImageIOBase * iobase, unsigned int i);
 
 
private:
  PixelIDValueType
  ExecuteInternalReadScalar(int componentType);
 
  PixelIDValueType
  ExecuteInternalReadVector(int componentType);
 
  PixelIDValueType
  ExecuteInternalReadComplex(int componentType);
 
 
  PixelIDValueEnum m_OutputPixelType;
  bool             m_LoadPrivateTags;
 
  std::string m_ImageIOName;
};
} // namespace simple
} // namespace itk
 
 
#endif // sitkImageReaderBase_h