otbPersistentSamplingFilterBase.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 otbPersistentSamplingFilterBase_h
#define otbPersistentSamplingFilterBase_h
 
#include "otbPersistentImageFilter.h"
#include "otbOGRDataSourceWrapper.h"
#include "otbImage.h"
#include "otbMacro.h" //for ITK_THREAD_RETURN_TYPE in ITK5
#include <string>
 
namespace otb
{
template <class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
class ITK_EXPORT PersistentSamplingFilterBase : public otb::PersistentImageFilter<TInputImage, TInputImage>
{
public:
  typedef PersistentSamplingFilterBase Self;
  typedef PersistentImageFilter<TInputImage, TInputImage> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkTypeMacro(PersistentSamplingFilterBase, PersistentImageFilter);
 
  typedef TInputImage InputImageType;
  typedef TMaskImage  MaskImageType;
 
  typedef typename TInputImage::RegionType RegionType;
 
  typedef ogr::DataSource::Pointer OGRDataPointer;
 
  void SetOGRData(const ogr::DataSource* vector);
 
  const ogr::DataSource* GetOGRData();
 
  void SetMask(const TMaskImage* mask);
 
  const TMaskImage* GetMask();
 
  void SetOGRLayerCreationOptions(const std::vector<std::string>& options);
 
  const std::vector<std::string>& GetOGRLayerCreationOptions();
 
  itkSetMacro(FieldName, std::string);
  itkGetMacro(FieldName, std::string);
 
  itkGetMacro(FieldIndex, int);
 
  itkSetMacro(LayerIndex, int);
  itkGetMacro(LayerIndex, int);
 
  itkSetMacro(OutLayerName, std::string);
  itkGetMacro(OutLayerName, std::string);
 
protected:
  PersistentSamplingFilterBase();
 
  ~PersistentSamplingFilterBase() override
  {
  }
 
  void GenerateOutputInformation() override;
 
  void GenerateInputRequestedRegion() override;
 
  void GenerateData(void) override;
 
  void AllocateOutputs(void) override;
 
  virtual void ThreadedGenerateVectorData(const ogr::Layer& layerForThread, itk::ThreadIdType threadid);
 
  void ExploreGeometry(const ogr::Feature& feature, OGRGeometry* geom, RegionType& region, itk::ThreadIdType& threadid);
 
  virtual void ProcessLine(const ogr::Feature& feature, OGRLineString* line, RegionType& region, itk::ThreadIdType& threadid);
 
  virtual void ProcessPolygon(const ogr::Feature& feature, OGRPolygon* polygon, RegionType& region, itk::ThreadIdType& threadid);
 
  virtual void ProcessSample(const ogr::Feature& feature, typename TInputImage::IndexType& imgIndex, typename TInputImage::PointType& imgPoint,
                             itk::ThreadIdType& threadid);
 
  virtual void PrepareFeature(const ogr::Feature& feature, itk::ThreadIdType& threadid);
 
  bool IsSampleInsidePolygon(OGRPolygon* poly, OGRPoint* tmpPoint);
 
  bool IsSampleOnLine(OGRLineString* line, typename TInputImage::PointType& position, typename TInputImage::SpacingType& absSpacing, OGRPolygon& tmpPolygon);
 
  RegionType FeatureBoundingRegion(const TInputImage* image, otb::ogr::Layer::const_iterator& featIt) const;
 
  virtual void DispatchInputVectors(void);
 
  virtual void GatherOutputVectors(void);
 
  virtual void FillOneOutput(unsigned int outIdx, ogr::DataSource* outDS, bool update);
 
  virtual void InitializeOutputDataSource(ogr::DataSource* inputDS, ogr::DataSource* outputDS);
 
  typedef struct
  {
    std::string  Name;
    OGRFieldType Type;
    int          Width;
    int          Precision;
  } SimpleFieldDefn;
 
  void ClearAdditionalFields();
 
  void CreateAdditionalField(std::string name, OGRFieldType type, int width = 0, int precision = 0);
 
  const std::vector<SimpleFieldDefn>& GetAdditionalFields();
 
  static itk::ITK_THREAD_RETURN_TYPE VectorThreaderCallback(void *arg);
 
  struct VectorThreadStruct
  {
    Pointer Filter;
  };
 
  ogr::Layer GetInMemoryInput(unsigned int threadId);
 
  ogr::Layer GetInMemoryOutput(unsigned int threadId, unsigned int index = 0);
 
private:
  PersistentSamplingFilterBase(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  std::string m_FieldName;
 
  int m_FieldIndex;
 
  int m_LayerIndex;
 
  std::string m_OutLayerName;
 
  std::vector<std::string> m_OGRLayerCreationOptions;
 
  std::vector<SimpleFieldDefn> m_AdditionalFields;
 
  std::vector<OGRDataPointer> m_InMemoryInputs;
 
  std::vector<std::vector<OGRDataPointer>> m_InMemoryOutputs;
};
} // End namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbPersistentSamplingFilterBase.hxx"
#endif
 
#endif