itkHessianToObjectnessMeasureImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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.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 itkHessianToObjectnessMeasureImageFilter_h
#define itkHessianToObjectnessMeasureImageFilter_h
 
#include "itkSymmetricSecondRankTensor.h"
#include "itkImageToImageFilter.h"
 
namespace itk
{
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT HessianToObjectnessMeasureImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(HessianToObjectnessMeasureImageFilter);

  using Self = HessianToObjectnessMeasureImageFilter;
  using Superclass = ImageToImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  using typename Superclass::InputImageType;
  using typename Superclass::OutputImageType;
  using InputPixelType = typename InputImageType::PixelType;
  using OutputPixelType = typename OutputImageType::PixelType;
  using OutputImageRegionType = typename OutputImageType::RegionType;

  static constexpr unsigned int ImageDimension = InputImageType::ImageDimension;
 
  using EigenValueType = double;
  using EigenValueArrayType = itk::FixedArray<EigenValueType, Self::ImageDimension>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(HessianToObjectnessMeasureImageFilter);

  itkSetMacro(Alpha, double);
  itkGetConstMacro(Alpha, double);

  itkSetMacro(Beta, double);
  itkGetConstMacro(Beta, double);

  itkSetMacro(Gamma, double);
  itkGetConstMacro(Gamma, double);

  itkSetMacro(ScaleObjectnessMeasure, bool);
  itkGetConstMacro(ScaleObjectnessMeasure, bool);
  itkBooleanMacro(ScaleObjectnessMeasure);

  itkSetMacro(ObjectDimension, unsigned int);
  itkGetConstMacro(ObjectDimension, unsigned int);

  itkSetMacro(BrightObject, bool);
  itkGetConstMacro(BrightObject, bool);
  itkBooleanMacro(BrightObject);
 
  itkConceptMacro(DoubleConvertibleToOutputCheck, (Concept::Convertible<double, OutputPixelType>));
 
protected:
  HessianToObjectnessMeasureImageFilter();
  ~HessianToObjectnessMeasureImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  VerifyPreconditions() const override;
 
  void
  DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;
 
 
private:
  // functor used to sort the eigenvalues are to be sorted
  // |e1|<=|e2|<=...<=|eN|
  //
  // Returns ( itk::Math::abs(a) < itk::Math::abs(b) )
  struct AbsLessCompare
  {
    bool
    operator()(EigenValueType a, EigenValueType b)
    {
      return itk::Math::abs(a) < itk::Math::abs(b);
    }
  };
 
  double       m_Alpha{ 0.5 };
  double       m_Beta{ 0.5 };
  double       m_Gamma{ 5.0 };
  unsigned int m_ObjectDimension{ 1 };
  bool         m_BrightObject{ true };
  bool         m_ScaleObjectnessMeasure{ true };
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkHessianToObjectnessMeasureImageFilter.hxx"
#endif
 
#endif