itkNeighborhoodOperator.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 itkNeighborhoodOperator_h
#define itkNeighborhoodOperator_h

#include "itkNeighborhood.h"
#include "itkNumericTraits.h"
#include <vector>

namespace itk
{
template< typename TPixel, unsigned int VDimension,
          typename TAllocator = NeighborhoodAllocator< TPixel > >
class ITK_TEMPLATE_EXPORT NeighborhoodOperator:
  public Neighborhood< TPixel, VDimension, TAllocator >
{
public:
  typedef NeighborhoodOperator                           Self;
  typedef Neighborhood< TPixel, VDimension, TAllocator > Superclass;

  itkTypeMacro(NeighborhoodOperator, NeighborhoodOperator);

  typedef typename Superclass::SizeType      SizeType;

  typedef TPixel PixelType;

  typedef SliceIterator< TPixel, Self > SliceIteratorType;

  NeighborhoodOperator()
  {  m_Direction = 0;  }

  NeighborhoodOperator(const Self & orig):
    Neighborhood< TPixel, VDimension, TAllocator >(orig)
  {   m_Direction = orig.m_Direction;   }

  Self & operator=(const Self & orig)
  {
    Superclass::operator=(orig);
    m_Direction = orig.m_Direction;
    return *this;
  }

  void SetDirection(const unsigned long & direction)
  {  m_Direction = direction;   }

  unsigned long GetDirection() const
  {  return m_Direction;  }

  virtual void CreateDirectional();

  virtual void CreateToRadius(const SizeType &);

  virtual void CreateToRadius(const SizeValueType);

  virtual void FlipAxes();

  virtual void PrintSelf(std::ostream & os, Indent i) const ITK_OVERRIDE
  {
    os << i << "NeighborhoodOperator { this=" << this
       << " Direction = " << m_Direction << " }" << std::endl;
    Superclass::PrintSelf( os, i.GetNextIndent() );
  }

  typedef typename NumericTraits< TPixel >::RealType PixelRealType;

  void ScaleCoefficients(PixelRealType);

protected:
  typedef std::vector< PixelRealType > CoefficientVector;

  virtual CoefficientVector GenerateCoefficients() = 0;

  virtual void Fill(const CoefficientVector &) = 0;

  virtual void FillCenteredDirectional(const CoefficientVector &);

  void InitializeToZero()
  {
    for ( unsigned int i = 0; i < this->Size(); ++i )
      {
      this->operator[](i) = NumericTraits< PixelType >::ZeroValue();
      }
  }

private:
  unsigned long m_Direction;
};
} // namespace itk

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

/*
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkNeighborhoodOperator.hxx"
#endif
*/
#endif