OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | List of all members
otb::VariadicInputsImageFilter< TOuptut, TInputs > Class Template Reference

#include <otbVariadicInputsImageFilter.h>

+ Inheritance diagram for otb::VariadicInputsImageFilter< TOuptut, TInputs >:
+ Collaboration diagram for otb::VariadicInputsImageFilter< TOuptut, TInputs >:

Public Types

using ConstPointer = itk::SmartPointer< const Self >
 
template<vcl_size_t I>
using InputImageType = typename std::tuple_element< I, InputTypesTupleType >::type
 
using InputTypesTupleType = std::tuple< TInputs...>
 
using Pointer = itk::SmartPointer< Self >
 
using Self = VariadicInputsImageFilter< TOuptut, TInputs...>
 
using Superclass = itk::ImageSource< TOuptut >
 
- Public Types inherited from itk::ImageSource< TOuptut >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOuptut OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageSource Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
 DefineLegacySetInputMacro (1)
 
 DefineLegacySetInputMacro (2)
 
 DefineLegacySetInputMacro (3)
 
 DefineLegacySetInputMacro (4)
 
 DefineLegacySetInputMacro (5)
 
 DefineLegacySetInputMacro (6)
 
 DefineLegacySetInputMacro (7)
 
 DefineLegacySetInputMacro (8)
 
 DefineLegacySetInputMacro (9)
 
 DefineLegacySetInputMacro (10)
 
template<std::vcl_size_t I = 0>
const InputImageType< I > * GetInput ()
 
template<std::vcl_size_t I = 0>
void SetInput (const InputImageType< I > *inputPtr)
 
void SetInputs (TInputs *...inputs)
 
auto GetInputs ()
 
- Public Member Functions inherited from itk::ImageSource< TOuptut >
virtual const char * GetNameOfClass () const
 
OutputImageTypeGetOutput (unsigned int idx)
 
const OutputImageTypeGetOutput () const
 
OutputImageTypeGetOutput ()
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void GraftOutput (DataObject *output)
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual bool GetReleaseDataFlag () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
void ReleaseDataFlagOff ()
 
void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr vcl_size_t NumberOfInputs = std::tuple_size<InputTypesTupleType>::value
 
- Static Public Attributes inherited from itk::ImageSource< TOuptut >
static const unsigned int OutputImageDimension
 

Protected Member Functions

 VariadicInputsImageFilter ()
 
 ~VariadicInputsImageFilter ()=default
 
- Protected Member Functions inherited from itk::ImageSource< TOuptut >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual void GenerateData () override
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual ~ImageSource ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual const char * GetPrimaryOutputName (void) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

template<vcl_size_t... Is>
auto GetInputsImpl (std::index_sequence< Is...>)
 
void operator= (const Self &)=delete
 
template<class Tuple , vcl_size_t... Is>
auto SetInputsImpl (Tuple &t, std::index_sequence< Is...>)
 
 VariadicInputsImageFilter (const Self &)=delete
 

Additional Inherited Members

- Static Protected Member Functions inherited from itk::ImageSource< TOuptut >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Detailed Description

template<class TOuptut, class... TInputs>
class otb::VariadicInputsImageFilter< TOuptut, TInputs >

Base class for image filter with variadic inputs.

This filter act as a base class for all filters that will take several input images with different types and produce an output image.

Type for each input is taken from the variadic template parameter TInputs.

Inputs get be set/get with SetInput<N>() and GetInput<N>(), when N is the index (first input is 0) of the input. This is resolved at compile time: you can not call SetInput<N>() with an argument not matching the Nth input type (it will lead to type mismatch compilation error).

Note that you can also call SetInput() and GetInput() which will automatically fetch the first input.

Alternatively, you can call SetInputs() with all the input image in the same order as in the template parameters.

Last, there is a macro that generates SetInput1() ... SetInput10() (iff the number of varidic input types is large enough) for backward compatibility.

Definition at line 56 of file otbVariadicInputsImageFilter.h.

Member Typedef Documentation

template<class TOuptut, class... TInputs>
using otb::VariadicInputsImageFilter< TOuptut, TInputs >::ConstPointer = itk::SmartPointer<const Self>

Definition at line 61 of file otbVariadicInputsImageFilter.h.

template<class TOuptut, class... TInputs>
template<vcl_size_t I>
using otb::VariadicInputsImageFilter< TOuptut, TInputs >::InputImageType = typename std::tuple_element<I,InputTypesTupleType>::type

Definition at line 67 of file otbVariadicInputsImageFilter.h.

template<class TOuptut, class... TInputs>
using otb::VariadicInputsImageFilter< TOuptut, TInputs >::InputTypesTupleType = std::tuple<TInputs...>

Definition at line 65 of file otbVariadicInputsImageFilter.h.

template<class TOuptut, class... TInputs>
using otb::VariadicInputsImageFilter< TOuptut, TInputs >::Pointer = itk::SmartPointer<Self>

Definition at line 60 of file otbVariadicInputsImageFilter.h.

template<class TOuptut, class... TInputs>
using otb::VariadicInputsImageFilter< TOuptut, TInputs >::Self = VariadicInputsImageFilter<TOuptut, TInputs...>

Definition at line 59 of file otbVariadicInputsImageFilter.h.

template<class TOuptut, class... TInputs>
using otb::VariadicInputsImageFilter< TOuptut, TInputs >::Superclass = itk::ImageSource<TOuptut>

Definition at line 62 of file otbVariadicInputsImageFilter.h.

Constructor & Destructor Documentation

template<class TOuptut, class... TInputs>
otb::VariadicInputsImageFilter< TOuptut, TInputs >::VariadicInputsImageFilter ( )
inlineprotected

Definition at line 138 of file otbVariadicInputsImageFilter.h.

template<class TOuptut, class... TInputs>
otb::VariadicInputsImageFilter< TOuptut, TInputs >::~VariadicInputsImageFilter ( )
protecteddefault
template<class TOuptut, class... TInputs>
otb::VariadicInputsImageFilter< TOuptut, TInputs >::VariadicInputsImageFilter ( const Self )
privatedelete

Member Function Documentation

template<class TOuptut, class... TInputs>
virtual::itk::LightObject::Pointer otb::VariadicInputsImageFilter< TOuptut, TInputs >::CreateAnother ( void  ) const
virtual

Reimplemented from itk::Object.

template<class TOuptut, class... TInputs>
otb::VariadicInputsImageFilter< TOuptut, TInputs >::DefineLegacySetInputMacro ( )
template<class TOuptut, class... TInputs>
otb::VariadicInputsImageFilter< TOuptut, TInputs >::DefineLegacySetInputMacro ( )
template<class TOuptut, class... TInputs>
otb::VariadicInputsImageFilter< TOuptut, TInputs >::DefineLegacySetInputMacro ( )
template<class TOuptut, class... TInputs>
otb::VariadicInputsImageFilter< TOuptut, TInputs >::DefineLegacySetInputMacro ( )
template<class TOuptut, class... TInputs>
otb::VariadicInputsImageFilter< TOuptut, TInputs >::DefineLegacySetInputMacro ( )
template<class TOuptut, class... TInputs>
otb::VariadicInputsImageFilter< TOuptut, TInputs >::DefineLegacySetInputMacro ( )
template<class TOuptut, class... TInputs>
otb::VariadicInputsImageFilter< TOuptut, TInputs >::DefineLegacySetInputMacro ( )
template<class TOuptut, class... TInputs>
otb::VariadicInputsImageFilter< TOuptut, TInputs >::DefineLegacySetInputMacro ( )
template<class TOuptut, class... TInputs>
otb::VariadicInputsImageFilter< TOuptut, TInputs >::DefineLegacySetInputMacro ( )
template<class TOuptut, class... TInputs>
otb::VariadicInputsImageFilter< TOuptut, TInputs >::DefineLegacySetInputMacro ( 10  )
template<class TOuptut, class... TInputs>
template<std::vcl_size_t I = 0>
const InputImageType<I>* otb::VariadicInputsImageFilter< TOuptut, TInputs >::GetInput ( void  )
inline
template<class TOuptut, class... TInputs>
auto otb::VariadicInputsImageFilter< TOuptut, TInputs >::GetInputs ( )
inline
Returns
A tuple with all inputs

Definition at line 131 of file otbVariadicInputsImageFilter.h.

template<class TOuptut, class... TInputs>
template<vcl_size_t... Is>
auto otb::VariadicInputsImageFilter< TOuptut, TInputs >::GetInputsImpl ( std::index_sequence< Is...>  )
inlineprivate
template<class TOuptut, class... TInputs>
static Pointer otb::VariadicInputsImageFilter< TOuptut, TInputs >::New ( )
static
template<class TOuptut, class... TInputs>
void otb::VariadicInputsImageFilter< TOuptut, TInputs >::operator= ( const Self )
privatedelete
template<class TOuptut, class... TInputs>
template<std::vcl_size_t I = 0>
void otb::VariadicInputsImageFilter< TOuptut, TInputs >::SetInput ( const InputImageType< I > *  inputPtr)
inline
Parameters
Setthe Ith input

Definition at line 82 of file otbVariadicInputsImageFilter.h.

template<class TOuptut, class... TInputs>
void otb::VariadicInputsImageFilter< TOuptut, TInputs >::SetInputs ( TInputs *...  inputs)
inline
Parameters
inputsA vararg list of inputs

Definition at line 121 of file otbVariadicInputsImageFilter.h.

template<class TOuptut, class... TInputs>
template<class Tuple , vcl_size_t... Is>
auto otb::VariadicInputsImageFilter< TOuptut, TInputs >::SetInputsImpl ( Tuple &  t,
std::index_sequence< Is...>   
)
inlineprivate

Member Data Documentation

template<class TOuptut, class... TInputs>
constexpr vcl_size_t otb::VariadicInputsImageFilter< TOuptut, TInputs >::NumberOfInputs = std::tuple_size<InputTypesTupleType>::value
static

The documentation for this class was generated from the following file: