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::GDALOverviewsBuilder Class Reference

#include <otbGDALOverviewsBuilder.h>

+ Inheritance diagram for otb::GDALOverviewsBuilder:
+ Collaboration diagram for otb::GDALOverviewsBuilder:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef GDALOverviewsBuilder Self
 
typedef itk::Size< 2 > Size
 
typedef std::vector< SizeSizeVector
 
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

unsigned int CountResolutions (unsigned int factor, unsigned int size) const
 
unsigned int CountResolutions (unsigned int size) const
 
unsigned int CountResolutions () const
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
GDALCompression GetCompressionMethod () const
 
vcl_size_t GetEstimatedSize () const
 
GDALFormat GetFormat () const
 
unsigned int GetHeight () const
 
const std::string & GetInputFileName () const
 
unsigned int GetNbResolutions () const
 
unsigned int GetOverviewsCount () const
 
GDALResampling GetResamplingMethod () const
 
unsigned int GetResolutionFactor () const
 
unsigned int GetWidth () const
 
bool IsBypassEnabled () const
 
void ListResolutions (SizeVector &, unsigned int factor, unsigned int count)
 
void ListResolutions (SizeVector &)
 
void SetBypassEnabled (bool)
 
void SetCompressionMethod (GDALCompression)
 
void SetFormat (GDALFormat)
 
void SetInputFileName (const std::string &str)
 
void SetNbResolutions (unsigned int)
 
void SetResamplingMethod (GDALResampling)
 
void SetResolutionFactor (unsigned int)
 
void Update () 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
 
virtual const char * GetNameOfClass () 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 DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
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 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 bool CanGenerateOverviews (const std::string &filename)
 
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

 GDALOverviewsBuilder ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~GDALOverviewsBuilder () override
 
- 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 GenerateData ()
 
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 ()
 
 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

 GDALOverviewsBuilder (const Self &)=delete
 
void OpenDataset (const std::string &filename)
 
void operator= (const Self &)=delete
 

Private Attributes

GDALCompression m_CompressionMethod
 
GDALFormat m_Format
 
GDALDatasetWrapper::Pointer m_GDALDataset
 
std::string m_InputFileName
 
bool m_IsBypassEnabled: 1
 
unsigned int m_NbResolutions
 
GDALResampling m_ResamplingMethod
 
unsigned int m_ResolutionFactor
 

Additional Inherited Members

- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Detailed Description

Definition at line 86 of file otbGDALOverviewsBuilder.h.

Member Typedef Documentation

Definition at line 92 of file otbGDALOverviewsBuilder.h.

Definition at line 91 of file otbGDALOverviewsBuilder.h.

Definition at line 89 of file otbGDALOverviewsBuilder.h.

Definition at line 94 of file otbGDALOverviewsBuilder.h.

Definition at line 95 of file otbGDALOverviewsBuilder.h.

Definition at line 90 of file otbGDALOverviewsBuilder.h.

Constructor & Destructor Documentation

otb::GDALOverviewsBuilder::GDALOverviewsBuilder ( )
protected
otb::GDALOverviewsBuilder::~GDALOverviewsBuilder ( )
inlineoverrideprotected

Definition at line 170 of file otbGDALOverviewsBuilder.h.

otb::GDALOverviewsBuilder::GDALOverviewsBuilder ( const Self )
privatedelete

Member Function Documentation

static bool otb::GDALOverviewsBuilder::CanGenerateOverviews ( const std::string &  filename)
static
unsigned int otb::GDALOverviewsBuilder::CountResolutions ( unsigned int  factor,
unsigned int  size 
) const

Count the number of resolution levels larger than factor^n.

unsigned int otb::GDALOverviewsBuilder::CountResolutions ( unsigned int  size) const
unsigned int otb::GDALOverviewsBuilder::CountResolutions ( ) const
virtual::itk::LightObject::Pointer otb::GDALOverviewsBuilder::CreateAnother ( void  ) const
virtual

Reimplemented from itk::Object.

GDALCompression otb::GDALOverviewsBuilder::GetCompressionMethod ( ) const
vcl_size_t otb::GDALOverviewsBuilder::GetEstimatedSize ( ) const
GDALFormat otb::GDALOverviewsBuilder::GetFormat ( ) const
unsigned int otb::GDALOverviewsBuilder::GetHeight ( ) const
const std::string& otb::GDALOverviewsBuilder::GetInputFileName ( ) const
unsigned int otb::GDALOverviewsBuilder::GetNbResolutions ( ) const
unsigned int otb::GDALOverviewsBuilder::GetOverviewsCount ( ) const
GDALResampling otb::GDALOverviewsBuilder::GetResamplingMethod ( ) const
unsigned int otb::GDALOverviewsBuilder::GetResolutionFactor ( ) const
unsigned int otb::GDALOverviewsBuilder::GetWidth ( ) const
bool otb::GDALOverviewsBuilder::IsBypassEnabled ( ) const
void otb::GDALOverviewsBuilder::ListResolutions ( SizeVector ,
unsigned int  factor,
unsigned int  count 
)
void otb::GDALOverviewsBuilder::ListResolutions ( SizeVector )
static Pointer otb::GDALOverviewsBuilder::New ( )
static

Method for creation through the object factory.

void otb::GDALOverviewsBuilder::OpenDataset ( const std::string &  filename)
private
void otb::GDALOverviewsBuilder::operator= ( const Self )
privatedelete
void otb::GDALOverviewsBuilder::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotectedvirtual

Reimplemented from itk::ProcessObject.

void otb::GDALOverviewsBuilder::SetBypassEnabled ( bool  )
void otb::GDALOverviewsBuilder::SetCompressionMethod ( GDALCompression  )
void otb::GDALOverviewsBuilder::SetFormat ( GDALFormat  )
void otb::GDALOverviewsBuilder::SetInputFileName ( const std::string &  str)
void otb::GDALOverviewsBuilder::SetNbResolutions ( unsigned  int)
void otb::GDALOverviewsBuilder::SetResamplingMethod ( GDALResampling  )
void otb::GDALOverviewsBuilder::SetResolutionFactor ( unsigned  int)
void otb::GDALOverviewsBuilder::Update ( )
overridevirtual

Reimplemented from itk::ProcessObject.

Member Data Documentation

GDALCompression otb::GDALOverviewsBuilder::m_CompressionMethod
private

Definition at line 190 of file otbGDALOverviewsBuilder.h.

GDALFormat otb::GDALOverviewsBuilder::m_Format
private

Definition at line 191 of file otbGDALOverviewsBuilder.h.

GDALDatasetWrapper::Pointer otb::GDALOverviewsBuilder::m_GDALDataset
private

Definition at line 185 of file otbGDALOverviewsBuilder.h.

std::string otb::GDALOverviewsBuilder::m_InputFileName
private

Definition at line 186 of file otbGDALOverviewsBuilder.h.

bool otb::GDALOverviewsBuilder::m_IsBypassEnabled
private

Definition at line 192 of file otbGDALOverviewsBuilder.h.

unsigned int otb::GDALOverviewsBuilder::m_NbResolutions
private

Definition at line 187 of file otbGDALOverviewsBuilder.h.

GDALResampling otb::GDALOverviewsBuilder::m_ResamplingMethod
private

Definition at line 189 of file otbGDALOverviewsBuilder.h.

unsigned int otb::GDALOverviewsBuilder::m_ResolutionFactor
private

Definition at line 188 of file otbGDALOverviewsBuilder.h.


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