itkEnhancedHistogramToRunLengthFeaturesFilter.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE 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
*
*         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 itkEnhancedHistogramToRunLengthFeaturesFilter_h
#define itkEnhancedHistogramToRunLengthFeaturesFilter_h
 
#include <itkHistogram.h>
#include <itkMacro.h>
#include <itkProcessObject.h>
#include <itkSimpleDataObjectDecorator.h>
 
namespace itk {
  namespace Statistics {
    template< typename THistogram >
    class EnhancedHistogramToRunLengthFeaturesFilter : public ProcessObject
    {
    public:
      typedef EnhancedHistogramToRunLengthFeaturesFilter     Self;
      typedef ProcessObject                          Superclass;
      typedef SmartPointer<Self>                     Pointer;
      typedef SmartPointer<const Self>               ConstPointer;
 
      itkTypeMacro( EnhancedHistogramToRunLengthFeaturesFilter, 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::
        TotalAbsoluteFrequencyType                            FrequencyType;
 
      using Superclass::SetInput;
      void SetInput ( const HistogramType * histogram );
      const HistogramType * GetInput() const;
 
      typedef DataObject::Pointer                   DataObjectPointer;
 
      typedef SimpleDataObjectDecorator<MeasurementType>     MeasurementObjectType;
 
      MeasurementType GetShortRunEmphasis() const;
      const MeasurementObjectType* GetShortRunEmphasisOutput() const;
 
      MeasurementType GetLongRunEmphasis() const;
      const MeasurementObjectType* GetLongRunEmphasisOutput() const;
 
      MeasurementType GetGreyLevelNonuniformity() const;
      const MeasurementObjectType* GetGreyLevelNonuniformityOutput() const;
 
      MeasurementType GetGreyLevelNonuniformityNormalized() const;
      const MeasurementObjectType* GetGreyLevelNonuniformityNormalizedOutput() const;
 
      MeasurementType GetRunLengthNonuniformity() const;
      const MeasurementObjectType* GetRunLengthNonuniformityOutput() const;
 
      MeasurementType GetRunLengthNonuniformityNormalized() const;
      const MeasurementObjectType* GetRunLengthNonuniformityNormalizedOutput() const;
 
      MeasurementType GetLowGreyLevelRunEmphasis() const;
      const MeasurementObjectType* GetLowGreyLevelRunEmphasisOutput() const;
 
      MeasurementType GetHighGreyLevelRunEmphasis() const;
      const MeasurementObjectType* GetHighGreyLevelRunEmphasisOutput() const;
 
      MeasurementType GetShortRunLowGreyLevelEmphasis() const;
      const MeasurementObjectType* GetShortRunLowGreyLevelEmphasisOutput() const;
 
      MeasurementType GetShortRunHighGreyLevelEmphasis() const;
      const MeasurementObjectType* GetShortRunHighGreyLevelEmphasisOutput() const;
 
      MeasurementType GetLongRunLowGreyLevelEmphasis() const;
      const MeasurementObjectType* GetLongRunLowGreyLevelEmphasisOutput() const;
 
      MeasurementType GetLongRunHighGreyLevelEmphasis() const;
      const MeasurementObjectType* GetLongRunHighGreyLevelEmphasisOutput() const;
 
      MeasurementType GetRunPercentage() const;
      const MeasurementObjectType* GetRunPercentageOutput() const;
 
      MeasurementType GetNumberOfRuns() const;
      const MeasurementObjectType* GetNumberOfRunsOutput() const;
 
      MeasurementType GetGreyLevelVariance() const;
      const MeasurementObjectType* GetGreyLevelVarianceOutput() const;
 
      MeasurementType GetRunLengthVariance() const;
      const MeasurementObjectType* GetRunLengthVarianceOutput() const;
 
      MeasurementType GetRunEntropy() const;
      const MeasurementObjectType* GetRunEntropyOutput() const;
 
      itkGetMacro( TotalNumberOfRuns, unsigned long );
 
      itkGetConstMacro(NumberOfVoxels, unsigned long);
      itkSetMacro(NumberOfVoxels, unsigned long);
 
      typedef enum
      {
        ShortRunEmphasis,
        LongRunEmphasis,
        GreyLevelNonuniformity,
        GreyLevelNonuniformityNormalized,
        RunLengthNonuniformity,
        RunLengthNonuniformityNormalized,
        LowGreyLevelRunEmphasis,
        HighGreyLevelRunEmphasis,
        ShortRunLowGreyLevelEmphasis,
        ShortRunHighGreyLevelEmphasis,
        LongRunLowGreyLevelEmphasis,
        LongRunHighGreyLevelEmphasis,
        RunPercentage,
        NumberOfRuns,
        GreyLevelVariance,
        RunLengthVariance,
        RunEntropy
      }  RunLengthFeatureName;
 
      MeasurementType GetFeature( RunLengthFeatureName name );
 
    protected:
      EnhancedHistogramToRunLengthFeaturesFilter();
      ~EnhancedHistogramToRunLengthFeaturesFilter() 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:
      EnhancedHistogramToRunLengthFeaturesFilter(const Self&); //purposely not implemented
      void operator=(const Self&); //purposely not implemented
 
      unsigned long                           m_TotalNumberOfRuns;
      unsigned long                           m_NumberOfVoxels;
    };
  } // end of namespace Statistics
} // end of namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#include <itkEnhancedHistogramToRunLengthFeaturesFilter.tpp>
#endif
 
#endif