otbScalarImageToTexturesFilter.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2024 Centre National d'Etudes Spatiales (CNES)
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * 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
 *
 * 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 otbScalarImageToTexturesFilter_h
#define otbScalarImageToTexturesFilter_h
 
#include "otbGreyLevelCooccurrenceIndexedList.h"
#include "itkImageToImageFilter.h"
 
namespace otb
{
 
template <class TInpuImage, class TOutputImage>
class ScalarImageToTexturesFilter : public itk::ImageToImageFilter<TInpuImage, TOutputImage>
{
public:
  typedef ScalarImageToTexturesFilter Self;
  typedef itk::ImageToImageFilter<TInpuImage, TOutputImage> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(ScalarImageToTexturesFilter, ImageToImageFilter);
 
  typedef TInpuImage                          InputImageType;
  typedef typename InputImageType::Pointer    InputImagePointerType;
  typedef typename InputImageType::PixelType  InputPixelType;
  typedef typename InputImageType::RegionType InputRegionType;
  typedef typename InputRegionType::SizeType  SizeType;
  typedef typename InputImageType::OffsetType OffsetType;
 
  typedef TOutputImage                         OutputImageType;
  typedef typename OutputImageType::Pointer    OutputImagePointerType;
  typedef typename OutputImageType::RegionType OutputRegionType;
 
  typedef GreyLevelCooccurrenceIndexedList<InputPixelType>            CooccurrenceIndexedListType;
  typedef typename CooccurrenceIndexedListType::Pointer               CooccurrenceIndexedListPointerType;
  typedef typename CooccurrenceIndexedListType::ConstPointer          CooccurrenceIndexedListConstPointerType;
  typedef typename CooccurrenceIndexedListType::IndexType             CooccurrenceIndexType;
  typedef typename CooccurrenceIndexedListType::PixelValueType        PixelValueType;
  typedef typename CooccurrenceIndexedListType::RelativeFrequencyType RelativeFrequencyType;
  typedef typename CooccurrenceIndexedListType::VectorType            VectorType;
 
  typedef typename VectorType::iterator       VectorIteratorType;
  typedef typename VectorType::const_iterator VectorConstIteratorType;
 
  itkSetMacro(Radius, SizeType);
 
  itkGetMacro(Radius, SizeType);
 
  itkSetMacro(Offset, OffsetType);
 
  itkGetMacro(Offset, OffsetType);
 
  itkSetMacro(NumberOfBinsPerAxis, unsigned int);
 
  itkGetMacro(NumberOfBinsPerAxis, unsigned int);
 
  itkSetMacro(InputImageMinimum, InputPixelType);
 
  itkGetMacro(InputImageMinimum, InputPixelType);
 
  itkSetMacro(InputImageMaximum, InputPixelType);
 
  itkGetMacro(InputImageMaximum, InputPixelType);
 
  itkSetMacro(SubsampleFactor, SizeType);
 
  itkGetMacro(SubsampleFactor, SizeType);
 
  itkSetMacro(SubsampleOffset, OffsetType);
 
  itkGetMacro(SubsampleOffset, OffsetType);
 
  OutputImageType* GetEnergyOutput();
 
  OutputImageType* GetEntropyOutput();
 
  OutputImageType* GetCorrelationOutput();
 
  OutputImageType* GetInverseDifferenceMomentOutput();
 
  OutputImageType* GetInertiaOutput();
 
  OutputImageType* GetClusterShadeOutput();
 
  OutputImageType* GetClusterProminenceOutput();
 
  OutputImageType* GetHaralickCorrelationOutput();
 
protected:
  ScalarImageToTexturesFilter();
 
  ~ScalarImageToTexturesFilter() override;
 
  void GenerateOutputInformation() override;
 
  void GenerateInputRequestedRegion() override;
 
  void BeforeThreadedGenerateData() override;
 
  void DynamicThreadedGenerateData(const OutputRegionType& outputRegion) override;
 
private:
  ScalarImageToTexturesFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  static OutputRegionType RegionUnion(const OutputRegionType& region1, const OutputRegionType& region2);
 
  SizeType m_Radius;
 
  OffsetType m_Offset;
 
  SizeType m_NeighborhoodRadius;
 
  unsigned int m_NumberOfBinsPerAxis;
 
  InputPixelType m_InputImageMinimum;
 
  InputPixelType m_InputImageMaximum;
 
  // TODO: should we use constexpr? only c++11 and problem for msvc
  inline double GetPixelValueTolerance() const
  {
    return 0.0001;
  }
 
  SizeType m_SubsampleFactor;
 
  OffsetType m_SubsampleOffset;
};
} // End namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbScalarImageToTexturesFilter.hxx"
#endif
 
#endif