itkFrequencyBandImageFilter.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 itkFrequencyBandImageFilter_h
#define itkFrequencyBandImageFilter_h

#include <itkUnaryFrequencyDomainFilter.h>

namespace itk
{
template< typename TImageType,
  typename TFrequencyIterator = FrequencyFFTLayoutImageRegionIteratorWithIndex<TImageType> >
class FrequencyBandImageFilter : public UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(FrequencyBandImageFilter);

  using Self = FrequencyBandImageFilter;
  using Superclass = UnaryFrequencyDomainFilter< TImageType, TFrequencyIterator >;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkTypeMacro(FrequencyBandImageFilter, UnaryFrequencyDomainFilter);

  using ImageType = TImageType;
  using ImagePointer = typename ImageType::Pointer;
  using ImageConstPointer = typename ImageType::ConstPointer;
  using IndexType = typename TImageType::IndexType;
  using PixelType = typename TImageType::PixelType;

  using ImageRegionType = typename TImageType::RegionType;

  static constexpr unsigned int ImageDimension = TImageType::ImageDimension;

  using FrequencyIteratorType = TFrequencyIterator;
  using FrequencyValueType = typename FrequencyIteratorType::FrequencyValueType;

/****** Frequency Threshold Getters/Setters *****/

  itkGetConstReferenceMacro(LowFrequencyThreshold, FrequencyValueType);
  itkSetMacro(LowFrequencyThreshold, FrequencyValueType);

  void SetLowFrequencyThresholdInRadians(const FrequencyValueType& freqLowInRadians);

  itkGetConstReferenceMacro(HighFrequencyThreshold, FrequencyValueType);
  itkSetMacro(HighFrequencyThreshold, FrequencyValueType);
  void SetHighFrequencyThresholdInRadians(const FrequencyValueType& freqHighInRadians);

  void SetFrequencyThresholds( const FrequencyValueType& freqLow,
                               const FrequencyValueType& freqHigh);

  void SetFrequencyThresholdsInRadians( const FrequencyValueType& freqLowInRadians,
                                        const FrequencyValueType& freqHighInRadians);

  itkSetMacro( PassLowFrequencyThreshold, bool );
  itkGetConstReferenceMacro(PassLowFrequencyThreshold, bool);
  itkBooleanMacro( PassLowFrequencyThreshold );

  itkSetMacro( PassHighFrequencyThreshold, bool );
  itkGetConstReferenceMacro(PassHighFrequencyThreshold, bool);
  itkBooleanMacro( PassHighFrequencyThreshold );

  itkSetMacro( PassBand, bool );
  itkGetConstReferenceMacro(PassBand, bool);
  itkBooleanMacro( PassBand );

  void SetPassBand(const bool pass_low_threshold, const bool pass_high_threshold);

  void SetStopBand(const bool pass_low_threshold, const bool pass_high_threshold);

  itkSetMacro( RadialBand, bool );
  itkGetConstReferenceMacro(RadialBand, bool);
  itkBooleanMacro( RadialBand );

  itkSetMacro( PassNegativeLowFrequencyThreshold, bool );
  itkGetConstReferenceMacro(PassNegativeLowFrequencyThreshold, bool);
  itkBooleanMacro( PassNegativeLowFrequencyThreshold );

  itkSetMacro( PassNegativeHighFrequencyThreshold, bool );
  itkGetConstReferenceMacro(PassNegativeHighFrequencyThreshold, bool);
  itkBooleanMacro( PassNegativeHighFrequencyThreshold );


protected:
  FrequencyBandImageFilter();
  void PrintSelf(std::ostream & os, Indent indent) const override;

  /* Checks the logic of FrequencyThresholds. */
  void VerifyPreconditions() ITKv5_CONST override;

  /* This is the box functor, which implements the filter's behavior. */
  void BandPass( FrequencyIteratorType& frequency );

private:
  std::function< void( const ImageRegionType& ) > m_DynamicThreadedGenerateDataFunction;

  FrequencyValueType m_LowFrequencyThreshold;
  FrequencyValueType m_HighFrequencyThreshold;

  bool m_PassBand{true};
  bool m_PassLowFrequencyThreshold{true};
  bool m_PassHighFrequencyThreshold{true};
  bool m_RadialBand{true};
  bool m_PassNegativeLowFrequencyThreshold{true};
  bool m_PassNegativeHighFrequencyThreshold{true};
};
} // end namespace itk

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

#endif