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

#include <otbSarConcatenateBurstsImageFilter.h>

+ Inheritance diagram for otb::SarConcatenateBurstsImageFilter< TImage >:
+ Collaboration diagram for otb::SarConcatenateBurstsImageFilter< TImage >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef ImageType::Pointer ImagePointerType
 
typedef TImage ImageType
 
typedef std::vector< RecordTypeLinesRecordVectorType
 
typedef itk::SmartPointer< SelfPointer
 
typedef ImageType::PointType PointType
 
typedef std::pair< unsigned
long, unsigned long > 
RecordType
 
typedef ImageType::RegionType RegionType
 
typedef
SarConcatenateBurstsImageFilter 
Self
 
typedef ImageType::SizeType SizeType
 
typedef TileImageFilter< TImage > Superclass
 
- Public Types inherited from otb::TileImageFilter< TImage >
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef ImageType::Pointer ImagePointerType
 
typedef TImage ImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef ImageType::RegionType RegionType
 
typedef TileImageFilter Self
 
typedef ImageType::SizeType SizeType
 
typedef
itk::ImageToImageFilter
< TImage, TImage > 
Superclass
 
- Public Types inherited from itk::ImageToImageFilter< TImage, TImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TImage InputImageType
 
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef SmartPointer< SelfPointer
 
typedef ImageToImageFilter Self
 
typedef ImageSource< TImage > Superclass
 
- Public Types inherited from itk::ImageSource< TOutputImage >
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 TOutputImage 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
 
bool getDeburstLinesAndSamples (LinesRecordVectorType &linesRecord, LinesRecordVectorType &samplesRecord, unsigned int first_burstInd, bool inputWithInvalidPixels)
 
virtual const char * GetNameOfClass () const
 
void SetSLCImageKeyWorList (ImageKeywordlist sarImageKWL)
 
- Public Member Functions inherited from otb::TileImageFilter< TImage >
virtual const SizeTypeGetLayout () const
 
virtual void SetLayout (SizeType _arg)
 
- Public Member Functions inherited from itk::ImageToImageFilter< TImage, TImage >
virtual double GetCoordinateTolerance () const
 
virtual double GetDirectionTolerance () const
 
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
virtual void PopBackInput () override
 
virtual void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual void SetDirectionTolerance (double _arg)
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const TImage *image)
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
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 (ProcessObject::DataObjectPointerArraySizeType idx) override
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (const ProcessObject::DataObjectIdentifierType &) 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 otb::TileImageFilter< TImage >
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 ()
 

Protected Member Functions

void GenerateOutputInformation () override
 
 SarConcatenateBurstsImageFilter ()=default
 
 ~SarConcatenateBurstsImageFilter ()=default
 
- Protected Member Functions inherited from otb::TileImageFilter< TImage >
void GenerateInputRequestedRegion () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void ThreadedGenerateData (const RegionType &outputRegionForThread, itk::ThreadIdType threadId) override
 
 TileImageFilter ()
 
void VerifyInputInformation () override
 
 ~TileImageFilter () override
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TImage, TImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
 ImageToImageFilter ()
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
 ~ImageToImageFilter ()
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
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 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
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
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 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

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

Private Attributes

ImageKeywordlist m_DeburstSLCImageKWL
 
unsigned int m_Offset_OriginL
 
ImageKeywordlist m_SLCImageKWL
 

Additional Inherited Members

- Static Public Attributes inherited from itk::ImageToImageFilter< TImage, TImage >
static const unsigned int InputImageDimension
 
static const unsigned int OutputImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static const unsigned int OutputImageDimension
 
- Protected Types inherited from itk::ImageToImageFilter< TImage, TImage >
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(OutputImageDimension),
itkGetStaticConstMacro(InputImageDimension) > 
InputToOutputRegionCopierType
 
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension) > 
OutputToInputRegionCopierType
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
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 TImage>
class otb::SarConcatenateBurstsImageFilter< TImage >

This filter allows making a spatial mosaic from a set of bursts.

This filter derives from TileImagefilter and produces a spatial mosaic from a set of bursts from Sentinel-1 IW products . The layout parameter allows setting up of the images will be patched together: it is a 2D array containing the number of images in the horizontal direction and vertical direction respectively.

Images can be set using the PushBackInput() or SetInput(unsigned int, Image *) methods. Please note that input images are supposed to be set in the lexicographical order.

This filter does not support missing images: the number of input images must match exactly layout[0]*layout[1]. Additional consistency checks are that the number of components and spacing must be consistent for all images, and the size of the images must match with each others.

Metadata are adapted in order to correspond to the contatenated SAR image.

Definition at line 57 of file otbSarConcatenateBurstsImageFilter.h.

Member Typedef Documentation

template<class TImage >
typedef itk::SmartPointer<const Self> otb::SarConcatenateBurstsImageFilter< TImage >::ConstPointer

Definition at line 65 of file otbSarConcatenateBurstsImageFilter.h.

template<class TImage >
typedef ImageType::Pointer otb::SarConcatenateBurstsImageFilter< TImage >::ImagePointerType

Definition at line 69 of file otbSarConcatenateBurstsImageFilter.h.

template<class TImage >
typedef TImage otb::SarConcatenateBurstsImageFilter< TImage >::ImageType

Helper typedefs

Definition at line 68 of file otbSarConcatenateBurstsImageFilter.h.

template<class TImage >
typedef std::vector<RecordType> otb::SarConcatenateBurstsImageFilter< TImage >::LinesRecordVectorType

Definition at line 75 of file otbSarConcatenateBurstsImageFilter.h.

template<class TImage >
typedef itk::SmartPointer<Self> otb::SarConcatenateBurstsImageFilter< TImage >::Pointer

Definition at line 64 of file otbSarConcatenateBurstsImageFilter.h.

template<class TImage >
typedef ImageType::PointType otb::SarConcatenateBurstsImageFilter< TImage >::PointType

Definition at line 72 of file otbSarConcatenateBurstsImageFilter.h.

template<class TImage >
typedef std::pair<unsigned long, unsigned long> otb::SarConcatenateBurstsImageFilter< TImage >::RecordType

Definition at line 74 of file otbSarConcatenateBurstsImageFilter.h.

template<class TImage >
typedef ImageType::RegionType otb::SarConcatenateBurstsImageFilter< TImage >::RegionType

Definition at line 71 of file otbSarConcatenateBurstsImageFilter.h.

Standard class typedef

Definition at line 62 of file otbSarConcatenateBurstsImageFilter.h.

template<class TImage >
typedef ImageType::SizeType otb::SarConcatenateBurstsImageFilter< TImage >::SizeType

Definition at line 70 of file otbSarConcatenateBurstsImageFilter.h.

template<class TImage >
typedef TileImageFilter<TImage> otb::SarConcatenateBurstsImageFilter< TImage >::Superclass

Definition at line 63 of file otbSarConcatenateBurstsImageFilter.h.

Constructor & Destructor Documentation

template<class TImage >
otb::SarConcatenateBurstsImageFilter< TImage >::SarConcatenateBurstsImageFilter ( )
protecteddefault

Constructor

template<class TImage >
otb::SarConcatenateBurstsImageFilter< TImage >::~SarConcatenateBurstsImageFilter ( )
protecteddefault

Destructor

template<class TImage >
otb::SarConcatenateBurstsImageFilter< TImage >::SarConcatenateBurstsImageFilter ( const Self )
privatedelete

Member Function Documentation

template<class TImage >
virtual::itk::LightObject::Pointer otb::SarConcatenateBurstsImageFilter< TImage >::CreateAnother ( void  ) const
virtual

Reimplemented from otb::TileImageFilter< TImage >.

template<class TImage >
void otb::SarConcatenateBurstsImageFilter< TImage >::GenerateOutputInformation ( void  )
overrideprotectedvirtual

Generate input requested region method

Reimplemented from otb::TileImageFilter< TImage >.

Definition at line 74 of file otbSarConcatenateBurstsImageFilter.hxx.

template<class TImage >
bool otb::SarConcatenateBurstsImageFilter< TImage >::getDeburstLinesAndSamples ( LinesRecordVectorType linesRecord,
LinesRecordVectorType samplesRecord,
unsigned int  first_burstInd,
bool  inputWithInvalidPixels 
)
template<class TImage >
virtual const char* otb::SarConcatenateBurstsImageFilter< TImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from otb::TileImageFilter< TImage >.

template<class TImage >
static Pointer otb::SarConcatenateBurstsImageFilter< TImage >::New ( )
static

Method for creation through the object factory.

template<class TImage >
void otb::SarConcatenateBurstsImageFilter< TImage >::operator= ( const Self )
privatedelete
template<class TImage >
void otb::SarConcatenateBurstsImageFilter< TImage >::SetSLCImageKeyWorList ( ImageKeywordlist  sarImageKWL)

Definition at line 33 of file otbSarConcatenateBurstsImageFilter.hxx.

Member Data Documentation

template<class TImage >
ImageKeywordlist otb::SarConcatenateBurstsImageFilter< TImage >::m_DeburstSLCImageKWL
private

Definition at line 108 of file otbSarConcatenateBurstsImageFilter.h.

template<class TImage >
unsigned int otb::SarConcatenateBurstsImageFilter< TImage >::m_Offset_OriginL
private

Definition at line 110 of file otbSarConcatenateBurstsImageFilter.h.

template<class TImage >
ImageKeywordlist otb::SarConcatenateBurstsImageFilter< TImage >::m_SLCImageKWL
private

Definition at line 105 of file otbSarConcatenateBurstsImageFilter.h.


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