itkEnhancedHistogramToSizeZoneFeaturesFilter.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 itkEnhancedHistogramToSizeZoneFeaturesFilter_h
#define itkEnhancedHistogramToSizeZoneFeaturesFilter_h
 
#include <itkHistogram.h>
#include <itkMacro.h>
#include <itkProcessObject.h>
#include <itkSimpleDataObjectDecorator.h>
 
namespace itk {
  namespace Statistics {
    template< typename THistogram >
    class EnhancedHistogramToSizeZoneFeaturesFilter : public ProcessObject
    {
    public:
      typedef EnhancedHistogramToSizeZoneFeaturesFilter     Self;
      typedef ProcessObject                          Superclass;
      typedef SmartPointer<Self>                     Pointer;
      typedef SmartPointer<const Self>               ConstPointer;
 
      itkTypeMacro( EnhancedHistogramToSizeZoneFeaturesFilter, 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 GetSmallZoneEmphasis() const;
      const MeasurementObjectType* GetSmallZoneEmphasisOutput() const;
 
      MeasurementType GetLargeZoneEmphasis() const;
      const MeasurementObjectType* GetLargeZoneEmphasisOutput() const;
 
      MeasurementType GetGreyLevelNonuniformity() const;
      const MeasurementObjectType* GetGreyLevelNonuniformityOutput() const;
 
      MeasurementType GetGreyLevelNonuniformityNormalized() const;
      const MeasurementObjectType* GetGreyLevelNonuniformityNormalizedOutput() const;
 
      MeasurementType GetSizeZoneNonuniformity() const;
      const MeasurementObjectType* GetSizeZoneNonuniformityOutput() const;
 
      MeasurementType GetSizeZoneNonuniformityNormalized() const;
      const MeasurementObjectType* GetSizeZoneNonuniformityNormalizedOutput() const;
 
      MeasurementType GetLowGreyLevelZoneEmphasis() const;
      const MeasurementObjectType* GetLowGreyLevelZoneEmphasisOutput() const;
 
      MeasurementType GetHighGreyLevelZoneEmphasis() const;
      const MeasurementObjectType* GetHighGreyLevelZoneEmphasisOutput() const;
 
      MeasurementType GetSmallZoneLowGreyLevelEmphasis() const;
      const MeasurementObjectType* GetSmallZoneLowGreyLevelEmphasisOutput() const;
 
      MeasurementType GetSmallZoneHighGreyLevelEmphasis() const;
      const MeasurementObjectType* GetSmallZoneHighGreyLevelEmphasisOutput() const;
 
      MeasurementType GetLargeZoneLowGreyLevelEmphasis() const;
      const MeasurementObjectType* GetLargeZoneLowGreyLevelEmphasisOutput() const;
 
      MeasurementType GetLargeZoneHighGreyLevelEmphasis() const;
      const MeasurementObjectType* GetLargeZoneHighGreyLevelEmphasisOutput() const;
 
      MeasurementType GetZonePercentage() const;
      const MeasurementObjectType* GetZonePercentageOutput() const;
 
      MeasurementType GetNumberOfZones() const;
      const MeasurementObjectType* GetNumberOfZonesOutput() const;
 
      MeasurementType GetGreyLevelVariance() const;
      const MeasurementObjectType* GetGreyLevelVarianceOutput() const;
 
      MeasurementType GetSizeZoneVariance() const;
      const MeasurementObjectType* GetSizeZoneVarianceOutput() const;
 
      MeasurementType GetZoneEntropy() const;
      const MeasurementObjectType* GetZoneEntropyOutput() const;
 
      itkGetMacro( TotalNumberOfZones, unsigned long );
 
      itkGetConstMacro(NumberOfVoxels, unsigned long);
      itkSetMacro(NumberOfVoxels, unsigned long);
 
      typedef enum
      {
        SmallZoneEmphasis,
        LargeZoneEmphasis,
        GreyLevelNonuniformity,
        GreyLevelNonuniformityNormalized,
        SizeZoneNonuniformity,
        SizeZoneNonuniformityNormalized,
        LowGreyLevelZoneEmphasis,
        HighGreyLevelZoneEmphasis,
        SmallZoneLowGreyLevelEmphasis,
        SmallZoneHighGreyLevelEmphasis,
        LargeZoneLowGreyLevelEmphasis,
        LargeZoneHighGreyLevelEmphasis,
        ZonePercentage,
        GreyLevelVariance,
        SizeZoneVariance,
        ZoneEntropy
      }  SizeZoneFeatureName;
 
      MeasurementType GetFeature( SizeZoneFeatureName name );
 
    protected:
      EnhancedHistogramToSizeZoneFeaturesFilter();
      ~EnhancedHistogramToSizeZoneFeaturesFilter() {};
      virtual void PrintSelf(std::ostream& os, Indent indent) const ITK_OVERRIDE;
 
      typedef ProcessObject::DataObjectPointerArraySizeType DataObjectPointerArraySizeType;
      using Superclass::MakeOutput;
      virtual DataObjectPointer MakeOutput( DataObjectPointerArraySizeType ) ITK_OVERRIDE;
 
      virtual void GenerateData() ITK_OVERRIDE;
 
    private:
      EnhancedHistogramToSizeZoneFeaturesFilter(const Self&); //purposely not implemented
      void operator=(const Self&); //purposely not implemented
 
      unsigned long                           m_TotalNumberOfZones;
      unsigned long                           m_NumberOfVoxels;
    };
  } // end of namespace Statistics
} // end of namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#include <itkEnhancedHistogramToSizeZoneFeaturesFilter.tpp>
#endif
 
#endif