itkVectorExpandImageFilter.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 __itkVectorExpandImageFilter_h
#define __itkVectorExpandImageFilter_h

#include "itkImageToImageFilter.h"
#include "itkVectorLinearInterpolateImageFunction.h"

namespace itk
{
template< class TInputImage, class TOutputImage >
class ITK_EXPORT VectorExpandImageFilter:
  public ImageToImageFilter< TInputImage, TOutputImage >
{
public:
  typedef VectorExpandImageFilter                         Self;
  typedef ImageToImageFilter< TInputImage, TOutputImage > Superclass;
  typedef SmartPointer< Self >                            Pointer;
  typedef SmartPointer< const Self >                      ConstPointer;

  itkNewMacro(Self);

  typedef typename TInputImage::Pointer     InputImagePointer;
  typedef typename TOutputImage::Pointer    OutputImagePointer;
  typedef typename TOutputImage::RegionType OutputImageRegionType;

  itkTypeMacro(VectorExpandImageFilter, ImageToImageFilter);

  itkStaticConstMacro(ImageDimension, unsigned int,
                      TInputImage::ImageDimension);

  typedef typename Superclass::InputImageType  InputImageType;
  typedef typename Superclass::OutputImageType OutputImageType;

  typedef typename OutputImageType::PixelType OutputPixelType;
  typedef typename OutputPixelType::ValueType OutputValueType;
  typedef typename InputImageType::PixelType  InputPixelType;
  typedef typename InputPixelType::ValueType  InputValueType;

  enum { VectorDimension = InputPixelType::Dimension };

  typedef float                                           ExpandFactorsType;
  typedef FixedArray< ExpandFactorsType, ImageDimension > ExpandFactorsArrayType;

  typedef double                                                               CoordRepType;
  typedef VectorInterpolateImageFunction< InputImageType, CoordRepType >       InterpolatorType;
  typedef typename InterpolatorType::Pointer                                   InterpolatorPointer;
  typedef VectorLinearInterpolateImageFunction< InputImageType, CoordRepType > DefaultInterpolatorType;

  itkSetObjectMacro(Interpolator, InterpolatorType);

  itkGetObjectMacro(Interpolator, InterpolatorType);

  itkSetMacro(ExpandFactors, ExpandFactorsArrayType);
  virtual void SetExpandFactors(const float factor);
  itkSetVectorMacro(ExpandFactors, const unsigned int, ImageDimension);

  itkGetConstReferenceMacro(ExpandFactors, ExpandFactorsArrayType);

//TEST_RMV20100728  virtual void SetEdgePaddingValue( const OutputPixelType&
// value );
//TEST_RMV20100728

//TEST_RMV20100728  virtual const OutputPixelType& GetEdgePaddingValue()
//TEST_RMV20100728    { return m_EdgePaddingValue; }

  virtual void GenerateOutputInformation();

  virtual void GenerateInputRequestedRegion();

#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro( InputHasNumericTraitsCheck,
                   ( Concept::HasNumericTraits< InputValueType > ) );
  itkConceptMacro( OutputHasNumericTraitsCheck,
                   ( Concept::HasNumericTraits< OutputValueType > ) );

#endif
protected:

  VectorExpandImageFilter();
  ~VectorExpandImageFilter() {}
  void PrintSelf(std::ostream & os, Indent indent) const;

  virtual
  void ThreadedGenerateData(const OutputImageRegionType & outputRegionForThread,
                            ThreadIdType threadId);

  virtual void BeforeThreadedGenerateData();

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

  ExpandFactorsArrayType   m_ExpandFactors;
  InterpolatorPointer      m_Interpolator;
//TEST_RMV20100728 * \warning: The following is valid only when the flag
//TEST_RMV20100728 * ITK_USE_CENTERED_PIXEL_COORDINATES_CONSISTENTLY is ON
//TEST_RMV20100728 * The output image will not contain any padding, and
// therefore the
//TEST_RMV20100728 * EdgePaddingValue will not be used.
//TEST_RMV20100728 *
//TEST_RMV20100728  OutputPixelType        m_EdgePaddingValue;
};
} // end namespace itk

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

#endif