itkEnhancedScalarImageToRunLengthFeaturesFilter.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
*
*         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 __itkEnhancedScalarImageToRunLengthFeaturesFilter_h
#define __itkEnhancedScalarImageToRunLengthFeaturesFilter_h

#include "itkDataObjectDecorator.h"

#include "itkEnhancedHistogramToRunLengthFeaturesFilter.h"
#include "itkEnhancedScalarImageToRunLengthMatrixFilter.h"

namespace itk
{
  namespace Statistics
  {
    template< typename TImageType,
      typename THistogramFrequencyContainer = DenseFrequencyContainer2 >
    class EnhancedScalarImageToRunLengthFeaturesFilter:public ProcessObject
    {
    public:
      typedef EnhancedScalarImageToRunLengthFeaturesFilter  Self;
      typedef ProcessObject                         Superclass;
      typedef SmartPointer< Self >                  Pointer;
      typedef SmartPointer< const Self >            ConstPointer;

      itkTypeMacro(EnhancedScalarImageToRunLengthFeaturesFilter, ProcessObject);

      itkNewMacro(Self);

      typedef THistogramFrequencyContainer FrequencyContainerType;
      typedef TImageType                   ImageType;
      typedef typename ImageType::Pointer  ImagePointer;

      typedef typename ImageType::PixelType                PixelType;
      typedef typename ImageType::OffsetType               OffsetType;
      typedef VectorContainer< unsigned char, OffsetType > OffsetVector;
      typedef typename OffsetVector::Pointer               OffsetVectorPointer;
      typedef typename OffsetVector::ConstPointer          OffsetVectorConstPointer;

      typedef EnhancedScalarImageToRunLengthMatrixFilter<
        ImageType, FrequencyContainerType >               RunLengthMatrixFilterType;

      typedef typename RunLengthMatrixFilterType::HistogramType
        HistogramType;

      typedef EnhancedHistogramToRunLengthFeaturesFilter< HistogramType >
        RunLengthFeaturesFilterType;

      typedef short                                    RunLengthFeatureName;
      typedef VectorContainer<unsigned char,
        RunLengthFeatureName>                          FeatureNameVector;
      typedef typename FeatureNameVector::Pointer      FeatureNameVectorPointer;
      typedef typename FeatureNameVector::ConstPointer FeatureNameVectorConstPointer;
      typedef VectorContainer< unsigned char, double > FeatureValueVector;
      typedef typename FeatureValueVector::Pointer     FeatureValueVectorPointer;

      typedef DataObject::Pointer DataObjectPointer;

      typedef DataObjectDecorator< FeatureValueVector >
        FeatureValueVectorDataObjectType;

      const FeatureValueVectorDataObjectType * GetFeatureMeansOutput() const;

      const FeatureValueVectorDataObjectType * GetFeatureStandardDeviationsOutput()
        const;

      using Superclass::SetInput;
      void SetInput(const ImageType *);

      const ImageType * GetInput() const;

      itkGetConstReferenceObjectMacro(FeatureMeans, FeatureValueVector);
      itkGetConstReferenceObjectMacro(FeatureStandardDeviations, FeatureValueVector);

      itkSetConstObjectMacro(RequestedFeatures, FeatureNameVector);
      itkGetConstObjectMacro(RequestedFeatures, FeatureNameVector);

      itkSetConstObjectMacro(Offsets, OffsetVector);
      itkGetConstObjectMacro(Offsets, OffsetVector);

      void SetNumberOfBinsPerAxis(unsigned int);

      void SetPixelValueMinMax(PixelType min, PixelType max);

      void SetDistanceValueMinMax( double min, double max );

      void SetMaskImage(const ImageType *);

      const ImageType * GetMaskImage() const;

      void SetInsidePixelValue(PixelType InsidePixelValue);

      itkGetConstMacro(FastCalculations, bool);
      itkSetMacro(FastCalculations, bool);
      itkBooleanMacro(FastCalculations);
      itkGetConstMacro(CombinedFeatureCalculation, bool);
      itkSetMacro(CombinedFeatureCalculation, bool);
      itkBooleanMacro(CombinedFeatureCalculation);

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

      void FastCompute();

      void FullCompute();

      void GenerateData() ITK_OVERRIDE;

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

    private:
      typename RunLengthMatrixFilterType::Pointer m_RunLengthMatrixGenerator;

      FeatureValueVectorPointer     m_FeatureMeans;
      FeatureValueVectorPointer     m_FeatureStandardDeviations;
      FeatureNameVectorConstPointer m_RequestedFeatures;
      OffsetVectorConstPointer      m_Offsets;
      bool                          m_FastCalculations;
      bool                          m_CombinedFeatureCalculation;
    };
  } // end of namespace Statistics
} // end of namespace itk

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

#endif