itkHistogramToTextureFeaturesFilter.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 itkHistogramToTextureFeaturesFilter_h
#define itkHistogramToTextureFeaturesFilter_h
 
#include "itkHistogram.h"
#include "itkMacro.h"
#include "itkProcessObject.h"
#include "itkSimpleDataObjectDecorator.h"
 
namespace itk
{
namespace Statistics
{
class HistogramToTextureFeaturesFilterEnums
{
public:
  enum class TextureFeature : uint8_t
  {
    Energy,
    Entropy,
    Correlation,
    InverseDifferenceMoment,
    Inertia,
    ClusterShade,
    ClusterProminence,
    HaralickCorrelation,
    InvalidFeatureName
  };
};
// Define how to print enumeration
extern ITKStatistics_EXPORT std::ostream &
operator<<(std::ostream & out, const HistogramToTextureFeaturesFilterEnums::TextureFeature value);

 
template <typename THistogram>
class ITK_TEMPLATE_EXPORT HistogramToTextureFeaturesFilter : public ProcessObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(HistogramToTextureFeaturesFilter);

  using Self = HistogramToTextureFeaturesFilter;
  using Superclass = ProcessObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(HistogramToTextureFeaturesFilter);

  itkNewMacro(Self);
 
  using HistogramType = THistogram;
  using HistogramPointer = typename HistogramType::Pointer;
  using HistogramConstPointer = typename HistogramType::ConstPointer;
  using MeasurementType = typename HistogramType::MeasurementType;
  using MeasurementVectorType = typename HistogramType::MeasurementVectorType;
  using IndexType = typename HistogramType::IndexType;
  using AbsoluteFrequencyType = typename HistogramType::AbsoluteFrequencyType;
  using RelativeFrequencyType = typename HistogramType::RelativeFrequencyType;
 
  using TotalAbsoluteFrequencyType = typename HistogramType::TotalAbsoluteFrequencyType;
 
  using TotalRelativeFrequencyType = typename HistogramType::TotalRelativeFrequencyType;

  using RelativeFrequencyContainerType = std::vector<RelativeFrequencyType>;

  using Superclass::SetInput;
  void
  SetInput(const HistogramType * histogram);
 
  const HistogramType *
  GetInput() const;

  using DataObjectPointer = DataObject::Pointer;

  using MeasurementObjectType = SimpleDataObjectDecorator<MeasurementType>;

  MeasurementType
  GetEnergy() const;
 
  const MeasurementObjectType *
  GetEnergyOutput() const;

  MeasurementType
  GetEntropy() const;
 
  const MeasurementObjectType *
  GetEntropyOutput() const;

  MeasurementType
  GetCorrelation() const;
 
  const MeasurementObjectType *
  GetCorrelationOutput() const;

  MeasurementType
  GetInverseDifferenceMoment() const;
 
  const MeasurementObjectType *
  GetInverseDifferenceMomentOutput() const;

  MeasurementType
  GetInertia() const;
 
  const MeasurementObjectType *
  GetInertiaOutput() const;

  MeasurementType
  GetClusterShade() const;
 
  const MeasurementObjectType *
  GetClusterShadeOutput() const;

  MeasurementType
  GetClusterProminence() const;
 
  const MeasurementObjectType *
  GetClusterProminenceOutput() const;

  MeasurementType
  GetHaralickCorrelation() const;
 
  const MeasurementObjectType *
  GetHaralickCorrelationOutput() const;
 
  using TextureFeatureEnum = HistogramToTextureFeaturesFilterEnums::TextureFeature;
#if !defined(ITK_LEGACY_REMOVE)
  static constexpr TextureFeatureEnum Energy = TextureFeatureEnum::Energy;
  static constexpr TextureFeatureEnum Entropy = TextureFeatureEnum::Entropy;
  static constexpr TextureFeatureEnum Correlation = TextureFeatureEnum::Correlation;
  static constexpr TextureFeatureEnum InverseDifferenceMoment = TextureFeatureEnum::InverseDifferenceMoment;
  static constexpr TextureFeatureEnum Inertia = TextureFeatureEnum::Inertia;
  static constexpr TextureFeatureEnum ClusterShade = TextureFeatureEnum::ClusterShade;
  static constexpr TextureFeatureEnum ClusterProminence = TextureFeatureEnum::ClusterProminence;
  static constexpr TextureFeatureEnum HaralickCorrelation = TextureFeatureEnum::HaralickCorrelation;
  static constexpr TextureFeatureEnum InvalidFeatureName = TextureFeatureEnum::InvalidFeatureName;
#endif

  MeasurementType
  GetFeature(TextureFeatureEnum feature);
 
protected:
  HistogramToTextureFeaturesFilter();
  ~HistogramToTextureFeaturesFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType;
  using Superclass::MakeOutput;
  DataObjectPointer MakeOutput(DataObjectPointerArraySizeType) override;
 
  void
  GenerateData() override;
 
private:
  void
  ComputeMeansAndVariances(double & pixelMean,
                           double & marginalMean,
                           double & marginalDevSquared,
                           double & pixelVariance);
 
  RelativeFrequencyContainerType m_RelativeFrequencyContainer{};
};
} // end of namespace Statistics
} // end of namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkHistogramToTextureFeaturesFilter.hxx"
#endif
 
#endif