This is the base class for all imagery using HDF5 as the file format. More...

#include <ossimHdf5ImageHandler.h>

Inheritance diagram for ossimHdf5ImageHandler:

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

virtual	~ossimHdf5ImageHandler ()
	virtual destructor More...

virtual ossimString	getShortName () const

virtual ossimString	getLongName () const

virtual ossimString	getClassName () const

virtual ossimRefPtr< ossimImageData >	getTile (const ossimIrect &rect, ossim_uint32 resLevel=0)
	Returns a pointer to a tile given an origin representing the upper left corner of the tile to grab from the image. More...

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

virtual ossim_uint32	getNumberOfInputBands () const
	Returns the number of bands in the image. More...

virtual ossim_uint32	getNumberOfOutputBands () const
	Returns the number of bands in a tile returned from this TileSource. More...

virtual ossim_uint32	getNumberOfLines (ossim_uint32 reduced_res_level=0) const
	Returns the number of lines in the image. More...

virtual ossim_uint32	getNumberOfSamples (ossim_uint32 reduced_res_level=0) const
	Returns the number of samples in the image. More...

virtual ossimIrect	getImageRectangle (ossim_uint32 reduced_res_level=0) const
	Returns the zero based image rectangle for the reduced resolution data set (rrds) passed in. 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 ossimScalarType	getOutputScalarType () const
	Returns the output pixel type of the tile source. More...

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

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

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

virtual void	close ()
	Close method. More...

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

virtual ossim_uint32	getNumberOfEntries () const

virtual void	getEntryNames (std::vector< ossimString > &entryNames) const
	Get the name of entry as a string. More...

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

virtual bool	setCurrentEntry (ossim_uint32 entryIdx)

virtual ossim_uint32	getCurrentEntry () const

ossimRefPtr< ossimHdf5ImageDataset >	getCurrentDataset ()

virtual double	getNullPixelValue (ossim_uint32 band=0) const

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

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

virtual void	setProperty (ossimRefPtr< ossimProperty > property)
	Set propterty method. More...

virtual ossimRefPtr< ossimProperty >	getProperty (const ossimString &name) const
	Get propterty method. More...

virtual void	getPropertyNames (std::vector< ossimString > &propertyNames) const
	Get propterty names. More...

virtual bool	open ()
	The derived class needs to initialize the raster dataset names m_renderableNames in their constructor, for this method to work. More...

const std::vector< ossimString > &	getRenderableSetNames ()

void	addRenderable (const ossimString &datasetName)
	Adds the dataset name, either the full HDF5 path or the simple object name, to the list of renderable datasets. More...

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

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

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

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

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

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

virtual const ossimImageHandler *	getOverview () const

virtual bool	hasOverviews () const

virtual ossimFilename	createDefaultOverviewFilename () const

virtual ossimFilename	createDefaultGeometryFilename () const

virtual ossimFilename	createDefaultMetadataFilename () const

virtual ossimFilename	createDefaultHistogramFilename () const

virtual ossimFilename	createDefaultValidVerticesFilename () const

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

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

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

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

virtual bool	open (const ossimFilename &imageFile)

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

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

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

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

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

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

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

virtual 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 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	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 bool	hasMetaData () const

virtual ossimRefPtr< ossimNBandLutDataObject >	getLut () const

virtual bool	hasLut () const

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 void	getEntryName (ossim_uint32 entryIdx, std::string &name) const
	Get the name of entry as a string. More...

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

ossimFilename	getOverviewFile () 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 ossimObject *	getObject ()
	For RTTI support. More...

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

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

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

virtual 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 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
void	allocate ()
	Allocates the tile. More...

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

virtual ossimRefPtr< ossimImageGeometry >	getInternalImageGeometry () const

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

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

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

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

virtual 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
std::vector< ossimString >	m_renderableNames

ossimRefPtr< ossimHdf5 >	m_hdf5

std::vector< ossimRefPtr< ossimHdf5ImageDataset > >	m_entries

ossim_uint32	m_currentEntry

ossimRefPtr< ossimImageData >	m_tile

std::mutex	m_mutex

Protected Attributes inherited from ossimImageHandler
ossimFilename	theImageFile

ossimFilename	theOverviewFile

ossimFilename	theSupplementaryDirectory

ossimRefPtr< ossimImageHandler >	theOverview

vector< ossimIpt >	theValidImageVertices

ossimImageMetaData	theMetaData

ossimRefPtr< ossimImageGeometry >	theGeometry

ossimRefPtr< ossimNBandLutDataObject >	theLut

std::vector< ossimDpt >	theDecimationFactors

ossimString	theImageID

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

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

ossimPixelType	thePixelType

std::shared_ptr< ossim::ImageHandlerState >	m_state

Protected Attributes inherited from ossimSource
bool	theEnableFlag

bool	theInitializedFlag

Protected Attributes inherited from ossimConnectableObject
ossimId	theId

ossimString	theDescription

ossimObject *	theOwner

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

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

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

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

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

bool	theEnabledFlag

std::list< ossimListener * >	theDelayedAdd

std::list< ossimListener * >	theDelayedRemove

bool	theFireEventFlag

Protected Attributes inherited from ossimErrorStatusInterface
ossimErrorCode	theErrorStatus

Friends
class	ossimHdf5ImageDataset

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

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

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

Detailed Description

This is the base class for all imagery using HDF5 as the file format.

HDF5 is unique in that it represents a variety of subformats for raster and projection information. The derived classes will need to specify the group and dataset names where the needed data lives.

Definition at line 26 of file ossimHdf5ImageHandler.h.

Constructor & Destructor Documentation

◆ ossimHdf5ImageHandler()

ossimHdf5ImageHandler::ossimHdf5ImageHandler ( )

default constructor

Definition at line 50 of file ossimHdf5ImageHandler.cpp.

 :  ossimImageHandler(),
    m_entries(),
    m_currentEntry(0),
    m_tile(0),
    m_mutex()
 {
 }

◆ ~ossimHdf5ImageHandler()

ossimHdf5ImageHandler::~ossimHdf5ImageHandler ( )

virtual

virtual destructor

Definition at line 59 of file ossimHdf5ImageHandler.cpp.

References close(), and isOpen().

 {
    if (isOpen())
    {
       close();
    }
 }

Member Function Documentation

◆ addRenderable()

void ossimHdf5ImageHandler::addRenderable ( const ossimString & datasetName )

inline

Adds the dataset name, either the full HDF5 path or the simple object name, to the list of renderable datasets.

Definition at line 212 of file ossimHdf5ImageHandler.h.

Referenced by ossimHdf5Tool::loadImageFiles().

212 { m_renderableNames.push_back(datasetName); }

ossimHdf5ImageHandler::m_renderableNames

std::vector< ossimString > m_renderableNames

Definition: ossimHdf5ImageHandler.h:218

◆ allocate()

void ossimHdf5ImageHandler::allocate ( )

protected

Allocates the tile.

Definition at line 67 of file ossimHdf5ImageHandler.cpp.

References ossimImageDataFactory::create(), ossimImageData::initialize(), ossimImageDataFactory::instance(), m_mutex, and m_tile.

Referenced by getTile().

 {
    m_mutex.lock();
    m_tile = ossimImageDataFactory::instance()->create(this, this);
    m_tile->initialize();
    m_mutex.unlock();
 }

◆ close()

void ossimHdf5ImageHandler::close ( )

virtual

Close method.

Reimplemented from ossimImageHandler.

Definition at line 425 of file ossimHdf5ImageHandler.cpp.

References ossimImageHandler::close(), m_entries, m_hdf5, m_tile, and ossimRefPtr< T >::valid().

Referenced by ~ossimHdf5ImageHandler().

 {
    // Close the datasets.
    m_entries.clear();
 
    // Then the file.
    if ( m_hdf5.valid() )
       m_hdf5 = 0;
 
    // ossimRefPtr so assign to 0(unreferencing) will handle memory.
    m_tile = 0;
 
    ossimImageHandler::close();
 }

◆ getClassName()

ossimString ossimHdf5ImageHandler::getClassName ( ) const

virtual

Returns: "ossimH5Reader"

Reimplemented from ossimObject.

Definition at line 387 of file ossimHdf5ImageHandler.cpp.

 {
    return ossimString("ossimHdf5ImageHandler");
 }

◆ getCurrentDataset()

ossimRefPtr< ossimHdf5ImageDataset > ossimHdf5ImageHandler::getCurrentDataset ( )

Definition at line 499 of file ossimHdf5ImageHandler.cpp.

References m_currentEntry, and m_entries.

 {
    if ( m_currentEntry >= m_entries.size() )
       return 0;
 
    return m_entries[m_currentEntry];
 }

◆ getCurrentEntry()

ossim_uint32 ossimHdf5ImageHandler::getCurrentEntry ( ) const

virtual

Returns: The current entry number.

Reimplemented from ossimImageHandler.

Definition at line 494 of file ossimHdf5ImageHandler.cpp.

References m_currentEntry.

 {
    return m_currentEntry;
 }

◆ getEntryList()

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

virtual

Parameters

entryList This is the list to initialize with entry indexes.

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

Reimplemented from ossimImageHandler.

Definition at line 454 of file ossimHdf5ImageHandler.cpp.

References m_entries.

 {
    const ossim_uint32 SIZE = m_entries.size();
    entryList.resize( SIZE );
    for ( ossim_uint32 i = 0; i < SIZE; ++i )
    {
       entryList[i] = i; 
    }
 }

◆ getEntryNames()

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

virtual

Get the name of entry as a string.

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.

Reimplemented from ossimImageHandler.

Definition at line 445 of file ossimHdf5ImageHandler.cpp.

References m_entries.

 {
    entryNames.clear();
    for (ossim_uint32 i=0; i<m_entries.size(); ++i )
    {
       entryNames.push_back(m_entries[i]->getName());
    }
 }

◆ getImageRectangle()

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

virtual

Returns the zero based image rectangle for the reduced resolution data set (rrds) passed in.

Note that rrds 0 is the highest resolution rrds.

Reimplemented from ossimImageHandler.

Definition at line 195 of file ossimHdf5ImageHandler.cpp.

References getNumberOfLines(), and getNumberOfSamples().

Referenced by getTile().

 {
    return ossimIrect(0,
                      0,
                      getNumberOfSamples(reduced_res_level) - 1,
                      getNumberOfLines(reduced_res_level)   - 1);
 }

◆ getImageTileHeight()

ossim_uint32 ossimHdf5ImageHandler::getImageTileHeight ( ) const

virtual

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

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

Implements ossimImageHandler.

Definition at line 372 of file ossimHdf5ImageHandler.cpp.

 {
    return 0; // Not tiled format.
 }

◆ getImageTileWidth()

ossim_uint32 ossimHdf5ImageHandler::getImageTileWidth ( ) const

virtual

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

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

Implements ossimImageHandler.

Definition at line 367 of file ossimHdf5ImageHandler.cpp.

 {
    return 0; // Not tiled format.
 }

◆ getLongName()

ossimString ossimHdf5ImageHandler::getLongName ( ) const

virtual

Returns: "ossim hdf5"

Reimplemented from ossimObject.

Definition at line 382 of file ossimHdf5ImageHandler.cpp.

 {
    return ossimString("ossim hdf5 reader");
 }

◆ getMaxPixelValue()

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

virtual

Returns the max pixel of the band.

Reimplemented from ossimImageHandler.

Definition at line 512 of file ossimHdf5ImageHandler.cpp.

References ossimImageHandler::getMaxPixelValue(), m_currentEntry, and m_entries.

 {
    if ( m_currentEntry >= m_entries.size() )
    {
       if(m_entries[m_currentEntry]->isMaxPixelSet())
       {
          return m_entries[m_currentEntry]->getMaxPixelValue(band);
       }
    }
    return ossimImageHandler::getMaxPixelValue( band );
 }

◆ getMinPixelValue()

double ossimHdf5ImageHandler::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 ossimImageHandler.

Definition at line 524 of file ossimHdf5ImageHandler.cpp.

References ossimImageHandler::getMinPixelValue(), m_currentEntry, and m_entries.

 {
    if ( m_currentEntry >= m_entries.size() )
    {
       if(m_entries[m_currentEntry]->isMinPixelSet())
       {
          return m_entries[m_currentEntry]->getMinPixelValue(band);
       }
    }
    return ossimImageHandler::getMinPixelValue( band );
 }

◆ getNullPixelValue()

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

virtual

Returns: Null pixel value.

Reimplemented from ossimImageHandler.

Reimplemented in ossimViirsHandler, and ossimViirsHandler.

Definition at line 507 of file ossimHdf5ImageHandler.cpp.

References ossimImageHandler::getNullPixelValue().

Referenced by getTile(), ossimHdf5ImageDataset::getTileBuf(), and ossimHdf5ImageDataset::scanForMinMax().

 {
    return ossimImageHandler::getNullPixelValue( band );
 }

◆ getNumberOfEntries()

ossim_uint32 ossimHdf5ImageHandler::getNumberOfEntries ( ) const

virtual

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

Reimplemented from ossimImageHandler.

Definition at line 440 of file ossimHdf5ImageHandler.cpp.

References m_entries.

 {
    return (ossim_uint32)m_entries.size();
 }

◆ getNumberOfInputBands()

ossim_uint32 ossimHdf5ImageHandler::getNumberOfInputBands ( ) const

virtual

Returns the number of bands in the image.

Satisfies pure virtual from ImageHandler class.

Implements ossimImageSource.

Definition at line 392 of file ossimHdf5ImageHandler.cpp.

References m_currentEntry, and m_entries.

Referenced by getNumberOfOutputBands(), and getTile().

 {
    ossim_uint32 result = 1;
 
    if ( m_currentEntry < m_entries.size() )
       result = m_entries[m_currentEntry]->getNumberOfBands();
 
    return result;
 }

◆ getNumberOfLines()

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

virtual

Returns the number of lines in the image.

Satisfies pure virtual from ImageHandler class.

Implements ossimImageHandler.

Definition at line 335 of file ossimHdf5ImageHandler.cpp.

References ossimImageHandler::getNumberOfLines(), m_currentEntry, m_entries, ossimImageHandler::theOverview, and ossimRefPtr< T >::valid().

Referenced by getImageRectangle().

 {
    ossim_uint32 r = 0;
    if (reduced_res_level == 0)
    {
       if (m_currentEntry < m_entries.size())
          r = m_entries[m_currentEntry]->getNumberOfLines();
    }
    else if ( theOverview.valid() )
    {
       r = theOverview->getNumberOfLines(reduced_res_level);
    }
 
    return r;
 }

◆ getNumberOfOutputBands()

ossim_uint32 ossimHdf5ImageHandler::getNumberOfOutputBands ( ) const

virtual

Returns the number of bands in a tile returned from this TileSource.

Note: we are supporting sources that can have multiple data objects. If you want to know the scalar type of an object you can pass in the

Reimplemented from ossimImageSource.

Definition at line 402 of file ossimHdf5ImageHandler.cpp.

References getNumberOfInputBands().

Referenced by getTile().

 {
    // Currently not band selectable.
    return getNumberOfInputBands();
 }

◆ getNumberOfSamples()

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

virtual

Returns the number of samples in the image.

Satisfies pure virtual from ImageHandler class.

Implements ossimImageHandler.

Definition at line 351 of file ossimHdf5ImageHandler.cpp.

References ossimImageHandler::getNumberOfSamples(), m_currentEntry, m_entries, ossimImageHandler::theOverview, and ossimRefPtr< T >::valid().

Referenced by getImageRectangle().

 {
    ossim_uint32 r = 0;
    if (reduced_res_level == 0)
    {
       if (m_currentEntry < m_entries.size())
          r = m_entries[m_currentEntry]->getNumberOfSamples();
    }
    else if ( theOverview.valid() )
    {
       r = theOverview->getNumberOfSamples(reduced_res_level);
    }
 
    return r;
 }

◆ getOutputScalarType()

ossimScalarType ossimHdf5ImageHandler::getOutputScalarType ( ) const

virtual

Returns the output pixel type of the tile source.

Reimplemented from ossimImageSource.

Definition at line 408 of file ossimHdf5ImageHandler.cpp.

References m_currentEntry, m_entries, and OSSIM_SCALAR_UNKNOWN.

 {
    ossimScalarType result = OSSIM_SCALAR_UNKNOWN;
 
    if ( m_currentEntry < m_entries.size() )
    {
       result = m_entries[m_currentEntry]->getScalarType();
    }
 
    return result;
 }

◆ getProperty()

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

virtual

Get propterty method.

Overrides ossimImageHandler::getProperty.

Parameters

name	Property name to get.

Reimplemented from ossimImageHandler.

Definition at line 560 of file ossimHdf5ImageHandler.cpp.

References ossimString::string().

 {
    ossimRefPtr<ossimProperty> prop = 0;
    if ( name.string() == LAYER_KW )
    {
       if ( m_currentEntry < m_entries.size() )
       {
          ossimString value = m_entries[m_currentEntry]->getName();
          prop = new ossimStringProperty(name, value);
       }
    }
    else
    {
       prop = ossimImageHandler::getProperty(name);
    }
    return prop;
 }

◆ getPropertyNames()

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

virtual

Get propterty names.

Overrides ossimImageHandler::getPropertyNames.

Parameters

propertyNames Array to initialize.

Reimplemented from ossimImageHandler.

Definition at line 578 of file ossimHdf5ImageHandler.cpp.

References ossimImageHandler::getPropertyNames().

 {
    propertyNames.push_back( ossimString("layer") );
    ossimImageHandler::getPropertyNames(propertyNames);
 }

◆ getRenderableSetNames()

const std::vector<ossimString>& ossimHdf5ImageHandler::getRenderableSetNames ( )

inline

Definition at line 208 of file ossimHdf5ImageHandler.h.

Referenced by ossimHdf5PluginHandlerFactory::getSupportedRenderableNames().

208 { return m_renderableNames; }

ossimHdf5ImageHandler::m_renderableNames

std::vector< ossimString > m_renderableNames

Definition: ossimHdf5ImageHandler.h:218

◆ getShortName()

ossimString ossimHdf5ImageHandler::getShortName ( ) const

virtual

Returns: "hdf5"

Reimplemented from ossimObject.

Definition at line 377 of file ossimHdf5ImageHandler.cpp.

 {
    return ossimString("ossim_hdf5_reader");
 }

◆ getTile() [1/2]

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

virtual

Returns a pointer to a tile given an origin representing the upper left corner of the tile to grab from the image.

Satisfies pure virtual from TileSource class.

Reimplemented from ossimImageSource.

Definition at line 75 of file ossimHdf5ImageHandler.cpp.

References allocate(), ossimRefPtr< T >::get(), ossimDataObject::getDataObjectStatus(), m_mutex, m_tile, ossimImageData::makeBlank(), OSSIM_NULL, ossimImageData::setImageRectangle(), and ossimRefPtr< T >::valid().

 {
    if ( m_tile.valid() == false ) // First time through.
    {
       allocate();
    }
 
    if (m_tile.valid())
    {
       // Image rectangle must be set prior to calling getTile.
       m_mutex.lock();
       m_tile->setImageRectangle(rect);
       m_mutex.unlock();
 
       if ( getTile( m_tile.get(), resLevel ) == false )
       {
          m_mutex.lock();
          if (m_tile->getDataObjectStatus() != OSSIM_NULL)
          {
             m_tile->makeBlank();
          }
          m_mutex.unlock();
       }
    }
 
    return m_tile;
 }

◆ getTile() [2/2]

bool ossimHdf5ImageHandler::getTile	(	ossimImageData *	result,
		ossim_uint32	resLevel = `0`
	)

virtual

Method to get a tile.

Parameters

result The tile to stuff. Note The requested rectangle in full image space and bands should be set in the result tile prior to passing. It will be an error if: result.getNumberOfBands() != this->getNumberOfOutputBands()

Returns: true on success false on error. If return is false, result is undefined so caller should handle appropriately with makeBlank or whatever.

Reimplemented from ossimImageSource.

Definition at line 104 of file ossimHdf5ImageHandler.cpp.

References ossimIrect::area(), ossimIrect::clipToRect(), ossimIrect::completely_within(), getImageRectangle(), ossimImageData::getImageRectangle(), getNullPixelValue(), ossimImageData::getNumberOfBands(), getNumberOfInputBands(), getNumberOfOutputBands(), ossimImageHandler::getOverviewTile(), ossim_hdf5::getScalarType(), isOpen(), ossimSource::isSourceEnabled(), ossimImageHandler::isValidRLevel(), ossimImageData::loadBand(), m_currentEntry, m_entries, m_mutex, ossimImageData::makeBlank(), OSSIM_FLOAT32, ossimReferenced::ref(), ossim::scalarSizeInBytes(), status, ossimReferenced::unref(), and ossimImageData::validate().

 {
    bool status = false;
 
    m_mutex.lock();
 
    //---
    // Not open, this tile source bypassed, or invalid res level,
    // return a blank tile.
    //---
    if( isOpen() && isSourceEnabled() && isValidRLevel(resLevel) &&
          result && (result->getNumberOfBands() == getNumberOfOutputBands()) )
    {
       result->ref(); // Increment ref count.
 
       //---
       // Check for overview tile.  Some overviews can contain r0 so always
       // call even if resLevel is 0.  Method returns true on success, false
       // on error.
       //---
       status = getOverviewTile(resLevel, result);
 
       if (!status) // Did not get an overview tile.
       {
          status = true;
 
          ossimIrect tile_rect = result->getImageRectangle();
 
          if ( ! tile_rect.completely_within(getImageRectangle(0)) )
          {
             // We won't fill totally so make blank first.
             result->makeBlank();
          }
 
          if (getImageRectangle(0).intersects(tile_rect))
          {
             // Make a clip rect.
             ossimIrect clipRect = tile_rect.clipToRect(getImageRectangle(0));
 
             if (tile_rect.completely_within( clipRect) == false)
             {
                // Not filling whole tile so blank it out first.
                result->makeBlank();
             }
 
             // Create buffer to hold the clip rect for a single band.
             ossim_uint32 clipRectSizeInBytes = clipRect.area() *
                   ossim::scalarSizeInBytes( m_entries[m_currentEntry]->getScalarType() );
             vector<char> dataBuffer(clipRectSizeInBytes);
 
             // Get the data.
             for (ossim_uint32 band = 0; band < getNumberOfInputBands(); ++band)
             {
                // Hdf5 file to buffer:
                m_entries[m_currentEntry]->getTileBuf(&dataBuffer.front(), clipRect, band);
 #if 0
                // Scan and fix non-standard null value:
                if ( m_entries[m_currentEntry]->getScalarType() == OSSIM_FLOAT32 )
                {
                   const ossim_float32 NP = getNullPixelValue(band);
                   const ossim_uint32 COUNT = clipRect.area();
                   ossim_float32* float_buffer = (ossim_float32*)&dataBuffer.front();
                   for ( ossim_uint32 i = 0; i < COUNT; ++i )
                   {
                      if ( float_buffer[i] < -999.0 )
                         float_buffer[i] = NP;
                   }
                }
 #endif
                // Buffer to tile:
                result->loadBand((void*)&dataBuffer.front(), clipRect, band);
             }
 
             // Validate the tile, i.e. full, partial, empty.
             result->validate();
          }
          else // No intersection...
          {
             result->makeBlank();
          }
       }
 
       result->unref();  // Decrement ref count.
    }
 
    m_mutex.unlock();
 
    return status;
 }

◆ isOpen()

bool ossimHdf5ImageHandler::isOpen ( ) const

virtual

Derived classes must implement this method to be concrete.

Returns: true if open, false if not.

Implements ossimImageHandler.

Definition at line 420 of file ossimHdf5ImageHandler.cpp.

References m_currentEntry, m_entries, m_hdf5, and ossimRefPtr< T >::valid().

Referenced by ossimViirsHandler::getImageGeometry(), getTile(), setCurrentEntry(), and ~ossimHdf5ImageHandler().

 {
    return ( m_hdf5.valid() &&  m_entries.size() && (m_currentEntry < m_entries.size()));
 }

◆ loadMetaData()

void ossimHdf5ImageHandler::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 from ossimImageHandler.

Definition at line 220 of file ossimHdf5ImageHandler.cpp.

References ossimImageHandler::loadMetaData(), and m_tile.

 {
    m_tile = 0;
    ossimImageHandler::loadMetaData();
 }

◆ loadState()

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

Definition at line 209 of file ossimHdf5ImageHandler.cpp.

References ossimImageHandler::loadState(), and open().

 {
    if (ossimImageHandler::loadState(kwl, prefix))
    {
       return open();
    }
 
    return false;
 }

◆ open()

bool ossimHdf5ImageHandler::open ( )

virtual

The derived class needs to initialize the raster dataset names m_renderableNames in their constructor, for this method to work.

This should be implemented by the derived HDF5-format readers defined in plugins.

Returns: true on success, false on error.

Implements ossimImageHandler.

Definition at line 226 of file ossimHdf5ImageHandler.cpp.

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

 {
    static const char* M = "ossimHdf5ImageHandler::open(filename) -- ";
    if(traceDebug()) ossimNotify(ossimNotifyLevel_DEBUG) << M <<" Entering..." << std::endl;
 
    // Start with a clean slate.
    if (isOpen())
    {
       close();
    }
 
    // Check for empty filename.
    if (theImageFile.empty())
       return false;
 
    theImageFile = theImageFile.expand();
    m_hdf5 = new ossimHdf5;
    if (!m_hdf5->open(theImageFile))
    {
       if(traceDebug()) ossimNotify(ossimNotifyLevel_DEBUG) << M <<" Unable to open image Leaving..." << std::endl;
       m_hdf5 = 0;
       return false;
    }
 
    if(traceDebug()) ossimNotify(ossimNotifyLevel_DEBUG) << M <<" Opened Image..." << std::endl;
 
    vector<H5::DataSet> datasetList;
    H5::Group root;
    m_hdf5->getRoot(root);
    m_hdf5->getNdimDatasets(root, datasetList, true);
 
    if ( datasetList.empty() )
    {
       return false;
       m_hdf5->close();
       m_hdf5 = 0;
    }
    // Filter for specified renderable datasets:
    if (m_renderableNames.size())
    {
       std::vector<H5::DataSet>::iterator dataset = datasetList.begin();
       while (dataset != datasetList.end())
       {
          bool found=false;
          ossimString dsName = dataset->getObjName();
          std::vector<ossimString>::iterator name = m_renderableNames.begin();
          while (name != m_renderableNames.end())
          {
             if (dsName.contains(*name))
             {
                found = true;
                break;
             }
             ++name;
          }
          if (!found)
             datasetList.erase(dataset);
          else
             ++dataset;
       }
    }
 #if 0
    ossimNotify(ossimNotifyLevel_DEBUG)<< "ossimHdf5ImageHandler:"<<__LINE__ << " DEBUG\nDataset names:\n";
    for ( ossim_uint32 i = 0; i < datasetList.size(); ++i )
    {
       ossimNotify(ossimNotifyLevel_DEBUG)<< "dataset[" << i << "]: "
             << datasetList[i].getObjName() << "\n";
    }
 #endif
    if ( datasetList.empty() )
    {
       m_hdf5 = 0;
       return false;
    }
 
    // Add the image dataset entries.
    std::vector<H5::DataSet>::iterator dataset = datasetList.begin();
    while (dataset != datasetList.end())
    {
       ossimRefPtr<ossimHdf5ImageDataset> oimgset = new ossimHdf5ImageDataset(this);
       oimgset->initialize(*dataset);
       m_entries.push_back(oimgset);
       ++dataset;
    }
 
    // Initialize the current entry to be 0:
    m_currentEntry = 999; // Forces init on change of index
    setCurrentEntry(0);
 
    // Establish a common geometry for all entries. TODO: Need to verify if this is a kosher thing
    // to do. It may be that multiple entries have different geometries associated.
    getImageGeometry();
    if (!theGeometry.valid())
       return false;
 
 #if 0 /* Please leave for debug. (drb) */
    std::vector<ossimHdf5ImageDataset>::const_iterator i = m_entries.begin();
    while ( i != m_entries.end() )
    {
       std::cout << (*i) << endl;
       ++i;
    }
 #endif
    if(traceDebug()) ossimNotify(ossimNotifyLevel_DEBUG) << M <<" Leaving..." << std::endl;
 
    return true;
 }

◆ saveState()

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

Definition at line 203 of file ossimHdf5ImageHandler.cpp.

References ossimImageHandler::saveState().

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

◆ setCurrentEntry()

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

Definition at line 464 of file ossimHdf5ImageHandler.cpp.

References ossimString::clear(), ossimImageHandler::completeOpen(), isOpen(), ossimIrect::ll(), ossimIrect::lr(), m_currentEntry, m_entries, m_tile, ossimImageHandler::theOverviewFile, ossimImageHandler::theValidImageVertices, ossimIrect::ul(), and ossimIrect::ur().

 {
    bool result = true;
    if (m_currentEntry != entryIdx)
    {
       // Entries always start at zero and increment sequentially..
       if ( entryIdx < m_entries.size() )
       {
          theOverviewFile.clear();
          m_currentEntry = entryIdx;
          m_tile = 0;
          ossimIrect validRect = m_entries[entryIdx]->getValidImageRect();
          theValidImageVertices.clear();
          theValidImageVertices.push_back(validRect.ul());
          theValidImageVertices.push_back(validRect.ur());
          theValidImageVertices.push_back(validRect.lr());
          theValidImageVertices.push_back(validRect.ll());
 
          if ( isOpen() )
             completeOpen();
       }
       else
       {
          result = false; // Entry index out of range.
       }
    }
 
    return result;
 }

◆ setProperty()

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

virtual

Set propterty method.

Overrides ossimImageHandler::setProperty.

Current property name handled: "scale" One double value representing the scale in meters per pixel. It is assumed the scale is same for x and y direction.

Parameters

property to set.

Reimplemented from ossimImageHandler.

Definition at line 536 of file ossimHdf5ImageHandler.cpp.

References ossimProperty::getName(), ossimString::string(), and ossimRefPtr< T >::valid().

 {
    if ( !property.valid() )
       return;
 
    if ( property->getName().string() == LAYER_KW )
    {
       ossimString s;
       property->valueToString(s);
       ossim_uint32 SIZE = (ossim_uint32)m_entries.size();
       for ( ossim_uint32 i = 0; i < SIZE; ++i )
       {
          if ( m_entries[i]->getName() == s.string() )
          {
             setCurrentEntry( i );
          }
       }
    }
    else
    {
       ossimImageHandler::setProperty(property);
    }
 }

Friends And Related Function Documentation

◆ ossimHdf5ImageDataset

friend class ossimHdf5ImageDataset

friend

Definition at line 28 of file ossimHdf5ImageHandler.h.

Member Data Documentation

◆ m_currentEntry

ossim_uint32 ossimHdf5ImageHandler::m_currentEntry

protected

Definition at line 221 of file ossimHdf5ImageHandler.h.

Referenced by getCurrentDataset(), getCurrentEntry(), getMaxPixelValue(), getMinPixelValue(), getNumberOfInputBands(), getNumberOfLines(), getNumberOfSamples(), getOutputScalarType(), getTile(), isOpen(), and setCurrentEntry().

◆ m_entries

std::vector<ossimRefPtr<ossimHdf5ImageDataset> > ossimHdf5ImageHandler::m_entries

protected

Definition at line 220 of file ossimHdf5ImageHandler.h.

Referenced by close(), getCurrentDataset(), getEntryList(), getEntryNames(), getMaxPixelValue(), getMinPixelValue(), getNumberOfEntries(), getNumberOfInputBands(), getNumberOfLines(), getNumberOfSamples(), getOutputScalarType(), getTile(), isOpen(), and setCurrentEntry().

◆ m_hdf5

ossimRefPtr<ossimHdf5> ossimHdf5ImageHandler::m_hdf5

protected

Definition at line 219 of file ossimHdf5ImageHandler.h.

Referenced by close(), ossimViirsHandler::getImageGeometry(), isOpen(), and ossimHdf5ImageDataset::ossimHdf5ImageDataset().

◆ m_mutex

std::mutex ossimHdf5ImageHandler::m_mutex

protected

Definition at line 223 of file ossimHdf5ImageHandler.h.

Referenced by allocate(), and getTile().

◆ m_renderableNames

std::vector<ossimString> ossimHdf5ImageHandler::m_renderableNames

protected

Definition at line 218 of file ossimHdf5ImageHandler.h.

Referenced by ossimViirsHandler::ossimViirsHandler().

◆ m_tile

ossimRefPtr<ossimImageData> ossimHdf5ImageHandler::m_tile

protected

Definition at line 222 of file ossimHdf5ImageHandler.h.

Referenced by allocate(), close(), getTile(), loadMetaData(), and setCurrentEntry().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ossimHdf5ImageHandler()

◆ ~ossimHdf5ImageHandler()

Member Function Documentation

◆ addRenderable()

◆ allocate()

◆ close()

◆ getClassName()

◆ getCurrentDataset()

◆ getCurrentEntry()

◆ getEntryList()

◆ getEntryNames()

◆ getImageRectangle()

◆ getImageTileHeight()

◆ getImageTileWidth()

◆ getLongName()

◆ getMaxPixelValue()

◆ getMinPixelValue()

◆ getNullPixelValue()

◆ getNumberOfEntries()

◆ getNumberOfInputBands()

◆ getNumberOfLines()

◆ getNumberOfOutputBands()

◆ getNumberOfSamples()

◆ getOutputScalarType()

◆ getProperty()

◆ getPropertyNames()

◆ getRenderableSetNames()

◆ getShortName()

◆ getTile() [1/2]

◆ getTile() [2/2]

◆ isOpen()

◆ loadMetaData()

◆ loadState()

◆ open()

◆ saveState()

◆ setCurrentEntry()

◆ setProperty()

Friends And Related Function Documentation

◆ ossimHdf5ImageDataset

Member Data Documentation

◆ m_currentEntry

◆ m_entries

◆ m_hdf5

◆ m_mutex

◆ m_renderableNames

◆ m_tile