itkImportImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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 itkImportImageFilter_h
#define itkImportImageFilter_h

#include "itkImageSource.h"

namespace itk
{
template< typename TPixel, unsigned int VImageDimension = 2 >
class ITK_TEMPLATE_EXPORT ImportImageFilter:
  public ImageSource< Image< TPixel, VImageDimension > >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(ImportImageFilter);

  using OutputImageType = Image< TPixel, VImageDimension >;
  using OutputImagePointer = typename OutputImageType::Pointer;
  using SpacingType = typename OutputImageType::SpacingType;
  using OriginType = typename OutputImageType::PointType;
  using ImportImageContainerType = ImportImageContainer< SizeValueType, TPixel >;

  using Self = ImportImageFilter;
  using Superclass = ImageSource< OutputImageType >;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkNewMacro(Self);

  itkTypeMacro(ImportImageFilter, ImageSource);

  using IndexType = Index< VImageDimension >;

  using SizeType = Size< VImageDimension >;

  using RegionType = ImageRegion< VImageDimension >;

  using OutputImagePixelType = TPixel;

  TPixel * GetImportPointer();

  void SetImportPointer(TPixel *ptr, SizeValueType num,
      bool LetImageContainerManageMemory);

  void SetRegion(const RegionType & region)
  { if ( m_Region != region ) { m_Region = region; this->Modified(); } }

  const RegionType & GetRegion() const
  { return m_Region; }

  itkSetMacro(Spacing, SpacingType);
  itkGetConstReferenceMacro(Spacing, SpacingType);
  itkSetVectorMacro(Spacing, const float, VImageDimension);

  itkSetMacro(Origin, OriginType);
  itkGetConstReferenceMacro(Origin, OriginType);
  itkSetVectorMacro(Origin, const float, VImageDimension);

  using DirectionType = Matrix< SpacePrecisionType, VImageDimension, VImageDimension >;

  virtual void SetDirection(const DirectionType & direction);

  itkGetConstReferenceMacro(Direction, DirectionType);

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

  void GenerateData() override;

  void GenerateOutputInformation() override;

  void EnlargeOutputRequestedRegion(DataObject *output) override;

private:
  RegionType    m_Region;
  SpacingType   m_Spacing;
  OriginType    m_Origin;
  DirectionType m_Direction;

  typename ImportImageContainerType::Pointer  m_ImportImageContainer;
  SizeValueType                               m_Size;
};
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkImportImageFilter.hxx"
#endif

#endif