OSSIM Image handler for video frames. More...

#include <ossimVideoImageHandler.h>

Inheritance diagram for ossimVideoImageHandler:

Public Member Functions
virtual bool	open ()=0
	Pure virtual open. More...

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

virtual void	close ()
	Deletes the overview and clears the valid image vertices. More...

virtual void	initialize ()=0
	Common initialization code for all construction methods. More...

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

virtual bool	setCurrentEntry (ossim_uint32 frame_number)
	Sets the currently active frame number as count from start of video. More...

virtual ossim_uint32	getCurrentEntry () const

virtual ossim_uint32	getNumberOfEntries () const

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

virtual ossim_uint32	getNumberOfSamples (ossim_uint32 resLevel=0) const
	Pure virtual, derived classes must implement. 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 ossim_uint32	getNumberOfInputBands () const
	Currently assuming all videos are RGB. More...

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

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

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

virtual ossimRefPtr< ossimImageGeometry >	getImageGeometry ()
	Returns the image geometry object associated with this tile source or NULL if non defined. More...

ossimRefPtr< ossimVideoHandler >	getVideo () const

ossimRefPtr< ossimVideoGeometry >	getVideoGeometry () const

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

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

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

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

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

virtual const ossimImageHandler *	getOverview () const

virtual bool	hasOverviews () const

virtual ossimFilename	createDefaultOverviewFilename () const

virtual ossimFilename	createDefaultGeometryFilename () const

virtual ossimFilename	createDefaultMetadataFilename () const

virtual ossimFilename	createDefaultHistogramFilename () const

virtual ossimFilename	createDefaultValidVerticesFilename () const

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

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

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

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

virtual bool	open (const ossimFilename &imageFile)

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

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

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

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

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

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

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

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

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

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

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

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

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

ossimFilename	getOverviewFile () const

virtual 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 bool	getTile (ossimImageData *result, ossim_uint32 resLevel=0)
	Method to get a tile. More...

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

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

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

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

virtual 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
	ossimVideoImageHandler ()

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
ossimRefPtr< ossimVideoHandler >	m_video

ossimRefPtr< ossimVideoGeometry >	m_videoGeometry

int	m_currentFrameNumber
	This is the currently active entry. More...

ossimRefPtr< ossimImageData >	m_tile

Protected Attributes inherited from ossimImageHandler
ossimFilename	theImageFile

ossimFilename	theOverviewFile

ossimFilename	theSupplementaryDirectory

ossimRefPtr< ossimImageHandler >	theOverview

vector< ossimIpt >	theValidImageVertices

ossimImageMetaData	theMetaData

ossimRefPtr< ossimImageGeometry >	theGeometry

ossimRefPtr< ossimNBandLutDataObject >	theLut

std::vector< ossimDpt >	theDecimationFactors

ossimString	theImageID

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

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

ossimPixelType	thePixelType

std::shared_ptr< ossim::ImageHandlerState >	m_state

Protected Attributes inherited from ossimSource
bool	theEnableFlag

bool	theInitializedFlag

Protected Attributes inherited from ossimConnectableObject
ossimId	theId

ossimString	theDescription

ossimObject *	theOwner

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

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

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

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

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

bool	theEnabledFlag

std::list< ossimListener * >	theDelayedAdd

std::list< ossimListener * >	theDelayedRemove

bool	theFireEventFlag

Protected Attributes inherited from ossimErrorStatusInterface
ossimErrorCode	theErrorStatus

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

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

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

Detailed Description

OSSIM Image handler for video frames.

Notes on video handling in OSSIM:

Currently, video is treated as a single file with multiple entries. Each entry corresponds to a single video frame. The number of entries = the number of frames.

Definition at line 26 of file ossimVideoImageHandler.h.

Constructor & Destructor Documentation

◆ ossimVideoImageHandler()

ossimVideoImageHandler::ossimVideoImageHandler ( )

protected

Definition at line 22 of file ossimVideoImageHandler.cpp.

 :  m_currentFrameNumber (-1)
 {
 }

Member Function Documentation

◆ close()

void ossimVideoImageHandler::close ( )

virtual

Deletes the overview and clears the valid image vertices.

Derived classes should implement.

Reimplemented from ossimImageHandler.

Definition at line 30 of file ossimVideoImageHandler.cpp.

References m_video, and m_videoGeometry.

 {
    m_video = 0;
    m_videoGeometry = 0;
 }

◆ getCurrentEntry()

ossim_uint32 ossimVideoImageHandler::getCurrentEntry ( ) const

virtual

Returns: The current entry number.

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

Reimplemented from ossimImageHandler.

Definition at line 69 of file ossimVideoImageHandler.cpp.

References m_currentFrameNumber.

 {
    if (m_currentFrameNumber < 0 )
       return 0;
 
    return m_currentFrameNumber;
 }

◆ getEntryList()

void ossimVideoImageHandler::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 39 of file ossimVideoImageHandler.cpp.

References getNumberOfEntries().

 {
    entryList.clear();
    ossim_uint32 num_frames = getNumberOfEntries();
    for (ossim_uint32 i=0; i<num_frames; ++i)
       entryList.push_back(i);
 }

◆ getImageGeometry()

ossimRefPtr< ossimImageGeometry > ossimVideoImageHandler::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 ossimImageHandler.

Definition at line 116 of file ossimVideoImageHandler.cpp.

References ossimVideoSource::computeFrameTime(), ossimVideoGeometry::getImageGeometry(), m_currentFrameNumber, m_video, m_videoGeometry, ossimImageHandler::theGeometry, and ossimRefPtr< T >::valid().

 {
    if (theGeometry.valid())
       return theGeometry;
 
    // Only full-image res level = 0 presently supported:
    if (!m_video.valid() || !m_videoGeometry.valid())
       return NULL;
 
    theGeometry = m_videoGeometry->getImageGeometry(m_video->computeFrameTime(m_currentFrameNumber));
    return theGeometry;
 }

◆ getImageTileHeight()

virtual ossim_uint32 ossimVideoImageHandler::getImageTileHeight ( ) const

inlinevirtual

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 49 of file ossimVideoImageHandler.h.

References ossimImageHandler::getNumberOfLines().

49 { return getNumberOfLines(); }

ossimVideoImageHandler::getNumberOfLines

virtual ossim_uint32 getNumberOfLines(ossim_uint32 resLevel=0) const

Pure virtual, derived classes must implement.

Definition: ossimVideoImageHandler.cpp:92

◆ getImageTileWidth()

virtual ossim_uint32 ossimVideoImageHandler::getImageTileWidth ( ) const

inlinevirtual

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 48 of file ossimVideoImageHandler.h.

References ossimImageHandler::getNumberOfSamples().

48 { return getNumberOfSamples(); }

ossimVideoImageHandler::getNumberOfSamples

virtual ossim_uint32 getNumberOfSamples(ossim_uint32 resLevel=0) const

Pure virtual, derived classes must implement.

Definition: ossimVideoImageHandler.cpp:104

◆ getNumberOfEntries()

ossim_uint32 ossimVideoImageHandler::getNumberOfEntries ( ) const

virtual

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

Reimplemented from ossimImageHandler.

Definition at line 80 of file ossimVideoImageHandler.cpp.

References ossimVideoSource::computeFrameNumber(), ossimVideoHandler::duration(), m_video, and ossimRefPtr< T >::valid().

Referenced by getEntryList().

 {
    if (!m_video.valid())
       return 0;
 
    ossim_uint32 num_frames = (ossim_uint32) m_video->computeFrameNumber(m_video->duration());
    return num_frames;
 }

◆ getNumberOfInputBands()

virtual ossim_uint32 ossimVideoImageHandler::getNumberOfInputBands ( ) const

inlinevirtual

Currently assuming all videos are RGB.

Implements ossimImageSource.

Definition at line 52 of file ossimVideoImageHandler.h.

52 { return 3; }

◆ getNumberOfLines()

ossim_uint32 ossimVideoImageHandler::getNumberOfLines ( ossim_uint32 resLevel = 0 ) const

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.

Implements ossimImageHandler.

Definition at line 92 of file ossimVideoImageHandler.cpp.

References ossimVideoSource::frameSize(), ossimIpt::line, m_video, and ossimRefPtr< T >::valid().

 {
    // Only full-image res level = 0 presently supported:
    if (!m_video.valid() || (resLevel != 0))
       return 0;
 
    return m_video->frameSize().line;
 }

◆ getNumberOfOutputBands()

virtual ossim_uint32 ossimVideoImageHandler::getNumberOfOutputBands ( ) const

inlinevirtual

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

Reimplemented from ossimImageSource.

Definition at line 53 of file ossimVideoImageHandler.h.

53 { return 3; }

◆ getNumberOfSamples()

ossim_uint32 ossimVideoImageHandler::getNumberOfSamples ( ossim_uint32 resLevel = 0 ) const

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.

Implements ossimImageHandler.

Definition at line 104 of file ossimVideoImageHandler.cpp.

References ossimVideoSource::frameSize(), m_video, ossimIpt::samp, and ossimRefPtr< T >::valid().

 {
    // Only full-image res level = 0 presently supported:
    if (!m_video.valid() || (resLevel != 0))
       return 0;
 
    return m_video->frameSize().samp;
 }

◆ getOutputScalarType()

virtual ossimScalarType ossimVideoImageHandler::getOutputScalarType ( ) const

inlinevirtual

This will be used to query the output pixel type of the tile source.

Please ignore the argument. It will soon be removed.

Reimplemented from ossimImageSource.

Definition at line 54 of file ossimVideoImageHandler.h.

References OSSIM_UINT8.

54 { return OSSIM_UINT8; }

OSSIM_UINT8

8 bit unsigned integer

Definition: ossimConstants.h:281

◆ getTile()

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

pure virtual

Returns: the requested region of interest

Reimplemented from ossimImageSource.

◆ getVideo()

ossimRefPtr<ossimVideoHandler> ossimVideoImageHandler::getVideo ( ) const

inline

Definition at line 63 of file ossimVideoImageHandler.h.

63 { return m_video; }

ossimVideoImageHandler::m_video

ossimRefPtr< ossimVideoHandler > m_video

Definition: ossimVideoImageHandler.h:69

◆ getVideoGeometry()

ossimRefPtr<ossimVideoGeometry> ossimVideoImageHandler::getVideoGeometry ( ) const

inline

Definition at line 64 of file ossimVideoImageHandler.h.

64 { return m_videoGeometry; }

ossimVideoImageHandler::m_videoGeometry

ossimRefPtr< ossimVideoGeometry > m_videoGeometry

Definition: ossimVideoImageHandler.h:70

◆ initialize()

virtual void ossimVideoImageHandler::initialize ( )

pure virtual

Common initialization code for all construction methods.

Reimplemented from ossimImageHandler.

◆ isOpen()

virtual bool ossimVideoImageHandler::isOpen ( ) const

pure virtual

Derived classes must implement this method to be concrete.

Returns: true if open, false if not.

Implements ossimImageHandler.

◆ open()

virtual bool ossimVideoImageHandler::open ( )

pure virtual

Pure virtual open.

Derived classes must implement.

Returns: Returns true on success, false on error.

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

Implements ossimImageHandler.

◆ setCurrentEntry()

bool ossimVideoImageHandler::setCurrentEntry ( ossim_uint32 frame_number )

virtual

Sets the currently active frame number as count from start of video.

Returns false if frame time is outside of allowable range.

Returns false if frame count is outside of allowable range.

Reimplemented from ossimImageHandler.

Definition at line 51 of file ossimVideoImageHandler.cpp.

References ossimVideoSource::computeFrameTime(), m_currentFrameNumber, m_video, ossimVideoHandler::seek(), ossimVideoSource::SEEK_ABSOLUTE, and ossimRefPtr< T >::valid().

 {
    if (!m_video.valid())
       return false;
 
    ossim_float64 frameTime = m_video->computeFrameTime(frame_number);
    if (m_video->seek(frameTime, ossimVideoSource::SEEK_ABSOLUTE))
    {
       m_currentFrameNumber = frame_number;
       return true;
    }
 
    return false;
 }

Member Data Documentation

◆ m_currentFrameNumber

int ossimVideoImageHandler::m_currentFrameNumber

protected

This is the currently active entry.

Definition at line 71 of file ossimVideoImageHandler.h.

Referenced by getCurrentEntry(), getImageGeometry(), and setCurrentEntry().

◆ m_tile

ossimRefPtr<ossimImageData> ossimVideoImageHandler::m_tile

protected

Definition at line 72 of file ossimVideoImageHandler.h.

◆ m_video

ossimRefPtr<ossimVideoHandler> ossimVideoImageHandler::m_video

protected

Definition at line 69 of file ossimVideoImageHandler.h.

Referenced by close(), getImageGeometry(), getNumberOfEntries(), getNumberOfLines(), getNumberOfSamples(), and setCurrentEntry().

◆ m_videoGeometry

ossimRefPtr<ossimVideoGeometry> ossimVideoImageHandler::m_videoGeometry

protected

Definition at line 70 of file ossimVideoImageHandler.h.

Referenced by close(), and getImageGeometry().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ossimVideoImageHandler()

Member Function Documentation

◆ close()

◆ getCurrentEntry()

◆ getEntryList()

◆ getImageGeometry()

◆ getImageTileHeight()

◆ getImageTileWidth()

◆ getNumberOfEntries()

◆ getNumberOfInputBands()

◆ getNumberOfLines()

◆ getNumberOfOutputBands()

◆ getNumberOfSamples()

◆ getOutputScalarType()

◆ getTile()

◆ getVideo()

◆ getVideoGeometry()

◆ initialize()

◆ isOpen()

◆ open()

◆ setCurrentEntry()

Member Data Documentation

◆ m_currentFrameNumber

◆ m_tile

◆ m_video

◆ m_videoGeometry