itkNeighborhoodOperatorImageFilter.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 __itkNeighborhoodOperatorImageFilter_h
#define __itkNeighborhoodOperatorImageFilter_h

#include "itkImageToImageFilter.h"
#include "itkNeighborhoodOperator.h"
#include "itkImage.h"
#include "itkZeroFluxNeumannBoundaryCondition.h"

namespace itk
{
template< class TInputImage, class TOutputImage, class TOperatorValueType = typename TOutputImage::PixelType >
class ITK_EXPORT NeighborhoodOperatorImageFilter:
  public ImageToImageFilter< TInputImage, TOutputImage >
{
public:
  typedef NeighborhoodOperatorImageFilter                 Self;
  typedef ImageToImageFilter< TInputImage, TOutputImage > Superclass;
  typedef       SmartPointer< Self >                      Pointer;
  typedef SmartPointer< const Self >                      ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(NeighborhoodOperatorImageFilter, ImageToImageFilter);

  typedef typename TOutputImage::PixelType         OutputPixelType;
  typedef typename TOutputImage::InternalPixelType OutputInternalPixelType;
  typedef typename  TInputImage::PixelType         InputPixelType;
  typedef typename  TInputImage::InternalPixelType InputInternalPixelType;
  typedef TOperatorValueType                       OperatorValueType;

  typedef typename NumericTraits<InputPixelType>::ValueType InputPixelValueType;
  typedef typename NumericTraits<OutputPixelType>::RealType ComputingPixelType;

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

  typedef TInputImage                      InputImageType;
  typedef TOutputImage                     OutputImageType;
  typedef typename InputImageType::Pointer InputImagePointer;

  typedef ImageBoundaryCondition< InputImageType > *
  ImageBoundaryConditionPointerType;

  typedef ZeroFluxNeumannBoundaryCondition< InputImageType > DefaultBoundaryCondition;

  typedef typename Superclass::OutputImageRegionType OutputImageRegionType;

  typedef Neighborhood< OperatorValueType,
                        itkGetStaticConstMacro(ImageDimension) > OutputNeighborhoodType;

  void SetOperator(const OutputNeighborhoodType & p)
  {
    m_Operator = p;
    this->Modified();
  }

  const OutputNeighborhoodType & GetOperator() const
  { return m_Operator; }

  void OverrideBoundaryCondition(const ImageBoundaryConditionPointerType i)
  { m_BoundsCondition = i; }

  ImageBoundaryConditionPointerType GetBoundaryCondition()
  { return m_BoundsCondition; }

  virtual void GenerateInputRequestedRegion()
  throw ( InvalidRequestedRegionError );

#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro( SameDimensionCheck,
                   ( Concept::SameDimension< InputImageDimension, ImageDimension > ) );
  itkConceptMacro( OperatorConvertibleToOutputCheck,
                   ( Concept::Convertible< OperatorValueType, OutputPixelType > ) );
  itkConceptMacro( InputConvertibleToOperatorCheck,
                   ( Concept::Convertible< InputPixelValueType, OperatorValueType > ) );
  itkConceptMacro( OperatorMultiplyOperatorCheck,
                   ( Concept::MultiplyOperator< OperatorValueType > ) );
  itkConceptMacro( OperatorAdditiveOperatorsCheck,
                   ( Concept::AdditiveOperators< OperatorValueType > ) );

#endif

protected:
  NeighborhoodOperatorImageFilter()
  { m_BoundsCondition = static_cast< ImageBoundaryConditionPointerType >( &m_DefaultBoundaryCondition ); }
  virtual ~NeighborhoodOperatorImageFilter() {}

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

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

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

  OutputNeighborhoodType m_Operator;

  ImageBoundaryConditionPointerType m_BoundsCondition;

  DefaultBoundaryCondition m_DefaultBoundaryCondition;
};
} // end namespace itk

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

#endif