tubeEnhanceContrastUsingPrior.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 tubeEnhanceContrastUsingPrior_h
#define tubeEnhanceContrastUsingPrior_h

// ITK Includes
#include "itkProcessObject.h"

// TubeTK Includes
#include "tubeWrappingMacros.h"

#include "itktubeEnhanceContrastUsingPriorImageFilter.h"


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

template <class TPixel, unsigned int VDimension>
class EnhanceContrastUsingPrior : public itk::ProcessObject
{
public:
  /** Standard class type alias. */
  using Self = EnhanceContrastUsingPrior;
  using Superclass = itk::ProcessObject;
  using Pointer = itk::SmartPointer<Self>;
  using ConstPointer = itk::SmartPointer<const Self>;

  using FilterType = itk::tube::EnhanceContrastUsingPriorImageFilter<TPixel, VDimension>;

  using ImageType = typename FilterType::ImageType;
  using ConstImagePointer = typename ImageType::ConstPointer;
  using ImagePointer = typename ImageType::Pointer;

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

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

  /* Set input image */
  tubeWrapSetConstObjectMacro(Input, ImageType, Filter);

  /** Set/Get input Mask Image */
  tubeWrapSetObjectMacro(InputMaskImage, ImageType, Filter);
  tubeWrapGetObjectMacro(InputMaskImage, ImageType, Filter);

  /** Set/Get Object Scale */
  tubeWrapSetMacro(ObjectScale, float, Filter);
  tubeWrapGetMacro(ObjectScale, float, Filter);

  /** Set/Get Background Scale */
  tubeWrapSetMacro(BackgroundScale, float, Filter);
  tubeWrapGetMacro(BackgroundScale, float, Filter);

  /** Set/Get Mask Object Value */
  tubeWrapSetMacro(MaskObjectValue, int, Filter);
  tubeWrapGetMacro(MaskObjectValue, int, Filter);

  /** Set/Get Mask Background Value */
  tubeWrapSetMacro(MaskBackgroundValue, int, Filter);
  tubeWrapGetMacro(MaskBackgroundValue, int, Filter);

  /** Set/Get Optimization Iterations */
  tubeWrapSetMacro(OptimizationIterations, int, Filter);
  tubeWrapGetMacro(OptimizationIterations, int, Filter);

  /** Set/Get Optimization Seed */
  tubeWrapSetMacro(OptimizationSeed, int, Filter);
  tubeWrapGetMacro(OptimizationSeed, int, Filter);

  tubeWrapGetObjectMacro(Output, ImageType, Filter);

  /* Runs tubes to image conversion */
  tubeWrapUpdateMacro(Filter);

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

private:
  /** itkConvertSpatialGraphToImageFilter parameters **/
  EnhanceContrastUsingPrior(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 "tubeEnhanceContrastUsingPrior.hxx"
#endif

#endif // End !defined( __tubeEnhanceContrastUsingPrior_h )