itkSobelOperator.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 __itkSobelOperator_h
#define __itkSobelOperator_h

#include "itkNeighborhoodOperator.h"

namespace itk
{
template< class TPixel, unsigned int VDimension = 2,
          class TAllocator = NeighborhoodAllocator< TPixel > >
class ITK_EXPORT SobelOperator:
  public NeighborhoodOperator< TPixel, VDimension, TAllocator >
{
public:

  typedef SobelOperator                                          Self;
  typedef NeighborhoodOperator< TPixel, VDimension, TAllocator > Superclass;

  itkTypeMacro(SobelOperator, NeighborhoodOperator);

  SobelOperator() {}
  SobelOperator(const Self & other):
    NeighborhoodOperator< TPixel, VDimension, TAllocator >(other)
  {}

  virtual void CreateDirectional()
  {
    this->CreateToRadius(1);
  }

  // virtual void CreateToRadius(const unsigned long);

  Self & operator=(const Self & other)
  {
    Superclass::operator=(other);
    return *this;
  }

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

protected:
  typedef typename Superclass::CoefficientVector CoefficientVector;
  typedef typename Superclass::PixelType         PixelType;

  CoefficientVector GenerateCoefficients();

  void Fill(const CoefficientVector & c);
};
} // namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_SobelOperator(_, EXPORT, TypeX, TypeY)     \
  namespace itk                                                 \
  {                                                             \
  _( 2 ( class EXPORT SobelOperator< ITK_TEMPLATE_2 TypeX > ) ) \
  namespace Templates                                           \
  {                                                             \
  typedef SobelOperator< ITK_TEMPLATE_2 TypeX >                 \
  SobelOperator##TypeY;                                       \
  }                                                             \
  }

#if ITK_TEMPLATE_EXPLICIT
#include "Templates/itkSobelOperator+-.h"
#endif

#if ITK_TEMPLATE_TXX
#include "itkSobelOperator.hxx"
#endif

#endif