tubeEnhanceEdgesUsingDiffusion.h

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

Library:   TubeTK

Copyright 2010 Kitware Inc. 28 Corporate Drive,
Clifton Park, NY, 12065, USA.

All rights reserved.

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

    https://www.apache.org/licenses/LICENSE-2.0

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 tubeEnhanceEdgesUsingDiffusion_h
#define tubeEnhanceEdgesUsingDiffusion_h

// ITK includes
#include <itkProcessObject.h>

// TubeTK includes
#include "tubeWrappingMacros.h"

#include "itktubeAnisotropicEdgeEnhancementDiffusionImageFilter.h"

namespace tube
{
/** \class EnhanceEdgesUsingDiffusion
 *
 *  \ingroup TubeTK
 */

template <class TInputImage, class TOutputImage>
class EnhanceEdgesUsingDiffusion : public itk::ProcessObject
{
public:
  /** Standard class type alias. */
  using Self = EnhanceEdgesUsingDiffusion;
  using Superclass = itk::ProcessObject;
  using Pointer = itk::SmartPointer<Self>;
  using ConstPointer = itk::SmartPointer<const Self>;

  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;

  using FilterType = itk::tube::AnisotropicEdgeEnhancementDiffusionImageFilter<InputImageType, OutputImageType>;

  /** Method for creation through the object factory. */
  itkNewMacro(Self);

  /** Run-time type information ( and related methods ). */
  itkOverrideGetNameOfClassMacro(EnhanceEdgesUsingDiffusion);

  /** Set/Get input image */
  tubeWrapSetConstObjectMacro(Input, InputImageType, Filter);
  tubeWrapGetConstObjectMacro(Input, InputImageType, Filter);

  /** Set/Get sigma value */
  tubeWrapSetMacro(Sigma, double, Filter);
  tubeWrapGetMacro(Sigma, double, Filter);

  /** Set/Get ContrastParameterLambdaE value */
  tubeWrapSetMacro(ContrastParameterLambdaE, double, Filter);
  tubeWrapGetMacro(ContrastParameterLambdaE, double, Filter);

  /** Set/Get TimeStep value */
  tubeWrapSetMacro(TimeStep, double, Filter);
  tubeWrapGetMacro(TimeStep, double, Filter);

  /** Set/Get NumberOfIterations value */
  tubeWrapSetMacro(NumberOfIterations, unsigned long, Filter);
  tubeWrapGetMacro(NumberOfIterations, unsigned long, Filter);

  /** Get SigmaOuter value */
  tubeWrapGetMacro(SigmaOuter, double, Filter);

  /** Get ThresholdParameterC value */
  tubeWrapGetMacro(ThresholdParameterC, double, Filter);

  /** Runs the enhancement algorithm */
  tubeWrapUpdateMacro(Filter);

  /** Get output segmentation mask */
  tubeWrapGetObjectMacro(Output, OutputImageType, Filter);

protected:
  EnhanceEdgesUsingDiffusion(void);
  ~EnhanceEdgesUsingDiffusion() {}
  void
  PrintSelf(std::ostream & os, itk::Indent indent) const override;

private:
  /** itktubeAnisotropicEdgeEnhancementDiffusionImageFilter parameters **/
  EnhanceEdgesUsingDiffusion(const Self &);
  void
  operator=(const Self &);

  // To remove warning "was hidden [-Woverloaded-virtual]"
  void
  SetInput(const DataObjectIdentifierType &, itk::DataObject *) override {};

  typename FilterType::Pointer m_Filter;
};

} // End namespace tube


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

#endif // End !defined( __tubeEnhanceEdgesUsingDiffusion_h )