#include <ossimImageCacheBase.h>

Inheritance diagram for ossimImageCacheBase:

Classes
struct	ossimFrameEntryData
	Protected structure that is only used internally by this class. More...

Public Member Functions
	ossimImageCacheBase ()
	Default constructor. More...

virtual void	close ()
	Closes this image handler and deletes any allocated data. More...

virtual bool	open ()=0
	Pure virtual open. More...

virtual ossim_uint32	getNumberOfLines (ossim_uint32 reduced_res_level=0) const
	Satisfies pure virtual requirement from ImageHandler class. More...

virtual ossim_uint32	getNumberOfSamples (ossim_uint32 reduced_res_level=0) const
	Satisfies pure virtual requirement from ImageHandler class. More...

virtual ossimIrect	getImageRectangle (ossim_uint32 reduced_res_level=0) const

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

virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)
	Method to load the state of an object from a keyword list. More...

virtual ossim_uint32	getNumberOfInputBands () const
	This method allows you to query the number of input bands. More...

virtual ossim_uint32	getNumberOfOutputBands () const
	This method allows one to query the number of output bands. More...

virtual ossim_uint32	getTileWidth () const
	Returns the width of the output tile. More...

virtual ossim_uint32	getTileHeight () const
	Returns the height of the output tile. More...

virtual ossim_uint32	getImageTileWidth () const
	Returns the tile width of the image or 0 if the image is not tiled. More...

virtual ossim_uint32	getImageTileHeight () const
	Returns the tile width of the image or 0 if the image is not tiled. More...

virtual void	getEntryList (std::vector< ossim_uint32 > &entryList) const

bool	isValidRLevel (ossim_uint32 reduced_res_level) const

bool	isOpen () const
	Determines if its open if there eists a table of contents object. More...

virtual ossimRefPtr< ossimImageGeometry >	getImageGeometry ()
	Populates the geometry object with image geometry information. More...

Public Member Functions inherited from ossimImageHandler
	ossimImageHandler ()
	Constructor (default): More...

virtual	~ossimImageHandler ()
	Destructor: Derived classes should implement. More...

virtual void	initialize ()
	initialize Does nothing in this class. More...

virtual bool	openOverview ()
	Searches for an overview. More...

virtual bool	openOverview (const ossimFilename &overview_file)
	Calls closeOverview(), then attempts to open the overview_file. More...

virtual void	closeOverview ()
	If theOverview is initialized it will be deleted and set to NULL. More...

virtual const ossimImageHandler *	getOverview () const

virtual bool	hasOverviews () const

virtual ossimFilename	createDefaultOverviewFilename () const

virtual ossimFilename	createDefaultGeometryFilename () const

virtual ossimFilename	createDefaultMetadataFilename () const

virtual ossimFilename	createDefaultHistogramFilename () const

virtual ossimFilename	createDefaultValidVerticesFilename () const

virtual bool	writeValidImageVertices (const std::vector< ossimIpt > &vertices, const ossimFilename &file=ossimFilename(""))
	Outputs vertices to file and updates the internal vertex array variable "theValidImageVertices". More...

virtual bool	openValidVertices (const ossimFilename &vertices_file)
	Opens the valid image vertices file and sets theValidImageVerticesFile variable. More...

virtual bool	openValidVertices ()
	Creates vertices file name based on image, then tries to open. More...

virtual bool	open (const ossimFilename &imageFile, ossim_uint32 entryIndex)
	Opens the image file. More...

virtual bool	open (const ossimFilename &imageFile)

virtual bool	open (std::shared_ptr< ossim::ImageHandlerState > state)

virtual bool	buildHistogram (int numberOfRLevels=0, ossimHistogramMode mode=OSSIM_HISTO_MODE_NORMAL)
	Build a histogram for image file. More...

virtual bool	buildAllHistograms (int numberOfRLevels=0, ossimHistogramMode mode=OSSIM_HISTO_MODE_NORMAL)
	Build a histograms for all image entries. More...

virtual bool	buildOverview (ossimImageHandlerOverviewCompressionType compressionType=OSSIM_OVERVIEW_COMPRESSION_NONE, ossim_uint32 quality=75, ossimFilterResampler::ossimFilterResamplerType resampleType=ossimFilterResampler::ossimFilterResampler_BOX, bool includeFullResFlag=false)
	Will build over file for theImageFile. More...

virtual bool	buildAllOverviews (ossimImageHandlerOverviewCompressionType compressionType=OSSIM_OVERVIEW_COMPRESSION_NONE, ossim_uint32 quality=75, ossimFilterResampler::ossimFilterResamplerType resampleType=ossimFilterResampler::ossimFilterResampler_BOX, bool includeFullResFlag=false)
	Will build over file for all image entries. More...

virtual bool	buildOverview (const ossimFilename &filename, ossimImageHandlerOverviewCompressionType compressionType=OSSIM_OVERVIEW_COMPRESSION_NONE, ossim_uint32 quality=75, ossimFilterResampler::ossimFilterResamplerType resampleType=ossimFilterResampler::ossimFilterResampler_BOX, bool includeFullResFlag=false)
	Will build an over file for filename. More...

ossimRefPtr< ossimMultiResLevelHistogram >	getImageHistogram () const
	Fetches the current entry image's histogram. More...

virtual void	setImageGeometry (ossimImageGeometry *geom)
	Sets the image geometry object. More...

virtual void	saveImageGeometry () const
	Saves the image geometry to a file that will be made based on the image file name. More...

virtual void	saveImageGeometry (const ossimFilename &geometry_file) const
	Saves the image geometry to a file that will be made based on the image file name. More...

virtual ossimIrect	getBoundingRect (ossim_uint32 resLevel=0) const
	Returns zero-based bounding rectangle of the image. More...

virtual void	getDecimationFactor (ossim_uint32 resLevel, ossimDpt &result) const

virtual void	getDecimationFactors (vector< ossimDpt > &decimations) const
	This returns all decimation for all levels. More...

virtual ossim_uint32	getNumberOfDecimationLevels () const
	This returns the total number of decimation levels. More...

virtual ossim_uint32	getNumberOfReducedResSets () const
	This method is obsolete. More...

virtual void	setFilename (const ossimFilename &filename)
	Sets the filename. More...

virtual const ossimFilename &	getFilename () const
	Returns the filename. More...

bool	canConnectMyInputTo (ossim_int32 inputIndex, const ossimConnectableObject *object) const
	Connection rule. More...

virtual void	getValidImageVertices (vector< ossimIpt > &validVertices, ossimVertexOrdering ordering=OSSIM_CLOCKWISE_ORDER, ossim_uint32 resLevel=0) const
	ordering specifies how the vertices should be arranged. More...

virtual bool	isBandSelector () const
	Indicates whether or not the image handler can control output band selection via the setOutputBandList method. More...

virtual bool	setOutputBandList (const std::vector< ossim_uint32 > &band_list)
	If the image handler "isBandSeletor()" then the band selection of the output chip can be controlled. More...

virtual bool	setOutputToInputBandList ()
	If the image handler "isBandSeletor()" then the band selection of the output are set to input or identity. More...

virtual bool	isIdentityBandList (const std::vector< ossim_uint32 > &bandList) const
	Convenience method to see if band list is identity. More...

virtual bool	isImageTiled () const
	Indicates whether or not the image is tiled internally. More...

virtual bool	hasMetaData () const

virtual ossimRefPtr< ossimNBandLutDataObject >	getLut () const

virtual bool	hasLut () const

virtual void	loadMetaData ()
	There is an external file with an omd extension. More...

virtual double	getMinPixelValue (ossim_uint32 band=0) const
	Retuns the min pixel value. More...

virtual double	getMaxPixelValue (ossim_uint32 band=0) const
	Returns the max pixel of the band. More...

virtual double	getNullPixelValue (ossim_uint32 band=0) const
	Each band has a null pixel associated with it. More...

virtual void	setMinPixelValue (ossim_uint32 band, const ossim_float64 &pix)
	convenience method to set min pixel value. More...

virtual void	setMaxPixelValue (ossim_uint32 band, const ossim_float64 &pix)
	convenience method to set max pixel value. More...

virtual void	setNullPixelValue (ossim_uint32 band, const ossim_float64 &pix)
	convenience method to set null pixel value. More...

virtual ossim_uint32	getCurrentEntry () const

virtual ossim_uint32	getNumberOfEntries () const

virtual void	getEntryName (ossim_uint32 entryIdx, std::string &name) const
	Get the name of entry as a string. More...

virtual void	getEntryNames (std::vector< ossimString > &entryNames) const

bool	useEntryIndex () const
	Convenience method to determine if entry index should be used for support files, e.g. More...

ossimFilename	getOverviewFile () const

virtual bool	setCurrentEntry (ossim_uint32 entryIdx)

virtual void	setProperty (ossimRefPtr< ossimProperty > property)

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

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

ossimFilename	getFilenameWithThisExtension (const ossimString &ext, bool set_e0_prefix=false) const
	Returns the image file with extension set using supplentary directory for dirname if set. More...

void	getFilenameWithThisExt (const ossimString &ext, ossimFilename &f) const
	Returns the image file with extension set using supplentary directory for dirname if set. More...

ossim_uint32	getStartingResLevel () const

void	setStartingResLevel (ossim_uint32 level)

bool	getOpenOverviewFlag () const

void	setOpenOverviewFlag (bool flag)
	Sets theOpenOverviewFlag. More...

virtual void	setSupplementaryDirectory (const ossimFilename &dir)
	Sets the supplementary directory. More...

virtual const ossimFilename &	getSupplementaryDirectory () const
	Returns the supplementary directory. More...

const ossimString &	getImageID () const
	Fetches the image ID. More...

void	setImageID (const ossimString &id)
	Sets the image ID in case it is externally generated. More...

ossimPixelType	getPixelType () const
	Returns the raster pixel alignment type. More...

virtual bool	getRgbBandList (std::vector< ossim_uint32 > &bandList) const
	Convenience method to get the zero based rgb output band list. More...

template<class T >
std::shared_ptr< T >	getStateAs ()

template<class T >
std::shared_ptr< const T >	getStateAs () const

std::shared_ptr< ossim::ImageHandlerState >	getState ()

std::shared_ptr< const ossim::ImageHandlerState >	getState () const

void	setState (std::shared_ptr< ossim::ImageHandlerState > state)

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

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

virtual	~ossimImageSource ()

virtual ossimRefPtr< ossimImageData >	getTile (const ossimIpt &origin, ossim_uint32 resLevel=0)

virtual ossimRefPtr< ossimImageData >	getTile (const ossimIrect &rect, ossim_uint32 resLevel=0)

virtual bool	getTile (ossimImageData *result, ossim_uint32 resLevel=0)
	Method to get a tile. More...

virtual ossimObject *	getObject ()
	For RTTI support. More...

virtual const ossimObject *	getObject () const
	For RTTI support. More...

virtual void	getDecimationFactors (std::vector< ossimDpt > &decimations) const
	Will return an array of all decimations for each resolution level. More...

virtual void	getOutputBandList (std::vector< ossim_uint32 > &bandList) const
	Initializes bandList. More...

virtual ossimScalarType	getOutputScalarType () const
	This will be used to query the output pixel type of the tile source. More...

virtual void	getBoundingRect (ossimIrect &rect, ossim_uint32 resLevel=0) const
	Gets the bounding rectangle of the source. More...

virtual void	getValidImageVertices (std::vector< ossimIpt > &validVertices, ossimVertexOrdering ordering=OSSIM_CLOCKWISE_ORDER, ossim_uint32 resLevel=0) const
	ordering specifies how the vertices should be arranged. More...

virtual void	setImageGeometry (const ossimImageGeometry *geom)
	Default implementation sets geometry of the first input to the geometry specified. More...

virtual bool	isIndexedData () 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 std::ostream &	print (std::ostream &out) const
	Outputs theErrorStatus as an ossimErrorCode and an ossimString. More...

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

Protected Member Functions
virtual	~ossimImageCacheBase ()
	Destructor. More...

void	setActualImageRect ()
	Will shift the rect and clamp it so not to go outside the -180 to 180 degree range. More...

void	checkLongitude (ossim_float64 &leftLon, const ossim_float64 &rightLon) const
	Method to test for 180.0 <–> 180.00 and set leftLon to -180 if both left and right are 180.0 degrees. More...

vector< ossimFrameEntryData >	getIntersectingEntries (const ossimIrect &rect)
	It is important to note that each frame is organized into an easting northing type orientation. More...

void	deleteAll ()

bool	buildFrameEntryArray (ossimFilename imageFile, ossim_uint32 frameWidth, ossim_uint32 frameHeight)

virtual void	establishDecimationFactors ()
	Virtual method determines the decimation factors at each resolution level. More...

Protected Member Functions inherited from ossimImageHandler
virtual ossimRefPtr< ossimImageGeometry >	getExternalImageGeometry () const
	Returns the image geometry object associated with this tile source or NULL if non defined. More...

virtual ossimRefPtr< ossimImageGeometry >	getInternalImageGeometry () const

virtual bool	getOverviewTile (ossim_uint32 resLevel, ossimImageData *result)
	Method to get an overview tile. More...

bool	initVertices (const char *file)
	Opens file and attempts to initialize the valid image vertices. More...

virtual void	completeOpen ()
	Will complete the opening process. More...

void	initImageParameters (ossimImageGeometry *geom) const
	Convenience method to set things needed in the image geometry from the image handler. More...

virtual bool	setOutputBandList (const std::vector< ossim_uint32 > &inBandList, std::vector< ossim_uint32 > &outBandList)
	Convenience method to set output band list. More...

void	getFilenameWithNoExtension (ossimFilename &f) const
	Get filename with no extension, using supplentary directory for dirname if set. More...

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

const ossimImageSource &	operator= (const ossimImageSource &)

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
ossimIrect	m_actualImageRect
	This holds the image bounds for the current entry. More...

ossim_uint32	m_numberOfLines
	This will be computed based on the frames organized within the directory. More...

ossim_uint32	m_numberOfSamples
	This will be computed based on the frames organized within the directory. More...

ossim_uint32	m_numberOfBands
	This is the actual data returned from a getTile request. More...

std::vector< ossimString >	m_fileNames
	The size of the input frames. More...

ossimIpt	m_tileSize
	The size of the output tile. More...

ossimRpfFrame *	m_workFrame

ossim_float64	m_bBox_LL_Lon

ossim_float64	m_bBox_LL_Lat

ossim_float64	m_bBox_UR_Lon

ossim_float64	m_bBox_UR_Lat

ossim_uint32	m_numOfFramesVertical

ossim_uint32	m_numOfFramesHorizontal

ossim_uint32	m_frame_width

ossim_uint32	m_frame_height

std::vector< std::vector< ossimRpfFrameEntry > >	m_frameEntryArray

Protected Attributes inherited from ossimImageHandler
ossimFilename	theImageFile

ossimFilename	theOverviewFile

ossimFilename	theSupplementaryDirectory

ossimRefPtr< ossimImageHandler >	theOverview

vector< ossimIpt >	theValidImageVertices

ossimImageMetaData	theMetaData

ossimRefPtr< ossimImageGeometry >	theGeometry

ossimRefPtr< ossimNBandLutDataObject >	theLut

std::vector< ossimDpt >	theDecimationFactors

ossimString	theImageID

ossim_uint32	theStartingResLevel
	theStartingResLevel If set to something other than zero(default) this is indicative that the reader is an overview. More...

bool	theOpenOverviewFlag
	If true opening of overviews will be attempted. More...

ossimPixelType	thePixelType

std::shared_ptr< ossim::ImageHandlerState >	m_state

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

Additional Inherited Members
Public Types inherited from ossimImageHandler
enum	ossimImageHandlerOverviewCompressionType { OSSIM_OVERVIEW_COMPRESSION_NONE = 0, OSSIM_OVERVIEW_COMPRESSION_JPEG, OSSIM_OVERVIEW_COMPRESSION_LZW, OSSIM_OVERVIEW_COMPRESSION_DEFLATE, OSSIM_OVERVIEW_COMPRESSION_PACKBITS }

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

Detailed Description

Definition at line 21 of file ossimImageCacheBase.h.

Constructor & Destructor Documentation

◆ ossimImageCacheBase()

ossimImageCacheBase::ossimImageCacheBase ( )

Default constructor.

Initializes all internal attributes to a default state.

Definition at line 48 of file ossimImageCacheBase.cpp.

    :
    ossimImageHandler(),
    m_actualImageRect(),
    m_numberOfLines(0),
    m_numberOfSamples(0),
    m_numberOfBands(0),
    m_fileNames(),
    m_tileSize(128, 128),
    m_workFrame(new ossimRpfFrame),
    m_bBox_LL_Lon(0.0),
    m_bBox_LL_Lat(0.0),
    m_bBox_UR_Lon(0.0),
    m_bBox_UR_Lat(0.0),
    m_numOfFramesVertical(0),
    m_numOfFramesHorizontal(0),
    m_frame_width(0),
    m_frame_height(0),
    m_frameEntryArray()
 {
   if (traceDebug())
   {
     ossimNotify(ossimNotifyLevel_DEBUG)
       << "ossimImageCacheBase::ossimImageCacheBase entered...\n";
 #ifdef OSSIM_ID_ENABLED
     ossimNotify(ossimNotifyLevel_DEBUG)
       << "OSSIM_ID:  " << OSSIM_ID << "\n";
 #endif      
   }
 
   m_actualImageRect.makeNan();
 
 }

◆ ~ossimImageCacheBase()

ossimImageCacheBase::~ossimImageCacheBase ( )

protectedvirtual

Destructor.

Will return allocated memory back to the heap.

Definition at line 82 of file ossimImageCacheBase.cpp.

 {
   if(m_workFrame)
   {
     delete m_workFrame;
     m_workFrame = 0;
   }
   close();
 }

Member Function Documentation

◆ buildFrameEntryArray()

bool ossimImageCacheBase::buildFrameEntryArray	(	ossimFilename	imageFile,
		ossim_uint32	frameWidth,
		ossim_uint32	frameHeight
	)

protected

Definition at line 112 of file ossimImageCacheBase.cpp.

 {
    static const char MODULE[] = "ossimImageCacheBase::buildFrameEntryArray";
    if ( traceDebug() )
    {
       ossimNotify(ossimNotifyLevel_DEBUG) << MODULE << " entered..." << endl;
    }
 
    // use to check if tiles have overlap pixels
    ossim_float64 avgLat = 0.0;
    ossim_float64 avgLon = 0.0;
 
    m_frame_width = frameWidth;
    m_frame_height = frameHeight;
 
    std::ifstream in((imageFile).c_str() );
    
    std::string line;
    ossim_uint32 index = 0; // used throughout
    while( in.good() )
    {
       // Read in a line.
       std::getline(in, line);
 
       ossimString tmpStr = ossimString(line);
       if (!tmpStr.empty())
       {
          if (index == 0)
          {
             std::vector<ossimString> box_lat_lon;
             tmpStr.split(box_lat_lon, "|");
             
             if (box_lat_lon.size() > 2)
             {
                std::vector<ossimString> ll;
                std::vector<ossimString> ur;
                
                box_lat_lon[0].split(ll, ",");
                box_lat_lon[1].split(ur, ",");
                ossimString bandStr = box_lat_lon[2];
                
                m_bBox_LL_Lon = ll[0].toFloat64();
                m_bBox_LL_Lat = ll[1].toFloat64();
                m_bBox_UR_Lon = ur[0].toFloat64();
                m_bBox_UR_Lat = ur[1].toFloat64();
                
                checkLongitude(m_bBox_LL_Lon, m_bBox_UR_Lon);
                
                m_numberOfBands = ossimString(bandStr).toInt32();
             }
             else
             {
                return false;
             }
          }
          else if (index == 1)
          {
             m_fileNames.push_back(tmpStr);
             std::vector<ossimString> frame_lat_lon = tmpStr.split("|");
             if (frame_lat_lon.size() > 2)
             {
                ossimString ll_lon_lat = frame_lat_lon[1];
                ossimString ur_lon_lat = frame_lat_lon[2];
                ossim_float64 ll_lon = ossimString(ll_lon_lat.split(",")[0]).toDouble();
                ossim_float64 ll_lat = ossimString(ll_lon_lat.split(",")[1]).toDouble();
                ossim_float64 ur_lon = ossimString(ur_lon_lat.split(",")[0]).toDouble();
                ossim_float64 ur_lat = ossimString(ur_lon_lat.split(",")[1]).toDouble();
 
                checkLongitude(ll_lon, ur_lon);
                
                ossim_float64 bBox_lat_diff = std::fabs(m_bBox_UR_Lat - m_bBox_LL_Lat);
                ossim_float64 bBox_lon_diff = std::fabs(m_bBox_UR_Lon - m_bBox_LL_Lon);
                
                ossim_float64 lat_diff = std::fabs(ur_lat - ll_lat);
                ossim_float64 lon_diff = std::fabs(ur_lon - ll_lon);
                
                m_numOfFramesVertical   = static_cast<ossim_uint32>(bBox_lat_diff/lat_diff + 0.5);
                m_numOfFramesHorizontal = static_cast<ossim_uint32>(bBox_lon_diff/lon_diff + 0.5);
 
                avgLon = std::fabs(bBox_lon_diff/m_numOfFramesHorizontal);
                avgLat = std::fabs(bBox_lat_diff/m_numOfFramesVertical);
                
                m_numberOfLines   = m_numOfFramesVertical*m_frame_height;
                m_numberOfSamples = m_numOfFramesHorizontal*m_frame_width;
 
                if ( traceDebug() )
                {
                   ossimNotify(ossimNotifyLevel_DEBUG)
                      << "\nscene height in degrees: " << bBox_lat_diff
                      << "\nscene width in degrees:  " << bBox_lon_diff
                      << "\nframe height in degrees: " << lat_diff
                      << "\nframe width in degrees:  " << lon_diff
                      << "\nframes vertical:         " << m_numOfFramesVertical
                      << "\nframes horizontal:       " << m_numOfFramesHorizontal
                      << "\nlines:                   " << m_numberOfLines
                      << "\nsamples:                 " << m_numberOfSamples << "\n";
                }
             }
             else
             {
                return false;
             }
          }
          else
          {
             m_fileNames.push_back(tmpStr);
          }
          
       } // matches: if (!tmpStr.empty())
       
       ++index;
       
    } // matches: while( in.good() )
    in.close();
 
    m_frameEntryArray.resize(m_numOfFramesVertical);
    for(index = 0; index < m_frameEntryArray.size(); ++index)
    {
       m_frameEntryArray[index].resize(m_numOfFramesHorizontal);
    }
 
    for(index = 0; index < m_fileNames.size(); ++index)
    {
       ossimString tmpStr = m_fileNames[index];
       std::vector<ossimString> frameInfos = tmpStr.split("|");
       if (frameInfos.size() > 1)
       {
          ossimString fileName = frameInfos[0];
          ossimString ll_lon_lat = frameInfos[1];
          ossimString ur_lon_lat = frameInfos[2];
          double ll_lon = ossimString(ll_lon_lat.split(",")[0]).toDouble();
          double ll_lat = ossimString(ll_lon_lat.split(",")[1]).toDouble();
          double ur_lon = ossimString(ur_lon_lat.split(",")[0]).toDouble();
          double ur_lat = ossimString(ur_lon_lat.split(",")[1]).toDouble();
          
          checkLongitude(ll_lon, ur_lon);
          
          ossim_float64 tmpColPostion = std::fabs(ll_lon - m_bBox_LL_Lon);
          ossim_float64 tmpFrameLon = std::fabs(ur_lon - ll_lon);
 
          if (std::fabs(tmpFrameLon - avgLon) > 0.002)
          {
             ossimNotify(ossimNotifyLevel_WARN) << fileName << " has overlap pixels with other image." << std::endl;
             return false;
          }
          
          ossim_float64 tmpRowPostion = std::fabs(m_bBox_UR_Lat - ur_lat);
          ossim_float64 tmpFrameLat = std::fabs(ur_lat - ll_lat);
 
          if (std::fabs(tmpFrameLat - avgLat) > 0.002)
          {
             ossimNotify(ossimNotifyLevel_WARN) << fileName << " has overlap pixels with other image." << std::endl;
             return false;
          }
          
          ossim_uint32 colNum = static_cast<ossim_uint32>(tmpColPostion/tmpFrameLon + 0.5);
          ossim_uint32 rowNum = static_cast<ossim_uint32>(tmpRowPostion/tmpFrameLat + 0.5);
          
          if (colNum >= m_numOfFramesHorizontal)
          {
             colNum = m_numOfFramesHorizontal-1; // Clamp to last column.
          }
          
          if (rowNum >= m_numOfFramesVertical)
          {
             rowNum = m_numOfFramesVertical-1; // Clamp to last row.
          }
 
          ossimRpfFrameEntry tempEntry;
          tempEntry.setEntry(ossimFilename(""), fileName);
          m_frameEntryArray[rowNum][colNum] = tempEntry;
       }
       else
       {
          return false;
       }
    }
 
    return true;
 }

◆ checkLongitude()

void ossimImageCacheBase::checkLongitude	(	ossim_float64 &	leftLon,
		const ossim_float64 &	rightLon
	)		const

protected

Method to test for 180.0 <–> 180.00 and set leftLon to -180 if both left and right are 180.0 degrees.

Parameters

leftLon	Left hand side longitude of scene. This is the value that will be flipped to -180 if test is true.
rightLon	Right hand side of scene.

Definition at line 295 of file ossimImageCacheBase.cpp.

References ossim::almostEqual().

 {
    //---
    // Test for scene coordinates being 180 to 180 and adjust leftLon to -180
    // if so.
    //
    // NOTE:
    // Setting tolerance to 1/7200 about 15 meters.
    // Not sure if this is too loose or not. (drb)
    //---
    const ossim_float64 TOLERANCE = 0.000138889; // 1/7200 about 15 meters.
 
    if ( ossim::almostEqual(leftLon, 180.0, TOLERANCE) )
    {
       if ( ossim::almostEqual(rightLon, 180.0, TOLERANCE) )
       {
          leftLon = -180.0;
       }
    }
 }

◆ close()

void ossimImageCacheBase::close ( )

virtual

Closes this image handler and deletes any allocated data.

Reimplemented from ossimImageHandler.

Reimplemented in ossimImageCacheTileSource.

Definition at line 92 of file ossimImageCacheBase.cpp.

 {
   deleteAll();
 }

◆ deleteAll()

void ossimImageCacheBase::deleteAll ( )

protected

Definition at line 437 of file ossimImageCacheBase.cpp.

 {
    theOverview = 0;
 }

◆ establishDecimationFactors()

void ossimImageCacheBase::establishDecimationFactors ( )

protectedvirtual

Virtual method determines the decimation factors at each resolution level.

This base class implementation computes the decimation by considering the ratios in image size between resolution levels, with fuzzy logic for rounding ratios to the nearest power of 2 if possible. Derived classes need to override this method if the decimations are provided as part of the image metadata.

Reimplemented from ossimImageHandler.

Definition at line 501 of file ossimImageCacheBase.cpp.

References ossimImageHandler::establishDecimationFactors().

 {
    theDecimationFactors.clear();
    
    // Just needed to set the first R level here, the base class can do the rest:
    ossimImageHandler::establishDecimationFactors();
 }

◆ getEntryList()

void ossimImageCacheBase::getEntryList ( std::vector< ossim_uint32 > & entryList ) const

virtual

Parameters

entryList This is the list to initialize with entry indexes.

Note: This implementation returns puts one entry "0" in the list.

Reimplemented from ossimImageHandler.

Definition at line 380 of file ossimImageCacheBase.cpp.

 {
    entryList.push_back(0);
 }

◆ getImageGeometry()

ossimRefPtr< ossimImageGeometry > ossimImageCacheBase::getImageGeometry ( )

virtual

Populates the geometry object with image geometry information.

This method is used to relay projection/model information to users. Returns true if geometry info is present, false if not. Keywords supported by this class are:

*  datum:    // datum code>   // Datum code
*  ul_lat:   // upper left latitude
*  ul_lon:   // upper left longitude
*  ll_lat:   // lower left latitude
*  ll_lon:   // lower left longitude
*  lr_lat:   // lower right latitude
*  lr_lon:   // lower right longitude
*  ur_lat:   // upper right latitude
*  ur_lon:   // upper right longitude
*  number_input_bands:     
*  number_output_bands:    
*  number_lines:           
*  number_samples:
*  decimal_degrees_per_pixel_lat:  // specifies the spacing per pixel along Y direction
*  decimal_degrees_per_pixel_lon:  // specifies the spacing per pixel along X direction
*  origin_latitude:                // specifies the origin or center of the projector for the latitude
*  central_meridian:               // specifies the origin or center of the projector for the longitude
*  tie_point_lat:     // tie point lat.  Represents the latitude of the upper left center of pixel
*  tie_point_lon:     // tie point lon.  Represents the longitude of the upper left center of pixel
*  zone:              // zone read from the CIB/CADRG boundary info
*  type:              // class name of the object for factory driven reconstruction
*  map_scale:         // Map scale of the image
*

See also: ossimImageSource for further code example on using the geometry.

Reimplemented from ossimImageHandler.

Definition at line 509 of file ossimImageCacheBase.cpp.

 {
    if (theGeometry.valid()) return theGeometry;
 
    // datum
    // WGS 84
    ossimKeywordlist kwl;
    const char* prefix = 0; // legacy
    kwl.add(prefix,
       ossimKeywordNames::DATUM_KW,
       "WGE",
       true);   
 
    ossimGpt ul(m_bBox_UR_Lat,m_bBox_LL_Lon);
    ossimGpt ll(m_bBox_LL_Lat,m_bBox_LL_Lon);
    ossimGpt ur(m_bBox_UR_Lat,m_bBox_UR_Lon);
    ossimGpt lr(m_bBox_LL_Lat,m_bBox_UR_Lon);
 
    double latInterval = fabs(ul.latd() - lr.latd())/ getNumberOfLines();
    double lonInterval = fabs(ul.lond() - ur.lond())/ getNumberOfSamples();
 
    kwl.add(prefix,
       ossimKeywordNames::UL_LAT_KW,
       ul.latd(),//-(latInterval/2.0),
       true);
 
    kwl.add(prefix,
       ossimKeywordNames::UL_LON_KW,
       ul.lond(),//+(lonInterval/2.0),
       true);
 
    kwl.add(prefix,
       ossimKeywordNames::LL_LAT_KW,
       ll.latd(),//+(latInterval/2.0),
       true);
 
    kwl.add(prefix,
       ossimKeywordNames::LL_LON_KW,
       ll.lond(),//+(lonInterval/2.0),
       true);
 
    kwl.add(prefix,
       ossimKeywordNames::LR_LAT_KW,
       lr.latd(),//+(latInterval/2.0),
       true);
 
    kwl.add(prefix,
       ossimKeywordNames::LR_LON_KW,
       lr.lond(),//-(lonInterval/2.0),
       true);
 
    kwl.add(prefix,
       ossimKeywordNames::UR_LAT_KW,
       ur.latd(),//-(latInterval/2.0),
       true);
 
    kwl.add(prefix,
       ossimKeywordNames::UR_LON_KW,
       ur.lond(),//-(latInterval/2.0),
       true);
 
    kwl.add(prefix,
       ossimKeywordNames::NUMBER_INPUT_BANDS_KW,
       getNumberOfInputBands(),
       true);
 
    kwl.add(prefix,
       ossimKeywordNames::NUMBER_OUTPUT_BANDS_KW,
       getNumberOfOutputBands(),
       true);
 
    kwl.add(prefix,
       ossimKeywordNames::NUMBER_LINES_KW,
       getNumberOfLines(),
       true);
 
    kwl.add(prefix,
       ossimKeywordNames::NUMBER_SAMPLES_KW,
       getNumberOfSamples(),
       true);
 
 
    //---
    // Make a projection to get the easting / northing of the tie point and
    // the scale in meters.  This will only be used by the CIB.
    //---
    kwl.add(prefix,
       ossimKeywordNames::DATUM_KW,
       "WGE",
       true);
 
    ossimGpt origin((ul.latd()+lr.latd())*.5,
       (ul.lond()+lr.lond())*.5,
       0.0);
 
    double deltaLatPerPixel = latInterval;
    double deltaLonPerPixel = lonInterval;
 
    ossimDpt tie;
 
    tie.lat = ul.latd() - deltaLatPerPixel/2.0;
    tie.lon = ul.lond() + deltaLonPerPixel/2.0;
 
    kwl.add(prefix, 
       ossimKeywordNames::TIE_POINT_XY_KW,
       tie.toString(),
       true);
 
    kwl.add(prefix,
       ossimKeywordNames::DECIMAL_DEGREES_PER_PIXEL_LAT,
       deltaLatPerPixel,
       true);
 
    kwl.add(prefix,
       ossimKeywordNames::DECIMAL_DEGREES_PER_PIXEL_LON,
       deltaLonPerPixel,
       true);
 
    kwl.add(prefix,
       ossimKeywordNames::ORIGIN_LATITUDE_KW,
       origin.latd(),
       true);
 
    kwl.add(prefix,
       ossimKeywordNames::CENTRAL_MERIDIAN_KW,
       origin.lond(),
       true);
 
    kwl.add(prefix,
       ossimKeywordNames::TIE_POINT_LAT_KW,
       ul.latd()-(deltaLatPerPixel/2.0),
       true);
 
    kwl.add(prefix,
       ossimKeywordNames::TIE_POINT_LON_KW,
       ul.lond()+(deltaLonPerPixel/2.0),
       true);
 
    kwl.add(prefix,
       ossimKeywordNames::TYPE_KW,
       "ossimEquDistCylProjection",
       true);
 
    // Capture this for next time.
    theGeometry = new ossimImageGeometry;
    theGeometry->loadState(kwl, prefix);
 
    // Set image things the geometry object should know about.
    initImageParameters( theGeometry.get() ); 
 
    return theGeometry;
 }

◆ getImageRectangle()

ossimIrect ossimImageCacheBase::getImageRectangle ( ossim_uint32 reduced_res_level = 0 ) const

virtual

Parameters

reduced_res_level Which res level to get the bounds for. 0 represents the default and is the full resolution.

Returns: A rectangle representing the bounds for the passed in resolution level.

Reimplemented from ossimImageHandler.

Definition at line 360 of file ossimImageCacheBase.cpp.

 {
    return ossimIrect(0,                         // upper left x
                      0,                         // upper left y
                      getNumberOfSamples(reduced_res_level) - 1,  // lower right x
                      getNumberOfLines(reduced_res_level)   - 1); // lower right y                     
 }

◆ getImageTileHeight()

ossim_uint32 ossimImageCacheBase::getImageTileHeight ( ) const

virtual

Returns the tile width of the image or 0 if the image is not tiled.

Note: this is not the same as the ossimImageSource::getTileWidth which returns the output tile width which can be different than the internal image tile width on disk.

Implements ossimImageHandler.

Definition at line 496 of file ossimImageCacheBase.cpp.

 {
    return 256;
 }

◆ getImageTileWidth()

ossim_uint32 ossimImageCacheBase::getImageTileWidth ( ) const

virtual

Returns the tile width of the image or 0 if the image is not tiled.

Note: this is not the same as the ossimImageSource::getTileWidth which returns the output tile width which can be different than the internal image tile width on disk.

Implements ossimImageHandler.

Definition at line 491 of file ossimImageCacheBase.cpp.

 {
    return 256;
 }

◆ getIntersectingEntries()

vector< ossimImageCacheBase::ossimFrameEntryData > ossimImageCacheBase::getIntersectingEntries ( const ossimIrect & rect )

protected

It is important to note that each frame is organized into an easting northing type orientation.

This means that a frame at 0,0 is at the lower left corner. Each frame's pixel data is has 0,0 at the upper left.

It will take the curent region to render and then find all entries that intersect that region.

Parameters

rect	the current region to render.

Returns: The list of entry data objects found for this rect.

Definition at line 401 of file ossimImageCacheBase.cpp.

References ossimIrect::clipToRect(), ossimRpfFrameEntry::exists(), ossimIrect::intersects(), ossimIrect::lr(), ossimIrect::ul(), ossimIpt::x, and ossimIpt::y.

 {
    vector<ossimFrameEntryData> result;
 
    // make sure we have the Toc entry to render
    if(!isOpen()) return result;
 
    ossimIrect imageRect = getImageRectangle();
    if(rect.intersects(imageRect))
    {
       ossimIrect clipRect  = rect.clipToRect(imageRect);
       ossimIrect frameRect(clipRect.ul().x/m_frame_width,
                            clipRect.ul().y/m_frame_height,
                            clipRect.lr().x/m_frame_width,
                            clipRect.lr().y/m_frame_height);
 
       for(ossim_int32 row = frameRect.ul().y; row <= frameRect.lr().y; ++row)
       {
          for(ossim_int32 col = frameRect.ul().x; col <= frameRect.lr().x; ++col)
          {
             ossimRpfFrameEntry tempEntry = m_frameEntryArray[row][col];
             if(tempEntry.exists())
             {
                result.push_back(ossimFrameEntryData(row,
                                                     col,
                                                     row*m_frame_height,
                                                     col*m_frame_width,
                                                     tempEntry));
             }
          }
       }
    }
 
    return result;
 }

◆ getNumberOfInputBands()

ossim_uint32 ossimImageCacheBase::getNumberOfInputBands ( ) const

virtual

This method allows you to query the number of input bands.

If an image is band selectable this will allow one to select the bands you wish to read in. This indicates that the number of input bands might not match the number of output bands.

Returns: number of input bands.

Implements ossimImageSource.

Reimplemented in ossimImageCacheTileSource.

Definition at line 317 of file ossimImageCacheBase.cpp.

 {
    return m_numberOfBands;
 }

◆ getNumberOfLines()

ossim_uint32 ossimImageCacheBase::getNumberOfLines ( ossim_uint32 reduced_res_level = 0 ) const

virtual

Satisfies pure virtual requirement from ImageHandler class.

Parameters

reduced_res_level The reduced res level to query number of lines from.

Returns: The number of lines in the image.

Implements ossimImageHandler.

Definition at line 327 of file ossimImageCacheBase.cpp.

 {
    if (reduced_res_level == 0)
    {
       return m_numberOfLines;
    }
    else if (theOverview.valid())
    {
       return theOverview->getNumberOfLines(reduced_res_level);
    }
    
    return 0;
 }

◆ getNumberOfOutputBands()

ossim_uint32 ossimImageCacheBase::getNumberOfOutputBands ( ) const

virtual

This method allows one to query the number of output bands.

This might not be the same as the n umber of input bands.

See also: getNumberOfInputBands().

Returns: number of output bands.

Reimplemented from ossimImageSource.

Reimplemented in ossimImageCacheTileSource.

Definition at line 322 of file ossimImageCacheBase.cpp.

 {
   return m_numberOfBands;
 }

◆ getNumberOfSamples()

ossim_uint32 ossimImageCacheBase::getNumberOfSamples ( ossim_uint32 reduced_res_level = 0 ) const

virtual

Satisfies pure virtual requirement from ImageHandler class.

Parameters

reduced_res_level The reduced res level to query number of samples from.

Returns: The number of samples in the image.

Implements ossimImageHandler.

Definition at line 341 of file ossimImageCacheBase.cpp.

 {
    if (reduced_res_level == 0)
    {
       return m_numberOfSamples;
    }
    else if (theOverview.valid())
    {
       return theOverview->getNumberOfSamples(reduced_res_level);
    }
    
    return 0;
 }

◆ getTileHeight()

ossim_uint32 ossimImageCacheBase::getTileHeight ( ) const

virtual

Returns the height of the output tile.

Reimplemented from ossimImageSource.

Definition at line 375 of file ossimImageCacheBase.cpp.

 {
    return m_tileSize.y;
 }

◆ getTileWidth()

ossim_uint32 ossimImageCacheBase::getTileWidth ( ) const

virtual

Returns the width of the output tile.

Reimplemented from ossimImageSource.

Definition at line 370 of file ossimImageCacheBase.cpp.

 {
    return m_tileSize.x;
 }

◆ isOpen()

bool ossimImageCacheBase::isOpen ( ) const

virtual

Determines if its open if there eists a table of contents object.

Returns: True if the handler is open and flase otherwise.

Implements ossimImageHandler.

Definition at line 97 of file ossimImageCacheBase.cpp.

References ossimString::downcase().

 {
   //return (theTableOfContents!=0);
   ossimString ext = theImageFile.ext().downcase();
 
   if(ext == "rpf")
   {
     return true;
   }
   else
   {
     return false;
   }
 }

◆ isValidRLevel()

bool ossimImageCacheBase::isValidRLevel ( ossim_uint32 reduced_res_level ) const

virtual

Parameters

reduced_res_level passed in resolution level.

Returns: True if the reduced_res_level is within an acceptable range and false otherwise.

Reimplemented from ossimImageHandler.

Definition at line 385 of file ossimImageCacheBase.cpp.

 {
    if (reduced_res_level == 0)
    {
       return true;
    }
    else if (theOverview.valid())
    {
       return theOverview->isValidRLevel(reduced_res_level);
    }
    else
    {
       return false;
    }
 }

◆ loadState()

bool ossimImageCacheBase::loadState	(	const ossimKeywordlist &	kwl,
		const char *	prefix = `0`
	)

virtual

Method to load the state of an object from a keyword list.

Loading with a prefix.

cibCadrgHandler->laodState(kwl, "handler1.");

Loading without a prefix.

cibCadrgHandler->laodState(kwl);

Since all objects are factory created you can go through the registry and pass the keyword list in.

ossimImageHandler* handler = ossimImageHandlerRegistry::instance()->open(kwl, prefix);

Parameters

kwl	Keywordlist that holds the state information for this object.
prefix	prefix value prepended to all keywords to uniquely locate the state attributes for this object.

Reimplemented from ossimImageHandler.

Definition at line 450 of file ossimImageCacheBase.cpp.

 {
    const char* MODULE = "ossimImageCacheBase::loadState";
 
    if(traceDebug())
    {
       CLOG << "Entering..." << endl;
    }
    bool result = ossimImageHandler::loadState(kwl, prefix);
 
    if(!result)
    {
       if(traceDebug())
       {
          CLOG << "Leaving..." << endl;
       }
       return false;
    }
    const char* lookup = 0;
    lookup = kwl.find(ossimString(prefix), "entry");
    ossim_int32 entry = ossimString(lookup).toInt32();
 
    // if an entry is specified then
    // call the open with an entry number
    if(lookup)
    {
       if(traceDebug())
       {
          CLOG << "Leaving..." << endl;
       }
       result = ossimImageHandler::open(theImageFile);
       setCurrentEntry(entry);
       return result;
    }
 
    result = ossimImageHandler::open(theImageFile);
 
    return result;
 }

◆ open()

virtual bool ossimImageCacheBase::open ( )

pure virtual

Pure virtual open.

Derived classes must implement.

Returns: Returns true on success, false on error.

Note: This method relies on the data member ossimImageData::theImageFile being set. Callers should do a "setFilename" prior to calling this method or use the ossimImageHandler::open that takes a file name and an entry index.

Implements ossimImageHandler.

Implemented in ossimImageCacheTileSource.

◆ saveState()

bool ossimImageCacheBase::saveState	(	ossimKeywordlist &	kwl,
		const char *	prefix = `0`
	)		const

virtual

Parameters

kwl	Keywordlist to save the state of the object to.
prefix	prefix to prepend to the keywords. This will help uniquely identify each keyword if multiple objects are saved to the same list.

Returns: True if successfully saved the state of the object and false otherwise.

Reimplemented from ossimImageHandler.

Definition at line 442 of file ossimImageCacheBase.cpp.

References ossimImageHandler::saveState().

 {
    bool result = ossimImageHandler::saveState(kwl, prefix);
 
    return result;
 }

◆ setActualImageRect()

void ossimImageCacheBase::setActualImageRect ( )

protected

Will shift the rect and clamp it so not to go outside the -180 to 180 degree range.

Definition at line 355 of file ossimImageCacheBase.cpp.

 {
    m_actualImageRect = ossimIrect(0,0,m_numberOfLines, m_numberOfSamples);
 }

Member Data Documentation

◆ m_actualImageRect

ossimIrect ossimImageCacheBase::m_actualImageRect

protected

This holds the image bounds for the current entry.

Definition at line 288 of file ossimImageCacheBase.h.

◆ m_bBox_LL_Lat

ossim_float64 ossimImageCacheBase::m_bBox_LL_Lat

protected

Definition at line 324 of file ossimImageCacheBase.h.

◆ m_bBox_LL_Lon

ossim_float64 ossimImageCacheBase::m_bBox_LL_Lon

protected

Definition at line 323 of file ossimImageCacheBase.h.

◆ m_bBox_UR_Lat

ossim_float64 ossimImageCacheBase::m_bBox_UR_Lat

protected

Definition at line 326 of file ossimImageCacheBase.h.

◆ m_bBox_UR_Lon

ossim_float64 ossimImageCacheBase::m_bBox_UR_Lon

protected

Definition at line 325 of file ossimImageCacheBase.h.

◆ m_fileNames

std::vector<ossimString> ossimImageCacheBase::m_fileNames

protected

The size of the input frames.

Definition at line 312 of file ossimImageCacheBase.h.

◆ m_frame_height

ossim_uint32 ossimImageCacheBase::m_frame_height

protected

Definition at line 330 of file ossimImageCacheBase.h.

◆ m_frame_width

ossim_uint32 ossimImageCacheBase::m_frame_width

protected

Definition at line 329 of file ossimImageCacheBase.h.

◆ m_frameEntryArray

std::vector< std::vector<ossimRpfFrameEntry> > ossimImageCacheBase::m_frameEntryArray

protected

Definition at line 332 of file ossimImageCacheBase.h.

◆ m_numberOfBands

ossim_uint32 ossimImageCacheBase::m_numberOfBands

protected

This is the actual data returned from a getTile request.

Definition at line 307 of file ossimImageCacheBase.h.

◆ m_numberOfLines

ossim_uint32 ossimImageCacheBase::m_numberOfLines

protected

This will be computed based on the frames organized within the directory.

The CibCadrg have fixed size frames of 1536x1536 and we must count how many there are.

Definition at line 295 of file ossimImageCacheBase.h.

◆ m_numberOfSamples

ossim_uint32 ossimImageCacheBase::m_numberOfSamples

protected

This will be computed based on the frames organized within the directory.

The CibCadrg have fixed size frames of 1536x1536 and we must count how many there are.

Definition at line 302 of file ossimImageCacheBase.h.

◆ m_numOfFramesHorizontal

ossim_uint32 ossimImageCacheBase::m_numOfFramesHorizontal

protected

Definition at line 328 of file ossimImageCacheBase.h.

◆ m_numOfFramesVertical

ossim_uint32 ossimImageCacheBase::m_numOfFramesVertical

protected

Definition at line 327 of file ossimImageCacheBase.h.

◆ m_tileSize

ossimIpt ossimImageCacheBase::m_tileSize

protected

The size of the output tile.

Definition at line 317 of file ossimImageCacheBase.h.

◆ m_workFrame

ossimRpfFrame* ossimImageCacheBase::m_workFrame

mutableprotected

Definition at line 319 of file ossimImageCacheBase.h.

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

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ossimImageCacheBase()

◆ ~ossimImageCacheBase()

Member Function Documentation

◆ buildFrameEntryArray()

◆ checkLongitude()

◆ close()

◆ deleteAll()

◆ establishDecimationFactors()

◆ getEntryList()

◆ getImageGeometry()

◆ getImageRectangle()

◆ getImageTileHeight()

◆ getImageTileWidth()

◆ getIntersectingEntries()

◆ getNumberOfInputBands()

◆ getNumberOfLines()

◆ getNumberOfOutputBands()

◆ getNumberOfSamples()

◆ getTileHeight()

◆ getTileWidth()

◆ isOpen()

◆ isValidRLevel()

◆ loadState()

◆ open()

◆ saveState()

◆ setActualImageRect()

Member Data Documentation

◆ m_actualImageRect

◆ m_bBox_LL_Lat

◆ m_bBox_LL_Lon

◆ m_bBox_UR_Lat

◆ m_bBox_UR_Lon

◆ m_fileNames

◆ m_frame_height

◆ m_frame_width

◆ m_frameEntryArray

◆ m_numberOfBands

◆ m_numberOfLines

◆ m_numberOfSamples

◆ m_numOfFramesHorizontal

◆ m_numOfFramesVertical

◆ m_tileSize

◆ m_workFrame