This class defines an abstract Handler which all image handlers(loaders) should derive from. More...

#include <ossimImageHandler.h>

Inheritance diagram for ossimImageHandler:

Public Types
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

Public Member Functions
	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 ()=0
	Pure virtual 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 void	close ()
	Deletes the overview and clears the valid image vertices. More...

virtual bool	isOpen () const =0
	Derived classes must implement this method to be concrete. More...

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 ossimRefPtr< ossimImageGeometry >	getImageGeometry ()
	Returns the image geometry object associated with this tile source or NULL if non defined. 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 ossim_uint32	getNumberOfLines (ossim_uint32 resLevel=0) const =0
	Pure virtual, derived classes must implement. More...

virtual ossim_uint32	getNumberOfSamples (ossim_uint32 resLevel=0) const =0
	Pure virtual, derived classes must implement. More...

virtual ossimIrect	getImageRectangle (ossim_uint32 resLevel=0) const
	Returns zero-based bounding rectangle of the image. 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...

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

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

virtual bool	isValidRLevel (ossim_uint32 resLevel) const
	Determines if the passed in reslution level is valid. 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 ossim_uint32	getImageTileWidth () const =0
	Returns the tile width of the image or 0 if the image is not tiled. More...

virtual ossim_uint32	getImageTileHeight () const =0
	Returns the tile width of the image or 0 if the image is not tiled. 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	getEntryList (std::vector< ossim_uint32 > &entryList) const

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 ossim_uint32	getNumberOfInputBands () const =0

virtual ossim_uint32	getNumberOfOutputBands () const
	Returns the number of bands in a tile returned from this TileSource. 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 ossim_uint32	getTileWidth () const
	Returns the default processing tile width. More...

virtual ossim_uint32	getTileHeight () const
	Returns the default processing tile height. 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 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 void	establishDecimationFactors ()
	Virtual method determines the decimation factors at each resolution level. 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
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

Detailed Description

This class defines an abstract Handler which all image handlers(loaders) should derive from.

Definition at line 35 of file ossimImageHandler.h.

Member Enumeration Documentation

◆ ossimImageHandlerOverviewCompressionType

enum ossimImageHandler::ossimImageHandlerOverviewCompressionType

Enumerator
OSSIM_OVERVIEW_COMPRESSION_NONE
OSSIM_OVERVIEW_COMPRESSION_JPEG
OSSIM_OVERVIEW_COMPRESSION_LZW
OSSIM_OVERVIEW_COMPRESSION_DEFLATE
OSSIM_OVERVIEW_COMPRESSION_PACKBITS

Definition at line 39 of file ossimImageHandler.h.

Constructor & Destructor Documentation

◆ ossimImageHandler()

ossimImageHandler::ossimImageHandler ( )

Constructor (default):

Definition at line 65 of file ossimImageHandler.cpp.

 :
 ossimImageSource(0, 0, 0, true, false /* output list is not fixed */ ),
 theImageFile(ossimFilename::NIL),
 theOverviewFile(ossimFilename::NIL),
 theSupplementaryDirectory(ossimFilename::NIL),
 theOverview(0),
 theValidImageVertices(0),
 theMetaData(),
 theGeometry(),
 theLut(0),
 theDecimationFactors(0),
 theImageID(""),
 theStartingResLevel(0),
 theOpenOverviewFlag(true),
 thePixelType(OSSIM_PIXEL_IS_POINT)
 {
    if (traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "ossimImageHandler::ossimImageHandler() DEBUG:" << std::endl;
 #ifdef OSSIM_ID_ENABLED
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "OSSIM_ID:  "
          << OSSIM_ID
          << std::endl;
 #endif      
    }
 
    // Check for global preference supplementary dir.
    theSupplementaryDirectory.string() = ossimPreferences::instance()->
       preferencesKWL().findKey( std::string("ossim_supplementary_directory") );
 }

◆ ~ossimImageHandler()

ossimImageHandler::~ossimImageHandler ( )

virtual

Destructor: Derived classes should implement.

Definition at line 99 of file ossimImageHandler.cpp.

References theOverview.

 {
    theOverview = 0;
 }

Member Function Documentation

◆ buildAllHistograms()

bool ossimImageHandler::buildAllHistograms	(	int	numberOfRLevels = `0`,
		ossimHistogramMode	mode = `OSSIM_HISTO_MODE_NORMAL`
	)

virtual

Build a histograms for all image entries.

Parameters

numberOfRLevels	sets the maximum number of reduced resolution level to compute histogram for.
mode	OSSIM_HISTO_MODE_NORMAL or OSSIM_HISTO_MODE_FAST.

Returns: true on success, false if not open.

Definition at line 552 of file ossimImageHandler.cpp.

References buildHistogram(), getCurrentEntry(), getEntryList(), and setCurrentEntry().

 {
    ossim_uint32 currentEntry = getCurrentEntry();
    std::vector<ossim_uint32> entryList;
    getEntryList(entryList);
    ossim_uint32 idx = 0;
    for(idx = 0; idx < entryList.size(); ++idx)
    {
       setCurrentEntry(entryList[idx]);
       if(!buildHistogram( numberOfRLevels, mode ))
       {
          setCurrentEntry(currentEntry);
          return false;
       }
    }
    
    setCurrentEntry(currentEntry);
    return true;
 }

◆ buildAllOverviews()

bool ossimImageHandler::buildAllOverviews	(	ossimImageHandlerOverviewCompressionType	compressionType = `OSSIM_OVERVIEW_COMPRESSION_NONE`,
		ossim_uint32	quality = `75`,
		ossimFilterResampler::ossimFilterResamplerType	resampleType = `ossimFilterResampler::ossimFilterResampler_BOX`,
		bool	includeFullResFlag = `false`
	)

virtual

Will build over file for all image entries.

Parameters

includeFullResFlag if true the full resolution layer will also be put in the overview format. This is handly for inefficeint formats.

Definition at line 589 of file ossimImageHandler.cpp.

References buildOverview(), getCurrentEntry(), getEntryList(), and setCurrentEntry().

 {
    ossim_uint32 currentEntry = getCurrentEntry();
    std::vector<ossim_uint32> entryList;
    getEntryList(entryList);
    ossim_uint32 idx = 0;
    for(idx = 0; idx < entryList.size(); ++idx)
    {
       setCurrentEntry(entryList[idx]);
       if(!buildOverview(compressionType, quality, resampleType, includeFullResFlag))
       {
          setCurrentEntry(currentEntry);
          return false;
       }
    }
    
    setCurrentEntry(currentEntry);
    return true;
 }

◆ buildHistogram()

bool ossimImageHandler::buildHistogram	(	int	numberOfRLevels = `0`,
		ossimHistogramMode	mode = `OSSIM_HISTO_MODE_NORMAL`
	)

virtual

Build a histogram for image file.

Parameters

numberOfRLevels	sets the maximum number of reduced resolution level to compute histogram for.
mode	OSSIM_HISTO_MODE_NORMAL or OSSIM_HISTO_MODE_FAST.

Returns: true on success, false if not open.

Definition at line 507 of file ossimImageHandler.cpp.

References ossimListenerManager::addListener(), ossimConnectableObject::connectMyInputTo(), ossimConnectableObject::disconnect(), ossimSource::enableSource(), ossimHistogramWriter::execute(), ossimRefPtr< T >::get(), getFilenameWithThisExtension(), getNumberOfDecimationLevels(), isOpen(), ossimImageHistogramSource::setComputationMode(), ossimHistogramWriter::setFilename(), ossimImageHistogramSource::setMaxNumberOfRLevels(), and theStdOutProgress.

Referenced by buildAllHistograms(), and ATP::AtpGenerator::constructChain().

 {
    if(isOpen())
    {
       ossimFilename file =
          getFilenameWithThisExtension(ossimString(".his"));
       
       ossimRefPtr<ossimImageHistogramSource> histoSource = new ossimImageHistogramSource;
       ossimRefPtr<ossimHistogramWriter> writer = new ossimHistogramWriter;
       
       if(numberOfRLevels)
       {
          histoSource->setMaxNumberOfRLevels(numberOfRLevels);
       }
       else
       {
          histoSource->setMaxNumberOfRLevels(getNumberOfDecimationLevels());
       }
       
       //---
       // Note if mode==OSSIM_HISTO_MODE_UNKNOWN the histoSource defaults to
       // normal mode.
       //---
       histoSource->setComputationMode( mode );
 
       histoSource->connectMyInputTo(0, this);
       histoSource->enableSource();
       writer->connectMyInputTo(0, histoSource.get());
       writer->setFilename(file);
       writer->addListener(&theStdOutProgress);
       writer->execute();
       histoSource->disconnect();
       writer->disconnect();
       histoSource = 0;
       writer = 0;
    }
    else
    {
       return false;
    }
    
    return true;
 }

◆ buildOverview() [1/2]

bool ossimImageHandler::buildOverview	(	ossimImageHandlerOverviewCompressionType	compressionType = `OSSIM_OVERVIEW_COMPRESSION_NONE`,
		ossim_uint32	quality = `75`,
		ossimFilterResampler::ossimFilterResamplerType	resampleType = `ossimFilterResampler::ossimFilterResampler_BOX`,
		bool	includeFullResFlag = `false`
	)

virtual

Will build over file for theImageFile.

Parameters

includeFullResFlag if true the full resolution layer will also be put in the overview format. This is handly for inefficeint formats.

Definition at line 573 of file ossimImageHandler.cpp.

References getFilenameWithThisExtension(), openOverview(), and theOverviewFile.

Referenced by buildAllOverviews().

 {
    ossimFilename file = getFilenameWithThisExtension(ossimString(".ovr"));
 
    theOverviewFile = file;
    if(buildOverview(file, compressionType, quality, resampleType, includeFullResFlag))
    {
       openOverview();
    }
 
    return true;
 }

◆ buildOverview() [2/2]

bool ossimImageHandler::buildOverview	(	const ossimFilename &	filename,
		ossimImageHandlerOverviewCompressionType	compressionType = `OSSIM_OVERVIEW_COMPRESSION_NONE`,
		ossim_uint32	quality = `75`,
		ossimFilterResampler::ossimFilterResamplerType	resampleType = `ossimFilterResampler::ossimFilterResampler_BOX`,
		bool	includeFullResFlag = `false`
	)

virtual

Will build an over file for filename.

Parameters

filename	Name of image file.
includeFullResFlag	if true the full resolution layer will also be put in the overview format. This is handly for inefficeint formats.

Definition at line 613 of file ossimImageHandler.cpp.

References ossimTiffOverviewBuilder::buildOverview(), closeOverview(), ossim::COMPRESSION_NONE, isOpen(), OSSIM_OVERVIEW_COMPRESSION_DEFLATE, OSSIM_OVERVIEW_COMPRESSION_JPEG, OSSIM_OVERVIEW_COMPRESSION_LZW, OSSIM_OVERVIEW_COMPRESSION_NONE, OSSIM_OVERVIEW_COMPRESSION_PACKBITS, ossimTiffOverviewBuilder::setCompressionType(), ossimTiffOverviewBuilder::setInputSource(), ossimTiffOverviewBuilder::setJpegCompressionQuality(), ossimTiffOverviewBuilder::setResampleType(), and theOverviewFile.

 {
    closeOverview();
    if(!isOpen())
    {
       return false;
    }
 
    theOverviewFile = filename;
    ossimTiffOverviewBuilder tiffBuilder;
    if ( tiffBuilder.setInputSource(this) == false )
    {
       return false;
    }
    
    ossim_uint16 cType = COMPRESSION_NONE;
    switch(compressionType)
    {
       case OSSIM_OVERVIEW_COMPRESSION_NONE:
       {
          cType = COMPRESSION_NONE;
          break;
       }
       case OSSIM_OVERVIEW_COMPRESSION_JPEG:
       {
          cType = COMPRESSION_JPEG;
          break;
       }
       case OSSIM_OVERVIEW_COMPRESSION_LZW:
       {
          cType = COMPRESSION_LZW;
          break;
       }
       case OSSIM_OVERVIEW_COMPRESSION_DEFLATE:
       {
 
          cType = COMPRESSION_DEFLATE;
          break;
       }
       case OSSIM_OVERVIEW_COMPRESSION_PACKBITS:
       {
          cType = COMPRESSION_PACKBITS;
          break;
       }
    }
    tiffBuilder.setJpegCompressionQuality(quality);
    tiffBuilder.setCompressionType(cType);
    tiffBuilder.setResampleType(resampleType);
    tiffBuilder.buildOverview(filename, includeFullResFlag);
 
    return true;
 }

◆ canConnectMyInputTo()

bool ossimImageHandler::canConnectMyInputTo	(	ossim_int32	inputIndex,
		const ossimConnectableObject *	object
	)		const

virtual

Connection rule.

Since image handler currently don't have any inputs this will just return false saying we can't connect anything to an image handler.

Implements ossimConnectableObject.

Reimplemented in ossimImageHandlerMtAdaptor.

Definition at line 1538 of file ossimImageHandler.cpp.

 {      
    return false;
 }

◆ close()

void ossimImageHandler::close ( )

virtual

Deletes the overview and clears the valid image vertices.

Derived classes should implement.

Reimplemented in ossimPngReader, ossimGpkgReader, ossimOpjJp2Reader, ossimJpegTileSource, ossimH5ImageHandler, ossimHdfReader, ossimHdf5ImageHandler, ossimAdrgTileSource, ossimGeneralRasterTileSource, ossimBitMaskTileSource, ossimNitfTileSource, ossimRangeDomeTileSource, ossimCibCadrgTileSource, ossimTiffTileSource, ossimLasReader, ossimplugins::ossimTerraSarTiffReader, ossimRpfCacheTileSource, ossimPointCloudImageHandler, ossimplugins::ossimRadarSat2TiffReader, ossimImageHandlerMtAdaptor, ossimDtedTileSource, ossimCcfTileSource, ossimImageCacheTileSource, ossimOgrGdalTileSource, ossimOgrVectorTileSource, ossimTiledImageHandler, ossimGdalTileSource, ossimKakaduJpipHandler, ossimBandSeparateHandler, ossimKmlSuperOverlayReader, ossimImageCacheBase, ossimVideoImageHandler, and ossimVpfTileSource.

Definition at line 1264 of file ossimImageHandler.cpp.

References setState(), theDecimationFactors, theGeometry, theOverview, and theValidImageVertices.

Referenced by ossimKakaduJpipHandler::close(), ossimImageHandlerMtAdaptor::close(), ossimPointCloudImageHandler::close(), ossimLasReader::close(), ossimTiffTileSource::close(), ossimCibCadrgTileSource::close(), ossimBitMaskTileSource::close(), ossimGeneralRasterTileSource::close(), ossimHdf5ImageHandler::close(), ossimH5ImageHandler::close(), ossimOpjJp2Reader::close(), ossimGpkgReader::close(), ossimPngReader::close(), ossimMG4LidarReader::closeEntry(), ossimGeoPdfReader::closeEntry(), ossimMrSidReader::closeEntry(), ossimKakaduJp2Reader::closeEntry(), ossimKakaduJ2kReader::closeEntry(), ossimGeoidImage::open(), open(), and ossimHdfReader::~ossimHdfReader().

 {
    theOverview = 0;
    theGeometry = 0;
    theValidImageVertices.clear();
    theDecimationFactors.clear();
    setState(0);
 }

◆ closeOverview()

void ossimImageHandler::closeOverview ( )

virtual

If theOverview is initialized it will be deleted and set to NULL.

Also clears theOverviewFile.

Returns: void

Definition at line 830 of file ossimImageHandler.cpp.

References theOverview.

Referenced by buildOverview(), and ossimImageHandlerMtAdaptor::close().

 {
    theOverview = 0;
 }

◆ completeOpen()

void ossimImageHandler::completeOpen ( )

protectedvirtual

Will complete the opening process.

If there are overviews it will open them. If there is meta data it will open that and if there is valid vertices it will open that.

Reimplemented in ossimLasReader.

Definition at line 1519 of file ossimImageHandler.cpp.

Referenced by ossimBandSeparateHandler::open(), ossimPointCloudImageHandler::open(), ossimPngReader::open(), ossimKakaduJpipHandler::openStream(), ossimHdf5ImageHandler::setCurrentEntry(), ossimH5ImageHandler::setCurrentEntry(), ossimNitfTileSource::setCurrentEntry(), ossimGpkgReader::setCurrentEntry(), ossimRpfCacheTileSource::setCurrentEntry(), ossimCibCadrgTileSource::setCurrentEntry(), ossimPointCloudImageHandler::setPointCloudHandler(), and setSupplementaryDirectory().

 {
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG) << "ossimImageHandler::completeOpen(): Entered........" << std::endl;
    }
    loadMetaData();
    if ( theOpenOverviewFlag )
    {
       openOverview();
    }
    establishDecimationFactors();
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG) << "ossimImageHandler::completeOpen(): Leaving......." << std::endl;
    }
    openValidVertices();
 }

◆ createDefaultGeometryFilename()

ossimFilename ossimImageHandler::createDefaultGeometryFilename ( ) const

virtual

Returns: ossimFilename represents an external OSSIM geometry filename.

Definition at line 1844 of file ossimImageHandler.cpp.

References getFilenameWithThisExtension().

Referenced by getProperty().

 {
    return getFilenameWithThisExtension("geom");
 }

◆ createDefaultHistogramFilename()

ossimFilename ossimImageHandler::createDefaultHistogramFilename ( ) const

virtual

Returns: ossimFilename represents an external OSSIM histogram filename.

Definition at line 1854 of file ossimImageHandler.cpp.

References getFilenameWithThisExtension().

Referenced by getProperty().

 {
    return getFilenameWithThisExtension("his");
 }

◆ createDefaultMetadataFilename()

ossimFilename ossimImageHandler::createDefaultMetadataFilename ( ) const

virtual

Returns: ossimFilename represents an external OSSIM metadata filename.

Definition at line 1849 of file ossimImageHandler.cpp.

References getFilenameWithThisExtension().

Referenced by getProperty().

 {
    return getFilenameWithThisExtension("omd");
 }

◆ createDefaultOverviewFilename()

ossimFilename ossimImageHandler::createDefaultOverviewFilename ( ) const

virtual

Returns: ossimFilename represents an external OSSIM overview filename.

Definition at line 1839 of file ossimImageHandler.cpp.

References getFilenameWithThisExtension().

Referenced by getProperty().

 {
    return getFilenameWithThisExtension("ovr");
 }

◆ createDefaultValidVerticesFilename()

ossimFilename ossimImageHandler::createDefaultValidVerticesFilename ( ) const

virtual

Returns: ossimFilename represents an external OSSIM valid vertices filename.

Definition at line 1859 of file ossimImageHandler.cpp.

References ossimFilename::dirCat(), ossimFilename::fileNoExtension(), getCurrentEntry(), getNumberOfEntries(), ossimFilename::path(), theImageFile, and ossimString::toString().

Referenced by getProperty(), ATP::AtpGenerator::getValidVertices(), and writeValidImageVertices().

 {
    ossimFilename result;
    
    result = theImageFile.path();
    result = result.dirCat(theImageFile.fileNoExtension());
    result += "_vertices";
    if(getNumberOfEntries() > 1)
    {
       result += "_e";
       result += ossimString::toString(getCurrentEntry());
    }
    result += ".kwl";
    
    return result;
 }

◆ establishDecimationFactors()

void ossimImageHandler::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 in ossimNitfTileSource, ossimRpfCacheTileSource, ossimImageCacheBase, and ossimBitMaskTileSource.

Definition at line 442 of file ossimImageHandler.cpp.

References getNumberOfDecimationLevels(), getNumberOfLines(), getNumberOfSamples(), theDecimationFactors, ossimDpt::x, and ossimDpt::y.

Referenced by ossimLasReader::completeOpen(), ossimImageCacheBase::establishDecimationFactors(), ossimRpfCacheTileSource::establishDecimationFactors(), and ossimNitfTileSource::establishDecimationFactors().

 {
    double line_decimation, samp_decimation, decimation, ratio;
    ossim_uint32 num_lines, num_samps;
    
    // The error margin here is effectively the percent error tolerated between ideal number of 
    // pixels for given power-of-2 decimation, and the actual number of pixels found at this 
    // decimation level. Typically, the last level will have fewer pixels than expected, hence the 
    // need for this logic...
    static const double ERROR_MARGIN = 1.1;  // 10% allowance
 
    // NOTE -- Until the end of this method, all decimation values are actually inverse quantities,
    // i.e., a decimation of 0.5 typical for rlevel 1 is represented here as 2. This facilitates the
    // fuzzy logic for recognizing powers of 2 (as integers)
 
    // Default implementation assumes R0 is not decimated. Check for R0 defined by derived class
    // however, in case this is not the case:
    ossimDpt decimation_r0 (1.0, 1.0);
    if (theDecimationFactors.size() > 0)
    {
       decimation_r0.x = 1.0/theDecimationFactors[0].x; // note use of inverse decimation
       decimation_r0.y = 1.0/theDecimationFactors[0].y; 
    }
    else
       theDecimationFactors.push_back(decimation_r0);
 
    // Variables used in loop below:
    ossim_uint32 num_lines_r0 = getNumberOfLines(0);
    ossim_uint32 num_samps_r0 = getNumberOfSamples(0);
    ossim_uint32 power_of_2_decimation = (ossim_uint32) decimation_r0.x;
 
    // Remaining res levels are computed as a ratio of image size at R0 to image size at Rn:
    ossim_uint32 nRlevels = getNumberOfDecimationLevels();
    for(ossim_uint32 res_level = 1; res_level < nRlevels; ++res_level)
    {
       num_lines = getNumberOfLines(res_level);
       num_samps = getNumberOfSamples(res_level);
       
       if ((num_lines < 2) || (num_samps < 2)) 
          break;
 
       line_decimation = decimation_r0.y * num_lines_r0 / (double)num_lines;
       samp_decimation = decimation_r0.x * num_samps_r0 / (double)num_samps;
       decimation = line_decimation<samp_decimation ? line_decimation:samp_decimation;
 
       // Check for possible error due to inexact ratios.
       // Loop until reasonable effort was made to establish the corresponding power-of-2 decimation.
       // If close match is found, the exact integer value is assigned:
       do 
       {
          power_of_2_decimation *= 2;
          ratio = (double)power_of_2_decimation / decimation;
          if (ratio < 1.0)
             ratio = 1.0/ratio;
          if (ratio < ERROR_MARGIN)
             decimation = (double) power_of_2_decimation;
 
       } while ((double) power_of_2_decimation < decimation);
 
       // Convert the computed decimation back to fractional form before saving in the factors list:
       decimation = 1.0/decimation;
       theDecimationFactors.push_back(ossimDpt(decimation, decimation));
    }
 }

◆ getBoundingRect()

ossimIrect ossimImageHandler::getBoundingRect ( ossim_uint32 resLevel = 0 ) const

virtual

Returns zero-based bounding rectangle of the image.

Same as getImageRectangle() call. Note sub-image offset now in ossimImageGeometry class.

Parameters

resLevel Reduced resolution level for rectangle.

Returns: Rectangle of reduced resolution level.

Reimplemented from ossimImageSource.

Definition at line 413 of file ossimImageHandler.cpp.

References getImageRectangle().

Referenced by ossimTiledImageHandler::allocate(), ossimBitMaskWriter::connectMyInputTo(), ossimVerticesFinderTool::execute(), ossimInfo::getCenterImage(), ossimInfo::getImageGeometryInfo(), ossimInfo::getImageInfo(), ossimInfo::getImageRect(), ossimNitfTileSource::getImageTileHeight(), ossimNitfTileSource::getImageTileWidth(), ossimGdalTileSource::getMaxSize(), ossimGdalTileSource::getTile(), ossimMrSidReader::getTile(), ossimMG4LidarReader::getTile(), ossimKakaduJpipHandler::getTileAtRes(), ossimGdalTileSource::getTileBlockRead(), ossimNitfTileSource::getTileHeight(), ossimNitfTileSource::getTileWidth(), ATP::AtpGenerator::getValidVertices(), initImageParameters(), main(), ossimBitMaskTileSource::open(), ossimGdalTileSource::setRlevelCache(), and ossimRpcSolver::solve().

 {
    return getImageRectangle(resLevel);
 }

◆ getCurrentEntry()

ossim_uint32 ossimImageHandler::getCurrentEntry ( ) const

virtual

Returns: The current entry number.

Note: This implementation returns 0. Derived classes should override if of multiple entry image type.

Reimplemented in ossimCibCadrgTileSource, ossimHdfReader, ossimH5ImageHandler, ossimNitfTileSource, ossimGpkgReader, ossimGdalTileSource, ossimHdf5ImageHandler, ossimLasReader, ossimPointCloudImageHandler, and ossimVideoImageHandler.

Definition at line 1461 of file ossimImageHandler.cpp.

Referenced by buildAllHistograms(), buildAllOverviews(), createDefaultValidVerticesFilename(), ossimProjectionFactoryBase::createProjection(), ossimTiffProjectionFactory::createProjection(), ossimNitfProjectionFactory::createProjection(), getExternalImageGeometry(), getFilenameWithThisExtension(), ossimKakaduJpipHandler::getImageGeometry(), getProperty(), and openValidVertices().

 {
    return 0;
 }

◆ getDecimationFactor()

void ossimImageHandler::getDecimationFactor	(	ossim_uint32	resLevel,
		ossimDpt &	result
	)		const

virtual

Parameters

resLevel	Reduced resolution set for requested decimation.
result	ossimDpt to initialize with requested decimation.

Note: Initialized "result" with the decimation factor for the passed in resLevel. Most of the time the returned factor is a square decimation along x and y indicated by result.x and .y = 1.0/(resLevel^2) where ^ means rasing to the power of. If the resLevel is 1 then the return decimation .5, .5. this is not the decimation to each resolution level but the total decimation from res level 0. So if resLevel is 2 then the return is .25, .25.; Derived classes should override if the decimation is anything other than a power of two change in each direction per res level.

Reimplemented from ossimImageSource.

Reimplemented in ossimGdalTileSource, ossimKakaduJ2kReader, and ossimMrSidReader.

Definition at line 419 of file ossimImageHandler.cpp.

References ossimDpt::makeNan(), and theDecimationFactors.

Referenced by ossimTiledImageHandler::getImageRectangle(), and getValidImageVertices().

 {
    if (resLevel < theDecimationFactors.size())
       result = theDecimationFactors[resLevel];
    else
       result.makeNan();
 }

◆ getDecimationFactors()

void ossimImageHandler::getDecimationFactors ( vector< ossimDpt > & decimations ) const

virtual

This returns all decimation for all levels.

Reimplemented in ossimKakaduJ2kReader, and ossimMrSidReader.

Definition at line 427 of file ossimImageHandler.cpp.

References theDecimationFactors.

Referenced by ossimImageModel::initialize().

 {
    decimations = theDecimationFactors;
 }

◆ getEntryList()

void ossimImageHandler::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 in ossimCibCadrgTileSource, ossimRpfCacheTileSource, ossimGeoPdfReader, ossimGdalTileSource, ossimNitfTileSource, ossimGpkgReader, ossimOgrVectorTileSource, ossimHdfReader, ossimH5ImageHandler, ossimHdf5ImageHandler, ossimLasReader, ossimImageCacheBase, ossimPointCloudImageHandler, and ossimVideoImageHandler.

Definition at line 1476 of file ossimImageHandler.cpp.

Referenced by buildAllHistograms(), buildAllOverviews(), ossimInfo::getCenterGround(), ossimInfo::getCenterImage(), ossimOgrVectorTileSource::getEntryList(), ossimGeoPdfReader::getEntryList(), ossimInfo::getGrd2img(), ossimInfo::getImageBounds(), ossimInfo::getImageGeometryInfo(), ossimInfo::getImageInfo(), ossimInfo::getImagePalette(), ossimInfo::getImageRect(), ossimInfo::getImg2grd(), ossimInfo::getNorthUpAngle(), getNumberOfEntries(), getProperty(), ossimInfo::getUpIsUpAngle(), and useEntryIndex().

 {
    entryList.push_back(0);
 }

◆ getEntryName()

void ossimImageHandler::getEntryName	(	ossim_uint32	entryIdx,
		std::string &	name
	)		const

virtual

Get the name of entry as a string.

This implementation clears name. Derived classes that support multiple entries and have "named" entries should re-implement to provide entry names. Example given from HDF5 file:

entry_name: /All_Data/VIIRS-IMG-GTM-EDR-GEO_All/QF1_VIIRSGTMGEO

Parameters

entryIdx	Zero based entry index. If out of range name will be cleared.
name	Initialized by this.

Definition at line 1510 of file ossimImageHandler.cpp.

References getEntryNames().

Referenced by ossimInfo::getImageInfo().

 {
    name = "";
    std::vector<ossimString> entryNames;
    getEntryNames(entryNames);
    if (entryIdx < entryNames.size())
       name = entryNames[entryIdx].string();
 }

◆ getEntryNames()

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

virtual

Parameters

getEntryNames List to initialize with strings associated with entries.

Note: This implementation calls getEntryList and converts entries in the list to strings. Derived classes that support multiple entries with associated strings should re-implement.

Reimplemented in ossimGpkgReader, ossimGdalTileSource, ossimH5ImageHandler, ossimHdf5ImageHandler, and ossimPointCloudImageHandler.

Definition at line 1505 of file ossimImageHandler.cpp.

Referenced by getEntryName(), and ossimGdalTileSource::getEntryNames().

 {
    entryStringList.clear();
 }

◆ getExternalImageGeometry()

ossimRefPtr< ossimImageGeometry > ossimImageHandler::getExternalImageGeometry ( ) const

protectedvirtual

Returns the image geometry object associated with this tile source or NULL if non defined.

The geometry contains full-to-local image transform as well as projection (image-to-world).

This method just looks for external .geom style override only. If you want to go through a registry then call getImageGeometry().

Reimplemented in ossimMrSidReader.

Definition at line 726 of file ossimImageHandler.cpp.

References ossimFilename::dirCat(), ossimFilename::exists(), ossimFilename::expand(), ossimFilename::file(), ossimKeywordlist::findKey(), getCurrentEntry(), getFilenameWithThisExt(), getFilenameWithThisExtension(), ossimImageGeometry::loadState(), ossimString::string(), theSupplementaryDirectory, ossimString::toString(), and ossimKeywordNames::TYPE_KW.

 {
    ossimRefPtr<ossimImageGeometry> geom = 0;
    // No geometry object has been set up yet. Check for external geometry file.
    // Try "foo.geom" if image is "foo.tif":
    ossimFilename filename;
    getFilenameWithThisExt( ossimString(".geom"), filename );
 
    if(!filename.exists())
    {
       // Try "foo_e0.tif" if image is "foo.tif" where "e0" is entry index.
       filename = getFilenameWithThisExtension(ossimString(".geom"), true);
    }
 
 #if 0 
 /* getgetFilenameWithThisExt... methods tack on sup dir if set. drb */
    if(!filename.exists())
    {
       // Try supplementary data directory for remote geometry:
       filename = getFilenameWithThisExtension(ossimString(".geom"), false);
       filename = theSupplementaryDirectory.dirCat(filename.file());
    }
    if(!filename.exists())
    {
       // Try supplementary data directory for remote geometry with entry index:
       filename = getFilenameWithThisExtension(ossimString(".geom"), true);
       filename = theSupplementaryDirectory.dirCat(filename.file());
    }
 #endif
 
    if(filename.exists())
    {
       // Open the geom file as a KWL and initialize our geometry object:
       filename = filename.expand();
       ossimKeywordlist geomKwl(filename);
 
       // Try loadState with no prefix.
       std::string prefix = "";
       std::string key = ossimKeywordNames::TYPE_KW;
       std::string value = geomKwl.findKey(prefix, key);
 
       if ( value.empty() || (value != "ossimImageGeometry") )
       {
          // Try with "image0." type prefix.
          prefix += std::string("image") + ossimString::toString(getCurrentEntry()).string() +
             std::string(".");
          value = geomKwl.findKey(prefix, key);
          
          if ( value.empty() || (value != "ossimImageGeometry") )
          {
             // Try with "image0.geometry." prefix.
             prefix += std::string( "geometry." );
             value = geomKwl.findKey(prefix, key);
             
             if ( value.empty() || (value != "ossimImageGeometry") )
             {
                // Try with "geometry." prefix.
                prefix = std::string( "geometry." );
                value = geomKwl.findKey(prefix, key);
             }
          }
       }
       
       if ( value == "ossimImageGeometry" )
       {
          geom = new ossimImageGeometry;
          if( !geom->loadState(geomKwl, prefix.c_str()) )
          {
             geom = 0;
          }
       }
    }
    
    return geom;
 }

◆ getFilename()

const ossimFilename & ossimImageHandler::getFilename ( ) const

virtual

Returns the filename.

Definition at line 1554 of file ossimImageHandler.cpp.

References theImageFile.

Referenced by ossimSingleImageChain::addHistogramRemapper(), ossimImageHandlerRegistry::addToStateCache(), ossimBitMaskWriter::connectMyInputTo(), ossimProjectionFactoryBase::createProjection(), ossimNitfProjectionFactory::createProjection(), ossimLandsatTopoCorrectionFilter::findLandsatHeader(), ossimGdalOverviewBuilder::generateHfaStats(), ossimInfo::getCenterGround(), ossimInfo::getCenterImage(), ATP::AtpGenerator::getCmpFilename(), ossimSingleImageChain::getFilename(), getFilenameWithThisExt(), getFilenameWithThisExtension(), ossimInfo::getImageBounds(), ossimInfo::getImageGeometryInfo(), ossimInfo::getImageRect(), ossimJpegTileSource::getInternalImageGeometry(), ossimGdalOverviewBuilder::getOutputFile(), getProperty(), ATP::AtpGenerator::getRefFilename(), ossimGdalDataset::initGdalOverviewManager(), main(), ossimKakaduJpipHandler::open(), ossimNitfTileSource::open(), ossimQuickbirdRpcModel::ossimQuickbirdRpcModel(), and ossimNitfTileSource::parseFile().

 {
    return theImageFile;
 }

◆ getFilenameWithNoExtension()

void ossimImageHandler::getFilenameWithNoExtension ( ossimFilename & f ) const

protected

Get filename with no extension, using supplentary directory for dirname if set.

Examples:

f = "foo.tif" f = "foo"

Definition at line 1784 of file ossimImageHandler.cpp.

References ossimString::after(), ossimFilename::drive(), ossimFilename::merge(), ossimFilename::setExtension(), ossimString::size(), ossimFilename::split(), and theSupplementaryDirectory.

Referenced by getFilenameWithThisExt(), and getFilenameWithThisExtension().

 {
    //---
    // If the supplementary directory is set, find the extension at that
    // location instead of at the default.
    //---
    if ( theSupplementaryDirectory.size() )
    {
       ossimString drivePart;
       ossimString pathPart;
       ossimString filePart;
       ossimString extPart;
 
       f.split(drivePart,
               pathPart,
               filePart,
               extPart);
 
       ossimFilename newDrivePart = theSupplementaryDirectory.drive();
       ossimFilename newPathPart  = theSupplementaryDirectory.after(newDrivePart);
 
       f.merge( newDrivePart, newPathPart, filePart, extPart );
    }
 
    // Wipe out the extension.
    f.setExtension("");
 }

◆ getFilenameWithThisExt()

void ossimImageHandler::getFilenameWithThisExt	(	const ossimString &	ext,
		ossimFilename &	f
	)		const

Returns the image file with extension set using supplentary directory for dirname if set.

This is like the getFilenameWithThisExtension(...) method except it does NOT add the "_en" if image is multi entry.

Examples:

theImageFile = "foo.tif"
ext parameter = "geom"
return of method will = "foo.geom"

Parameters

ext	Extension to tack onto file. Can have or have not ".", it will be added if "." is not the first character.
f	Initialized by this.

Definition at line 1766 of file ossimImageHandler.cpp.

References getFilename(), getFilenameWithNoExtension(), ossimString::size(), and ossimString::string().

Referenced by getExternalImageGeometry(), and ossimLasReader::init().

 {
    // Get the image file.
    f = getFilename();
 
    getFilenameWithNoExtension( f );
 
    if (ext.size())
    {
       if (ext.string()[0] != '.')
       {
          f += ".";
       }
       f += ext;
    } 
 }

◆ getFilenameWithThisExtension()

ossimFilename ossimImageHandler::getFilenameWithThisExtension	(	const ossimString &	ext,
		bool	set_e0_prefix = `false`
	)		const

Returns the image file with extension set using supplentary directory for dirname if set.

Default behaviour is to add the "_en.ext" only if the file is multi-entry. Use set_e0_prefix to override this.

Examples:

theImageFile = "foo.hdf"
The number of entries = 1
ext parameter = "geom"
return of method will = "foo.geom"
theImageFile = "foo.hdf"
The number of entries = 12
The current entry = 3
ext parameter = "geom"
return of method will = "foo_e3.geom"

Parameters

ext	Extension to tack onto file. Can have or have not ".", it will be added if "." is not the first character.
set_e0_prefix	If true and the number of entries = 1 then "foo.geom" would come out "foo_e0.geom" instead. Default = false.

Returns: theImageFile with the extension replaced with ext.

Definition at line 1740 of file ossimImageHandler.cpp.

References getCurrentEntry(), getFilename(), getFilenameWithNoExtension(), getNumberOfEntries(), ossimString::size(), ossimString::string(), and ossimString::toString().

Referenced by ossimSingleImageChain::addHistogramRemapper(), ossimSingleImageChain::addImageHandler(), buildHistogram(), buildOverview(), createDefaultGeometryFilename(), createDefaultHistogramFilename(), createDefaultMetadataFilename(), createDefaultOverviewFilename(), getExternalImageGeometry(), getImageHistogram(), ossimImageUtil::getThumbnailFilename(), loadMetaData(), ossimSingleImageChain::openHistogram(), saveImageGeometry(), and ossimOverviewSequencer::writeHistogram().

 {
    // Get the image file.
    ossimFilename f = getFilename();
 
    getFilenameWithNoExtension( f );
 
    if (set_e0_prefix || (getNumberOfEntries() > 1))
    {
       f += "_e";
       f += ossimString::toString(getCurrentEntry());
    }
    
    if (ext.size())
    {
       if (ext.string()[0] != '.')
       {
          f += ".";
       }
       f += ext;
    }
    return f;
 }

◆ getImageGeometry()

ossimRefPtr< ossimImageGeometry > ossimImageHandler::getImageGeometry ( )

virtual

Returns the image geometry object associated with this tile source or NULL if non defined.

The geometry contains full-to-local image transform as well as projection (image-to-world).

Reimplemented from ossimImageSource.

Reimplemented in ossimCibCadrgTileSource, ossimGpkgReader, ossimPngReader, ossimImageCacheBase, ossimKakaduJp2Reader, ossimRpfCacheTileSource, ossimLasReader, ossimH5ImageHandler, ossimMrSidReader, ossimGeoPdfReader, ossimPointCloudImageHandler, ossimMG4LidarReader, ossimJpegTileSource, ossimOpjJp2Reader, ossimHdfReader, ossimGeneralRasterTileSource, ossimUsgsDemTileSource, ossimOgrVectorTileSource, ossimAdrgTileSource, ossimKmlSuperOverlayReader, ossimDtedTileSource, ossimGdalTileSource, ossimVpfTileSource, ossimRangeDomeTileSource, ossimBitMaskTileSource, ossimBandSeparateHandler, ossimplugins::ossimTerraSarTiffReader, ossimplugins::ossimRadarSat2TiffReader, ossimKakaduJpipHandler, ossimVideoImageHandler, ossimLandsatTileSource, ossimEnviTileSource, ossimERSTileSource, ossimSrtmTileSource, ossimQbTileFilesHandler, ossimDoqqTileSource, ossimQuickbirdTiffTileSource, ossimViirsHandler, ossimViirsHandler, and ossimQuickbirdNitfTileSource.

Definition at line 685 of file ossimImageHandler.cpp.

References ossimImageGeometryRegistry::extendGeometry(), ossimRefPtr< T >::get(), getExternalImageGeometry(), getInternalImageGeometry(), initImageParameters(), ossimImageGeometryRegistry::instance(), and theGeometry.

Referenced by ossimPointObservation::addMeasurement(), ATP::AtpGenerator::constructChain(), ossimKakaduJpipImageGeometryFactory::extendGeometry(), ossimImageGeometryFactory::extendGeometry(), ossimInfo::getCenterGround(), ossimInfo::getGrd2img(), ossimInfo::getImageBounds(), ossimQuickbirdNitfTileSource::getImageGeometry(), ossimKakaduJpipHandler::getImageGeometry(), ossimInfo::getImageGeometryInfo(), ossimInfo::getImg2grd(), ossimChipperUtil::getIrect(), ossimInfo::getNorthUpAngle(), ossimInfo::getUpIsUpAngle(), ATP::AtpGenerator::getValidVertices(), ossimChipperUtil::hasSensorModelInput(), ossimImageProjectionModel::initialize(), ossimTiledElevationDatabase::initializeReferenceProjection(), ossimEquationUtil::initInputSources(), main(), ossimChipProcTool::newIdentityProjection(), ossimGeoidImage::open(), ossimImageElevationHandler::open(), ossimImageGeometry::open(), ossimTilingPoly::parseShpFile(), ossimRpcSolver::solve(), and ossimIvtGeomXformVisitor::visit().

 {
    if ( !theGeometry )
    {
       //---
       // Check factory for external geom:
       //---
       theGeometry = getExternalImageGeometry();
 
       if ( !theGeometry )
       {
          //---
          // WARNING:
          // Must create/set the geometry at this point or the next call to
          // ossimImageGeometryRegistry::extendGeometry will put us in an infinite loop
          // as it does a recursive call back to ossimImageHandler::getImageGeometry().
          //---
          theGeometry = new ossimImageGeometry();
          initImageParameters( theGeometry.get() );
 
          //---
          // And finally allow factories to extend the internal geometry.
          // This allows plugins for tagged formats with tags not know in the base
          // to extend the internal geometry.
          //
          // Plugins can do handler->getImageGeometry() then modify/extend.
          //---
          if(!ossimImageGeometryRegistry::instance()->extendGeometry( this ))
          {
             //---
             // Check for internal, for geotiff, nitf and so on as last resort for getting some
             // kind of geometry loaded
             //---
             theGeometry = getInternalImageGeometry();
             initImageParameters( theGeometry.get() );
          }
       }
    }
    return theGeometry;
 }

◆ getImageHistogram()

ossimRefPtr< ossimMultiResLevelHistogram > ossimImageHandler::getImageHistogram ( ) const

Fetches the current entry image's histogram.

Returns: Ref pointer to histogram or null if histogram does not exist.

Note: Old behaviour: "If none exists, it will be created." taken out.

Do: ossimRefPtr<ossimMultiResLevelHistogram> his = ih->getImageHistogram(); if ( ih.valid() ) { } else { ih->buildHistogram(); }

Definition at line 670 of file ossimImageHandler.cpp.

References getFilenameWithThisExtension(), ossimMultiResLevelHistogram::importHistogram(), and isOpen().

Referenced by ossimShorelineTool::autoComputeThreshold(), ATP::AtpGenerator::constructChain(), and ossimBandMergeTool::initHistogramStretch().

 {
    ossimRefPtr<ossimMultiResLevelHistogram> histogram = 0;
    if ( isOpen() )
    {
       ossimFilename histoFile = getFilenameWithThisExtension(ossimString(".his"));
       histogram = new ossimMultiResLevelHistogram();
       if ( histogram->importHistogram(histoFile) == false )
       {
          histogram = 0;
       }
    }
    return histogram;
 }

◆ getImageID()

const ossimString& ossimImageHandler::getImageID ( ) const

inline

Fetches the image ID.

This is initialized to -1 in the constructor but is searched for in loadState():

Definition at line 715 of file ossimImageHandler.h.

Referenced by ATP::AtpGenerator::constructChain(), ATP::AtpGenerator::getCmpImageID(), and ATP::AtpGenerator::getRefImageID().

715 { return theImageID; }

ossimImageHandler::theImageID

ossimString theImageID

Definition: ossimImageHandler.h:841

◆ getImageRectangle()

ossimIrect ossimImageHandler::getImageRectangle ( ossim_uint32 resLevel = 0 ) const

virtual

Returns zero-based bounding rectangle of the image.

Note sub-image offset now in ossimImageGeometry class.

Parameters

resLevel Reduced resolution level for rectangle.

Returns: Rectangle of reduced resolution level.

Reimplemented in ossimCibCadrgTileSource, ossimRpfCacheTileSource, ossimOgrGdalTileSource, ossimAdrgTileSource, ossimOgrVectorTileSource, ossimDtedTileSource, ossimH5ImageHandler, ossimOpjJp2Reader, ossimPngReader, ossimCcfTileSource, ossimGdalTileSource, ossimTiledImageHandler, ossimHdf5ImageHandler, ossimGpkgReader, ossimJpegTileSource, ossimUsgsDemTileSource, ossimKmlSuperOverlayReader, ossimVpfTileSource, and ossimImageCacheBase.

Definition at line 388 of file ossimImageHandler.cpp.

References getNumberOfLines(), getNumberOfSamples(), isOpen(), isValidRLevel(), and ossimIrect::makeNan().

Referenced by getBoundingRect(), ossimGdalTileSource::getImageRectangle(), ossimGeoPdfReader::getIntersectingEntries(), ossimChipperUtil::getIrect(), ossimHdfReader::getTile(), ossimBitMaskTileSource::getTile(), ossimTiffTileSource::getTile(), ossimGeoPdfReader::getTile(), ossimGdalDataset::init(), ossimOverviewSequencer::initialize(), ossimTiffTileSource::loadFromScanLine(), ossimGeoidImage::open(), and ossimQuickbirdRpcModel::parseTiffFile().

 {
    ossimIrect result;
    
    if( isOpen() && isValidRLevel(resLevel) )
    {
       ossim_int32 lines   = getNumberOfLines(resLevel);
       ossim_int32 samples = getNumberOfSamples(resLevel);
       if( !lines || !samples )
       {
          result.makeNan();
       }
       else
       {
          result = ossimIrect(0, 0, samples-1, lines-1);
       }
    }
    else
    {
       result.makeNan();
    }
 
    return result;
 }

◆ getImageTileHeight()

virtual ossim_uint32 ossimImageHandler::getImageTileHeight ( ) const

pure 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.

Implemented in ossimCibCadrgTileSource, ossimRpfCacheTileSource, ossimTiffTileSource, ossimPngReader, ossimGdalTileSource, ossimNitfTileSource, ossimGpkgReader, ossimAdrgTileSource, ossimOgrVectorTileSource, ossimOgrGdalTileSource, ossimCcfTileSource, ossimDtedTileSource, ossimImageCacheBase, ossimLasReader, ossimUsgsDemTileSource, ossimH5ImageHandler, ossimOpjJp2Reader, ossimJpegTileSource, ossimHdf5ImageHandler, ossimVpfTileSource, ossimGeneralRasterTileSource, ossimPointCloudImageHandler, ossimGeoPdfReader, ossimKakaduJp2Reader, ossimKmlSuperOverlayReader, ossimKakaduJ2kReader, ossimMG4LidarReader, ossimMrSidReader, ossimHdfReader, ossimRangeDomeTileSource, ossimTiledImageHandler, ossimBitMaskTileSource, ossimBandSeparateHandler, ossimImageHandlerMtAdaptor, ossimKakaduJpipHandler, and ossimVideoImageHandler.

Referenced by ossimSingleImageChain::createRenderedChain(), ossimImageHandlerMtAdaptor::getImageTileHeight(), and isImageTiled().

◆ getImageTileWidth()

virtual ossim_uint32 ossimImageHandler::getImageTileWidth ( ) const

pure 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.

Implemented in ossimCibCadrgTileSource, ossimRpfCacheTileSource, ossimTiffTileSource, ossimPngReader, ossimGdalTileSource, ossimNitfTileSource, ossimGpkgReader, ossimAdrgTileSource, ossimOgrVectorTileSource, ossimOgrGdalTileSource, ossimCcfTileSource, ossimDtedTileSource, ossimImageCacheBase, ossimLasReader, ossimUsgsDemTileSource, ossimH5ImageHandler, ossimOpjJp2Reader, ossimJpegTileSource, ossimHdf5ImageHandler, ossimVpfTileSource, ossimGeneralRasterTileSource, ossimPointCloudImageHandler, ossimGeoPdfReader, ossimKakaduJp2Reader, ossimKmlSuperOverlayReader, ossimKakaduJ2kReader, ossimMG4LidarReader, ossimMrSidReader, ossimRangeDomeTileSource, ossimHdfReader, ossimTiledImageHandler, ossimBitMaskTileSource, ossimBandSeparateHandler, ossimImageHandlerMtAdaptor, ossimKakaduJpipHandler, and ossimVideoImageHandler.

Referenced by ossimSingleImageChain::createRenderedChain(), ossimImageHandlerMtAdaptor::getImageTileWidth(), and isImageTiled().

◆ getInternalImageGeometry()

ossimRefPtr< ossimImageGeometry > ossimImageHandler::getInternalImageGeometry ( ) const

protectedvirtual

Reimplemented in ossimMrSidReader, ossimGeoPdfReader, ossimMG4LidarReader, ossimJpegTileSource, ossimUsgsDemTileSource, ossimGdalTileSource, ossimOgrGdalTileSource, ossimOgrVectorTileSource, ossimKmlSuperOverlayReader, ossimEnviTileSource, ossimplugins::ossimTerraSarTiffReader, and ossimplugins::ossimRadarSat2TiffReader.

Definition at line 802 of file ossimImageHandler.cpp.

Referenced by getImageGeometry().

 {
    // Default, derived classes should override.
    ossimRefPtr<ossimImageGeometry> geom = new ossimImageGeometry();
    return geom;
 }

◆ getLut()

ossimRefPtr< ossimNBandLutDataObject > ossimImageHandler::getLut ( ) const

virtual

Definition at line 1829 of file ossimImageHandler.cpp.

References theLut.

Referenced by ossimGdalWriter::checkColorLut(), ossimTiffWriter::checkColorLut(), and ossimInfo::getImagePalette().

 {
    return theLut;
 }

◆ getMaxPixelValue()

double ossimImageHandler::getMaxPixelValue ( ossim_uint32 band = 0 ) const

virtual

Returns the max pixel of the band.

Reimplemented from ossimImageSource.

Reimplemented in ossimNitfTileSource, ossimGdalTileSource, ossimLasReader, ossimTiffTileSource, ossimPointCloudImageHandler, ossimHdf5ImageHandler, ossimPngReader, ossimOgrVectorTileSource, ossimOgrGdalTileSource, ossimKakaduNitfReader, ossimGeneralRasterTileSource, ossimOpjJp2Reader, ossimVpfTileSource, ossimImageCacheTileSource, ossimDtedTileSource, ossimBitMaskTileSource, ossimUsgsDemTileSource, ossimImageHandlerMtAdaptor, and ossimLandsatTileSource.

Definition at line 1424 of file ossimImageHandler.cpp.

References ossim::defaultMax(), ossimImageMetaData::getMaxPix(), ossimImageMetaData::getNumberOfBands(), ossimImageSource::getOutputScalarType(), and theMetaData.

Referenced by ossimInfo::getImageInfo(), ossimImageHandlerMtAdaptor::getMaxPixelValue(), ossimImageCacheTileSource::getMaxPixelValue(), ossimKakaduNitfReader::getMaxPixelValue(), ossimHdf5ImageHandler::getMaxPixelValue(), ossimTiffTileSource::getMaxPixelValue(), ossimGdalTileSource::getMaxPixelValue(), and ossimNitfTileSource::getMaxPixelValue().

 {
    if(theMetaData.getNumberOfBands())
    {
       return theMetaData.getMaxPix(band);
    }
    return ossim::defaultMax(getOutputScalarType());
 }

◆ getMinPixelValue()

double ossimImageHandler::getMinPixelValue ( ossim_uint32 band = 0 ) const

virtual

Retuns the min pixel value.

If there was an external eta data file then use the meta data from that file. If not given then we will return the default min

Reimplemented from ossimImageSource.

Reimplemented in ossimNitfTileSource, ossimGdalTileSource, ossimTiffTileSource, ossimLasReader, ossimHdf5ImageHandler, ossimPointCloudImageHandler, ossimOgrVectorTileSource, ossimOgrGdalTileSource, ossimKakaduNitfReader, ossimGeneralRasterTileSource, ossimVpfTileSource, ossimImageCacheTileSource, ossimDtedTileSource, ossimBitMaskTileSource, ossimUsgsDemTileSource, ossimImageHandlerMtAdaptor, and ossimLandsatTileSource.

Definition at line 1415 of file ossimImageHandler.cpp.

References ossim::defaultMin(), ossimImageMetaData::getMinPix(), ossimImageMetaData::getNumberOfBands(), ossimImageSource::getOutputScalarType(), and theMetaData.

Referenced by ossimInfo::getImageInfo(), ossimImageHandlerMtAdaptor::getMinPixelValue(), ossimImageCacheTileSource::getMinPixelValue(), ossimKakaduNitfReader::getMinPixelValue(), ossimHdf5ImageHandler::getMinPixelValue(), ossimTiffTileSource::getMinPixelValue(), ossimGdalTileSource::getMinPixelValue(), and ossimNitfTileSource::getMinPixelValue().

 {
    if(theMetaData.getNumberOfBands())
    {
       return theMetaData.getMinPix(band);
    }
    return ossim::defaultMin(getOutputScalarType());
 }

◆ getNullPixelValue()

double ossimImageHandler::getNullPixelValue ( ossim_uint32 band = 0 ) const

virtual

Each band has a null pixel associated with it.

The null pixel represents an invalid value.

Reimplemented from ossimImageSource.

Reimplemented in ossimNitfTileSource, ossimGdalTileSource, ossimLasReader, ossimTiffTileSource, ossimH5ImageHandler, ossimPointCloudImageHandler, ossimHdf5ImageHandler, ossimOgrVectorTileSource, ossimOgrGdalTileSource, ossimKakaduNitfReader, ossimGeneralRasterTileSource, ossimVpfTileSource, ossimImageCacheTileSource, ossimDtedTileSource, ossimBitMaskTileSource, ossimUsgsDemTileSource, ossimImageHandlerMtAdaptor, ossimLandsatTileSource, ossimViirsHandler, and ossimViirsHandler.

Definition at line 1433 of file ossimImageHandler.cpp.

References ossim::defaultNull(), ossimImageMetaData::getNullPix(), ossimImageMetaData::getNumberOfBands(), ossimImageSource::getOutputScalarType(), and theMetaData.

Referenced by ossimInfo::getImageInfo(), ossimImageHandlerMtAdaptor::getNullPixelValue(), ossimImageCacheTileSource::getNullPixelValue(), ossimKakaduNitfReader::getNullPixelValue(), ossimHdf5ImageHandler::getNullPixelValue(), ossimH5ImageHandler::getNullPixelValue(), ossimTiffTileSource::getNullPixelValue(), ossimGdalTileSource::getNullPixelValue(), ossimNitfTileSource::getNullPixelValue(), and ossimRangeDomeTileSource::getTile().

 {
    if(theMetaData.getNumberOfBands())
    {
       return theMetaData.getNullPix(band);
    }
    
    return ossim::defaultNull(getOutputScalarType());
 }

◆ getNumberOfDecimationLevels()

ossim_uint32 ossimImageHandler::getNumberOfDecimationLevels ( ) const

virtual

This returns the total number of decimation levels.

It is important to note that res level 0 or full resolution is included in the list and has decimation values 1.0, 1.0

Reimplemented from ossimImageSource.

Reimplemented in ossimLasReader, ossimGpkgReader, ossimPointCloudImageHandler, ossimTiffTileSource, ossimKakaduJ2kReader, ossimKakaduJp2Reader, ossimMrSidReader, ossimMG4LidarReader, ossimOgrGdalTileSource, ossimOgrVectorTileSource, ossimBitMaskTileSource, ossimCcfTileSource, ossimGdalTileSource, ossimOpjJp2Reader, ossimKakaduNitfReader, ossimVpfTileSource, ossimImageHandlerMtAdaptor, and ossimKakaduJpipHandler.

Definition at line 373 of file ossimImageHandler.cpp.

References getNumberOfDecimationLevels(), theOverview, and ossimRefPtr< T >::valid().

 {
    ossim_uint32 result = 1; // Add r0
    if (theOverview.valid())
    {
       result += theOverview->getNumberOfDecimationLevels();
    }
    return result;
 }

◆ getNumberOfEntries()

ossim_uint32 ossimImageHandler::getNumberOfEntries ( ) const

virtual

Returns: The number of entries (images) in the image file.

Reimplemented in ossimGeoPdfReader, ossimNitfTileSource, ossimGpkgReader, ossimOgrVectorTileSource, ossimHdfReader, ossimH5ImageHandler, ossimHdf5ImageHandler, and ossimVideoImageHandler.

Definition at line 1497 of file ossimImageHandler.cpp.

References getEntryList().

Referenced by createDefaultValidVerticesFilename(), getFilenameWithThisExtension(), ossimInfo::getImagePalette(), ossimKakaduNitfOverviewBuilder::getOutputFile(), and openValidVertices().

 {
    std::vector<ossim_uint32> tempList;
    getEntryList(tempList);
    
    return (ossim_uint32)tempList.size();
 }

◆ getNumberOfLines()

virtual ossim_uint32 ossimImageHandler::getNumberOfLines ( ossim_uint32 resLevel = 0 ) const

pure virtual

Pure virtual, derived classes must implement.

Parameters

resLevel Reduced resolution level to return lines of. Default = 0

Returns: The number of lines for specified reduced resolution level.

Implemented in ossimKakaduJ2kReader, ossimKakaduJp2Reader, ossimMrSidReader, ossimGeoPdfReader, ossimMG4LidarReader, ossimCibCadrgTileSource, ossimTiffTileSource, ossimNitfTileSource, ossimHdfReader, ossimLasReader, ossimRpfCacheTileSource, ossimPointCloudImageHandler, ossimKakaduNitfReader, ossimAdrgTileSource, ossimH5ImageHandler, ossimOpjJp2Reader, ossimPngReader, ossimRangeDomeTileSource, ossimDtedTileSource, ossimOgrGdalTileSource, ossimHdf5ImageHandler, ossimOgrVectorTileSource, ossimGpkgReader, ossimGdalTileSource, ossimCcfTileSource, ossimJpegTileSource, ossimGeneralRasterTileSource, ossimKmlSuperOverlayReader, ossimBitMaskTileSource, ossimUsgsDemTileSource, ossimVpfTileSource, ossimTiledImageHandler, ossimImageHandlerMtAdaptor, ossimBandSeparateHandler, ossimKakaduJpipHandler, ossimImageCacheBase, and ossimVideoImageHandler.

◆ getNumberOfReducedResSets()

ossim_uint32 ossimImageHandler::getNumberOfReducedResSets ( ) const

virtual

This method is obsolete.

Please use getNumberOfDecimationLevels.

For backwards compatibility this calls getNumberOfDecimationLevels.

Definition at line 383 of file ossimImageHandler.cpp.

References getNumberOfDecimationLevels().

 {
    return getNumberOfDecimationLevels();
 }

◆ getNumberOfSamples()

virtual ossim_uint32 ossimImageHandler::getNumberOfSamples ( ossim_uint32 resLevel = 0 ) const

pure virtual

Pure virtual, derived classes must implement.

Parameters

resLevel Reduced resolution level to return samples of. Default = 0

Returns: The number of samples for specified reduced resolution level.

Implemented in ossimKakaduJ2kReader, ossimKakaduJp2Reader, ossimMrSidReader, ossimGeoPdfReader, ossimMG4LidarReader, ossimCibCadrgTileSource, ossimTiffTileSource, ossimLasReader, ossimHdfReader, ossimNitfTileSource, ossimRpfCacheTileSource, ossimPointCloudImageHandler, ossimKakaduNitfReader, ossimAdrgTileSource, ossimH5ImageHandler, ossimOpjJp2Reader, ossimPngReader, ossimDtedTileSource, ossimOgrGdalTileSource, ossimHdf5ImageHandler, ossimRangeDomeTileSource, ossimOgrVectorTileSource, ossimGpkgReader, ossimGdalTileSource, ossimCcfTileSource, ossimJpegTileSource, ossimGeneralRasterTileSource, ossimKmlSuperOverlayReader, ossimUsgsDemTileSource, ossimBitMaskTileSource, ossimVpfTileSource, ossimTiledImageHandler, ossimImageHandlerMtAdaptor, ossimBandSeparateHandler, ossimImageCacheBase, ossimKakaduJpipHandler, and ossimVideoImageHandler.

◆ getOpenOverviewFlag()

bool ossimImageHandler::getOpenOverviewFlag ( ) const

Returns: theOpenOverviewFlag

Definition at line 1886 of file ossimImageHandler.cpp.

References theOpenOverviewFlag.

 {
    return theOpenOverviewFlag;
 }

◆ getOverview()

const ossimImageHandler * ossimImageHandler::getOverview ( ) const

virtual

Returns: the image handler of the overview, if it has been successfully opened.

Definition at line 835 of file ossimImageHandler.cpp.

References ossimRefPtr< T >::get(), and theOverview.

Referenced by ossimSingleImageChain::addImageHandler(), ossimInfo::getImageInfo(), and ossimImageHandlerFactory::openSrcRecord().

 {
    return theOverview.get();
 }

◆ getOverviewFile()

ossimFilename ossimImageHandler::getOverviewFile ( ) const

Definition at line 1471 of file ossimImageHandler.cpp.

References theOverviewFile.

 {
    return theOverviewFile;
 }

◆ getOverviewTile()

bool ossimImageHandler::getOverviewTile	(	ossim_uint32	resLevel,
		ossimImageData *	result
	)

protectedvirtual

Method to get an overview tile.

Derived classes should override if they have built in overviews or something different than the standard external overview file. Image handlers can call this method from getTile in place of inlining code or if derived class needs to override this method.

Parameters

resLevel	The resolution level to pull from with resLevel 0 being full res.
result	The tile to stuff. passing.

Returns: true on success false on error. Typically this will return false if resLevel==0 unless the overview has r0. If return is false, result is undefined so caller should handle appropriately with makeBlank or whatever.

Reimplemented in ossimKakaduJp2Reader, ossimKakaduJ2kReader, ossimOpjJp2Reader, and ossimKakaduNitfReader.

Definition at line 1812 of file ossimImageHandler.cpp.

References ossimImageData::getNumberOfBands(), ossimImageSource::getNumberOfOutputBands(), ossimImageSource::getTile(), isValidRLevel(), status, theOverview, and ossimRefPtr< T >::valid().

 {
    bool status = false;
    
    if (theOverview.valid())
    {
       if (theOverview->isValidRLevel(resLevel) && result &&
           (result->getNumberOfBands() == getNumberOfOutputBands()) )
       {
          status = theOverview->getTile(result, resLevel);
       }
    }
    
    return status;
 }

◆ getPixelType()

ossimPixelType ossimImageHandler::getPixelType ( ) const

inline

Returns the raster pixel alignment type.

OSSIM treats all alignments internally as pixel-is-point. This is only a flag to identify the source's alignment type.

Definition at line 722 of file ossimImageHandler.h.

722 { return thePixelType; }

ossimImageHandler::thePixelType

ossimPixelType thePixelType

Definition: ossimImageHandler.h:854

◆ getProperty()

ossimRefPtr< ossimProperty > ossimImageHandler::getProperty ( const ossimString & name ) const

virtual

Reimplemented from ossimImageSource.

Reimplemented in ossimCibCadrgTileSource, ossimRpfCacheTileSource, ossimLasReader, ossimTiffTileSource, ossimGdalTileSource, ossimPointCloudImageHandler, ossimH5ImageHandler, ossimNitfTileSource, ossimHdf5ImageHandler, ossimOgrGdalTileSource, ossimDtedTileSource, ossimAdrgTileSource, ossimCcfTileSource, ossimJpegTileSource, ossimPngReader, ossimGpkgReader, ossimRangeDomeTileSource, ossimEnviTileSource, ossimLandsatTileSource, ossimKakaduJpipHandler, ossimSrtmTileSource, and ossimDoqqTileSource.

Definition at line 1601 of file ossimImageHandler.cpp.

References ossimStringProperty::addConstraint(), createDefaultGeometryFilename(), createDefaultHistogramFilename(), createDefaultMetadataFilename(), createDefaultOverviewFilename(), createDefaultValidVerticesFilename(), ossimKeywordNames::ENTRY_KW, getCurrentEntry(), getEntryList(), getFilename(), getNumberOfDecimationLevels(), ossimImageSource::getNumberOfInputBands(), getNumberOfLines(), getNumberOfSamples(), ossimImageSource::getOutputScalarType(), ossimScalarTypeLut::instance(), ossimKeywordNames::NUMBER_BANDS_KW, ossimKeywordNames::NUMBER_LINES_KW, ossimKeywordNames::NUMBER_REDUCED_RES_SETS_KW, ossimKeywordNames::NUMBER_SAMPLES_KW, ossimFilenameProperty::ossimFilenamePropertyIoType_INPUT, ossimKeywordNames::SCALAR_TYPE_KW, ossimProperty::setCacheRefreshBit(), ossimStringProperty::setEditableFlag(), ossimProperty::setFullRefreshBit(), ossimFilenameProperty::setIoType(), ossimProperty::setReadOnlyFlag(), and ossimString::toString().

 {
 
    if(name == ossimKeywordNames::ENTRY_KW)
    {
       std::vector<ossim_uint32> entryList;
       getEntryList(entryList);
       
       ossimStringProperty* stringProperty = new ossimStringProperty(name,
                                                                     ossimString::toString(getCurrentEntry()));
       ossim_uint32 idx = 0;
       for(idx = 0; idx < entryList.size(); ++idx)
       {
          stringProperty->addConstraint(ossimString::toString(entryList[idx]));
       }
       stringProperty->setFullRefreshBit();
       stringProperty->setEditableFlag(false);
 
       return stringProperty;
    }
    else if(name == ossimKeywordNames::NUMBER_SAMPLES_KW)
    {
       ossimNumericProperty* prop = new ossimNumericProperty(name, ossimString::toString(getNumberOfSamples()));
       prop->setReadOnlyFlag(true);
       
       return prop;
    }
    else if(name == ossimKeywordNames::NUMBER_LINES_KW)
    {
       ossimNumericProperty* prop = new ossimNumericProperty(name, ossimString::toString(getNumberOfLines()));
       prop->setReadOnlyFlag(true);
       
       return prop;
    }
    else if(name == ossimKeywordNames::NUMBER_BANDS_KW)
    {
       ossimNumericProperty* prop = new ossimNumericProperty(name, ossimString::toString(getNumberOfInputBands()));
       prop->setReadOnlyFlag(true);
       
       return prop;
    }
    else if(name == ossimKeywordNames::NUMBER_REDUCED_RES_SETS_KW)
    {
       ossimNumericProperty* prop = new ossimNumericProperty(name, ossimString::toString(getNumberOfDecimationLevels()));
       prop->setReadOnlyFlag(true);
       
       return prop;
    }
    else if(name == ossimKeywordNames::SCALAR_TYPE_KW)
    {
       ossimStringProperty* prop = new ossimStringProperty(name, ossimScalarTypeLut::instance()->getEntryString(getOutputScalarType()));
       prop->setReadOnlyFlag(true);
       
       return prop;
    }
    else if(name == "histogram_filename")
    {
       ossimFilenameProperty* filenameProp =
          new ossimFilenameProperty(name, createDefaultHistogramFilename());
       
       filenameProp->setIoType(ossimFilenameProperty::ossimFilenamePropertyIoType_INPUT);
       filenameProp->setCacheRefreshBit();
       
       return filenameProp;
       
    }
    else if(name == "geometry_filename")
    {
       ossimFilenameProperty* filenameProp =
          new ossimFilenameProperty(name, createDefaultGeometryFilename());
       
       filenameProp->setIoType(ossimFilenameProperty::ossimFilenamePropertyIoType_INPUT);
       filenameProp->setCacheRefreshBit();
       
       return filenameProp;
       
    }
    else if(name == "valid_vertices_filename")
    {
       ossimFilenameProperty* filenameProp =
          new ossimFilenameProperty(name, createDefaultValidVerticesFilename());
       
       filenameProp->setIoType(ossimFilenameProperty::ossimFilenamePropertyIoType_INPUT);
       filenameProp->setCacheRefreshBit();
       
       return filenameProp;
    }
    else if(name == "metadata_filename")
    {
       ossimFilenameProperty* filenameProp =
          new ossimFilenameProperty(name, createDefaultMetadataFilename());
       
       filenameProp->setIoType(ossimFilenameProperty::ossimFilenamePropertyIoType_INPUT);
       filenameProp->setCacheRefreshBit();
       
       return filenameProp;
    }
    else if(name == "overview_filename")
    {
       ossimFilenameProperty* filenameProp =
          new ossimFilenameProperty(name, createDefaultOverviewFilename());
       
       filenameProp->setIoType(ossimFilenameProperty::ossimFilenamePropertyIoType_INPUT);
       filenameProp->setCacheRefreshBit();
       
       return filenameProp;
    }
    else if(name == "filename")
    {
       ossimFilenameProperty* filenameProp =
          new ossimFilenameProperty(name, getFilename());
       
       filenameProp->setIoType(ossimFilenameProperty::ossimFilenamePropertyIoType_INPUT);
       filenameProp->setFullRefreshBit();
       
       return filenameProp;
    }
    else if ( name == OPEN_OVERVIEW_FLAG_KW)
    {
       ossimRefPtr<ossimProperty> result =
          new ossimBooleanProperty(ossimString(OPEN_OVERVIEW_FLAG_KW), theOpenOverviewFlag); 
       return result;
    }
    
    return ossimImageSource::getProperty(name);
 }

◆ getPropertyNames()

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

virtual

Reimplemented from ossimImageSource.

Reimplemented in ossimCibCadrgTileSource, ossimLasReader, ossimGdalTileSource, ossimTiffTileSource, ossimH5ImageHandler, ossimHdf5ImageHandler, ossimNitfTileSource, ossimOgrGdalTileSource, ossimDtedTileSource, ossimAdrgTileSource, ossimCcfTileSource, ossimJpegTileSource, ossimPngReader, ossimGpkgReader, ossimEnviTileSource, ossimLandsatTileSource, ossimSrtmTileSource, ossimKakaduJpipHandler, and ossimDoqqTileSource.

Definition at line 1728 of file ossimImageHandler.cpp.

References ossimKeywordNames::ENTRY_KW, ossimImageSource::getPropertyNames(), ossimKeywordNames::NUMBER_BANDS_KW, ossimKeywordNames::NUMBER_LINES_KW, ossimKeywordNames::NUMBER_REDUCED_RES_SETS_KW, ossimKeywordNames::NUMBER_SAMPLES_KW, and ossimKeywordNames::SCALAR_TYPE_KW.

 {
    ossimImageSource::getPropertyNames(propertyNames);
    propertyNames.push_back(ossimKeywordNames::ENTRY_KW);
    propertyNames.push_back(ossimKeywordNames::NUMBER_SAMPLES_KW);
    propertyNames.push_back(ossimKeywordNames::NUMBER_LINES_KW);
    propertyNames.push_back(ossimKeywordNames::NUMBER_BANDS_KW);
    propertyNames.push_back(ossimKeywordNames::NUMBER_REDUCED_RES_SETS_KW);
    propertyNames.push_back(ossimKeywordNames::SCALAR_TYPE_KW);
    propertyNames.push_back(OPEN_OVERVIEW_FLAG_KW);
 }

◆ getRgbBandList()

bool ossimImageHandler::getRgbBandList ( std::vector< ossim_uint32 > & bandList ) const

virtual

Convenience method to get the zero based rgb output band list.

This method returns false and is here only so derived classes can override.

Parameters

bandList

Returns: false

Reimplemented in ossimNitfTileSource, and ossimEnviTileSource.

Definition at line 1283 of file ossimImageHandler.cpp.

References ossimImageMetaData::getRgbBands(), and theMetaData.

Referenced by ossimBandSelector::getRgbBandList(), ossimInfo::getRgbBands(), and ossimSingleImageChain::setToThreeBands().

 {
    // Looks for "rgb_bands" key in dot omd file.  E.g. "rgb_bands: (2,1,0)"
    return theMetaData.getRgbBands( bandList );
 }

◆ getStartingResLevel()

ossim_uint32 ossimImageHandler::getStartingResLevel ( ) const

Definition at line 1876 of file ossimImageHandler.cpp.

References theStartingResLevel.

 {
    return theStartingResLevel;
 }

◆ getState() [1/2]

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

inline

Definition at line 740 of file ossimImageHandler.h.

Referenced by ossimImageHandlerRegistry::addToStateCache(), and ossimTiffProjectionFactory::createProjection().

740 {return m_state;}

ossimImageHandler::m_state

std::shared_ptr< ossim::ImageHandlerState > m_state

Definition: ossimImageHandler.h:856

◆ getState() [2/2]

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

inline

Definition at line 741 of file ossimImageHandler.h.

741 {return m_state;}

ossimImageHandler::m_state

std::shared_ptr< ossim::ImageHandlerState > m_state

Definition: ossimImageHandler.h:856

◆ getStateAs() [1/2]

template<class T >

std::shared_ptr<T> ossimImageHandler::getStateAs ( )

inline

Definition at line 737 of file ossimImageHandler.h.

737 {return dynamic_pointer_cast<T> (m_state);}

ossimImageHandler::m_state

std::shared_ptr< ossim::ImageHandlerState > m_state

Definition: ossimImageHandler.h:856

◆ getStateAs() [2/2]

template<class T >

std::shared_ptr<const T> ossimImageHandler::getStateAs ( ) const

inline

Definition at line 739 of file ossimImageHandler.h.

739 {return dynamic_pointer_cast<const T> (m_state);}

ossimImageHandler::m_state

std::shared_ptr< ossim::ImageHandlerState > m_state

Definition: ossimImageHandler.h:856

◆ getSupplementaryDirectory()

const ossimFilename & ossimImageHandler::getSupplementaryDirectory ( ) const

virtual

Returns the supplementary directory.

Definition at line 1577 of file ossimImageHandler.cpp.

References theSupplementaryDirectory.

 {
    return theSupplementaryDirectory;
 }

◆ getValidImageVertices()

void ossimImageHandler::getValidImageVertices	(	vector< ossimIpt > &	validVertices,
		ossimVertexOrdering	ordering = `OSSIM_CLOCKWISE_ORDER`,
		ossim_uint32	resLevel = `0`
	)		const

virtual

ordering specifies how the vertices should be arranged.

valid image vertices is basically the tightly fit convex hull of the image. Usually an image has NULL values and are internally not upright rectangular. This can cause problems some spatial filters.

The default implementation is to return the bounding rect.

Definition at line 1232 of file ossimImageHandler.cpp.

References getDecimationFactor(), ossimImageSource::getValidImageVertices(), ossimDpt::hasNans(), OSSIM_COUNTERCLOCKWISE_ORDER, theValidImageVertices, ossimDpt::x, x, and ossimDpt::y.

Referenced by ATP::AtpGenerator::getValidVertices().

 {
    ossimDpt decimation;
    getDecimationFactor(resLevel, decimation);
    if(decimation.hasNans())
    {
       return;
    }
    if (theValidImageVertices.size() != 0)
    {
       validVertices.clear();
       for (ossim_uint32 i=0; i<theValidImageVertices.size(); ++i)
       {
          ossimIpt pt(ossim::round<int>(theValidImageVertices[i].x*decimation.x),
                      ossim::round<int>(theValidImageVertices[i].y*decimation.y));
          validVertices.push_back(pt);
       }
 
       if(ordering == OSSIM_COUNTERCLOCKWISE_ORDER)
       {
          std::reverse(validVertices.begin()+1, validVertices.end());
       }
    }
    else
    {
       // Call the base class method which will set to bounding rectangle.
       ossimImageSource::getValidImageVertices(validVertices, ordering, resLevel);
    }
 }

◆ hasLut()

bool ossimImageHandler::hasLut ( ) const

virtual

Definition at line 1834 of file ossimImageHandler.cpp.

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

Referenced by ossimGdalWriter::checkColorLut().

 {
    return theLut.valid();
 }

◆ hasMetaData()

bool ossimImageHandler::hasMetaData ( ) const

virtual

Definition at line 1544 of file ossimImageHandler.cpp.

References ossimImageMetaData::isValid(), and theMetaData.

Referenced by ossimGdalTileSource::computeMinMax().

 {
    return theMetaData.isValid();
 }

◆ hasOverviews()

bool ossimImageHandler::hasOverviews ( ) const

virtual

Returns: true if getNumberOfReducedResSets > 1, false if not.

See also: getNumberOfReducedResSets()

Definition at line 840 of file ossimImageHandler.cpp.

References getNumberOfDecimationLevels().

 {
    return (getNumberOfDecimationLevels() > 1);
 }

◆ initialize()

void ossimImageHandler::initialize ( )

virtual

initialize Does nothing in this class.

Implemented to satisfy pure virtual.

Implements ossimImageSource.

Reimplemented in ossimRangeDomeTileSource, and ossimVideoImageHandler.

Definition at line 104 of file ossimImageHandler.cpp.

105 {

106 }

◆ initImageParameters()

void ossimImageHandler::initImageParameters ( ossimImageGeometry * geom ) const

protected

Convenience method to set things needed in the image geometry from the image handler.

At time of writing sets the decimation and image size.

Parameters

geom	ossimImageGeometry to initiale.

Definition at line 1898 of file ossimImageHandler.cpp.

References getBoundingRect(), ossimImageGeometry::getImageSize(), getNumberOfDecimationLevels(), ossimImageGeometry::getNumberOfDecimations(), ossimIpt::hasNans(), ossimIrect::height(), ossimImageGeometry::setDiscreteDecimation(), ossimImageGeometry::setImageSize(), theDecimationFactors, and ossimIrect::width().

 {
    if ( geom )
    {
       // Set decimation levels
       ossim_uint32 num_levels = getNumberOfDecimationLevels();
       if ((num_levels > 0) && (num_levels != geom->getNumberOfDecimations()))
       {
          geom->setDiscreteDecimation(theDecimationFactors);
       }
 
       // Set image size.
       if(geom->getImageSize().hasNans())
       {
          ossimIrect rect = getBoundingRect();
          geom->setImageSize(ossimIpt(rect.width(), rect.height()));
       } 
    }
 }

◆ initVertices()

bool ossimImageHandler::initVertices ( const char * file )

protected

Opens file and attempts to initialize the valid image vertices.

Returns true on success, false on error.

Definition at line 267 of file ossimImageHandler.cpp.

References ossim::StreamFactoryRegistry::createIstream(), ossimString::find(), ossim::StreamFactoryRegistry::instance(), m_state, and ossimErrorCodes::OSSIM_OK.

Referenced by openValidVertices().

 {
    static const char MODULE[] = "ossimImageHandler::initVertices";
    bool loadFromFileFlag = true;
    std::shared_ptr<ossimKeywordlist> kwl;
    if(m_state)
    {
       bool validVerticesFlag = false;
       if(m_state->getValidVertices())
       {
          loadFromFileFlag = false;
          kwl = m_state->getValidVertices();
          if(kwl)
          {
             ossimString connectionString = kwl->find("connection_string");
             if(connectionString != file)
             {
                loadFromFileFlag = true;
             }
             else if(kwl->getSize()<=0)
             {
                return false;
             }
          }
       }
       else
       {
          loadFromFileFlag = true;
       }
    }
    if(!kwl) kwl = std::make_shared<ossimKeywordlist>();
 
    if(loadFromFileFlag)
    {
       kwl = std::make_shared<ossimKeywordlist>();
       std::shared_ptr<ossim::istream> instream = ossim::StreamFactoryRegistry::instance()->createIstream(file);
       kwl->add("connection_string", file, true);
       if (!instream)
       {
          //if(m_state)
          //   m_state->setValidVertices(kwl);
          return false; 
       } 
 
       kwl->parseStream(*instream);
       if(m_state && kwl->getSize())
          m_state->setValidVertices(kwl);
    }
    
    if (kwl->getErrorStatus() != ossimErrorCodes::OSSIM_OK)
    {
       if (traceDebug())
       {
          ossimNotify(ossimNotifyLevel_DEBUG)
             << "ossimImageHandler::initVertices NOTICE:"
             << "\nError reading valid vertice file:  " << file << std::endl;
       }
       return false;
    }
 
    // Clean out any old vertices...
    theValidImageVertices.clear();
    std::vector<ossimString> indexedPrefixes;
    kwl->getSortedList(indexedPrefixes, "point");
    ossim_uint32 number_of_points = indexedPrefixes.size();
    for (ossim_uint32 i=0; i<number_of_points; i++)
    {
       ossimIpt pt;
       const char* lookup;
       lookup = kwl->find(indexedPrefixes[i], ".x");
       if (lookup)
       {
          pt.x = atoi(lookup);
          lookup = kwl->find(indexedPrefixes[i], ".y");
          if (lookup)
             pt.y = atoi(lookup);
       }
 
       if (!lookup)
       {
          if (traceDebug())
             CLOG << " ERROR: lookup failed for: " << indexedPrefixes[i] << std::endl;
          return false;
       }
          
       theValidImageVertices.push_back(pt);
    }
 
    
    if (traceDebug())
    {
       CLOG << " DEBUG:"
            << "\nVertices file:  " << file
            << "\nValid image vertices:"
            << std::endl;
       for (ossim_uint32 i=0; i<theValidImageVertices.size(); ++i)
       {
          ossimNotify(ossimNotifyLevel_DEBUG)
             << "\npoint[" << i << "]:  " << theValidImageVertices[i];
       }
       ossimNotify(ossimNotifyLevel_DEBUG) << std::endl;
    }
    
    return true;
 }

◆ isBandSelector()

bool ossimImageHandler::isBandSelector ( ) const

virtual

Indicates whether or not the image handler can control output band selection via the setOutputBandList method.

Returns: true if band selector; false, if not.

Reimplemented in ossimGeneralRasterTileSource, and ossimTiffTileSource.

Definition at line 1273 of file ossimImageHandler.cpp.

Referenced by ossimOverviewBuilderBase::finalize(), ossimBandSelector::getBandSelectableImageHandler(), ossimTiffTileSource::isBandSelector(), ossimGeneralRasterTileSource::isBandSelector(), ossimOverviewBuilderBase::setInputSource(), and setOutputToInputBandList().

 {
    return false;
 }

◆ isIdentityBandList()

bool ossimImageHandler::isIdentityBandList ( const std::vector< ossim_uint32 > & bandList ) const

virtual

Convenience method to see if band list is identity.

Parameters

bandList List to check.

Returns: true if band selector; false, if not.

Definition at line 1301 of file ossimImageHandler.cpp.

References ossimImageSource::getOutputBandList().

Referenced by ossimTiffTileSource::saveState().

 {
    bool result = false;
    const ossim_uint32 BANDS = (ossim_uint32)bandList.size();
    if ( BANDS )
    {
       std::vector<ossim_uint32> inputList;
       ossimImageSource::getOutputBandList( inputList ); // This populates an identity band list.
 
       if ( inputList.size() == BANDS )
       {
          ossim_uint32 band = 0;
          while ( band < BANDS )
          {
             if ( inputList[band] != bandList[band] )
             {
                break;
             }
             ++band;
          }
          if ( band == BANDS )
          {
             result = true;
          }
       }
    }
    return result;
 }

◆ isImageTiled()

bool ossimImageHandler::isImageTiled ( ) const

virtual

Indicates whether or not the image is tiled internally.

This implementation returns true if (getImageTileWidth() && getImageTileHeight()) are both non zero. Override in the image handler if something else is desired. Returns true if tiled, false if not.

Reimplemented in ossimTiledImageHandler, and ossimKakaduJpipHandler.

Definition at line 1369 of file ossimImageHandler.cpp.

References getImageTileHeight(), and getImageTileWidth().

Referenced by ossimSingleImageChain::createRenderedChain().

 {
    return (getImageTileWidth() && getImageTileHeight());
 }

◆ isOpen()

virtual bool ossimImageHandler::isOpen ( ) const

pure virtual

Derived classes must implement this method to be concrete.

Returns: true if open, false if not.

Implemented in ossimCibCadrgTileSource, ossimRpfCacheTileSource, ossimGdalTileSource, ossimKakaduJ2kReader, ossimKakaduJp2Reader, ossimPngReader, ossimNitfTileSource, ossimTiffTileSource, ossimMrSidReader, ossimGpkgReader, ossimImageCacheBase, ossimGeoPdfReader, ossimOgrVectorTileSource, ossimOgrGdalTileSource, ossimCcfTileSource, ossimDtedTileSource, ossimMG4LidarReader, ossimAdrgTileSource, ossimUsgsDemTileSource, ossimJpegTileSource, ossimH5ImageHandler, ossimOpjJp2Reader, ossimHdfReader, ossimGeneralRasterTileSource, ossimHdf5ImageHandler, ossimVpfTileSource, ossimKmlSuperOverlayReader, ossimBitMaskTileSource, ossimRangeDomeTileSource, ossimLasReader, ossimPointCloudImageHandler, ossimImageHandlerMtAdaptor, ossimTiledImageHandler, ossimBandSeparateHandler, ossimKakaduJpipHandler, and ossimVideoImageHandler.

Referenced by buildHistogram(), buildOverview(), getImageHistogram(), getImageRectangle(), ossimImageHandlerMtAdaptor::isOpen(), open(), and useEntryIndex().

◆ isValidRLevel()

bool ossimImageHandler::isValidRLevel ( ossim_uint32 resLevel ) const

virtual

Determines if the passed in reslution level is valid.

If this reader is used as an overview the caller should pass in a resLevel relative to the full image.

Parameters

resLevel zero base resolution level.

Returns: true on success, false on error.

Reimplemented in ossimCibCadrgTileSource, ossimRpfCacheTileSource, ossimTiffTileSource, ossimImageCacheBase, ossimJpegTileSource, ossimGeneralRasterTileSource, and ossimBitMaskTileSource.

Definition at line 1207 of file ossimImageHandler.cpp.

References getNumberOfDecimationLevels(), and theStartingResLevel.

 {
    bool result = false;
    
    const ossim_uint32 LEVELS = getNumberOfDecimationLevels();
    
    if ( !theStartingResLevel) // Not an overview.
    {
       result = (resLevel < LEVELS);
    }
    else  // Used as overview.
    {
       if (resLevel >= theStartingResLevel)
       {
          //---
          // Adjust the res level to be zero based for this overview before
          // checking.
          //---
          result = ( (resLevel - theStartingResLevel) < LEVELS);
       }
    }
    
    return result;
 }

◆ loadMetaData()

void ossimImageHandler::loadMetaData ( )

virtual

There is an external file with an omd extension.

this file contains additional information about the image such as the null pixel, min and max values. For general raster it will contain much more than that.

Reimplemented in ossimDtedTileSource, and ossimHdf5ImageHandler.

Definition at line 1374 of file ossimImageHandler.cpp.

References ossimString::c_str(), ossimImageMetaData::clear(), ossim::StreamFactoryRegistry::createIstream(), getFilenameWithThisExtension(), ossimImageSource::getOutputScalarType(), ossim::StreamFactoryRegistry::instance(), ossimImageMetaData::loadState(), m_state, ossimKeywordlist::parseStream(), ossimImageMetaData::setScalarType(), and theMetaData.

Referenced by ossimHdf5ImageHandler::loadMetaData().

 {
 
    if(m_state&&m_state->getMetaData())
    {
       theMetaData = *m_state->getMetaData();
    }
    else
    {
       ossimFilename filename = getFilenameWithThisExtension(ossimString(".omd"), false);
       theMetaData.clear();
 
       std::shared_ptr<ossim::istream> instream = ossim::StreamFactoryRegistry::instance()->createIstream(filename.c_str());
 
       if(!instream)
       {
          filename = getFilenameWithThisExtension(ossimString(".omd"), true);
          instream = ossim::StreamFactoryRegistry::instance()->createIstream(filename.c_str());
       }
 
       if(instream)
       {
         ossimKeywordlist kwl;
         
         kwl.parseStream(*instream);
         
         theMetaData.loadState(kwl);
       }
       else
       {
         theMetaData.setScalarType(getOutputScalarType());
       }
       if(m_state)
       {
          m_state->setMetaData(std::make_shared<ossimImageMetaData>(theMetaData));         
       }
 
    }
 
 }

◆ loadState()

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

virtual

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

Return true if ok or false on error.

Reimplemented from ossimImageSource.

Reimplemented in ossimCibCadrgTileSource, ossimLasReader, ossimKakaduJp2Reader, ossimKakaduJ2kReader, ossimPointCloudImageHandler, ossimMrSidReader, ossimGeoPdfReader, ossimMG4LidarReader, ossimTiffTileSource, ossimRpfCacheTileSource, ossimHdfReader, ossimNitfTileSource, ossimCcfTileSource, ossimOgrGdalTileSource, ossimAdrgTileSource, ossimDtedTileSource, ossimOgrVectorTileSource, ossimH5ImageHandler, ossimOpjJp2Reader, ossimPngReader, ossimGdalTileSource, ossimHdf5ImageHandler, ossimGpkgReader, ossimUsgsDemTileSource, ossimJpegTileSource, ossimImageCacheBase, ossimKmlSuperOverlayReader, ossimRangeDomeTileSource, ossimVpfTileSource, ossimGeneralRasterTileSource, ossimTiledImageHandler, ossimKakaduJpipHandler, ossimBandSeparateHandler, ossimplugins::ossimTerraSarTiffReader, ossimplugins::ossimRadarSat2TiffReader, ossimEnviTileSource, ossimLandsatTileSource, ossimImageHandlerMtAdaptor, ossimSrtmTileSource, ossimERSTileSource, ossimQuickbirdNitfTileSource, and ossimDoqqTileSource.

Definition at line 141 of file ossimImageHandler.cpp.

References theDecimationFactors.

 {
    static const char MODULE[] = "ossimImageHandler::loadState(kwl, prefix)";
    theDecimationFactors.clear();
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << MODULE << " DEBUG: entered ..."
          << std::endl;
    }
    
    ossimImageSource::loadState(kwl, prefix);
    
    if (kwl.getErrorStatus() == ossimErrorCodes::OSSIM_ERROR)
    {
       ossimNotify(ossimNotifyLevel_WARN)
          << MODULE
          << "WARNING: error detected in keyword list!  State not load."
          << std::endl;
       
       if(traceDebug())
       {
          ossimNotify(ossimNotifyLevel_DEBUG)
             << MODULE << " DEBUG: "
             << "leaving with error in kwl ..." << std::endl;
       }
       return false;
    }
    
    const char* lookup = kwl.find(prefix, ossimKeywordNames::FILENAME_KW);
    if (!lookup)
    {
       // Deprecated...
       lookup = kwl.find(prefix, ossimKeywordNames::IMAGE_FILE_KW);
    }
    
    if (lookup)
    {
       theImageFile = lookup;
    }
    
    lookup = kwl.find(prefix, ossimKeywordNames::OVERVIEW_FILE_KW);
    if(lookup)
    {
       theOverviewFile = ossimFilename(lookup);
    }
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << MODULE << " DEBUG:\n"
          << "filename = " << theImageFile << std::endl;
    }
    
    // Check for an external geometry file to initialize our image geometry object:
    lookup = kwl.find(prefix, ossimKeywordNames::GEOM_FILE_KW);
    if (lookup)
    {
       ossimKeywordlist geomKwl;
       if (geomKwl.addFile(lookup) == true)
       {
          theGeometry = new ossimImageGeometry;
          theGeometry->loadState(geomKwl);
          if(traceDebug())
          {
             ossimNotify(ossimNotifyLevel_DEBUG)
                << MODULE << " DEBUG:"
                << "Loaded external geometry file:  "
                << lookup
                << "\n" << geomKwl << std::endl;
          }
       }
    }
    
    // Check for an valid image vetices file.
    lookup = kwl.find(prefix, VALID_VERTICES_FILE_KW);
    if (lookup)
    {
       initVertices(lookup);
    }
 
    // Starting resolution level.
    lookup = kwl.find(prefix, START_RES_LEVEL_KW);
    if (lookup)
    {
       theStartingResLevel = ossimString(lookup).toUInt32();
    }
 
    // Open overview flag.
    lookup = kwl.find(prefix, OPEN_OVERVIEW_FLAG_KW);
    if (lookup)
    {
       setOpenOverviewFlag( ossimString(lookup).toBool() );
    }
 
    // The supplementary directory for finding the overview
    lookup = kwl.find(prefix, SUPPLEMENTARY_DIRECTORY_KW);
    if (lookup)
    {
       theSupplementaryDirectory = ossimFilename(lookup);
    }
 
    if(getNumberOfInputs())
    {
       theInputObjectList.clear();
    }
    theInputListIsFixedFlag = true;
    
    // Read image id if present:
    theImageID = kwl.find(prefix, ossimKeywordNames::IMAGE_ID_KW);
 
    lookup = kwl.find(prefix, ossimKeywordNames::PIXEL_TYPE_KW);
    if (lookup)
    {
       thePixelType = (ossimPixelType) atoi(lookup);
    }
 
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << MODULE << " DEBUG: Leaving Ok ..."
          << std::endl;
    }
    return true;
 }

◆ open() [1/4]

virtual bool ossimImageHandler::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.

Implemented in ossimH5ImageHandler, ossimTiffTileSource, ossimPngReader, ossimGpkgReader, ossimHdf5ImageHandler, ossimJpegTileSource, ossimKakaduJ2kReader, ossimKakaduJp2Reader, ossimMrSidReader, ossimGeoPdfReader, ossimOpjJp2Reader, ossimMG4LidarReader, ossimGeneralRasterTileSource, ossimHdfReader, ossimBitMaskTileSource, ossimCibCadrgTileSource, ossimRangeDomeTileSource, ossimNitfTileSource, ossimRpfCacheTileSource, ossimOgrGdalTileSource, ossimAdrgTileSource, ossimOgrVectorTileSource, ossimImageHandlerMtAdaptor, ossimGdalTileSource, ossimLasReader, ossimDtedTileSource, ossimImageCacheTileSource, ossimPointCloudImageHandler, ossimKmlSuperOverlayReader, ossimCcfTileSource, ossimKakaduJpipHandler, ossimTiledImageHandler, ossimUsgsDemTileSource, ossimImageCacheBase, ossimBandSeparateHandler, ossimVpfTileSource, ossimEnviTileSource, ossimLandsatTileSource, ossimQbTileFilesHandler, ossimSrtmTileSource, ossimVideoImageHandler, ossimQuickbirdTiffTileSource, and ossimQuickbirdNitfTileSource.

Referenced by ossimImageCacheTileSource::fillTile(), ossimDtedTileSource::loadState(), main(), ossimImageHandlerFactory::open(), ossimHdf5PluginHandlerFactory::open(), ossimplugins::ossimPluginReaderFactory::open(), ossimKakaduJpipInfo::open(), ossimImageHandlerMtAdaptor::open(), ossimImageHandlerRegistry::open(), open(), ossimGdalFactory::openOverview(), ossimOpjReaderFactory::openOverview(), ossimImageHandlerFactory::openOverview(), and ossimKakaduReaderFactory::openOverview().

◆ open() [2/4]

bool ossimImageHandler::open	(	const ossimFilename &	imageFile,
		ossim_uint32	entryIndex
	)

virtual

Opens the image file.

Parameters

imageFile	File to open.
entryIndex

Returns: true on success, false on error.

Definition at line 1173 of file ossimImageHandler.cpp.

References close(), isOpen(), open(), setCurrentEntry(), and setFilename().

 {
    if(isOpen())
    {
       close();
    }
    setFilename(imageFile);
    
    bool result = open();
 
    if(result)
    {
       return setCurrentEntry(entryIndex);
    }
 
    return result;
 }

◆ open() [3/4]

bool ossimImageHandler::open ( const ossimFilename & imageFile )

virtual

Reimplemented in ossimJpegTileSource, ossimTiffTileSource, ossimplugins::ossimTerraSarTiffReader, ossimplugins::ossimRadarSat2TiffReader, ossimERSTileSource, and ossimDoqqTileSource.

Definition at line 1161 of file ossimImageHandler.cpp.

References close(), isOpen(), open(), and setFilename().

 {
    if(isOpen())
    {
       close();
    }
 
    setFilename(imageFile);
    
    return open();
 }

◆ open() [4/4]

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

virtual

Definition at line 1192 of file ossimImageHandler.cpp.

References close(), isOpen(), open(), setFilename(), and setState().

 {
    bool result = false;
    if(isOpen())
    {
       close();
    }
    setFilename(state->getConnectionString());
    setState(state);
    result = open();
 
    return result;
 }

◆ openOverview() [1/2]

bool ossimImageHandler::openOverview ( )

virtual

Searches for an overview.

Uses theImageFile as a key. If theImageFile = "foo.tif" it will look for "foo.ovr" first, then "foo_ovr.tif" next. Calls openOverview(const ossimFilename& overview_file)

Returns: true on success, false on error.

See also: openOverview(const ossimFilename& overview_file)

Definition at line 927 of file ossimImageHandler.cpp.

Referenced by ossimSingleImageChain::addImageHandler(), buildOverview(), and ossimImageHandlerFactory::openSrcRecord().

 {
    static const char MODULE[] = "ossimImageHandler::openOverview()";
    if (traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG) << MODULE << " entered...\n";
    }
    
    bool result = false;
    
    closeOverview();
 
    if(m_state)
    {
       // check if we have an overview state
       std::shared_ptr<ossim::ImageHandlerState> overviewState = m_state->getOverviewState();
       if(overviewState)
       {
          // check to see if the overvies state was cached 
          // to mark has checked but no overview
          if(overviewState->getConnectionString().empty())
          {
             return false;
          }
          ossim_uint32 overviewStartingResLevel = getNumberOfDecimationLevels();
          theOverview = ossimImageHandlerRegistry::instance()->open( overviewState );
          if(theOverview)
          {
             result = true;
             //---
             // Set the owner in case the overview reader needs to get something
             // from the it like min/max/null.
             //---
             theOverview->changeOwner(this);
             
             // Set the starting res level of the overview.
             theOverview->setStartingResLevel(overviewStartingResLevel);
             
             // Capture the file name.
             theOverviewFile = overviewState->getConnectionString();
 
             //---
             // Some overview handlers cannot store what the null is.  Like dted
             // null is -32767 not default -32768 so this allows passing this to the
             // overview reader provided it overrides setMin/Max/NullPixel value
             // methods. (drb)
             //---
             const ossim_uint32 BANDS = getNumberOfOutputBands();
             for (ossim_uint32 band = 0; band < BANDS; ++band)
             {
                theOverview->setMinPixelValue(band, getMinPixelValue(band));
                theOverview->setMaxPixelValue(band, getMaxPixelValue(band));
                theOverview->setNullPixelValue(band, getNullPixelValue(band));
             }
             if (traceDebug())
             {
                ossimNotify(ossimNotifyLevel_DEBUG)
                   << "overview starting res level: " << overviewStartingResLevel
                   << "\noverview levels: "
                   << theOverview->getNumberOfDecimationLevels()
                   << "\nlevels: " << getNumberOfDecimationLevels()
                   << endl;
             }
             
             //---
             // This is not really a container event; however, using for now.
             //---
             ossimContainerEvent event(this,
                                       OSSIM_EVENT_ADD_OBJECT_ID);
             event.setObjectList(theOverview.get());
             fireEvent(event);
             return result;
          }
       } 
    }
    // 1) ESH 03/2009 -- Use the overview file set e.g. using a .spec file.
    ossimFilename overviewFilename = getOverviewFile();
 
    // ossimFilename::exists() currently does not work with s3 url's.
    if ( overviewFilename.empty() ) // || (overviewFilename.exists() == false) )
    {
       // 2) Generate the name from image name.
       overviewFilename = createDefaultOverviewFilename();
    }
 
    // ossimFilename::exists() currently does not work with s3 url's.
    if ( overviewFilename.size() ) 
    {
       result = openOverview( overviewFilename );
 
       if (traceDebug())
       {
          ossimNotify(ossimNotifyLevel_DEBUG)
             << (result?"Opened ":"Could not open ") << "overview: " << overviewFilename
             << "\n";
       }
    }
    if ( !result )
    {
       if (overviewFilename.empty() || (overviewFilename.exists() == false) )
       {  
          // 3) For backward compatibility check if single entry and _e0.ovr
          overviewFilename = getFilenameWithThisExtension(ossimString(".ovr"), true);
 
          if (overviewFilename.empty() || (overviewFilename.exists() == false) )
          {
             //---
             // 4) For overviews built with gdal.
             // Examples:
             // Single entry: foo.tif.ovr
             // Multi-entry: foo.tif.x.ovr where "x" == one based entry number.
             // 
             // Note: Take into account a supplementary dir if any.
             //---
             if ( theSupplementaryDirectory.empty() )
             {
                overviewFilename = getFilename();
             }
             else
             {
                overviewFilename = theSupplementaryDirectory;
                overviewFilename = overviewFilename.dirCat( getFilename().file() );
    
             }
 
             if ( getNumberOfEntries() > 1 )
             {
                overviewFilename += ".";
                // Sample multi-entry data "one" based; hence, the + 1.
                overviewFilename += ossimString::toString( getCurrentEntry()+1 );
             }
             overviewFilename += ".ovr";
          }
       }
    
       if ( overviewFilename.exists() )
       {
          result = openOverview( overviewFilename );
 
          if (traceDebug())
          {
             ossimNotify(ossimNotifyLevel_DEBUG)
                << (result?"Opened ":"Could not open ") << "overview: " << overviewFilename
                << "\n";
          }
       }
    }
 
    if (traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << MODULE << " exit result: " << (result?"true":"false") << "\n";
    }
 
    return result;
 }

◆ openOverview() [2/2]

bool ossimImageHandler::openOverview ( const ossimFilename & overview_file )

virtual

Calls closeOverview(), then attempts to open the overview_file.

On success, theOverviewFile will be set and theOverview will be initialized. On failure, theOverviewFile will be cleared and theOverview deleted and set to NULL.

Parameters

overview_file ossimFilename representing overview file.

Returns: true on success, false on error.

See also: closeOverview()

Definition at line 845 of file ossimImageHandler.cpp.

 {
    bool result = false;
    if (traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "ossimImageHandler::openOverview(overview_file): ...entered!";
    }
    closeOverview();
 
    if (overview_file != theImageFile) // Make sure we don't open ourselves.
    {
       //---
       // Get the number of level before the call to opening the overview so
       // the overview can be told what it's starting res level is.
       //---
       ossim_uint32 overviewStartingResLevel = getNumberOfDecimationLevels();
 
 
       // Try to open:
       theOverview = ossimImageHandlerRegistry::instance()->openOverview( overview_file );
       if (theOverview.valid())
       {
          result = true;
          
          //---
          // Set the owner in case the overview reader needs to get something
          // from the it like min/max/null.
          //---
          theOverview->changeOwner(this);
          
          // Set the starting res level of the overview.
          theOverview->setStartingResLevel(overviewStartingResLevel);
          
          // Capture the file name.
          theOverviewFile = overview_file;
 
          //---
          // Some overview handlers cannot store what the null is.  Like dted
          // null is -32767 not default -32768 so this allows passing this to the
          // overview reader provided it overrides setMin/Max/NullPixel value
          // methods. (drb)
          //---
          const ossim_uint32 BANDS = getNumberOfOutputBands();
          for (ossim_uint32 band = 0; band < BANDS; ++band)
          {
             theOverview->setMinPixelValue(band, getMinPixelValue(band));
             theOverview->setMaxPixelValue(band, getMaxPixelValue(band));
             theOverview->setNullPixelValue(band, getNullPixelValue(band));
          }
          if(m_state)
          { 
             m_state->setOverviewState(theOverview->getState());
          }
          if (traceDebug())
          {
             ossimNotify(ossimNotifyLevel_DEBUG)
                << "overview starting res level: " << overviewStartingResLevel
                << "\noverview levels: "
                << theOverview->getNumberOfDecimationLevels()
                << "\nlevels: " << getNumberOfDecimationLevels()
                << endl;
          }
          
          //---
          // This is not really a container event; however, using for now.
          //---
          ossimContainerEvent event(this,
                                    OSSIM_EVENT_ADD_OBJECT_ID);
          event.setObjectList(theOverview.get());
          fireEvent(event);
       }
    }
    if (traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "ossimImageHandler::openOverview(overview_file): ...leaving!";
    }
    
    return result;
 }

◆ openValidVertices() [1/2]

bool ossimImageHandler::openValidVertices ( const ossimFilename & vertices_file )

virtual

Opens the valid image vertices file and sets theValidImageVerticesFile variable.

Parameters

vertices_file File name containing valid vertices for image.

Returns: true on success, false on error.

Definition at line 1132 of file ossimImageHandler.cpp.

References initVertices().

Referenced by ATP::AtpGenerator::getValidVertices().

 {
    return initVertices(vertices_file);
 }

◆ openValidVertices() [2/2]

bool ossimImageHandler::openValidVertices ( )

virtual

Creates vertices file name based on image, then tries to open.

If theImageFile = "foo.tif" it will look for "foo_vertices.kwl".

Returns: true on success, false on error.

Definition at line 1137 of file ossimImageHandler.cpp.

References ossimFilename::dirCat(), ossimFilename::fileNoExtension(), getCurrentEntry(), getNumberOfEntries(), ossimFilename::path(), theImageFile, and ossimString::toString().

 {
    ossimFilename vertices_file;
    vertices_file = theImageFile.path();
    vertices_file = vertices_file.dirCat(theImageFile.fileNoExtension());
    if(getNumberOfEntries() > 1)
    {
       vertices_file += ossimString("_vertices") + "_e" + ossimString::toString(getCurrentEntry()) + ".kwl";
    }
    else
    {
       vertices_file += "_vertices.kwl";
    }
    
    if (traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "Looking for " << vertices_file
          << " vertices file..." << std::endl;
    }
 
    return openValidVertices(vertices_file);
 }

◆ saveImageGeometry() [1/2]

void ossimImageHandler::saveImageGeometry ( ) const

virtual

Saves the image geometry to a file that will be made based on the image file name.

Reimplemented from ossimImageSource.

Definition at line 814 of file ossimImageHandler.cpp.

References getFilenameWithThisExtension().

 {
    ossimFilename geometryFile = getFilenameWithThisExtension(ossimString(".geom"));
    saveImageGeometry(geometryFile);
 }

◆ saveImageGeometry() [2/2]

void ossimImageHandler::saveImageGeometry ( const ossimFilename & geometry_file ) const

virtual

Saves the image geometry to a file that will be made based on the image file name.

Reimplemented from ossimImageSource.

Definition at line 820 of file ossimImageHandler.cpp.

References ossimString::chars(), ossimImageGeometry::saveState(), theGeometry, ossimRefPtr< T >::valid(), and ossimKeywordlist::write().

 {
    if (theGeometry.valid())
    {
       ossimKeywordlist kwl;
       theGeometry->saveState(kwl);
       kwl.write(geometry_file.chars());
    }
 }

◆ saveState()

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

virtual

Method to save the state of an object to a keyword list.

Return true if ok or false on error.

Reimplemented from ossimImageSource.

Reimplemented in ossimGeoPdfReader, ossimLasReader, ossimCibCadrgTileSource, ossimPointCloudImageHandler, ossimTiffTileSource, ossimRpfCacheTileSource, ossimNitfTileSource, ossimCcfTileSource, ossimOgrGdalTileSource, ossimAdrgTileSource, ossimDtedTileSource, ossimOgrVectorTileSource, ossimH5ImageHandler, ossimOpjJp2Reader, ossimPngReader, ossimGdalTileSource, ossimHdf5ImageHandler, ossimGpkgReader, ossimRangeDomeTileSource, ossimJpegTileSource, ossimUsgsDemTileSource, ossimKmlSuperOverlayReader, ossimVpfTileSource, ossimGeneralRasterTileSource, ossimImageCacheBase, ossimKakaduJpipHandler, ossimTiledImageHandler, ossimBandSeparateHandler, ossimplugins::ossimTerraSarTiffReader, ossimplugins::ossimRadarSat2TiffReader, ossimEnviTileSource, ossimImageHandlerMtAdaptor, ossimSrtmTileSource, and ossimQuickbirdNitfTileSource.

Definition at line 111 of file ossimImageHandler.cpp.

References ossimKeywordlist::add(), ossimString::c_str(), ossimKeywordNames::FILENAME_KW, ossimErrorStatusInterface::getErrorStatus(), ossimErrorCodes::OSSIM_ERROR, ossimNotify(), ossimNotifyLevel_WARN, ossimImageSource::saveState(), and theImageFile.

 {
    static const char MODULE[] = "ossimImageHandler::saveState";
 
    ossimImageSource::saveState(kwl, prefix);
    if (kwl.getErrorStatus() == ossimErrorCodes::OSSIM_ERROR)
    {
       ossimNotify(ossimNotifyLevel_WARN)
          << MODULE
          << " ERROR detected in keyword list!  State not saved."
          << std::endl;
       return false;
    }
 
    kwl.add(prefix, ossimKeywordNames::FILENAME_KW, theImageFile.c_str(), true);
    kwl.add(prefix, HAS_LUT_KW, (theLut.valid()?"true":"false"), true);
    kwl.add(prefix, ossimKeywordNames::IMAGE_ID_KW, theImageID, true);
    kwl.add(prefix, ossimKeywordNames::OVERVIEW_FILE_KW, theOverviewFile.c_str(), true);
    kwl.add(prefix, SUPPLEMENTARY_DIRECTORY_KW, theSupplementaryDirectory.c_str(), true);
    kwl.add(prefix, START_RES_LEVEL_KW, theStartingResLevel, true);
    kwl.add(prefix, OPEN_OVERVIEW_FLAG_KW, (theOpenOverviewFlag?"1":"0"), true);
    kwl.add(prefix, ossimKeywordNames::PIXEL_TYPE_KW, (ossim_uint16) thePixelType, true);
 
    return true;
 }

◆ setCurrentEntry()

bool ossimImageHandler::setCurrentEntry ( ossim_uint32 entryIdx )

virtual

Parameters

entryIdx Entry number to select.

Note: The implementation does nothing. Derived classes that handle multiple images should override.

Returns: true if it was able to set the current entry and false otherwise.

Reimplemented in ossimCibCadrgTileSource, ossimRpfCacheTileSource, ossimGpkgReader, ossimOgrGdalTileSource, ossimNitfTileSource, ossimGeoPdfReader, ossimGdalTileSource, ossimLasReader, ossimH5ImageHandler, ossimOgrVectorTileSource, ossimHdf5ImageHandler, ossimPointCloudImageHandler, ossimHdfReader, and ossimVideoImageHandler.

Definition at line 1466 of file ossimImageHandler.cpp.

Referenced by ossimSingleImageChain::addImageHandler(), buildAllHistograms(), buildAllOverviews(), ATP::AtpGenerator::constructChain(), ossimChipProcTool::createInputChain(), ossimVerticesFinderTool::execute(), ossimInfo::getCenterGround(), ossimInfo::getCenterImage(), ossimInfo::getGrd2img(), ossimInfo::getImageBounds(), ossimInfo::getImageGeometryInfo(), ossimInfo::getImageInfo(), ossimInfo::getImagePalette(), ossimInfo::getImageRect(), ossimInfo::getImg2grd(), ossimInfo::getNorthUpAngle(), ossimInfo::getUpIsUpAngle(), ossimSubImageTool::initialize(), open(), ossimImageHandlerFactory::openSrcRecord(), ossimAutRegUtil::setChainEntry(), ossimChipperUtil::setChainEntry(), and setProperty().

 {
    return true;
 }

◆ setFilename()

void ossimImageHandler::setFilename ( const ossimFilename & filename )

virtual

Sets the filename.

Definition at line 1549 of file ossimImageHandler.cpp.

References theImageFile.

Referenced by ossimHdf5Tool::loadImageFiles(), and open().

 {
    theImageFile = filename;
 }

◆ setImageGeometry()

void ossimImageHandler::setImageGeometry ( ossimImageGeometry * geom )

virtual

Sets the image geometry object.

Note: Callers should note that this will override any existing geometry.; This does not write the geometry to disk, to do so call one of the saveImageGeometry methods.

Definition at line 809 of file ossimImageHandler.cpp.

References theGeometry.

 {
    theGeometry = geom;
 }

◆ setImageID()

void ossimImageHandler::setImageID ( const ossimString & id )

inline

Sets the image ID in case it is externally generated.

Definition at line 718 of file ossimImageHandler.h.

Referenced by ATP::AtpGenerator::constructChain().

718 { theImageID = id; }

ossimImageHandler::theImageID

ossimString theImageID

Definition: ossimImageHandler.h:841

◆ setMaxPixelValue()

void ossimImageHandler::setMaxPixelValue	(	ossim_uint32	band,
		const ossim_float64 &	pix
	)

virtual

convenience method to set max pixel value.

Added for overview readers so that the image handler that owns the overview reader can pass on it's max value.

Parameters

band	Zero based band to set.
pix	Max pixel value.

Reimplemented in ossimKakaduNitfReader.

Definition at line 1449 of file ossimImageHandler.cpp.

References ossimImageMetaData::setMaxPix(), and theMetaData.

Referenced by ossimKakaduNitfReader::setMaxPixelValue().

 {
    theMetaData.setMaxPix(band, pix); 
 }

◆ setMinPixelValue()

void ossimImageHandler::setMinPixelValue	(	ossim_uint32	band,
		const ossim_float64 &	pix
	)

virtual

convenience method to set min pixel value.

Added for overview readers so that the image handler that owns the overview reader can pass on it's min value.

Parameters

band	Zero based band to set.
pix	Min pixel value.

Reimplemented in ossimKakaduNitfReader.

Definition at line 1443 of file ossimImageHandler.cpp.

References ossimImageMetaData::setMinPix(), and theMetaData.

Referenced by ossimKakaduNitfReader::setMinPixelValue().

 {
    theMetaData.setMinPix(band, pix);
 }

◆ setNullPixelValue()

void ossimImageHandler::setNullPixelValue	(	ossim_uint32	band,
		const ossim_float64 &	pix
	)

virtual

convenience method to set null pixel value.

Added for overview readers so that the image handler that owns the overview reader can pass on it's max value.

Parameters

band	Zero based band to set.
pix	Null pixel value.

Reimplemented in ossimKakaduNitfReader.

Definition at line 1455 of file ossimImageHandler.cpp.

References ossimImageMetaData::setNullPix(), and theMetaData.

Referenced by ossimKakaduNitfReader::setNullPixelValue().

 {
    theMetaData.setNullPix(band, pix);  
 }

◆ setOpenOverviewFlag()

void ossimImageHandler::setOpenOverviewFlag ( bool flag )

Sets theOpenOverviewFlag.

If true opening of overviews will be attempted on normal open. If false only the base image will be opened (shallow open). Defaulted to true in constructor.

Definition at line 1891 of file ossimImageHandler.cpp.

References theOpenOverviewFlag.

Referenced by ossimHdf5PluginHandlerFactory::open(), ossimplugins::ossimPluginReaderFactory::open(), ossimImageHandlerFactory::open(), ossimPngReaderFactory::open(), ossimKakaduReaderFactory::open(), ossimGdalFactory::openOverview(), ossimOpjReaderFactory::openOverview(), ossimImageHandlerFactory::openOverview(), and ossimKakaduReaderFactory::openOverview().

 {
    theOpenOverviewFlag = flag;
 
    // If false close overview if open??? (drb)
 }

◆ setOutputBandList() [1/2]

bool ossimImageHandler::setOutputBandList ( const std::vector< ossim_uint32 > & band_list )

virtual

If the image handler "isBandSeletor()" then the band selection of the output chip can be controlled.

This method returns false. Derived classes that are band selectors should override.

Parameters

band_list Requested bands.

Returns: true on success, false on error.

Reimplemented in ossimGdalTileSource, ossimHdfReader, ossimGeneralRasterTileSource, and ossimTiffTileSource.

Definition at line 1278 of file ossimImageHandler.cpp.

Referenced by ossimOverviewBuilderBase::finalize(), ossimBandSelector::setOutputBandList(), ossimTiffTileSource::setOutputBandList(), ossimGeneralRasterTileSource::setOutputBandList(), setOutputBandList(), and setOutputToInputBandList().

 {
    return false;
 }

◆ setOutputBandList() [2/2]

bool ossimImageHandler::setOutputBandList	(	const std::vector< ossim_uint32 > &	inBandList,
		std::vector< ossim_uint32 > &	outBandList
	)

protectedvirtual

Convenience method to set output band list.

This performs range checking and calls theOverview->setOutputBandList on success.

Parameters

inBandList	The new band list.
outBandList	Band list to initialize.

Returns: true on success, false on error.

Definition at line 1331 of file ossimImageHandler.cpp.

References ossimImageSource::getNumberOfInputBands(), ossimImageSource::getOutputBandList(), setOutputBandList(), theOverview, and ossimRefPtr< T >::valid().

 {
    bool result = false;
 
    const ossim_uint32 INPUT_BANDS  = getNumberOfInputBands();
    const ossim_uint32 OUTPUT_BANDS = (ossim_uint32)inBandList.size();
 
    if ( INPUT_BANDS && OUTPUT_BANDS )
    {
       result = true;
       outBandList.resize( OUTPUT_BANDS );
       for ( ossim_uint32 band = 0; band < OUTPUT_BANDS; ++band )
       {
          if ( inBandList[band] < INPUT_BANDS )
          {
             outBandList[band] = inBandList[band];
          }
          else // Out of range...
          {
             result = false;
             break;
          }
       }
       if ( result && theOverview.valid() )
       {
          result = theOverview->setOutputBandList( inBandList );
       }
    }
 
    if ( result == false )
    {
       ossimImageSource::getOutputBandList( outBandList ); // Set to identity.
    }
 
    return result;
 }

◆ setOutputToInputBandList()

bool ossimImageHandler::setOutputToInputBandList ( )

virtual

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

Does nothing and returns false if not a band selector.

Returns: If band selector, returns the output of setOutputBandList; if not, returns false.

Definition at line 1289 of file ossimImageHandler.cpp.

References ossimImageSource::getOutputBandList(), isBandSelector(), and setOutputBandList().

Referenced by ossimOverviewBuilderBase::setInputSource().

 {
    bool result = false;
    if ( isBandSelector() )
    {
       std::vector<ossim_uint32> bandList;
       ossimImageSource::getOutputBandList( bandList );
       result = setOutputBandList( bandList );
    }
    return result;
 }

◆ setProperty()

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

virtual

Reimplemented from ossimImageSource.

Reimplemented in ossimLasReader, ossimTiffTileSource, ossimGdalTileSource, ossimPointCloudImageHandler, ossimNitfTileSource, ossimH5ImageHandler, ossimOgrGdalTileSource, ossimHdf5ImageHandler, ossimPngReader, ossimGpkgReader, ossimRangeDomeTileSource, and ossimKakaduJpipHandler.

Definition at line 1582 of file ossimImageHandler.cpp.

References ossimKeywordNames::ENTRY_KW, ossimProperty::getName(), setCurrentEntry(), ossimRefPtr< T >::valid(), and ossimProperty::valueToString().

Referenced by ossimKakaduJpipHandler::setProperty(), ossimRangeDomeTileSource::setProperty(), ossimGpkgReader::setProperty(), ossimNitfTileSource::setProperty(), and ossimTiffTileSource::setProperty().

 {
    if ( property.valid() )
    {
       if(property->getName() == ossimKeywordNames::ENTRY_KW)
       {
          setCurrentEntry(property->valueToString().toUInt32());
       }
       else if ( property->getName() == OPEN_OVERVIEW_FLAG_KW )
       {
          setOpenOverviewFlag( property->valueToString().toBool() );
       }
       else
       {
          ossimImageSource::setProperty(property);
       }
    }
 }

◆ setStartingResLevel()

void ossimImageHandler::setStartingResLevel ( ossim_uint32 level )

Definition at line 1881 of file ossimImageHandler.cpp.

References theStartingResLevel.

 {
    theStartingResLevel = level;
 }

◆ setState()

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

inline

Definition at line 742 of file ossimImageHandler.h.

Referenced by close(), and open().

742 {m_state = state;}

ossimImageHandler::m_state

std::shared_ptr< ossim::ImageHandlerState > m_state

Definition: ossimImageHandler.h:856

◆ setSupplementaryDirectory()

void ossimImageHandler::setSupplementaryDirectory ( const ossimFilename & dir )

virtual

Sets the supplementary directory.

Definition at line 1559 of file ossimImageHandler.cpp.

References completeOpen(), ossimFilename::isDir(), ossimFilename::path(), theDecimationFactors, theOverview, theSupplementaryDirectory, and ossimRefPtr< T >::valid().

Referenced by ossimSingleImageChain::addImageHandler(), and ossimImageHandlerFactory::openSrcRecord().

 {
    if (dir.isDir())
       theSupplementaryDirectory = dir;
    else
       theSupplementaryDirectory = dir.path();
    // A change in supplementary directory presents an opportunity to find the OVR that could not be
    // opened previously, as well as other support data items:
    if (!theOverview.valid())
    {
       if (theDecimationFactors.size() > 0)
       {
         theDecimationFactors.clear();
       }
       completeOpen();
    }
 }

◆ useEntryIndex()

bool ossimImageHandler::useEntryIndex ( ) const

Convenience method to determine if entry index should be used for support files, e.g.

file.his or file_e1.his.

Returns: true if file is open, && ( (entryList.size() > 1) || (entryList[0] != 0) ) false otherwise.

Note: This is just a hint. Put here as code was duplicated everywhere. Callers can do what they wish.

Definition at line 1481 of file ossimImageHandler.cpp.

References getEntryList(), and isOpen().

 {
    bool result = false;
    if ( isOpen() )
    {
       std::vector<ossim_uint32> entryList;
       getEntryList(entryList);
 
       if ( entryList.size() )
       {
          if ( (entryList.size() > 1) || (entryList[0] != 0) ) result = true;
       }
    }
    return result;
 }

◆ writeValidImageVertices()

bool ossimImageHandler::writeValidImageVertices	(	const std::vector< ossimIpt > &	vertices,
		const ossimFilename &	file = `ossimFilename("")`
	)

virtual

Outputs vertices to file and updates the internal vertex array variable "theValidImageVertices".

Parameters

vertices	Array of ossimIpts to write.
file	Name of output file to write to. If file is empty, the output file will be the image file with no extension + _vertices.kwl. So if the image is "foo.tif" you'll get "foo_vertices.kwl".

Returns: true on success, false on error.

Definition at line 1085 of file ossimImageHandler.cpp.

References ossimKeywordlist::add(), ossimString::c_str(), ossimPolygon::checkOrdering(), createDefaultValidVerticesFilename(), ossimFilename::exists(), ossimPolygon::getOrdering(), OSSIM_COUNTERCLOCKWISE_ORDER, theValidImageVertices, ossimString::toString(), and ossimKeywordlist::write().

 {
    ossimFilename tempFile = file;
    if(tempFile == "")
    {
       tempFile = createDefaultValidVerticesFilename();
    }
    ossim_uint32 i = 0;
    ossimKeywordlist tempKwl;
    ossimPolygon poly(vertices);
    
    poly.checkOrdering();
 
    // Capture the vertices.
    theValidImageVertices = vertices;
    
    if(poly.getOrdering() == OSSIM_COUNTERCLOCKWISE_ORDER)
    {
       std::reverse(theValidImageVertices.begin(), theValidImageVertices.end());
    }
    
    if(theValidImageVertices.size())
    {
       for(i = 0; i < theValidImageVertices.size(); ++i)
       {
          ossimString prefix = ossimString("point") + ossimString::toString(i) + ".";
          tempKwl.add(prefix.c_str(),
                      "x",
                      theValidImageVertices[i].x,
                      true);
           tempKwl.add(prefix.c_str(),
                      "y",
                      theValidImageVertices[i].y,
                      true);
       }
       
       tempKwl.write(tempFile.c_str());
    }
 
    if ( tempFile.exists() )
    {
       return true;
    }
 
    return false; // Write of file failed.
 }

Member Data Documentation

◆ m_state

std::shared_ptr<ossim::ImageHandlerState> ossimImageHandler::m_state

protected

Definition at line 856 of file ossimImageHandler.h.

Referenced by initVertices(), and loadMetaData().

◆ theDecimationFactors

std::vector<ossimDpt> ossimImageHandler::theDecimationFactors

protected

Definition at line 840 of file ossimImageHandler.h.

Referenced by close(), ossimBitMaskTileSource::establishDecimationFactors(), ossimRpfCacheTileSource::establishDecimationFactors(), ossimNitfTileSource::establishDecimationFactors(), establishDecimationFactors(), getDecimationFactor(), getDecimationFactors(), ossimBitMaskTileSource::getNumberOfDecimationLevels(), initImageParameters(), ossimRangeDomeTileSource::loadState(), ossimPointCloudImageHandler::loadState(), loadState(), ossimHdfReader::setCurrentEntry(), ossimGdalTileSource::setCurrentEntry(), ossimCibCadrgTileSource::setCurrentEntry(), and setSupplementaryDirectory().

◆ theGeometry

ossimRefPtr<ossimImageGeometry> ossimImageHandler::theGeometry

mutableprotected

Definition at line 838 of file ossimImageHandler.h.

◆ theImageFile

ossimFilename ossimImageHandler::theImageFile

protected

Definition at line 832 of file ossimImageHandler.h.

Referenced by ossimQbTileFilesHandler::computeImageRects(), createDefaultValidVerticesFilename(), ossimBandSeparateHandler::getBandFileNames(), ossimMrSidReader::getExternalImageGeometry(), ossimGdalTileSource::getExternalImageGeometryFromXml(), getFilename(), ossimMrSidReader::getGeoProjection(), ossimGeneralRasterTileSource::getHdrInfo(), ossimQuickbirdTiffTileSource::getImageGeometry(), ossimQbTileFilesHandler::getImageGeometry(), ossimGeneralRasterTileSource::getImageGeometry(), ossimH5ImageHandler::getLatLonDatasets(), ossimCibCadrgTileSource::getPropertyNames(), ossimKmlSuperOverlayReader::getTopLevelKmlFileInfo(), ossimGeneralRasterTileSource::getXmlInfo(), if(), ossimKakaduJp2Reader::isJp2(), ossimOgrVectorTileSource::isOgrVectorDataSource(), ossimKmlSuperOverlayReader::isOpen(), ossimGeoPdfReader::isOpen(), ossimRpfCacheTileSource::isOpen(), ossimBitMaskTileSource::isSupportedExtension(), ossimHdfReader::isSupportedExtension(), ossimDtedTileSource::loadMetaData(), ossimDtedTileSource::loadState(), ossimVpfTileSource::open(), ossimKmlSuperOverlayReader::open(), ossimPointCloudImageHandler::open(), ossimTiffTileSource::open(), ossimOgrGdalTileSource::open(), ossimRangeDomeTileSource::open(), ossimBitMaskTileSource::open(), ossimJpegTileSource::open(), ossimPngReader::open(), openValidVertices(), ossimTiffTileSource::print(), ossimPngReader::restart(), saveState(), setFilename(), and ossimTiffTileSource::validateMinMaxNull().

◆ theImageID

ossimString ossimImageHandler::theImageID

protected

Definition at line 841 of file ossimImageHandler.h.

◆ theLut

ossimRefPtr<ossimNBandLutDataObject> ossimImageHandler::theLut

protected

Definition at line 839 of file ossimImageHandler.h.

Referenced by getLut(), ossimGdalTileSource::getMaxPixelValue(), ossimGdalTileSource::getMinPixelValue(), ossimGdalTileSource::getNullPixelValue(), ossimGdalTileSource::getOutputScalarType(), hasLut(), ossimNitfTileSource::initializeLut(), ossimNitfTileSource::lutUncompress(), ossimGdalTileSource::populateLut(), ossimTiffTileSource::populateLut(), ossimRpfCacheTileSource::populateLut(), ossimCibCadrgTileSource::populateLut(), ossimNitfTileSource::setCurrentEntry(), ossimGdalTileSource::setPreservePaletteIndexesFlag(), and ossimNitfTileSource::vqUncompressC4().

◆ theMetaData

ossimImageMetaData ossimImageHandler::theMetaData

protected

◆ theOpenOverviewFlag

bool ossimImageHandler::theOpenOverviewFlag

protected

If true opening of overviews will be attempted.

If false only the base image will be opened (shallow open). Defaulted to true in constructor.

Definition at line 853 of file ossimImageHandler.h.

Referenced by getOpenOverviewFlag(), and setOpenOverviewFlag().

◆ theOverview

ossimRefPtr<ossimImageHandler> ossimImageHandler::theOverview

protected

Definition at line 835 of file ossimImageHandler.h.

◆ theOverviewFile

ossimFilename ossimImageHandler::theOverviewFile

protected

Definition at line 833 of file ossimImageHandler.h.

Referenced by buildOverview(), getOverviewFile(), ossimHdfReader::setCurrentEntry(), ossimHdf5ImageHandler::setCurrentEntry(), ossimH5ImageHandler::setCurrentEntry(), ossimGdalTileSource::setCurrentEntry(), ossimNitfTileSource::setCurrentEntry(), ossimGpkgReader::setCurrentEntry(), ossimRpfCacheTileSource::setCurrentEntry(), and ossimCibCadrgTileSource::setCurrentEntry().

◆ thePixelType

ossimPixelType ossimImageHandler::thePixelType

mutableprotected

Definition at line 854 of file ossimImageHandler.h.

Referenced by ossimOgrGdalTileSource::loadState(), and ossimOgrGdalTileSource::ossimOgrGdalTileSource().

◆ theStartingResLevel

ossim_uint32 ossimImageHandler::theStartingResLevel

protected

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

Definition at line 847 of file ossimImageHandler.h.

Referenced by ossimTiffTileSource::getNumberOfDecimationLevels(), ossimBitMaskTileSource::getNumberOfLines(), ossimKakaduNitfReader::getNumberOfLines(), ossimTiffTileSource::getNumberOfLines(), ossimBitMaskTileSource::getNumberOfSamples(), ossimKakaduNitfReader::getNumberOfSamples(), ossimTiffTileSource::getNumberOfSamples(), ossimKakaduNitfReader::getOverviewTile(), getStartingResLevel(), ossimBitMaskTileSource::getTile(), ossimTiffTileSource::getTile(), ossimNitfTileSource::getTile(), ossimBitMaskTileSource::isValidRLevel(), ossimTiffTileSource::isValidRLevel(), isValidRLevel(), ossimBitMaskTileSource::open(), ossimBitMaskTileSource::setAssociatedMaskWriter(), and setStartingResLevel().

◆ theSupplementaryDirectory

ossimFilename ossimImageHandler::theSupplementaryDirectory

protected

Definition at line 834 of file ossimImageHandler.h.

Referenced by getExternalImageGeometry(), getFilenameWithNoExtension(), getSupplementaryDirectory(), and setSupplementaryDirectory().

◆ theValidImageVertices

vector<ossimIpt> ossimImageHandler::theValidImageVertices

protected

Definition at line 836 of file ossimImageHandler.h.

Referenced by close(), getValidImageVertices(), ossimCcfTileSource::initVerticesFromHeader(), ossimHdf5ImageHandler::setCurrentEntry(), and writeValidImageVertices().

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ ossimImageHandlerOverviewCompressionType

Constructor & Destructor Documentation

◆ ossimImageHandler()

◆ ~ossimImageHandler()

Member Function Documentation

◆ buildAllHistograms()

◆ buildAllOverviews()

◆ buildHistogram()

◆ buildOverview() [1/2]

◆ buildOverview() [2/2]

◆ canConnectMyInputTo()

◆ close()

◆ closeOverview()

◆ completeOpen()

◆ createDefaultGeometryFilename()

◆ createDefaultHistogramFilename()

◆ createDefaultMetadataFilename()

◆ createDefaultOverviewFilename()

◆ createDefaultValidVerticesFilename()

◆ establishDecimationFactors()

◆ getBoundingRect()

◆ getCurrentEntry()

◆ getDecimationFactor()

◆ getDecimationFactors()

◆ getEntryList()

◆ getEntryName()

◆ getEntryNames()

◆ getExternalImageGeometry()

◆ getFilename()

◆ getFilenameWithNoExtension()

◆ getFilenameWithThisExt()

◆ getFilenameWithThisExtension()

◆ getImageGeometry()

◆ getImageHistogram()

◆ getImageID()

◆ getImageRectangle()

◆ getImageTileHeight()

◆ getImageTileWidth()

◆ getInternalImageGeometry()

◆ getLut()

◆ getMaxPixelValue()

◆ getMinPixelValue()

◆ getNullPixelValue()

◆ getNumberOfDecimationLevels()

◆ getNumberOfEntries()

◆ getNumberOfLines()

◆ getNumberOfReducedResSets()

◆ getNumberOfSamples()

◆ getOpenOverviewFlag()

◆ getOverview()

◆ getOverviewFile()

◆ getOverviewTile()

◆ getPixelType()

◆ getProperty()

◆ getPropertyNames()

◆ getRgbBandList()

◆ getStartingResLevel()

◆ getState() [1/2]

◆ getState() [2/2]

◆ getStateAs() [1/2]

◆ getStateAs() [2/2]

◆ getSupplementaryDirectory()

◆ getValidImageVertices()

◆ hasLut()

◆ hasMetaData()

◆ hasOverviews()

◆ initialize()

◆ initImageParameters()

◆ initVertices()

◆ isBandSelector()

◆ isIdentityBandList()

◆ isImageTiled()

◆ isOpen()

◆ isValidRLevel()