itkScalarImageToRunLengthFeaturesFilter.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 itkScalarImageToRunLengthFeaturesFilter_h
#define itkScalarImageToRunLengthFeaturesFilter_h
 
#include "itkDataObjectDecorator.h"
 
#include "itkHistogramToRunLengthFeaturesFilter.h"
#include "itkScalarImageToRunLengthMatrixFilter.h"
 
namespace itk
{
namespace Statistics
{
 
template <typename TImageType, typename THistogramFrequencyContainer = DenseFrequencyContainer2>
class ITK_TEMPLATE_EXPORT ScalarImageToRunLengthFeaturesFilter : public ProcessObject
{
public:
  using Self = ScalarImageToRunLengthFeaturesFilter;
  using Superclass = ProcessObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(ScalarImageToRunLengthFeaturesFilter);

  itkNewMacro(Self);
 
  using FrequencyContainerType = THistogramFrequencyContainer;
  using ImageType = TImageType;
  using ImagePointer = typename ImageType::Pointer;
 
  using PixelType = typename ImageType::PixelType;
  using OffsetType = typename ImageType::OffsetType;
  using OffsetVector = VectorContainer<unsigned char, OffsetType>;
  using OffsetVectorPointer = typename OffsetVector::Pointer;
  using OffsetVectorConstPointer = typename OffsetVector::ConstPointer;
 
  using RunLengthMatrixFilterType = ScalarImageToRunLengthMatrixFilter<ImageType, FrequencyContainerType>;
 
  using HistogramType = typename RunLengthMatrixFilterType::HistogramType;
 
  using RunLengthFeaturesFilterType = HistogramToRunLengthFeaturesFilter<HistogramType>;
 
  // More work needs to be done to fix wrapping
  // using RunLengthFeatureName = itk::Statistics::RunLengthFeatureEnum;
  using RunLengthFeatureName = uint8_t;
  using FeatureNameVector = VectorContainer<unsigned char, RunLengthFeatureName>;
  using FeatureNameVectorPointer = typename FeatureNameVector::Pointer;
  using FeatureNameVectorConstPointer = typename FeatureNameVector::ConstPointer;
  using FeatureValueVector = VectorContainer<unsigned char, double>;
  using FeatureValueVectorPointer = typename FeatureValueVector::Pointer;

  using DataObjectPointer = DataObject::Pointer;

  using FeatureValueVectorDataObjectType = DataObjectDecorator<FeatureValueVector>;
 
  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);
 
protected:
  ScalarImageToRunLengthFeaturesFilter();
  ~ScalarImageToRunLengthFeaturesFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  FastCompute();
 
  void
  FullCompute();

  void
  GenerateData() override;

  using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType;
  using Superclass::MakeOutput;
  DataObjectPointer MakeOutput(DataObjectPointerArraySizeType) override;
 
private:
  typename RunLengthMatrixFilterType::Pointer m_RunLengthMatrixGenerator{};
 
  FeatureValueVectorPointer     m_FeatureMeans{};
  FeatureValueVectorPointer     m_FeatureStandardDeviations{};
  FeatureNameVectorConstPointer m_RequestedFeatures{};
  OffsetVectorConstPointer      m_Offsets{};
  bool                          m_FastCalculations{};
};
} // end of namespace Statistics
} // end of namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkScalarImageToRunLengthFeaturesFilter.hxx"
#endif
 
#endif