sitkImportImageFilter.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 sitkImportImageFilter_h
#define sitkImportImageFilter_h
 
#include "sitkMacro.h"
#include "sitkImage.h"
#include "sitkImageReaderBase.h"
#include "sitkMemberFunctionFactory.h"
 
namespace itk::simple
{

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

  std::string
  ToString() const override;

  std::string
  GetName() const override
  {
    return std::string("ImportImageFilter");
  }
 
  void
  SetSize(const std::vector<unsigned int> & size);
  const std::vector<unsigned int> &
  GetSize() const;
 
  void
  SetSpacing(const std::vector<double> & spacing);
  const std::vector<double> &
  GetSpacing() const;
 
  void
  SetOrigin(const std::vector<double> & origin);
  const std::vector<double> &
  GetOrigin() const;
 
  void
  SetDirection(const std::vector<double> & direction);
  const std::vector<double> &
  GetDirection() const;
 
  void
  SetBufferAsInt8(int8_t * buffer, unsigned int numberOfComponents = 1);
  void
  SetBufferAsUInt8(uint8_t * buffer, unsigned int numberOfComponents = 1);
  void
  SetBufferAsInt16(int16_t * buffer, unsigned int numberOfComponents = 1);
  void
  SetBufferAsUInt16(uint16_t * buffer, unsigned int numberOfComponents = 1);
  void
  SetBufferAsInt32(int32_t * buffer, unsigned int numberOfComponents = 1);
  void
  SetBufferAsUInt32(uint32_t * buffer, unsigned int numberOfComponents = 1);
  void
  SetBufferAsInt64(int64_t * buffer, unsigned int numberOfComponents = 1);
  void
  SetBufferAsUInt64(uint64_t * buffer, unsigned int numberOfComponents = 1);
  void
  SetBufferAsFloat(float * buffer, unsigned int numberOfComponents = 1);
  void
  SetBufferAsDouble(double * buffer, unsigned int numberOfComponents = 1);
 
  Image
  Execute() override;
 
protected:
  // Internal method called by the template dispatch system
  template <class TImageType>
  Image
  ExecuteInternal();
 
private:
  // function pointer type
  typedef Image (Self::*MemberFunctionType)();
 
  // friend to get access to executeInternal member
  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
  static const detail::MemberFunctionFactory<MemberFunctionType> &
  GetMemberFunctionFactory();
 
  unsigned int     m_NumberOfComponentsPerPixel{ 0 };
  PixelIDValueType m_PixelIDValue{ sitkUnknown };
 
  std::vector<double>       m_Origin{ std::vector<double>(3, 0.0) };
  std::vector<double>       m_Spacing{ std::vector<double>(3, 1.0) };
  std::vector<unsigned int> m_Size;
  std::vector<double>       m_Direction;
 
  void * m_Buffer{ nullptr };
};
 
Image SITKIO_EXPORT
ImportAsInt8(int8_t *                          buffer,
             const std::vector<unsigned int> & size,
             const std::vector<double> &       spacing = std::vector<double>(3, 1.0),
             const std::vector<double> &       origin = std::vector<double>(3, 0.0),
             const std::vector<double> &       direction = std::vector<double>(),
             unsigned int                      numberOfComponents = 1);
 
Image SITKIO_EXPORT
ImportAsUInt8(uint8_t *                         buffer,
              const std::vector<unsigned int> & size,
              const std::vector<double> &       spacing = std::vector<double>(3, 1.0),
              const std::vector<double> &       origin = std::vector<double>(3, 0.0),
              const std::vector<double> &       direction = std::vector<double>(),
              unsigned int                      numberOfComponents = 1);
 
Image SITKIO_EXPORT
ImportAsInt16(int16_t *                         buffer,
              const std::vector<unsigned int> & size,
              const std::vector<double> &       spacing = std::vector<double>(3, 1.0),
              const std::vector<double> &       origin = std::vector<double>(3, 0.0),
              const std::vector<double> &       direction = std::vector<double>(),
              unsigned int                      numberOfComponents = 1);
 
Image SITKIO_EXPORT
ImportAsUInt16(uint16_t *                        buffer,
               const std::vector<unsigned int> & size,
               const std::vector<double> &       spacing = std::vector<double>(3, 1.0),
               const std::vector<double> &       origin = std::vector<double>(3, 0.0),
               const std::vector<double> &       direction = std::vector<double>(),
               unsigned int                      numberOfComponents = 1);
 
Image SITKIO_EXPORT
ImportAsInt32(int32_t *                         buffer,
              const std::vector<unsigned int> & size,
              const std::vector<double> &       spacing = std::vector<double>(3, 1.0),
              const std::vector<double> &       origin = std::vector<double>(3, 0.0),
              const std::vector<double> &       direction = std::vector<double>(),
              unsigned int                      numberOfComponents = 1);
 
Image SITKIO_EXPORT
ImportAsUInt32(uint32_t *                        buffer,
               const std::vector<unsigned int> & size,
               const std::vector<double> &       spacing = std::vector<double>(3, 1.0),
               const std::vector<double> &       origin = std::vector<double>(3, 0.0),
               const std::vector<double> &       direction = std::vector<double>(),
               unsigned int                      numberOfComponents = 1);
 
Image SITKIO_EXPORT
ImportAsInt64(int64_t *                         buffer,
              const std::vector<unsigned int> & size,
              const std::vector<double> &       spacing = std::vector<double>(3, 1.0),
              const std::vector<double> &       origin = std::vector<double>(3, 0.0),
              const std::vector<double> &       direction = std::vector<double>(),
              unsigned int                      numberOfComponents = 1);
 
Image SITKIO_EXPORT
ImportAsUInt64(uint64_t *                        buffer,
               const std::vector<unsigned int> & size,
               const std::vector<double> &       spacing = std::vector<double>(3, 1.0),
               const std::vector<double> &       origin = std::vector<double>(3, 0.0),
               const std::vector<double> &       direction = std::vector<double>(),
               unsigned int                      numberOfComponents = 1);
 
Image SITKIO_EXPORT
ImportAsFloat(float *                           buffer,
              const std::vector<unsigned int> & size,
              const std::vector<double> &       spacing = std::vector<double>(3, 1.0),
              const std::vector<double> &       origin = std::vector<double>(3, 0.0),
              const std::vector<double> &       direction = std::vector<double>(),
              unsigned int                      numberOfComponents = 1);
 
Image SITKIO_EXPORT
ImportAsDouble(double *                          buffer,
               const std::vector<unsigned int> & size,
               const std::vector<double> &       spacing = std::vector<double>(3, 1.0),
               const std::vector<double> &       origin = std::vector<double>(3, 0.0),
               const std::vector<double> &       direction = std::vector<double>(),
               unsigned int                      numberOfComponents = 1);
 
} // namespace itk::simple
 
#endif