rtkExtractPhaseImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright RTK 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
 *
 *         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 rtkExtractPhaseImageFilter_h
#define rtkExtractPhaseImageFilter_h

#include <itkInPlaceImageFilter.h>

namespace rtk
{
template <class TImage>
class ITK_TEMPLATE_EXPORT ExtractPhaseImageFilter : public itk::InPlaceImageFilter<TImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ExtractPhaseImageFilter);

  using Self = ExtractPhaseImageFilter;
  using Superclass = itk::InPlaceImageFilter<TImage>;
  using Pointer = itk::SmartPointer<Self>;
  using ConstPointer = itk::SmartPointer<const Self>;

  using KernelSizeType = typename TImage::SizeType::SizeValueType;
  using PositionsListType = std::vector<int>;
  typedef enum
  {
    LOCAL_PHASE = 0,
    LINEAR_BETWEEN_MINIMA,
    LINEAR_BETWEEN_MAXIMA
  } ModelType;

  itkNewMacro(Self);

#ifdef itkOverrideGetNameOfClassMacro
  itkOverrideGetNameOfClassMacro(ExtractPhaseImageFilter);
#else
  itkTypeMacro(ExtractPhaseImageFilter, itk::InPlaceImageFilter);
#endif


  itkSetMacro(MovingAverageSize, KernelSizeType);
  itkGetMacro(MovingAverageSize, KernelSizeType);

  itkSetMacro(UnsharpMaskSize, KernelSizeType);
  itkGetMacro(UnsharpMaskSize, KernelSizeType);

  itkGetMacro(MinimaPositions, PositionsListType);
  itkGetMacro(MaximaPositions, PositionsListType);

  itkSetMacro(Model, ModelType);
  itkGetMacro(Model, ModelType);

protected:
  ExtractPhaseImageFilter();
  ~ExtractPhaseImageFilter() override = default;

  void
  GenerateData() override;

private:
  void
  ComputeLinearPhaseBetweenPositions(const PositionsListType & positions);

  KernelSizeType    m_MovingAverageSize;
  KernelSizeType    m_UnsharpMaskSize;
  PositionsListType m_MinimaPositions;
  PositionsListType m_MaximaPositions;
  ModelType         m_Model;
}; // end of class

} // end of namespace rtk

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

#endif