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 ImportImageFilter:
  public ImageSource< Image< TPixel, VImageDimension > >
{
public:
  typedef Image< TPixel, VImageDimension >      OutputImageType;
  typedef typename OutputImageType::Pointer     OutputImagePointer;
  typedef typename OutputImageType::SpacingType SpacingType;
  typedef typename OutputImageType::PointType   OriginType;

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

  itkNewMacro(Self);

  itkTypeMacro(ImportImageFilter, ImageSource);

  typedef Index< VImageDimension > IndexType;

  typedef Size< VImageDimension > SizeType;

  typedef ImageRegion< VImageDimension > RegionType;

  typedef TPixel OutputImagePixelType;

  TPixel * GetImportPointer();

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

  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);

  typedef Matrix< SpacePrecisionType, VImageDimension, VImageDimension > DirectionType;

  virtual void SetDirection(const DirectionType & direction);

  itkGetConstReferenceMacro(Direction, DirectionType);

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

  virtual void GenerateData() ITK_OVERRIDE;

  virtual void GenerateOutputInformation() ITK_OVERRIDE;

  virtual void EnlargeOutputRequestedRegion(DataObject *output) ITK_OVERRIDE;

private:
  ImportImageFilter(const ImportImageFilter &); //purposely not implemented
  void operator=(const ImportImageFilter &);    //purposely not implemented

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

  TPixel *      m_ImportPointer;
  bool          m_FilterManageMemory;
  SizeValueType m_Size;
};
} // end namespace itk

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

#endif