otbOGRDataToSamplePositionFilter.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 otbOGRDataToSamplePositionFilter_h
#define otbOGRDataToSamplePositionFilter_h
 
#include "otbPersistentSamplingFilterBase.h"
#include "otbPersistentFilterStreamingDecorator.h"
#include "otbSamplingRateCalculator.h"
#include "otbPeriodicSampler.h"
#include "otbImage.h"
#include <string>
 
namespace otb
{
 
template <class TInputImage, class TMaskImage, class TSampler>
class ITK_EXPORT PersistentOGRDataToSamplePositionFilter : public PersistentSamplingFilterBase<TInputImage, TMaskImage>
{
public:
 
  typedef PersistentOGRDataToSamplePositionFilter Self;
  typedef PersistentSamplingFilterBase<TInputImage, TMaskImage> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  typedef TInputImage                         InputImageType;
  typedef typename InputImageType::Pointer    InputImagePointer;
  typedef typename InputImageType::RegionType RegionType;
  typedef typename InputImageType::PointType  PointType;
 
  typedef TMaskImage                      MaskImageType;
  typedef typename MaskImageType::Pointer MaskImagePointer;
 
  typedef ogr::DataSource          OGRDataType;
  typedef ogr::DataSource::Pointer OGRDataPointer;
 
  typedef TSampler                            SamplerType;
  typedef typename SamplerType::Pointer       SamplerPointerType;
  typedef typename SamplerType::ParameterType SamplerParameterType;
  typedef typename std::map<std::string, SamplerPointerType> SamplerMapType;
 
  typedef std::map<std::string, unsigned int> ClassPartitionType;
 
  typedef itk::DataObject::DataObjectPointerArraySizeType DataObjectPointerArraySizeType;
 
  itkNewMacro(Self);
 
  itkTypeMacro(PersistentOGRDataToSamplePositionFilter, PersistentSamplingFilterBase);
 
  void Synthetize(void) override
  {
  }
 
  void Reset(void) override;
 
  SamplerMapType& GetSamplers(unsigned int level);
 
  void SetOutputPositionContainerAndRates(otb::ogr::DataSource* data, const SamplingRateCalculator::MapRateType& map, unsigned int level);
 
  const otb::ogr::DataSource* GetOutputPositionContainer(unsigned int level) const;
  otb::ogr::DataSource* GetOutputPositionContainer(unsigned int level);
 
  unsigned int GetNumberOfLevels();
 
  void ClearOutputs();
 
  itk::DataObject::Pointer MakeOutput(DataObjectPointerArraySizeType idx) override;
  using Superclass::MakeOutput;
 
  itkSetMacro(OriginFieldName, std::string);
  itkGetMacro(OriginFieldName, std::string);
 
protected:
  PersistentOGRDataToSamplePositionFilter();
 
  ~PersistentOGRDataToSamplePositionFilter() override
  {
  }
 
  void ProcessSample(const ogr::Feature& feature, typename TInputImage::IndexType& imgIndex, typename TInputImage::PointType& imgPoint,
                     itk::ThreadIdType& threadid) override;
 
  void DispatchInputVectors(void) override;
 
  void FillOneOutput(unsigned int outIdx, ogr::DataSource* outDS, bool update) override;
 
private:
  PersistentOGRDataToSamplePositionFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  void ComputeClassPartition(void);
 
  ClassPartitionType m_ClassPartition;
 
  std::vector<SamplerMapType> m_Samplers;
 
  std::string m_OriginFieldName;
 
  bool m_UseOriginField;
};
 
template <class TInputImage, class TMaskImage = otb::Image<unsigned char>, class TSampler = otb::PeriodicSampler>
class ITK_EXPORT OGRDataToSamplePositionFilter
    : public PersistentFilterStreamingDecorator<PersistentOGRDataToSamplePositionFilter<TInputImage, TMaskImage, TSampler>>
{
public:
 
  typedef OGRDataToSamplePositionFilter Self;
  typedef PersistentFilterStreamingDecorator<PersistentOGRDataToSamplePositionFilter<TInputImage, TMaskImage, TSampler>> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  typedef TInputImage          InputImageType;
  typedef TMaskImage           MaskImageType;
  typedef otb::ogr::DataSource OGRDataType;
 
  typedef typename Superclass::FilterType FilterType;
 
  typedef TSampler                            SamplerType;
  typedef typename SamplerType::Pointer       SamplerPointerType;
  typedef typename SamplerType::ParameterType SamplerParameterType;
  typedef typename std::map<std::string, SamplerPointerType> SamplerMapType;
 
  itkNewMacro(Self);
 
  itkTypeMacro(OGRDataToSamplePositionFilter, PersistentFilterStreamingDecorator);
 
  using Superclass::SetInput;
 
  virtual void SetInput(const TInputImage* image);
 
  const TInputImage* GetInput();
 
  void SetOGRData(const otb::ogr::DataSource* data);
 
  const otb::ogr::DataSource* GetOGRData();
 
  void SetMask(const TMaskImage* mask);
 
  const TMaskImage* GetMask();
 
  void SetFieldName(std::string key);
 
  std::string GetFieldName();
 
  void SetLayerIndex(int index);
 
  int GetLayerIndex();
 
  void SetSamplerParameters(SamplerParameterType param, unsigned int level = 0);
 
  SamplerMapType& GetSamplers(unsigned int level = 0);
 
  void SetOutputPositionContainerAndRates(otb::ogr::DataSource* data, const SamplingRateCalculator::MapRateType& map, unsigned int level = 0);
 
  otb::ogr::DataSource* GetOutputPositionContainer(unsigned int level = 0);
 
  void SetOriginFieldName(std::string key);
 
  std::string GetOriginFieldName();
 
protected:
  OGRDataToSamplePositionFilter()
  {
  }
 
  ~OGRDataToSamplePositionFilter() override
  {
  }
 
private:
  OGRDataToSamplePositionFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
};
 
} // end of namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbOGRDataToSamplePositionFilter.hxx"
#endif
 
#endif