itkEnhancedHistogramToTextureFeaturesFilter.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 __itkEnhancedHistogramToTextureFeaturesFilter_h
#define __itkEnhancedHistogramToTextureFeaturesFilter_h

#include "itkHistogram.h"
#include "itkMacro.h"
#include "itkProcessObject.h"
#include "itkSimpleDataObjectDecorator.h"

#define itkMacroGLCMFeatureGetter(name)                                       \
  const MeasurementObjectType * Get##name##Output() const;                      \
  \
  MeasurementType Get##name() const;

namespace itk
{
  namespace Statistics
  {
    template< typename THistogram >
    class EnhancedHistogramToTextureFeaturesFilter:public ProcessObject
    {
    public:
      typedef EnhancedHistogramToTextureFeaturesFilter Self;
      typedef ProcessObject                    Superclass;
      typedef SmartPointer< Self >             Pointer;
      typedef SmartPointer< const Self >       ConstPointer;

      itkTypeMacro(EnhancedHistogramToTextureFeaturesFilter, ProcessObject);

      itkNewMacro(Self);

      typedef THistogram                                    HistogramType;
      typedef typename HistogramType::Pointer               HistogramPointer;
      typedef typename HistogramType::ConstPointer          HistogramConstPointer;
      typedef typename HistogramType::MeasurementType       MeasurementType;
      typedef typename HistogramType::MeasurementVectorType MeasurementVectorType;
      typedef typename HistogramType::IndexType             IndexType;
      typedef typename HistogramType::AbsoluteFrequencyType AbsoluteFrequencyType;
      typedef typename HistogramType::RelativeFrequencyType RelativeFrequencyType;

      typedef typename HistogramType::TotalAbsoluteFrequencyType
        TotalAbsoluteFrequencyType;

      typedef typename HistogramType::TotalRelativeFrequencyType
        TotalRelativeFrequencyType;

      typedef std::vector< RelativeFrequencyType > RelativeFrequencyContainerType;

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

      const HistogramType * GetInput() const;

      typedef DataObject::Pointer DataObjectPointer;

      typedef SimpleDataObjectDecorator< MeasurementType > MeasurementObjectType;

      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;

      itkMacroGLCMFeatureGetter(Autocorrelation);
      itkMacroGLCMFeatureGetter(Contrast);
      itkMacroGLCMFeatureGetter(Dissimilarity);
      itkMacroGLCMFeatureGetter(MaximumProbability);
      itkMacroGLCMFeatureGetter(InverseVariance);
      itkMacroGLCMFeatureGetter(Homogeneity1);
      itkMacroGLCMFeatureGetter(ClusterTendency);
      itkMacroGLCMFeatureGetter(Variance);
      itkMacroGLCMFeatureGetter(SumAverage);
      itkMacroGLCMFeatureGetter(SumEntropy);
      itkMacroGLCMFeatureGetter(SumVariance);
      itkMacroGLCMFeatureGetter(DifferenceAverage);
      itkMacroGLCMFeatureGetter(DifferenceEntropy);
      itkMacroGLCMFeatureGetter(DifferenceVariance);
      itkMacroGLCMFeatureGetter(InverseDifferenceMomentNormalized);
      itkMacroGLCMFeatureGetter(InverseDifferenceNormalized);
      itkMacroGLCMFeatureGetter(InverseDifference);
      itkMacroGLCMFeatureGetter(JointAverage);
      itkMacroGLCMFeatureGetter(FirstMeasureOfInformationCorrelation);
      itkMacroGLCMFeatureGetter(SecondMeasureOfInformationCorrelation);

      typedef enum {
        Energy,
        Entropy,
        Correlation,
        InverseDifferenceMoment,
        Inertia,
        ClusterShade,
        ClusterProminence,
        HaralickCorrelation,
        Autocorrelation,
        Contrast,
        Dissimilarity,
        MaximumProbability,
        InverseVariance,
        Homogeneity1,
        ClusterTendency,
        Variance,
        SumAverage,
        SumEntropy,
        SumVariance,
        DifferenceAverage,
        DifferenceEntropy,
        DifferenceVariance,
        InverseDifferenceMomentNormalized,
        InverseDifferenceNormalized,
        InverseDifference,
        JointAverage,
        FirstMeasureOfInformationCorrelation,
        SecondMeasureOfInformationCorrelation,
        InvalidFeatureName
      }  TextureFeatureName;

      MeasurementType GetFeature(TextureFeatureName name);

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

      typedef ProcessObject::DataObjectPointerArraySizeType DataObjectPointerArraySizeType;
      using Superclass::MakeOutput;
      DataObjectPointer MakeOutput(DataObjectPointerArraySizeType) ITK_OVERRIDE;

      void GenerateData() ITK_OVERRIDE;

    private:
      EnhancedHistogramToTextureFeaturesFilter(const Self &); //purposely not implemented
      void operator=(const Self &);                   //purposely not implemented

      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 "itkEnhancedHistogramToTextureFeaturesFilter.hxx"
#endif

#endif