otbImageSampleExtractorFilter.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 otbImageSampleExtractorFilter_h
#define otbImageSampleExtractorFilter_h
 
#include "otbPersistentSamplingFilterBase.h"
#include "otbPersistentFilterStreamingDecorator.h"
#include "otbOGRDataSourceWrapper.h"
#include "otbImage.h"
#include <string>
 
namespace otb
{
 
template <class TInputImage>
class ITK_EXPORT PersistentImageSampleExtractorFilter : public PersistentSamplingFilterBase<TInputImage>
{
public:
 
  typedef PersistentImageSampleExtractorFilter      Self;
  typedef PersistentSamplingFilterBase<TInputImage> 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 typename InputImageType::IndexType         IndexType;
  typedef typename InputImageType::PixelType         PixelType;
  typedef typename InputImageType::InternalPixelType InternalPixelType;
 
  typedef ogr::DataSource          OGRDataType;
  typedef ogr::DataSource::Pointer OGRDataPointer;
 
  typedef itk::DataObject::DataObjectPointerArraySizeType DataObjectPointerArraySizeType;
 
  itkNewMacro(Self);
 
  itkTypeMacro(PersistentImageSampleExtractorFilter, PersistentSamplingFilterBase);
 
  void SetOutputSamples(ogr::DataSource* data);
 
  ogr::DataSource* GetOutputSamples();
 
  void Synthetize(void) override
  {
  }
 
  void Reset(void) override;
 
  itkSetMacro(SampleFieldPrefix, std::string);
  itkGetMacro(SampleFieldPrefix, std::string);
 
  void SetSampleFieldNames(std::vector<std::string>& names);
 
  const std::vector<std::string>& GetSampleFieldNames();
 
protected:
  PersistentImageSampleExtractorFilter();
 
  ~PersistentImageSampleExtractorFilter() override
  {
  }
 
  void GenerateOutputInformation() override;
 
  void GenerateInputRequestedRegion() override;
 
  void ThreadedGenerateVectorData(const ogr::Layer& layerForThread, itk::ThreadIdType threadid) override;
 
private:
  PersistentImageSampleExtractorFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  void InitializeFields();
 
  std::string m_SampleFieldPrefix;
 
  std::vector<std::string> m_SampleFieldNames;
};
 
template <class TInputImage>
class ITK_EXPORT ImageSampleExtractorFilter : public PersistentFilterStreamingDecorator<PersistentImageSampleExtractorFilter<TInputImage>>
{
public:
 
  typedef ImageSampleExtractorFilter                                                            Self;
  typedef PersistentFilterStreamingDecorator<PersistentImageSampleExtractorFilter<TInputImage>> Superclass;
  typedef itk::SmartPointer<Self>                                                               Pointer;
  typedef itk::SmartPointer<const Self>                                                         ConstPointer;
 
  typedef TInputImage          InputImageType;
  typedef otb::ogr::DataSource OGRDataType;
 
  typedef typename Superclass::FilterType FilterType;
 
  itkNewMacro(Self);
 
  itkTypeMacro(ImageSampleExtractorFilter, PersistentFilterStreamingDecorator);
 
  using Superclass::SetInput;
  virtual void SetInput(const TInputImage* image);
 
  const TInputImage* GetInput();
 
  void SetSamplePositions(const otb::ogr::DataSource* data);
  const otb::ogr::DataSource* GetSamplePositions();
 
  void SetOutputSamples(OGRDataType::Pointer data);
  const otb::ogr::DataSource* GetOutputSamples();
 
  void SetOutputFieldPrefix(const std::string& key);
  std::string GetOutputFieldPrefix();
 
  void SetOutputFieldNames(std::vector<std::string>& names);
 
  const std::vector<std::string>& GetOutputFieldNames();
 
  void SetLayerIndex(int index);
  int GetLayerIndex();
 
  void SetClassFieldName(const std::string& name);
  std::string GetClassFieldName(void);
 
protected:
  ImageSampleExtractorFilter()
  {
  }
 
  ~ImageSampleExtractorFilter() override
  {
  }
 
private:
  ImageSampleExtractorFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
};
 
} // end of namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbImageSampleExtractorFilter.hxx"
#endif
 
#endif