ossimGdalOverviewBuilder Class to build overviews from the GDAL library. More...

#include <ossimGdalOverviewBuilder.h>

Inheritance diagram for ossimGdalOverviewBuilder:

Public Types
enum	ossimGdalOverviewType { ossimGdalOverviewType_UNKNOWN = 0, ossimGdalOverviewTiffNearest = 1, ossimGdalOverviewTiffAverage = 2, ossimGdalOverviewHfaNearest = 3, ossimGdalOverviewHfaAverage = 4 }
	Enumerations for the type of GDAL overviews to build. More...

Public Types inherited from ossimConnectableObject
enum	ossimConnectableObjectDirectionType { CONNECTABLE_DIRECTION_NONE = 0, CONNECTABLE_DIRECTION_INPUT = 1, CONNECTABLE_DIRECTION_OUTPUT = 2 }

typedef std::vector< ossimRefPtr< ossimConnectableObject > >	ConnectableObjectList

Public Types inherited from ossimProcessInterface
enum	ossimProcessStatus { PROCESS_STATUS_UNKNOWN = 0, PROCESS_STATUS_EXECUTING = 1, PROCESS_STATUS_ABORTED = 2, PROCESS_STATUS_ABORT_REQUEST = 3, PROCESS_STATUS_NOT_EXECUTING = 4 }

Public Member Functions
	ossimGdalOverviewBuilder ()
	default constructor More...

virtual	~ossimGdalOverviewBuilder ()
	virtual destructor More...

bool	open (const ossimFilename &file)
	Open that takes a file name. More...

virtual bool	execute ()
	Builds the overviews. More...

virtual bool	setInputSource (ossimImageHandler *imageSource)
	Sets the input to the builder. More...

virtual void	setOutputFile (const ossimFilename &file)
	Sets the output filename. More...

virtual ossimFilename	getOutputFile () const
	Returns the output. More...

virtual bool	setOverviewType (const ossimString &type)
	Sets the overview output type. More...

virtual ossimString	getOverviewType () const
	Gets the overview type. More...

virtual void	getTypeNameList (std::vector< ossimString > &typeList) const
	Method to populate class supported types. More...

virtual ossimObject *	getObject ()

virtual const ossimObject *	getObject () const

virtual bool	canConnectMyInputTo (ossim_int32 index, const ossimConnectableObject *obj) const

virtual void	setProperty (ossimRefPtr< ossimProperty > property)
	Method to set properties. More...

virtual void	getPropertyNames (std::vector< ossimString > &propertyNames) const
	Method to populate the list of property names. More...

virtual std::ostream &	print (std::ostream &out) const
	print method. More...

Public Member Functions inherited from ossimOverviewBuilderBase
	ossimOverviewBuilderBase ()
	default constructor More...

virtual bool	setOutputWriter (ossimImageFileWriter *outputWriter)
	Sets an optional file writer to the builder. More...

virtual bool	hasOverviewType (const ossimString &type) const
	Method to check if builder can handle type. More...

virtual ossim_uint32	getOverviewStopDimension () const
	Get the overview stop dimension. More...

virtual void	setOverviewStopDimension (ossim_uint32 dim)
	Sets the overview stop dimension. More...

ossimHistogramMode	getHistogramMode () const
	Gets the histogram accumulation mode. More...

void	setHistogramMode (ossimHistogramMode mode)
	Sets the histogram accumulation mode. More...

virtual void	finalize ()
	Finalize method. More...

void	setBitMaskSpec (const ossimKeywordlist &bit_mask_spec)
	Specifies parameters (in KWL) for generation of an alpha (bit) mask such that any full or partial null pixels will be masked out. More...

void	setScanForMinMax (bool flag)
	Turn on/off scan for min max flag. More...

bool	getScanForMinMax () const

void	setScanForMinMaxNull (bool flag)
	Turn on/off scan for min, max, null flag. More...

bool	getScanForMinMaxNull () const

Public Member Functions inherited from ossimSource
	ossimSource (ossimObject *owner=0)

	ossimSource (ossimObject *owner, ossim_uint32 inputListSize, ossim_uint32 outputListSize, bool inputListIsFixedFlag=true, bool outputListIsFixedFlag=true)

virtual	~ossimSource ()

virtual bool	isSourceEnabled () const

virtual void	enableSource ()

virtual void	disableSource ()

virtual bool	getEnableFlag () const

virtual void	setEnableFlag (bool flag)

virtual bool	isInitialized () const

virtual void	setInitializedFlag (bool flag)

virtual void	initialize ()

virtual ossimRefPtr< ossimProperty >	getProperty (const ossimString &name) const

virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const

virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)

Public Member Functions inherited from ossimConnectableObject
	ossimConnectableObject (ossimObject *owner=0)
	Base constructor of this object. More...

	ossimConnectableObject (ossimObject *owner, ossim_int32 inputListSize, ossim_int32 outputListSize, bool inputListIsFixedFlag=true, bool outputListIsFixedFlag=true)

virtual	~ossimConnectableObject ()

void	setId (const ossimId &id)
	All connectable objects will have id's. More...

const ossimId &	getId () const
	Will allow us to get this object's id. More...

const ossimObject *	getOwner () const
	Fetches the current owner, most likely a container but not limited to one. More...

virtual void	changeOwner (ossimObject *owner)
	Permits changing the object's owner. More...

virtual void	setDescription (const ossimString &description)

virtual ossimString	getDescription () const

virtual bool	isConnected (ossimConnectableObjectDirectionType direction=CONNECTABLE_DIRECTION_INPUT) const
	will check the direction specified to see if all slots are full. More...

	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findConnectableObject(const ossimId &id))

	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findObjectOfType(RTTItypeid typeId, ossimConnectableObjectDirectionType directionType, bool recurse=true))

	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findObjectOfType(const ossimString &obj, ossimConnectableObjectDirectionType directionType, bool recurse=true))

	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findInputObjectOfType(const ossimString &className))

virtual ossim_int32	findInputIndex (const ossimConnectableObject *object)
	Return a valid index of the input list if the passed in object is found else return -1. More...

virtual ossim_int32	findInputIndex (const ossimId &id)
	Return a valid index of the input list if the passed id is found else return -1. More...

virtual ossim_int32	findOutputIndex (const ossimConnectableObject *object)
	Return a valid index of the output list if the passed in object is found else return -1. More...

virtual ossim_int32	findOutputIndex (const ossimId &id)
	Return a valid index of the output list if the passed in object is found else return -1. More...

virtual ossim_int32	getMyInputIndexToConnectTo (ossimConnectableObject *object) const
	Should return the first available index to connect to. More...

virtual ossim_int32	getMyOutputIndexToConnectTo (ossimConnectableObject *object) const
	Should return the first available index to connect to. More...

virtual bool	canConnectMyOutputTo (ossim_int32 myOutputIndex, const ossimConnectableObject *object) const
	default implementation is to allow anyone to connect to us. More...

virtual void	disconnect (ossimConnectableObject *object=0)
	Will disconnect the object passed in. More...

virtual void	disconnect (const ossimId &id)
	Will disconnect the object passed in. More...

virtual ossimRefPtr< ossimConnectableObject >	disconnectMyInput (ossim_int32 inputIndex, bool disconnectOutputFlag=true, bool createEventFlag=true)
	Will disconnect the object at the given input index and generate a connection event. More...

virtual void	disconnectMyInput (ossimConnectableObject *input, bool disconnectOutputFlag=true, bool createEventFlag=true)
	Finds the index of the passed in input and calls disconnectMyInput(inputIndex, disconnectOutputFlag, createEventFlag);. More...

virtual void	disconnectMyInputs (ConnectableObjectList &inputList, bool disconnectOutputFlag=true, bool createEventFlag=true)

virtual ossimRefPtr< ossimConnectableObject >	disconnectMyOutput (ossim_int32 outputIndex, bool disconnectInputFlag=true, bool createEventFlag=true)
	Will disconnect the object at the given output index and generate a connection event. More...

virtual void	disconnectMyOutput (ossimConnectableObject *output, bool disconnectInputFlag=true, bool createEventFlag=true)
	Will disconnect the output object. More...

virtual void	disconnectMyOutputs (ConnectableObjectList &outputList, bool disconnectOutputFlag=true, bool createEventFlag=true)

virtual void	disconnectAllInputs ()
	Will disconnect all of the input objects. More...

virtual void	disconnectAllOutputs ()
	Will disconnect all of the output objects. More...

virtual ossim_int32	connectMyInputTo (ossimConnectableObject *inputObject, bool makeOutputConnection=true, bool createEventFlag=true)
	Will try to connect this objects input to the passed in object. More...

virtual ossim_int32	connectMyInputTo (ossim_int32 inputIndex, ossimConnectableObject *inputObject, bool makeOutputConnection=true, bool createEventFlag=true)
	Will connect the specified input to the passed in object. More...

virtual bool	connectMyInputTo (ConnectableObjectList &inputList, bool makeOutputConnection=true, bool createEventFlag=true)

virtual ossim_int32	connectMyOutputTo (ossimConnectableObject *outputObject, bool makeInputConnection=true, bool createEventFlag=true)
	Will try to connect this objects output to the passed in object. More...

virtual bool	connectMyOutputTo (ConnectableObjectList &outputList, bool makeInputConnection=true, bool createEventFlag=true)

virtual bool	connectInputList (ConnectableObjectList &inputList)
	Will disconnect itself from all inputs and reset to the passed in input list. More...

virtual bool	connectOutputList (ConnectableObjectList &outputList)
	Will disconnect itself from all outputs and reset to the passed in output list. More...

virtual ossim_uint32	getNumberOfInputs () const
	Returns the number of input objects. More...

virtual ossim_uint32	getNumberOfOutputs () const
	Return the number of output objects. More...

ossimConnectableObject *	getInput (ossim_uint32 index=0)
	returns the object at the specified index. More...

const ossimConnectableObject *	getInput (ossim_uint32 index=0) const
	returns the object at the specified index. More...

ossimConnectableObject *	getOutput (ossim_uint32 index=0)
	returns the object at the specified index. More...

const ossimConnectableObject *	getOutput (ossim_uint32 index=0) const
	returns the object at the specified index. More...

virtual void	setNumberOfInputs (ossim_int32 numberOfInputs)
	Will set the number of inputs. More...

virtual bool	getInputListIsFixedFlag () const

virtual bool	getOutputListIsFixedFlag () const

virtual void	setNumberOfOutputs (ossim_int32 numberOfInputs)
	Will set the number of outputs. More...

const ConnectableObjectList &	getInputList () const

const ConnectableObjectList &	getOutputList () const

ConnectableObjectList &	getInputList ()

ConnectableObjectList &	getOutputList ()

	OSSIM_DEPRECATE_METHOD (virtual void findAllObjectsOfType(ConnectableObjectList &result, const RTTItypeid &typeInfo, bool recurse=true))

	OSSIM_DEPRECATE_METHOD (virtual void findAllObjectsOfType(ConnectableObjectList &result, const ossimString &className, bool recurse=true))

virtual void	propagateEventToOutputs (ossimEvent &event)

virtual void	propagateEventToInputs (ossimEvent &event)

virtual void	setProperty (const ossimString &name, const ossimString &value)

virtual ossim_uint32	saveStateOfAllInputs (ossimKeywordlist &kwl, bool saveThisStateFlag=true, ossim_uint32 objectIndex=1, const char *prefix=0) const
	Save the state of all inputs to a keyword list. More...

virtual bool	fillContainer (ossimConnectableContainer &container)
	Inserts this object and all of its children and inputs into the container provided. More...

bool	moveInputUp (const ossimId &id)
	Moves the input connection matching id up one in the connection list. More...

bool	moveInputDown (const ossimId &id)
	Moves the input connection matching id down one in the connection list. More...

bool	moveInputToTop (const ossimId &id)
	Moves the input connection matching id to the top of the connection list. More...

bool	moveInputToBottom (const ossimId &id)
	Moves the input connection matching id to the bottom of the connection list. More...

virtual void	accept (ossimVisitor &visitor)
	We will add a visitor interface for all connectable objects. More...

Public Member Functions inherited from ossimObject
	ossimObject ()

virtual	~ossimObject ()

virtual ossimObject *	dup () const

virtual ossimString	getShortName () const

virtual ossimString	getLongName () const

virtual ossimString	getClassName () const

virtual RTTItypeid	getType () const

virtual bool	canCastTo (ossimObject *obj) const

virtual bool	canCastTo (const RTTItypeid &id) const

virtual bool	canCastTo (const ossimString &parentClassName) const

virtual bool	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const

Public Member Functions inherited from ossimReferenced
	ossimReferenced ()

	ossimReferenced (const ossimReferenced &)

ossimReferenced &	operator= (const ossimReferenced &)

void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...

void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

int	referenceCount () const

Public Member Functions inherited from ossimListenerManager
	ossimListenerManager ()

virtual	~ossimListenerManager ()

virtual void	fireEvent (ossimEvent &event)

virtual bool	addListener (ossimListener *listener)

virtual bool	removeListener (ossimListener *listener)

virtual bool	findListener (ossimListener *listener)

Public Member Functions inherited from ossimPropertyInterface
	ossimPropertyInterface ()

virtual	~ossimPropertyInterface ()

virtual ossimString	getPropertyValueAsString (const ossimString &name) const

void	getPropertyList (std::vector< ossimRefPtr< ossimProperty > > &propertyList) const

void	setProperties (std::vector< ossimRefPtr< ossimProperty > > &propertyList)

Public Member Functions inherited from ossimErrorStatusInterface
	ossimErrorStatusInterface ()

virtual	~ossimErrorStatusInterface ()

virtual ossimErrorCode	getErrorStatus () const

virtual ossimString	getErrorStatusString () const

virtual void	setErrorStatus (ossimErrorCode error_status) const

virtual void	setErrorStatus () const

virtual void	clearErrorStatus () const

bool	hasError () const

Public Member Functions inherited from ossimProcessInterface
	ossimProcessInterface ()

virtual	~ossimProcessInterface ()

virtual void	abort ()

bool	needsAborting () const

bool	isAbortRequested () const

bool	isAborted () const

bool	isExecuting () const

ossimProcessStatus	getProcessStatus () const

virtual void	setProcessStatus (ossimProcessStatus processStatus)

virtual double	getPercentComplete () const

virtual void	setPercentComplete (double percentComplete)

virtual ossimListenerManager *	getManager ()

void	enableEvents ()

void	disableEvents ()

void	setCurrentMessage (const ossimString &message)

Public Member Functions inherited from ossimConnectableObjectListener
	ossimConnectableObjectListener ()

virtual	~ossimConnectableObjectListener ()

virtual void	processEvent (ossimEvent &event)
	ProcessEvent. More...

virtual void	objectDestructingEvent (ossimObjectDestructingEvent &)

virtual void	connectionEvent (ossimConnectionEvent &)

virtual void	disconnectInputEvent (ossimConnectionEvent &)

virtual void	disconnectOutputEvent (ossimConnectionEvent &)

virtual void	connectInputEvent (ossimConnectionEvent &)

virtual void	connectOutputEvent (ossimConnectionEvent &)

virtual void	propertyEvent (ossimPropertyEvent &)

virtual void	addObjectEvent (ossimContainerEvent &)

virtual void	removeObjectEvent (ossimContainerEvent &)

virtual void	containerEvent (ossimContainerEvent &)

virtual void	refreshEvent (ossimRefreshEvent &)

Public Member Functions inherited from ossimListener
	ossimListener ()

virtual	~ossimListener ()

void	enableListener ()

void	disableListener ()

void	setListenerEnableFlag (bool flag)

bool	isListenerEnabled () const

bool	getListenerEnableFlag () const

Private Member Functions
bool	generateHfaStats () const

ossimString	getGdalResamplingType () const

ossimString	getExtensionFromType () const

Private Attributes
ossimGdalDataset *	theDataset

ossimFilename	theOutputFile

ossimGdalOverviewType	theOverviewType

std::vector< ossim_int32 >	theLevels

bool	theGenerateHfaStatsFlag

Additional Inherited Members
Protected Member Functions inherited from ossimOverviewBuilderBase
virtual	~ossimOverviewBuilderBase ()
	virtual destructor More...

ossim_uint32	getRequiredResLevels (const ossimImageHandler *ih) const
	Gets the required number of res levels. More...

void	initializePreferenceSettings ()
	Initializes preference settings. More...

void	initializeScanOptions ()
	Checks scalar type and turns on scanning for min, max, nulls if needed. More...

Protected Member Functions inherited from ossimSource
	ossimSource (const ossimSource &rhs)

const ossimSource &	operator= (const ossimSource &rhs)

Protected Member Functions inherited from ossimConnectableObject
ossimConnectableObject *	findObjectOfType (ConnectableObjectList *connectableList, ossimVisitor &visitor)

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Member Functions inherited from ossimListenerManager
	ossimListenerManager (const ossimListenerManager &rhs)

Protected Attributes inherited from ossimOverviewBuilderBase
ossim_uint32	m_overviewStopDimension

ossimHistogramMode	m_histoMode

ossimKeywordlist	m_bitMaskSpec

ossimRefPtr< ossimImageHandler >	m_imageHandler

std::vector< ossim_uint32 >	m_originalBandList

ossimRefPtr< ossimBitMaskWriter >	m_maskWriter

ossimRefPtr< ossimMaskFilter >	m_maskFilter

ossimFilename	m_outputFile

bool	m_scanForMinMax

bool	m_scanForMinMaxNull

bool	m_scanFloatData

Protected Attributes inherited from ossimSource
bool	theEnableFlag

bool	theInitializedFlag

Protected Attributes inherited from ossimConnectableObject
ossimId	theId

ossimString	theDescription

ossimObject *	theOwner

bool	theInputListIsFixedFlag
	Indicates whether the theInputObjectList is fixed. More...

bool	theOutputListIsFixedFlag
	Indicates whether the theOutputObjectList is fixed. More...

ConnectableObjectList	theInputObjectList
	Holds a list of input objects. More...

ConnectableObjectList	theOutputObjectList
	Holds a list of output objects. More...

Protected Attributes inherited from ossimListenerManager
std::list< ossimListener * >	theListenerList

bool	theEnabledFlag

std::list< ossimListener * >	theDelayedAdd

std::list< ossimListener * >	theDelayedRemove

bool	theFireEventFlag

Protected Attributes inherited from ossimErrorStatusInterface
ossimErrorCode	theErrorStatus

Protected Attributes inherited from ossimProcessInterface
double	thePercentComplete

ossimProcessStatus	theProcessStatus

ossimString	theMessage

bool	theEventFlag

Protected Attributes inherited from ossimListener
bool	theListenerEnableFlag

Detailed Description

ossimGdalOverviewBuilder Class to build overviews from the GDAL library.

Definition at line 31 of file ossimGdalOverviewBuilder.h.

Member Enumeration Documentation

◆ ossimGdalOverviewType

enum ossimGdalOverviewBuilder::ossimGdalOverviewType

Enumerations for the type of GDAL overviews to build.

Enumerator
ossimGdalOverviewType_UNKNOWN
ossimGdalOverviewTiffNearest
ossimGdalOverviewTiffAverage
ossimGdalOverviewHfaNearest
ossimGdalOverviewHfaAverage

Definition at line 38 of file ossimGdalOverviewBuilder.h.

    {
       ossimGdalOverviewType_UNKNOWN = 0,
       ossimGdalOverviewTiffNearest  = 1,
       ossimGdalOverviewTiffAverage  = 2,
       ossimGdalOverviewHfaNearest   = 3,
       ossimGdalOverviewHfaAverage   = 4
    };

Constructor & Destructor Documentation

◆ ossimGdalOverviewBuilder()

ossimGdalOverviewBuilder::ossimGdalOverviewBuilder ( )

default constructor

Definition at line 38 of file ossimGdalOverviewBuilder.cpp.

    :
    theDataset(0),
    theOutputFile(),
    theOverviewType(ossimGdalOverviewTiffAverage),
    theLevels(0),
    theGenerateHfaStatsFlag(false)
 {
 }

◆ ~ossimGdalOverviewBuilder()

ossimGdalOverviewBuilder::~ossimGdalOverviewBuilder ( )

virtual

virtual destructor

Definition at line 48 of file ossimGdalOverviewBuilder.cpp.

References theDataset.

 {
    if ( theDataset )
    {
       delete theDataset;
       theDataset = 0;
    }
 }

Member Function Documentation

◆ canConnectMyInputTo()

bool ossimGdalOverviewBuilder::canConnectMyInputTo	(	ossim_int32	index,
		const ossimConnectableObject *	obj
	)		const

virtual

Returns: true if input is an image handler. Satisfies pure virtual.

Implements ossimConnectableObject.

Definition at line 494 of file ossimGdalOverviewBuilder.cpp.

References PTR_CAST.

 {
    if ( (index == 0) &&
         PTR_CAST(ossimImageHandler, obj) )
    {
       return true;
    }
 
    return false;
 }

◆ execute()

bool ossimGdalOverviewBuilder::execute ( )

virtual

Builds the overviews.

Returns: true on success, false on error.

Note: If setOutputFile was not called the output name will be derived from the image name. If image was "foo.tif" the overview file will be "foo.rrd" or "foo.ovr".

Implements ossimOverviewBuilderBase.

Definition at line 161 of file ossimGdalOverviewBuilder.cpp.

 {
    if (traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "ossimGdalOverviewBuilder::execute entered..."
          << endl;
    }
 
    bool result = false;
    
    if (!theDataset || !theDataset->getImageHandler())
    {
       return result;
    }
 
    // Get the output file.
    ossimFilename overviewFile = getOutputFile();
 
    // Check the file.  Disallow same file overview building.
    if (theDataset->getImageHandler()->getFilename() == overviewFile)
    {
       ossimNotify(ossimNotifyLevel_WARN)
          << "Source image file and overview file cannot be the same!"
          << std::endl;
       return result;
    }
 
    if (theGenerateHfaStatsFlag)
    {
       theDataset->setGdalAcces(GA_Update);
       theDataset->initGdalOverviewManager();
       if (generateHfaStats() == false)
       {
          cerr << " generateHfaStats failed..." << endl;
       }
       else
       {
          // delete theDataset;
          // return true;
       }
    }
 
    // theDataset->setGdalAcces(GA_Update);
 
    theDataset->initGdalOverviewManager();
    
    // Get the number of bands.
    // ossim_uint32 bands = theDataset->getImageHandler()->
    // getNumberOfOutputBands();
 
    // Get the resampling string.
    ossimString pszResampling = getGdalResamplingType();
 
    // Compute the number of levels.
    ossimIrect bounds = theDataset->getImageHandler()->getBoundingRect();
    ossim_uint32 minBound = ossim::min( bounds.width(), bounds.height() );
 
    //---
    // Set the decimation levels.  If set through the property interface use
    // that; else compute.
    //---
    ossim_int32 numberOfLevels = 0;
 
    if (theLevels.size())
    {
       numberOfLevels = theLevels.size();
    }
    else
    {
       ossim_uint32 stopDim = getOverviewStopDimension();
       while (minBound > stopDim)
       {
          minBound = minBound / 2;
          ++numberOfLevels;
       }
       
       if (numberOfLevels == 0)
       {
          return result; // nothing to do.
       }
    }
    
    ossim_int32* levelDecimationFactor = new ossim_int32[numberOfLevels];
 
    ossim_uint32 idx;
 
    if (theLevels.size())
    {
       for (idx = 0; idx < theLevels.size(); ++idx)
       {
          levelDecimationFactor[idx] = theLevels[idx];
       }
    }
    else
    {
       levelDecimationFactor[0] = 2;
       for(idx = 1; idx < static_cast<ossim_uint32>(numberOfLevels); ++idx)
       {
          levelDecimationFactor[idx] = levelDecimationFactor[idx-1]*2;
       }
    }
    
    if (traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "ossimGdalOverviewBuilder::execute DEBUG:"
          << "\noverviewFilename:   " << overviewFile
          << "\npszResampling:      " << pszResampling
          << "\nnumberOfLevels:     " << numberOfLevels
          << endl;
       for(idx = 0; idx < static_cast<ossim_uint32>(numberOfLevels); ++idx)
       {
          ossimNotify(ossimNotifyLevel_DEBUG)
             << "levelDecimationFactor["
             << idx << "]: " << levelDecimationFactor[idx]
             << endl;
       }
    }
 
    CPLErr eErr = CE_None;
 
    if ( (theOverviewType == ossimGdalOverviewHfaAverage) ||
         (theOverviewType == ossimGdalOverviewHfaNearest) )
    {
       CPLSetConfigOption("USE_RRD", "YES");
    }
 
    if( theDataset->BuildOverviews( pszResampling.c_str(), 
                                    numberOfLevels,
                                    levelDecimationFactor,
                                    0,
                                    0,
                                    GDALTermProgress,
                                    0 ) != CE_None )
    {
       ossimNotify(ossimNotifyLevel_WARN)
          << "Overview building failed." << std::endl;
    }
 
    if ( levelDecimationFactor )
    {
       delete [] levelDecimationFactor;
       levelDecimationFactor = 0;
    }
    
    if (eErr  == CE_None )
    {
       result = true;
    }
 
    if (result == true)
    {
       ossimNotify(ossimNotifyLevel_NOTICE)
          << "Wrote file:  " << overviewFile << std::endl;
    }
 
    return result;
 }

◆ generateHfaStats()

bool ossimGdalOverviewBuilder::generateHfaStats ( ) const

private

Definition at line 378 of file ossimGdalOverviewBuilder.cpp.

References ossimString::c_str(), ossimString::empty(), ossimFilename::file(), ossimImageHandler::getFilename(), ossimGdalDataset::getImageHandler(), getOutputFile(), and theDataset.

 {
    // GDALAllRegister();
    
    //---
    // Equivalent:
    // gdal_translate -of HFA -co AUX=YES -co STATISTICS=YES
    // -co DEPENDENT_FILE=utm.tif utm.tif utm.aux
    //---
    bool result = false;
 
    if (!theDataset)
    {
       return result;
    }
    if (!theDataset->getImageHandler())
    {
       return result;
    }
    
    ossimFilename sourceImageFile =
       theDataset->getImageHandler()->getFilename();
    if (sourceImageFile.empty())
    {
       return result;
    }
 
    // This is the output driver.
    GDALDriverH hDriver = GDALGetDriverByName( "HFA" );
    if (!hDriver)
    {
       return false;
    }
 
    // This is the source data set.
    GDALDatasetH hDataset = theDataset;
 
    GDALDatasetH hOutDS   = 0; 
    int bStrict = true;
    
    char** papszCreateOptions = 0;
    GDALProgressFunc pfnProgress = GDALTermProgress;
    
    ossimString s = "DEPENDENT_FILE=";
    s += sourceImageFile.file(); // Must not have absolute path...
    
    papszCreateOptions = CSLAddString( papszCreateOptions, "AUX=YES");
    papszCreateOptions = CSLAddString( papszCreateOptions, "STATISTICS=YES");
    papszCreateOptions = CSLAddString( papszCreateOptions, s.c_str() );
 
    hOutDS = GDALCreateCopy( hDriver,
                             getOutputFile().c_str(),
                             hDataset, 
                             bStrict,
                             papszCreateOptions, 
                             pfnProgress,
                             0 );
 
    CSLDestroy( papszCreateOptions );
    if( hOutDS != 0 )
    {
       GDALClose( hOutDS );
    }
    
    return true;
 }

◆ getExtensionFromType()

ossimString ossimGdalOverviewBuilder::getExtensionFromType ( ) const

private

Returns: extension like "ovr" or "rrd".

Definition at line 465 of file ossimGdalOverviewBuilder.cpp.

References ossimGdalOverviewHfaAverage, ossimGdalOverviewHfaNearest, and theOverviewType.

Referenced by getOutputFile().

 {
    ossimString result;
    switch (theOverviewType)
    {
       case ossimGdalOverviewHfaNearest:
       case ossimGdalOverviewHfaAverage:  
          result = "aux";
          break;
 
       default:
          result = "ovr";
          break;
    }
    return result;
 }

◆ getGdalResamplingType()

ossimString ossimGdalOverviewBuilder::getGdalResamplingType ( ) const

private

Returns: The gdal resampling string from theOverviewType.

Definition at line 445 of file ossimGdalOverviewBuilder.cpp.

References ossimGdalOverviewHfaAverage, ossimGdalOverviewHfaNearest, ossimGdalOverviewTiffAverage, ossimGdalOverviewTiffNearest, ossimGdalOverviewType_UNKNOWN, and theOverviewType.

 {
    ossimString result;
    switch (theOverviewType)
    {
       case ossimGdalOverviewTiffNearest:
       case ossimGdalOverviewHfaNearest:
          result = "nearest";
          break;
       case ossimGdalOverviewTiffAverage:
       case ossimGdalOverviewHfaAverage:
          result = "average";
          break;
       case ossimGdalOverviewType_UNKNOWN:
          result = "unknown";
          break;
    }
    return result;
 }

◆ getObject() [1/2]

ossimObject * ossimGdalOverviewBuilder::getObject ( )

virtual

Returns: ossimObject* to this object. Satisfies pure virtual.

Implements ossimProcessInterface.

Definition at line 484 of file ossimGdalOverviewBuilder.cpp.

 {
    return this;
 }

◆ getObject() [2/2]

const ossimObject * ossimGdalOverviewBuilder::getObject ( ) const

virtual

Returns: const ossimObject* to this object. Satisfies pure virtual.

Implements ossimProcessInterface.

Definition at line 489 of file ossimGdalOverviewBuilder.cpp.

 {
    return this;
 }

◆ getOutputFile()

ossimFilename ossimGdalOverviewBuilder::getOutputFile ( ) const

virtual

Returns the output.

This will be derived from the input file if not explicitly set.

Returns: The output filename.

Implements ossimOverviewBuilderBase.

Definition at line 62 of file ossimGdalOverviewBuilder.cpp.

References getExtensionFromType(), ossimImageHandler::getFilename(), ossimGdalDataset::getImageHandler(), ossimFilename::NIL, ossimGdalOverviewHfaAverage, ossimGdalOverviewHfaNearest, ossimFilename::setExtension(), theDataset, theOutputFile, and theOverviewType.

Referenced by generateHfaStats().

 {
    if (theOutputFile == ossimFilename::NIL)
    {
       if (theDataset)
       {
          if (theDataset->getImageHandler())
          {
             ossimFilename outputFile =
                theDataset->getImageHandler()->getFilename();
 
             switch (theOverviewType)
             {
                case ossimGdalOverviewHfaNearest:
                case ossimGdalOverviewHfaAverage:  
                   outputFile.setExtension(getExtensionFromType());
                   break;
                default:
                   outputFile += ".ovr";
                   break;
             }
             return outputFile;
          }
       }
    }
    
    return theOutputFile;
 }

◆ getOverviewType()

ossimString ossimGdalOverviewBuilder::getOverviewType ( ) const

virtual

Gets the overview type.

Satisfies pure virtual from ossimOverviewBuilderBase.

Returns: The overview output type as a string.

Implements ossimOverviewBuilderBase.

Definition at line 143 of file ossimGdalOverviewBuilder.cpp.

 {
    return ossimString(OVR_TYPE[theOverviewType]);
 }

◆ getPropertyNames()

void ossimGdalOverviewBuilder::getPropertyNames ( std::vector< ossimString > & propertyNames ) const

virtual

Method to populate the list of property names.

Parameters

propertyNames List to populate. This does not clear the list just adds to it.

Reimplemented from ossimSource.

Definition at line 360 of file ossimGdalOverviewBuilder.cpp.

 {
    propertyNames.push_back(ossimString("levels"));
    propertyNames.push_back(ossimString("generate-hfa-stats"));
 }

◆ getTypeNameList()

void ossimGdalOverviewBuilder::getTypeNameList ( std::vector< ossimString > & typeList ) const

virtual

Method to populate class supported types.

Satisfies pure virtual from ossimOverviewBuilderBase.

Parameters

typeList List of ossimStrings to add to.

Implements ossimOverviewBuilderBase.

Definition at line 148 of file ossimGdalOverviewBuilder.cpp.

 {
    typeList.push_back(
       ossimString(OVR_TYPE[ossimGdalOverviewTiffNearest]));
    typeList.push_back(
       ossimString(OVR_TYPE[ossimGdalOverviewTiffAverage]));
    typeList.push_back(
       ossimString(OVR_TYPE[ossimGdalOverviewHfaNearest]));
    typeList.push_back(
       ossimString(OVR_TYPE[ossimGdalOverviewHfaAverage]));
 }

◆ open()

bool ossimGdalOverviewBuilder::open ( const ossimFilename & file )

Open that takes a file name.

Parameters

file	The file to open.

Returns: true on success, false on error.

Definition at line 91 of file ossimGdalOverviewBuilder.cpp.

References ossimGdalDataset::open(), and theDataset.

 {
    if (theDataset)
    {
       delete theDataset;
    }
    theDataset = new ossimGdalDataset;
    return theDataset->open(file);
 }

◆ print()

std::ostream & ossimGdalOverviewBuilder::print ( std::ostream & out ) const

virtual

print method.

Returns: std::ostream&

Reimplemented from ossimProcessInterface.

Definition at line 367 of file ossimGdalOverviewBuilder.cpp.

References ossimString::c_str(), and theOutputFile.

 {
    out << "ossimGdalOverviewBuilder::print"
        << "\nfilename: " << theOutputFile.c_str()
        << "\noverview_type: "
        << OVR_TYPE[theOverviewType]
        << "\nresampling type: " << getGdalResamplingType()
        << std::endl;
    return out;
 }

◆ setInputSource()

bool ossimGdalOverviewBuilder::setInputSource ( ossimImageHandler * imageSource )

virtual

Sets the input to the builder.

Satisfies pure virtual from ossimOverviewBuilderBase.

Parameters

imageSource The input to the builder.

Returns: True on successful initializion, false on error.

Reimplemented from ossimOverviewBuilderBase.

Definition at line 101 of file ossimGdalOverviewBuilder.cpp.

References ossimGdalDataset::setImageHandler(), and theDataset.

 {
    if ( !imageSource )
    {
       return false;
    }
    
    if (theDataset)
    {
       delete theDataset;
    }
 
    theDataset = new ossimGdalDataset();
    theDataset->setImageHandler(imageSource);
    return true;
 }

◆ setOutputFile()

void ossimGdalOverviewBuilder::setOutputFile ( const ossimFilename & file )

virtual

Sets the output filename.

Satisfies pure virtual from ossimOverviewBuilderBase.

Parameters

file	The output file name.

Implements ossimOverviewBuilderBase.

Definition at line 57 of file ossimGdalOverviewBuilder.cpp.

References theOutputFile.

 {
    theOutputFile = file;
 }

◆ setOverviewType()

bool ossimGdalOverviewBuilder::setOverviewType ( const ossimString & type )

virtual

Sets the overview output type.

Satisfies pure virtual from ossimOverviewBuilderBase.

Currently handled types are: "ossim_tiff_nearest" and "ossim_tiff_box"

Parameters

type	This should be the string representing the type. This method will do nothing if type is not handled and return false.

Returns: true if type is handled, false if not.

Implements ossimOverviewBuilderBase.

Definition at line 118 of file ossimGdalOverviewBuilder.cpp.

 {
    if(type == OVR_TYPE[ossimGdalOverviewTiffNearest])
    {
       theOverviewType = ossimGdalOverviewTiffNearest;
    }
    else if(type == OVR_TYPE[ossimGdalOverviewTiffAverage])
    {
       theOverviewType = ossimGdalOverviewTiffAverage;
    }
    else if(type == OVR_TYPE[ossimGdalOverviewHfaNearest])
    {
       theOverviewType = ossimGdalOverviewHfaNearest;
    }
    else if(type == OVR_TYPE[ossimGdalOverviewHfaAverage])
    {
       theOverviewType = ossimGdalOverviewHfaAverage;
    }
    else
    {
       return false;
    }
    return true;
 }

◆ setProperty()

void ossimGdalOverviewBuilder::setProperty ( ossimRefPtr< ossimProperty > property )

virtual

Method to set properties.

Parameters

property Property to set.

Note: Currently supported property: name=levels, value should be list of levels separated by a comma with no spaces. Example: "2,4,8,16,32,64"

Reimplemented from ossimSource.

Definition at line 321 of file ossimGdalOverviewBuilder.cpp.

References ossimString::downcase(), and ossimRefPtr< T >::valid().

 {
    if (property.valid() == false)
    {
       return;
    }
 
    ossimString s = property->getName();
    s.downcase();
    if ( s == "levels" )
    {
       ossimString value;
       property->valueToString(value);
       
       if (traceDebug())
       {
          ossimNotify(ossimNotifyLevel_DEBUG)
             << "ossimGdalOverviewBuilder::setProperty DEBUG:"
             << std::endl;
       }
       theLevels.clear();
       std::vector<ossimString> v1 = value.split(",");
       for (ossim_uint32 i = 0; i < v1.size(); ++i)
       {
          ossim_int32 level = v1[i].toInt32();
          theLevels.push_back(level);
          if (traceDebug())
          {
             ossimNotify(ossimNotifyLevel_DEBUG)
                << "level[" << i << "]:  " << level << std::endl;
          }
       }
    }
    else if ( s == "generate-hfa-stats" )
    {
       theGenerateHfaStatsFlag = true;
    }
 }

Member Data Documentation

◆ theDataset

ossimGdalDataset* ossimGdalOverviewBuilder::theDataset

private

Definition at line 172 of file ossimGdalOverviewBuilder.h.

Referenced by generateHfaStats(), getOutputFile(), open(), setInputSource(), and ~ossimGdalOverviewBuilder().

◆ theGenerateHfaStatsFlag

bool ossimGdalOverviewBuilder::theGenerateHfaStatsFlag

private

Definition at line 176 of file ossimGdalOverviewBuilder.h.

◆ theLevels

std::vector<ossim_int32> ossimGdalOverviewBuilder::theLevels

private

Definition at line 175 of file ossimGdalOverviewBuilder.h.

◆ theOutputFile

ossimFilename ossimGdalOverviewBuilder::theOutputFile

private

Definition at line 173 of file ossimGdalOverviewBuilder.h.

Referenced by getOutputFile(), print(), and setOutputFile().

◆ theOverviewType

ossimGdalOverviewType ossimGdalOverviewBuilder::theOverviewType

private

Definition at line 174 of file ossimGdalOverviewBuilder.h.

Referenced by getExtensionFromType(), getGdalResamplingType(), and getOutputFile().

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

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ossimGdalOverviewType

Constructor & Destructor Documentation

◆ ossimGdalOverviewBuilder()

◆ ~ossimGdalOverviewBuilder()

Member Function Documentation

◆ canConnectMyInputTo()

◆ execute()

◆ generateHfaStats()

◆ getExtensionFromType()

◆ getGdalResamplingType()

◆ getObject() [1/2]

◆ getObject() [2/2]

◆ getOutputFile()

◆ getOverviewType()

◆ getPropertyNames()

◆ getTypeNameList()

◆ open()

◆ print()

◆ setInputSource()

◆ setOutputFile()

◆ setOverviewType()

◆ setProperty()

Member Data Documentation

◆ theDataset

◆ theGenerateHfaStatsFlag

◆ theLevels

◆ theOutputFile

◆ theOverviewType