OTB  9.1.1
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler > Class Template Reference
Group Learning » Module OTBSampling

#include <otbOGRDataToSamplePositionFilter.h>

+ Inheritance diagram for otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >:
+ Collaboration diagram for otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >:

Public Types

typedef itk::SmartPointer< const Self > ConstPointer
 
typedef Superclass::FilterType FilterType
 
typedef TInputImage InputImageType
 
typedef TMaskImage MaskImageType
 
typedef otb::ogr::DataSource OGRDataType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef std::map< std::string, SamplerPointerType > SamplerMapType
 
typedef SamplerType::ParameterType SamplerParameterType
 
typedef SamplerType::Pointer SamplerPointerType
 
typedef TSampler SamplerType
 
typedef OGRDataToSamplePositionFilter Self
 
typedef PersistentFilterStreamingDecorator< PersistentOGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler > > Superclass
 
- Public Types inherited from otb::PersistentFilterStreamingDecorator< PersistentOGRDataToSamplePositionFilter< TInputImage, otb::Image< unsigned char >, otb::PeriodicSampler > >
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef FilterType::Pointer FilterPointerType
 
typedef PersistentOGRDataToSamplePositionFilter< TInputImage, otb::Image< unsigned char >, otb::PeriodicSampler > FilterType
 
typedef FilterType::InputImageType ImageType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef PersistentFilterStreamingDecorator Self
 
typedef StreamerType::Pointer StreamerPointerType
 
typedef StreamingImageVirtualWriter< ImageType > StreamerType
 
typedef itk::ProcessObject Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
std::string GetFieldName ()
 
const TInputImage * GetInput ()
 
int GetLayerIndex ()
 
const TMaskImage * GetMask ()
 
virtual const char * GetNameOfClass () const
 
const otb::ogr::DataSource * GetOGRData ()
 
std::string GetOriginFieldName ()
 
otb::ogr::DataSource * GetOutputPositionContainer (unsigned int level=0)
 
SamplerMapType & GetSamplers (unsigned int level=0)
 
void SetFieldName (std::string key)
 
virtual void SetInput (const TInputImage *image)
 
void SetLayerIndex (int index)
 
void SetMask (const TMaskImage *mask)
 
void SetOGRData (const otb::ogr::DataSource *data)
 
void SetOriginFieldName (std::string key)
 
void SetOutputPositionContainerAndRates (otb::ogr::DataSource *data, const SamplingRateCalculator::MapRateType &map, unsigned int level=0)
 
void SetSamplerParameters (SamplerParameterType param, unsigned int level=0)
 
- Public Member Functions inherited from otb::PersistentFilterStreamingDecorator< PersistentOGRDataToSamplePositionFilter< TInputImage, otb::Image< unsigned char >, otb::PeriodicSampler > >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const FilterType * GetFilter () const
 
virtual const char * GetNameOfClass () const
 
 itkGetObjectMacro (Filter, FilterType)
 
 itkGetObjectMacro (Streamer, StreamerType)
 
virtual void SetFilter (FilterType *_arg)
 
void Update (void) override
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from otb::PersistentFilterStreamingDecorator< PersistentOGRDataToSamplePositionFilter< TInputImage, otb::Image< unsigned char >, otb::PeriodicSampler > >
static Pointer New ()
 

Protected Member Functions

 OGRDataToSamplePositionFilter ()
 
 ~OGRDataToSamplePositionFilter () override
 
- Protected Member Functions inherited from otb::PersistentFilterStreamingDecorator< PersistentOGRDataToSamplePositionFilter< TInputImage, otb::Image< unsigned char >, otb::PeriodicSampler > >
void GenerateData (void) override
 
 PersistentFilterStreamingDecorator ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~PersistentFilterStreamingDecorator () override
 

Private Member Functions

 OGRDataToSamplePositionFilter (const Self &)=delete
 
void operator= (const Self &)=delete
 

Additional Inherited Members

- Protected Attributes inherited from otb::PersistentFilterStreamingDecorator< PersistentOGRDataToSamplePositionFilter< TInputImage, otb::Image< unsigned char >, otb::PeriodicSampler > >
FilterPointerType m_Filter
 
StreamerPointerType m_Streamer
 

Detailed Description

template<class TInputImage, class TMaskImage = otb::Image<unsigned char>, class TSampler = otb::PeriodicSampler>
class otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >

Extracts sample position from an image using a persistent filter.

See also
PersistentOGRDataToSamplePositionFilter

Definition at line 175 of file otbOGRDataToSamplePositionFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage , class TMaskImage = otb::Image<unsigned char>, class TSampler = otb::PeriodicSampler>
typedef itk::SmartPointer<const Self> otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::ConstPointer

Definition at line 184 of file otbOGRDataToSamplePositionFilter.h.

◆ FilterType

template<class TInputImage , class TMaskImage = otb::Image<unsigned char>, class TSampler = otb::PeriodicSampler>
typedef Superclass::FilterType otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::FilterType

Definition at line 190 of file otbOGRDataToSamplePositionFilter.h.

◆ InputImageType

template<class TInputImage , class TMaskImage = otb::Image<unsigned char>, class TSampler = otb::PeriodicSampler>
typedef TInputImage otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::InputImageType

Definition at line 186 of file otbOGRDataToSamplePositionFilter.h.

◆ MaskImageType

template<class TInputImage , class TMaskImage = otb::Image<unsigned char>, class TSampler = otb::PeriodicSampler>
typedef TMaskImage otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::MaskImageType

Definition at line 187 of file otbOGRDataToSamplePositionFilter.h.

◆ OGRDataType

template<class TInputImage , class TMaskImage = otb::Image<unsigned char>, class TSampler = otb::PeriodicSampler>
typedef otb::ogr::DataSource otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::OGRDataType

Definition at line 188 of file otbOGRDataToSamplePositionFilter.h.

◆ Pointer

template<class TInputImage , class TMaskImage = otb::Image<unsigned char>, class TSampler = otb::PeriodicSampler>
typedef itk::SmartPointer<Self> otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::Pointer

Definition at line 183 of file otbOGRDataToSamplePositionFilter.h.

◆ SamplerMapType

template<class TInputImage , class TMaskImage = otb::Image<unsigned char>, class TSampler = otb::PeriodicSampler>
typedef std::map<std::string, SamplerPointerType> otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::SamplerMapType

Definition at line 195 of file otbOGRDataToSamplePositionFilter.h.

◆ SamplerParameterType

template<class TInputImage , class TMaskImage = otb::Image<unsigned char>, class TSampler = otb::PeriodicSampler>
typedef SamplerType::ParameterType otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::SamplerParameterType

Definition at line 194 of file otbOGRDataToSamplePositionFilter.h.

◆ SamplerPointerType

template<class TInputImage , class TMaskImage = otb::Image<unsigned char>, class TSampler = otb::PeriodicSampler>
typedef SamplerType::Pointer otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::SamplerPointerType

Definition at line 193 of file otbOGRDataToSamplePositionFilter.h.

◆ SamplerType

template<class TInputImage , class TMaskImage = otb::Image<unsigned char>, class TSampler = otb::PeriodicSampler>
typedef TSampler otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::SamplerType

Definition at line 192 of file otbOGRDataToSamplePositionFilter.h.

◆ Self

template<class TInputImage , class TMaskImage = otb::Image<unsigned char>, class TSampler = otb::PeriodicSampler>
typedef OGRDataToSamplePositionFilter otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::Self

Standard Self typedef

Definition at line 181 of file otbOGRDataToSamplePositionFilter.h.

◆ Superclass

template<class TInputImage , class TMaskImage = otb::Image<unsigned char>, class TSampler = otb::PeriodicSampler>
typedef PersistentFilterStreamingDecorator<PersistentOGRDataToSamplePositionFilter<TInputImage, TMaskImage, TSampler> > otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::Superclass

Definition at line 182 of file otbOGRDataToSamplePositionFilter.h.

Constructor & Destructor Documentation

◆ OGRDataToSamplePositionFilter() [1/2]

template<class TInputImage , class TMaskImage = otb::Image<unsigned char>, class TSampler = otb::PeriodicSampler>
otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::OGRDataToSamplePositionFilter ( )
inlineprotected

Constructor

Definition at line 255 of file otbOGRDataToSamplePositionFilter.h.

◆ ~OGRDataToSamplePositionFilter()

template<class TInputImage , class TMaskImage = otb::Image<unsigned char>, class TSampler = otb::PeriodicSampler>
otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::~OGRDataToSamplePositionFilter ( )
inlineoverrideprotected

Destructor

Definition at line 260 of file otbOGRDataToSamplePositionFilter.h.

◆ OGRDataToSamplePositionFilter() [2/2]

template<class TInputImage , class TMaskImage = otb::Image<unsigned char>, class TSampler = otb::PeriodicSampler>
otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::OGRDataToSamplePositionFilter ( const Self &  )
privatedelete

Member Function Documentation

◆ CreateAnother()

template<class TInputImage , class TMaskImage = otb::Image<unsigned char>, class TSampler = otb::PeriodicSampler>
virtual::itk::LightObject::Pointer otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::CreateAnother ( void  ) const

◆ GetFieldName()

template<class TInputImage , class TMaskImage , class TSampler >
std::string otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::GetFieldName

Get the field name containing class names

Definition at line 370 of file otbOGRDataToSamplePositionFilter.hxx.

◆ GetInput()

template<class TInputImage , class TMaskImage , class TSampler >
const TInputImage * otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::GetInput

Get the input image

Definition at line 334 of file otbOGRDataToSamplePositionFilter.hxx.

◆ GetLayerIndex()

template<class TInputImage , class TMaskImage , class TSampler >
int otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::GetLayerIndex

Get the layer index containing sampling areas

Definition at line 382 of file otbOGRDataToSamplePositionFilter.hxx.

◆ GetMask()

template<class TInputImage , class TMaskImage , class TSampler >
const TMaskImage * otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::GetMask

Get input mask (may be null)

Definition at line 358 of file otbOGRDataToSamplePositionFilter.hxx.

◆ GetNameOfClass()

template<class TInputImage , class TMaskImage = otb::Image<unsigned char>, class TSampler = otb::PeriodicSampler>
virtual const char* otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::GetNameOfClass ( ) const
virtual

Creation through object factory macro

◆ GetOGRData()

template<class TInputImage , class TMaskImage , class TSampler >
const otb::ogr::DataSource * otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::GetOGRData

Get the input OGRDataSource containing sampling areas

Definition at line 346 of file otbOGRDataToSamplePositionFilter.hxx.

◆ GetOriginFieldName()

template<class TInputImage , class TMaskImage , class TSampler >
std::string otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::GetOriginFieldName

Get the field name storing the original FID of each sample

Definition at line 425 of file otbOGRDataToSamplePositionFilter.hxx.

◆ GetOutputPositionContainer()

template<class TInputImage , class TMaskImage , class TSampler >
otb::ogr::DataSource * otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::GetOutputPositionContainer ( unsigned int  level = 0)

Get the output position container at a given level.

Definition at line 413 of file otbOGRDataToSamplePositionFilter.hxx.

◆ GetSamplers()

template<class TInputImage , class TMaskImage , class TSampler >
OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::SamplerMapType & otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::GetSamplers ( unsigned int  level = 0)

Get a reference to the internal sampler map at a given level.

Definition at line 399 of file otbOGRDataToSamplePositionFilter.hxx.

◆ New()

template<class TInputImage , class TMaskImage = otb::Image<unsigned char>, class TSampler = otb::PeriodicSampler>
static Pointer otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::New ( )
static

Type macro

Referenced by otb::Wrapper::TrainImagesBase::SplitTrainingAndValidationSamples().

◆ operator=()

template<class TInputImage , class TMaskImage = otb::Image<unsigned char>, class TSampler = otb::PeriodicSampler>
void otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::operator= ( const Self &  )
privatedelete

◆ SetFieldName()

template<class TInputImage , class TMaskImage , class TSampler >
void otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::SetFieldName ( std::string  key)

Set the field name containing class names

Definition at line 364 of file otbOGRDataToSamplePositionFilter.hxx.

◆ SetInput()

template<class TInputImage , class TMaskImage , class TSampler >
void otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::SetInput ( const TInputImage *  image)
virtual

Set the input image

Definition at line 328 of file otbOGRDataToSamplePositionFilter.hxx.

◆ SetLayerIndex()

template<class TInputImage , class TMaskImage , class TSampler >
void otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::SetLayerIndex ( int  index)

Set the layer index containing sampling areas

Definition at line 376 of file otbOGRDataToSamplePositionFilter.hxx.

◆ SetMask()

template<class TInputImage , class TMaskImage , class TSampler >
void otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::SetMask ( const TMaskImage *  mask)

Set the input mask (optional)

Definition at line 352 of file otbOGRDataToSamplePositionFilter.hxx.

◆ SetOGRData()

template<class TInputImage , class TMaskImage , class TSampler >
void otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::SetOGRData ( const otb::ogr::DataSource *  data)

Set the input OGRDataSource containing sampling areas

Definition at line 340 of file otbOGRDataToSamplePositionFilter.hxx.

◆ SetOriginFieldName()

template<class TInputImage , class TMaskImage , class TSampler >
void otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::SetOriginFieldName ( std::string  key)

Set the field name storing the original FID of each sample

Definition at line 419 of file otbOGRDataToSamplePositionFilter.hxx.

◆ SetOutputPositionContainerAndRates()

template<class TInputImage , class TMaskImage , class TSampler >
void otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::SetOutputPositionContainerAndRates ( otb::ogr::DataSource *  data,
const SamplingRateCalculator::MapRateType &  map,
unsigned int  level = 0 
)

Set the output container with the associated rates at a given level.

Definition at line 405 of file otbOGRDataToSamplePositionFilter.hxx.

◆ SetSamplerParameters()

template<class TInputImage , class TMaskImage , class TSampler >
void otb::OGRDataToSamplePositionFilter< TInputImage, TMaskImage, TSampler >::SetSamplerParameters ( SamplerParameterType  param,
unsigned int  level = 0 
)

Set the sampling parameters for all classes at a given level.

Definition at line 388 of file otbOGRDataToSamplePositionFilter.hxx.

The documentation for this class was generated from the following files:
Generated at Mon Mar 24 2025 11:05:55 for OTB with   doxygen 1.8.17