itkSpatialObjectToImageFilter.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkSpatialObjectToImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2008-10-18 16:11:13 $
  Version:   $Revision: 1.12 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkSpatialObjectToImageFilter_h
#define __itkSpatialObjectToImageFilter_h

#include "itkImageSource.h"
#include "itkConceptChecking.h"

namespace itk
{
  
template <class TInputSpatialObject, class TOutputImage>
class ITK_EXPORT SpatialObjectToImageFilter : public ImageSource<TOutputImage>
{
public:
  typedef SpatialObjectToImageFilter                     Self;
  typedef ImageSource<TOutputImage>                      Superclass;
  typedef SmartPointer<Self>                             Pointer;
  typedef SmartPointer<const Self>                       ConstPointer;

  typedef TOutputImage                                   OutputImageType;
  typedef typename OutputImageType::SizeType             SizeType;
  typedef typename OutputImageType::PointType            PointType;
  typedef typename OutputImageType::Pointer              OutputImagePointer;
  typedef typename OutputImageType::ValueType            ValueType;
  typedef typename OutputImageType::SpacingType          SpacingType;
  typedef typename OutputImageType::DirectionType        DirectionType;
  
  itkNewMacro(Self);

  itkTypeMacro(SpatialObjectToImageFilter, ImageSource);

  typedef typename Superclass::OutputImageRegionType      OutputImageRegionType;

  typedef TInputSpatialObject                             InputSpatialObjectType;
  typedef typename InputSpatialObjectType::Pointer        InputSpatialObjectPointer;
  typedef typename InputSpatialObjectType::ConstPointer   InputSpatialObjectConstPointer;
  typedef typename TInputSpatialObject::ChildrenListType  ChildrenListType;

  itkStaticConstMacro(ObjectDimension, unsigned int,
                      InputSpatialObjectType::ObjectDimension);

  itkStaticConstMacro(OutputImageDimension, unsigned int,
                      TOutputImage::ImageDimension);

  virtual void SetInput( const InputSpatialObjectType *object);
  virtual void SetInput( unsigned int, const InputSpatialObjectType * object);
  const InputSpatialObjectType * GetInput( void );
  const InputSpatialObjectType * GetInput( unsigned int idx );

  virtual void SetSpacing( const SpacingType& spacing);
  virtual void SetSpacing( const double* spacing);
  virtual void SetSpacing( const float* spacing);
  virtual const double * GetSpacing( void ) const;

  virtual void SetDirection( const DirectionType & direction );
  virtual const DirectionType & GetDirection( void ) const;

  itkSetMacro( InsideValue, ValueType );
  itkGetMacro( InsideValue, ValueType );

  itkSetMacro( OutsideValue, ValueType );
  itkGetMacro( OutsideValue, ValueType );

  virtual void SetOrigin( const PointType& origin );
  virtual void SetOrigin( const double* origin );
  virtual void SetOrigin( const float* origin );
  virtual const double * GetOrigin( void ) const;

  itkSetMacro( ChildrenDepth, unsigned int );
  itkGetMacro( ChildrenDepth, unsigned int );

  itkSetMacro( Size, SizeType );
  itkGetMacro( Size, SizeType );

  itkSetMacro( UseObjectValue, bool );
  itkGetMacro( UseObjectValue, bool );

protected:
  SpatialObjectToImageFilter();
  ~SpatialObjectToImageFilter();

  virtual void GenerateOutputInformation(){}; // do nothing
  virtual void GenerateData();

  SizeType      m_Size;
  double        m_Spacing[OutputImageDimension];
  double        m_Origin[OutputImageDimension];
  DirectionType m_Direction;

  unsigned int  m_ChildrenDepth;
  ValueType     m_InsideValue;
  ValueType     m_OutsideValue;
  bool          m_UseObjectValue;

  virtual void PrintSelf(std::ostream& os, Indent indent) const;

private:

  SpatialObjectToImageFilter(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

};

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkSpatialObjectToImageFilter.txx"
#endif

#endif