ossimKakaduJ2kReader class for reading images with JPEG2000 (J2K) compressed blocks using kakadu library for decompression. More...

#include <ossimKakaduJ2kReader.h>

Inheritance diagram for ossimKakaduJ2kReader:

Public Member Functions
	ossimKakaduJ2kReader ()
	default construtor More...

virtual	~ossimKakaduJ2kReader ()
	virtural destructor More...

virtual ossimString	getShortName () const
	Returns short name. More...

virtual ossimString	getLongName () const
	Returns long name. More...

virtual ossimString	getClassName () const
	Returns short name. More...

virtual ossimRefPtr< ossimImageData >	getTile (const ossimIrect &rect, ossim_uint32 resLevel=0)
	Method to grab a tile(rectangle) from image. 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	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 ossimScalarType	getOutputScalarType () const
	Returns the output pixel type of the tile source. More...

virtual void	getDecimationFactor (ossim_uint32 resLevel, ossimDpt &result) const
	Gets the decimation factor for a resLevel. More...

virtual void	getDecimationFactors (vector< ossimDpt > &decimations) const
	Get array of decimations for all levels. More...

virtual ossim_uint32	getNumberOfDecimationLevels () const
	Returns the number of decimation levels. More...

virtual ossim_uint32	getNumberOfLines (ossim_uint32 resLevel=0) const
	Gets number of lines for res level. More...

virtual ossim_uint32	getNumberOfSamples (ossim_uint32 resLevel=0) const
	Gets the number of samples for res level. More...

virtual bool	open ()
	Open method. More...

virtual bool	isOpen () const
	Method to test for open file stream. More...

virtual void	closeEntry ()
	Method to close current entry. 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...

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 void	close ()
	Deletes the overview and clears the valid image vertices. More...

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

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

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

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

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

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

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

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

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

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

virtual 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 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	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 ossim_uint32	getCurrentEntry () const

virtual ossim_uint32	getNumberOfEntries () const

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

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

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

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

ossimFilename	getOverviewFile () const

virtual bool	setCurrentEntry (ossim_uint32 entryIdx)

virtual void	setProperty (ossimRefPtr< ossimProperty > property)

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

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

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

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

ossim_uint32	getStartingResLevel () const

void	setStartingResLevel (ossim_uint32 level)

bool	getOpenOverviewFlag () const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual	~ossimImageSource ()

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

virtual 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 RTTItypeid	getType () const

virtual bool	canCastTo (ossimObject *obj) const

virtual bool	canCastTo (const RTTItypeid &id) const

virtual bool	canCastTo (const ossimString &parentClassName) const

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

Public Member Functions inherited from ossimReferenced
	ossimReferenced ()

	ossimReferenced (const ossimReferenced &)

ossimReferenced &	operator= (const ossimReferenced &)

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

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

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

int	referenceCount () const

Public Member Functions inherited from ossimListenerManager
	ossimListenerManager ()

virtual	~ossimListenerManager ()

virtual void	fireEvent (ossimEvent &event)

virtual bool	addListener (ossimListener *listener)

virtual bool	removeListener (ossimListener *listener)

virtual bool	findListener (ossimListener *listener)

Public Member Functions inherited from ossimPropertyInterface
	ossimPropertyInterface ()

virtual	~ossimPropertyInterface ()

virtual ossimString	getPropertyValueAsString (const ossimString &name) const

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

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

Public Member Functions inherited from ossimErrorStatusInterface
	ossimErrorStatusInterface ()

virtual	~ossimErrorStatusInterface ()

virtual ossimErrorCode	getErrorStatus () const

virtual ossimString	getErrorStatusString () const

virtual void	setErrorStatus (ossimErrorCode error_status) const

virtual void	setErrorStatus () const

virtual void	clearErrorStatus () const

bool	hasError () const

Protected Member Functions
virtual bool	getOverviewTile (ossim_uint32 resLevel, ossimImageData *result)
	Gets an overview tile. More...

virtual ossim_int32	get_capabilities ()
	Gets kdu source capability. More...

virtual ossim_int32	read (kdu_core::kdu_byte *buf, ossim_int32 num_bytes)
	Read method. More...

virtual bool	seek (kdu_core::kdu_long offset)
	Seek method. More...

virtual kdu_core::kdu_long	get_pos ()
	Get file position relative to the start of code stream offset. 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

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)

Private Member Functions
void	initializeTile ()
	Initializes data member "theTile". More...

bool	loadTileFromCache (ossim_uint32 x, ossim_uint32 y, const ossimIrect &clipRect)
	Loads a block of data to theCacheTile from the cache. More...

bool	loadTile (ossim_uint32 x, ossim_uint32 y)
	Loads a block of data to theCacheTile. More...

Private Attributes
kdu_core::kdu_codestream	theCodestream

kdu_core::kdu_thread_env *	theThreadEnv

kdu_core::kdu_thread_queue *	theOpenTileThreadQueue

ossim_uint32	theSourcePrecisionBits

ossim_uint32	theMinDwtLevels

std::ifstream	theFileStr

ossimJ2kSizRecord	theSizRecord

ossimScalarType	theScalarType

ossimIrect	theImageRect

ossimRefPtr< ossimImageData >	theTile

ossimRefPtr< ossimImageData >	theCacheTile

ossim_uint32	theTileSizeX

ossim_uint32	theTileSizeY

ossimAppFixedTileCache::ossimAppFixedCacheId	theCacheId

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

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

Detailed Description

ossimKakaduJ2kReader class for reading images with JPEG2000 (J2K) compressed blocks using kakadu library for decompression.

Definition at line 44 of file ossimKakaduJ2kReader.h.

Constructor & Destructor Documentation

◆ ossimKakaduJ2kReader()

ossimKakaduJ2kReader::ossimKakaduJ2kReader ( )

default construtor

◆ ~ossimKakaduJ2kReader()

ossimKakaduJ2kReader::~ossimKakaduJ2kReader ( )

virtual

virtural destructor

Definition at line 73 of file ossimKakaduJ2kReader.cpp.

References closeEntry().

 {
    closeEntry();
 }

Member Function Documentation

◆ closeEntry()

void ossimKakaduJ2kReader::closeEntry ( )

virtual

Method to close current entry.

Note: There is a bool kdu_compressed_source::close() and a void ossimImageHandler::close(); hence, a new close to avoid conflicting return types.

Definition at line 462 of file ossimKakaduJ2kReader.cpp.

References ossimImageHandler::close(), ossimAppFixedTileCache::deleteCache(), ossimAppFixedTileCache::instance(), theCacheId, theCacheTile, theCodestream, theFileStr, theOpenTileThreadQueue, theThreadEnv, theTile, theTileSizeX, and theTileSizeY.

Referenced by ~ossimKakaduJ2kReader().

 {
    theFileStr.close();
 
    // Cleanup processing environment
    if ( theThreadEnv )
    {
       theThreadEnv->join(NULL,true); // Wait until all internal processing is complete.
       theThreadEnv->terminate(theOpenTileThreadQueue, true);
       theThreadEnv->cs_terminate(theCodestream);   // Terminates background codestream processing.
       theThreadEnv->destroy();
       delete theThreadEnv;
       theThreadEnv = 0;
    }
    
    if(theCodestream.exists())
    {
       theCodestream.destroy();
    }
 
    if (theOpenTileThreadQueue)
    {
       theOpenTileThreadQueue = 0;
    }
 
    if (theCacheId != -1)
    {
       ossimAppFixedTileCache::instance()->deleteCache(theCacheId);
       theCacheId = -1;
    }
 
    theTile      = 0;
    theCacheTile = 0;
    theTileSizeX = 0;
    theTileSizeY = 0;
 
    ossimImageHandler::close();
 }

◆ get_capabilities()

ossim_int32 ossimKakaduJ2kReader::get_capabilities ( )

inlineprotectedvirtual

Gets kdu source capability.

Overrides kdu_compressed_source::get_capabilities

Returns: KDU_SOURCE_CAP_SEEKABLE

Definition at line 316 of file ossimKakaduJ2kReader.h.

 {
    return ( KDU_SOURCE_CAP_SEEKABLE );
 }

◆ get_pos()

kdu_core::kdu_long ossimKakaduJ2kReader::get_pos ( )

inlineprotectedvirtual

Get file position relative to the start of code stream offset.

Overrides kdu_compressed_source::get_pos

Returns: Position in codestream.

Definition at line 344 of file ossimKakaduJ2kReader.h.

References theFileStr.

 {
    //---
    // Must subtract the SOC(start of code stream) from the real file position
    // since positions are relative to SOC.
    //---
    return static_cast<kdu_core::kdu_long>(theFileStr.tellg());
 }

◆ getClassName()

ossimString ossimKakaduJ2kReader::getClassName ( ) const

virtual

Returns short name.

Returns: "ossim_kakadu_j2k_reader"

Reimplemented from ossimObject.

Definition at line 88 of file ossimKakaduJ2kReader.cpp.

 {
    return ossimString("ossimKakaduJ2kReader");
 }

◆ getDecimationFactor()

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

virtual

Gets the decimation factor for a resLevel.

Parameters

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

Reimplemented from ossimImageHandler.

Definition at line 93 of file ossimKakaduJ2kReader.cpp.

References getNumberOfDecimationLevels(), getNumberOfLines(), ossimImageHandler::getNumberOfLines(), getNumberOfSamples(), ossimImageHandler::getNumberOfSamples(), ossim::nan(), theMinDwtLevels, ossimImageHandler::theOverview, ossimRefPtr< T >::valid(), ossimDpt::x, and ossimDpt::y.

Referenced by getDecimationFactors(), getNumberOfLines(), and getNumberOfSamples().

 {
    if (resLevel == 0)
    {
       //---
       // Assumption r0 or first layer is full res.  Might need to change to
       // use nitf IMAG field.
       //---
       result.x = 1.0;
       result.y = 1.0;
    }
    else if ( theOverview.valid() && (resLevel > theMinDwtLevels) &&
              (resLevel < getNumberOfDecimationLevels()) )
    {
       //---
       // External overview file.
       // 
       // Use the real lines and samples in case an resLevel is skipped.
       //
       // Note we must subtract the internal overviews as the external
       // overview reader does not know about them.
       //---
       ossim_float64 r0 = getNumberOfSamples(0);
       ossim_float64 rL =
          theOverview->getNumberOfSamples(resLevel-theMinDwtLevels);
       
       if (r0) // Divide by zero check
       {
          result.x = rL/r0;
       }
       else
       {
          result.x = ossim::nan();
       }
       r0 = getNumberOfLines(0);
       rL = theOverview->getNumberOfLines(resLevel-theMinDwtLevels);
       
       if (r0) // Divide by zero check.
       {
          result.y = rL/r0;
       }
       else
       {
          result.y = ossim::nan();
       }
    }
    else
    {
       // Internal overviews are on power of two decimation.
       result.x = 1.0 / pow((double)2, (double)resLevel);
       result.y = result.x;
    }
 }

◆ getDecimationFactors()

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

virtual

Get array of decimations for all levels.

Parameters

decimations Vector to initialize with decimations.

Reimplemented from ossimImageHandler.

Definition at line 148 of file ossimKakaduJ2kReader.cpp.

References getDecimationFactor(), and getNumberOfDecimationLevels().

 {
    const ossim_uint32 LEVELS = getNumberOfDecimationLevels();
    decimations.resize(LEVELS);
    for (ossim_uint32 level = 0; level < LEVELS; ++level)
    {
       getDecimationFactor(level, decimations[level]);
    }
 }

◆ getImageTileHeight()

ossim_uint32 ossimKakaduJ2kReader::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 669 of file ossimKakaduJ2kReader.cpp.

References ossimJ2kSizRecord::m_XTsiz, ossimJ2kSizRecord::m_YTsiz, and theSizRecord.

Referenced by initializeTile().

 {
    ossim_uint32 result = 0;
    if ( (theSizRecord.m_XTsiz <= 1024) && (theSizRecord.m_YTsiz <= 1024) )
    {
       result = theSizRecord.m_YTsiz;
    }
    return result;
 }

◆ getImageTileWidth()

ossim_uint32 ossimKakaduJ2kReader::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 659 of file ossimKakaduJ2kReader.cpp.

References ossimJ2kSizRecord::m_XTsiz, ossimJ2kSizRecord::m_YTsiz, and theSizRecord.

Referenced by initializeTile().

 {
    ossim_uint32 result = 0;
    if ( (theSizRecord.m_XTsiz <= 1024) && (theSizRecord.m_YTsiz <= 1024) )
    {
       result = theSizRecord.m_XTsiz;
    }
    return result;
 }

◆ getLongName()

ossimString ossimKakaduJ2kReader::getLongName ( ) const

virtual

Returns long name.

Returns: "ossim kakadu j2k reader"

Reimplemented from ossimObject.

Definition at line 83 of file ossimKakaduJ2kReader.cpp.

 {
    return ossimString("ossim kakadu j2k reader");
 }

◆ getNumberOfDecimationLevels()

ossim_uint32 ossimKakaduJ2kReader::getNumberOfDecimationLevels ( ) const

virtual

Returns the number of decimation levels.

This returns the total number of decimation levels. It is important to note that res level 0 or full resolution is included in the list and has decimation values 1.0, 1.0

Returns: The number of decimation levels.

Reimplemented from ossimImageHandler.

Definition at line 159 of file ossimKakaduJ2kReader.cpp.

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

Referenced by getDecimationFactor(), getDecimationFactors(), getNumberOfLines(), getNumberOfSamples(), and getOverviewTile().

 {
    ossim_uint32 result = 1; // Add r0
 
    if (theMinDwtLevels)
    {
       //---
       // Add internal overviews.
       //---
       result += theMinDwtLevels;
    }
 
    if (theOverview.valid())
    {
       //---
       // Add external overviews.
       //
       // NOTE: The ossimTiffTileSource will count r0 if present or it will
       //       add 1 to the decimation count if r0 is NOT present. Since
       //       since r0 has already be added subtract one.
       //---
       result += theOverview->getNumberOfDecimationLevels()-1;
    }
 
    return result;
 }

◆ getNumberOfInputBands()

ossim_uint32 ossimKakaduJ2kReader::getNumberOfInputBands ( ) const

virtual

Returns the number of bands in the image.

Satisfies pure virtual from ImageHandler class.

Implements ossimImageSource.

Definition at line 649 of file ossimKakaduJ2kReader.cpp.

References ossimJ2kSizRecord::m_Csiz, and theSizRecord.

 {
    return theSizRecord.m_Csiz;
 }

◆ getNumberOfLines()

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

virtual

Gets number of lines for res level.

Overrides ossimJ2kTileSource::getNumberOfLines

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 186 of file ossimKakaduJ2kReader.cpp.

References getDecimationFactor(), getNumberOfDecimationLevels(), ossimDpt::hasNans(), ossimJ2kSizRecord::m_Ysiz, theSizRecord, and ossimDpt::y.

Referenced by getDecimationFactor().

 {
    ossim_uint32 result = 0;
    if (resLevel < getNumberOfDecimationLevels())
    {
       result = theSizRecord.m_Ysiz;
       if ( resLevel > 0 )
       {
          ossimDpt dpt;
          getDecimationFactor(resLevel, dpt);
          if ( !dpt.hasNans() )
          {
             result = static_cast<ossim_uint32>(result * dpt.y);
          }
       }
    }
    return result;
 }

◆ getNumberOfOutputBands()

ossim_uint32 ossimKakaduJ2kReader::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 654 of file ossimKakaduJ2kReader.cpp.

References ossimJ2kSizRecord::m_Csiz, and theSizRecord.

Referenced by getOverviewTile(), and initializeTile().

 {
    return theSizRecord.m_Csiz;
 }

◆ getNumberOfSamples()

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

virtual

Gets the number of samples for res level.

Overrides ossimJ2kTileSource::getNumberOfSamples

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 206 of file ossimKakaduJ2kReader.cpp.

References getDecimationFactor(), getNumberOfDecimationLevels(), ossimJ2kSizRecord::m_Xsiz, theSizRecord, and ossimDpt::x.

Referenced by getDecimationFactor().

 {
    ossim_uint32 result = 0;
    if (resLevel < getNumberOfDecimationLevels())
    {
       result = theSizRecord.m_Xsiz;
       if ( resLevel > 0 )
       {
          ossimDpt dpt;
          getDecimationFactor(resLevel, dpt);
          result = static_cast<ossim_uint32>(result * dpt.x);
       }
    }
    return result;
 }

◆ getOutputScalarType()

ossimScalarType ossimKakaduJ2kReader::getOutputScalarType ( ) const

virtual

Returns the output pixel type of the tile source.

Reimplemented from ossimImageSource.

Definition at line 679 of file ossimKakaduJ2kReader.cpp.

References ossimJ2kSizRecord::getScalarType(), and theSizRecord.

Referenced by initializeTile().

 {
    return theSizRecord.getScalarType();
 }

◆ getOverviewTile()

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

protectedvirtual

Gets an overview tile.

Overrides ossimImageHandler::getOverviewTile

Parameters

resLevel	The resolution level to pull from with resLevel 0 being full res.
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. This method will subtract the subImageOffset if needed for external overview call since they do not know about the sub image offset.

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

Reimplemented from ossimImageHandler.

Definition at line 611 of file ossimKakaduJ2kReader.cpp.

References ossim::copyRegionToTile(), ossimImageData::getNumberOfBands(), getNumberOfDecimationLevels(), getNumberOfOutputBands(), ossimImageSource::getTile(), ossimNotify(), ossimNotifyLevel_WARN, status, theCodestream, theMinDwtLevels, theOpenTileThreadQueue, ossimImageHandler::theOverview, theThreadEnv, and ossimException::what().

Referenced by getTile(), and loadTile().

 {
    bool status = false;
 
    if ( (resLevel < getNumberOfDecimationLevels()) && result &&
         (result->getNumberOfBands() == getNumberOfOutputBands()) )
    {
       if (resLevel <= theMinDwtLevels)
       {
          // Internal overviews...
          try
          {
             status = ossim::copyRegionToTile(theCodestream,
                                              static_cast<int>(resLevel),
                                              theThreadEnv,
                                              theOpenTileThreadQueue,
                                              result);
          }
          catch(const ossimException& e)
          {
             ossimNotify(ossimNotifyLevel_WARN)
                << __FILE__ << " " << __LINE__ << " caught exception\n"
                << e.what();
             status = false;
          }
 
       } // matches:  if (resLevel <= theMinDwtLevels)
       else
       {
          // External overviews...
          status = theOverview->getTile(result, resLevel - theMinDwtLevels);
       }
    }
 
    return status;
 }

◆ getShortName()

ossimString ossimKakaduJ2kReader::getShortName ( ) const

virtual

Returns short name.

Returns: "ossim_kakadu_j2k_reader"

Reimplemented from ossimObject.

Definition at line 78 of file ossimKakaduJ2kReader.cpp.

 {
    return ossimString("ossim_kakadu_j2k_reader");
 }

◆ getTile()

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

virtual

Method to grab a tile(rectangle) from image.

Parameters

rect	The zero based rectangle to grab.
resLevel	The reduced resolution level to grab from.

Returns: The ref pointer with the image data pointer.

Reimplemented from ossimImageSource.

Definition at line 515 of file ossimKakaduJ2kReader.cpp.

References ossimIrect::clipToRect(), ossimIrect::completely_within(), ossimRefPtr< T >::get(), ossimImageData::getBuf(), ossimImageData::getImageRectangle(), getOverviewTile(), ossimIrect::intersects(), isOpen(), ossimSource::isSourceEnabled(), ossimImageHandler::isValidRLevel(), loadTile(), ossimImageData::loadTile(), loadTileFromCache(), ossimIrect::lr(), ossimImageData::makeBlank(), OSSIM_BSQ, ossimImageData::setImageRectangle(), ossimIrect::stretchToTileBoundary(), theCacheTile, theImageRect, theTile, theTileSizeX, theTileSizeY, ossimIrect::ul(), ossimRefPtr< T >::valid(), ossimImageData::validate(), ossimIpt::x, x, ossimIpt::y, and y.

 {
    // This tile source bypassed, or invalid res level, return a blank tile.
    if(!isSourceEnabled() || !isOpen() || !isValidRLevel(resLevel))
    {
       return ossimRefPtr<ossimImageData>();
    }
 
    if (theTile.valid())
    {
       // Rectangle must be set prior to getOverviewTile call.
       theTile->setImageRectangle(rect);
 
       if (resLevel)
       {
          if ( getOverviewTile(resLevel, theTile.get() ) == false )
          {
             theTile->makeBlank();
          }
       }
       else
       {
          //---
          // See if the whole tile is going to be filled, if not, start out with
          // a blank tile so data from a previous load gets wiped out.
          //---
          if ( !rect.completely_within(theImageRect) )
          {
             // Start with a blank tile.
             theTile->makeBlank();
          }
          
          //---
          // See if any point of the requested tile is in the image.
          //---
          if ( rect.intersects(theImageRect) )
          {
             ossimIrect clipRect = rect.clipToRect(theImageRect);
 
             ossimIrect exandedRect  = clipRect;
 
             //---
             // Shift the upper left corner of the "clip_rect" to the an even
             // j2k tile boundry.  
             //---
             exandedRect.stretchToTileBoundary(ossimIpt(theTileSizeX,
                                                        theTileSizeY));
             
             // Vertical tile loop.
             ossim_int32 y = exandedRect.ul().y;
             while (y < exandedRect.lr().y)
             {
                // Horizontal tile loop.
                ossim_int32 x = exandedRect.ul().x;
                while (x < exandedRect.lr().x)
                {
                   if ( loadTileFromCache(x, y, clipRect) == false )
                   {
                      if ( loadTile(x, y) )
                      {
                         //---
                         // Note: Clip the cache tile to the image clipRect
                         // since there are j2k tiles that go beyond the image
                         // dimensions, i.e., edge tiles.
                         //---    
                         ossimIrect cr =
                            theCacheTile->getImageRectangle().
                            clipToRect(clipRect);
                         
                         theTile->loadTile(theCacheTile->getBuf(),
                                           theCacheTile->getImageRectangle(),
                                           cr,
                                           OSSIM_BSQ);
                      }
                      
                   }
                   
                   x += theTileSizeX; // Go to next tile.
                }
                
                y += theTileSizeY; // Go to next row of tiles.
             }
 
             // Set the tile status.
             theTile->validate();
             
          } // matches: if ( rect.intersects(theImageRect) )
          
       } // r0 block
       
    } // matches: if (theTile.valid())
 
    return theTile;
 }

◆ initializeTile()

void ossimKakaduJ2kReader::initializeTile ( )

private

Initializes data member "theTile".

Definition at line 684 of file ossimKakaduJ2kReader.cpp.

References ossim::defaultTileSize(), getImageTileHeight(), getImageTileWidth(), getNumberOfOutputBands(), getOutputScalarType(), ossimImageData::initialize(), ossimImageDataFactory::instance(), theCacheTile, theTile, theTileSizeX, theTileSizeY, ossimIpt::x, and ossimIpt::y.

 {
    theTileSizeX = this->getImageTileWidth();
    theTileSizeY = this->getImageTileHeight();
 
    // Check for zero width, height and limit output tile sizes to 1024.
    if ( !theTileSizeX || !theTileSizeY ||
         ( theTileSizeX > 1024) || (theTileSizeY > 1024) )
    {
       ossimIpt tileSize;
       ossim::defaultTileSize(tileSize);
 
       theTileSizeX = tileSize.x;
       theTileSizeY = tileSize.y;
    }
    
    theTile = ossimImageDataFactory::instance()->
       create( this,
               this->getOutputScalarType(),
               this->getNumberOfOutputBands(),
               theTileSizeX,
               theTileSizeY);
 
    theTile->initialize();
 
    theCacheTile = ossimImageDataFactory::instance()->
       create( this,
               this->getOutputScalarType(),
               this->getNumberOfOutputBands(),
               theTileSizeX,
               theTileSizeY);
    
    theCacheTile->initialize();
 }

◆ isOpen()

bool ossimKakaduJ2kReader::isOpen ( ) const

virtual

Method to test for open file stream.

Returns: true if open, false if not.

Implements ossimImageHandler.

Definition at line 454 of file ossimKakaduJ2kReader.cpp.

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

Referenced by getTile().

 {
    // return theFileStr.is_open();
 
    // Temp fix for gcc's that don't have a const "ifstream::is_open() const"
    return theTile.valid();
 }

◆ loadState()

bool ossimKakaduJ2kReader::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 501 of file ossimKakaduJ2kReader.cpp.

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

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

◆ loadTile()

bool ossimKakaduJ2kReader::loadTile	(	ossim_uint32	x,
		ossim_uint32	y
	)

private

Loads a block of data to theCacheTile.

Parameters

x	Starting x position of block to load.
y	Starting y position of block to load.

Returns: true on success, false on error.

Note: x and y are zero based relative to the upper left corner so any sub image offset should be subtracted off.

Definition at line 748 of file ossimKakaduJ2kReader.cpp.

References ossimAppFixedTileCache::addTile(), ossimRefPtr< T >::get(), getOverviewTile(), ossimAppFixedTileCache::instance(), ossimNotify(), ossimNotifyLevel_WARN, ossimImageData::setImageRectangle(), theCacheId, theCacheTile, theTileSizeX, theTileSizeY, ossimIpt::x, x, ossimIpt::y, and y.

Referenced by getTile().

 {
    bool result = true;
    
    ossimIpt ul(x, y);
    ossimIpt lr(ul.x + theTileSizeX - 1,
                ul.y + theTileSizeY - 1);
 
    // Set the cache rectangle to be an even j2k tile.
    theCacheTile->setImageRectangle(ossimIrect(ul, lr));
 
    //---
    // Let the getOverviewTile do the rest of the work.
    if ( getOverviewTile(0, theCacheTile.get()) )
    {
       // Add it to the cache for the next time.
       ossimAppFixedTileCache::instance()->addTile(theCacheId, theCacheTile);
    }
    else
    {
       ossimNotify(ossimNotifyLevel_WARN)
          << __FILE__ << __LINE__
          << " ossimKakaduJ2kReader::loadBlock failed!"
          << std::endl;
       result = false;
    }
    
    return result;
 }

◆ loadTileFromCache()

bool ossimKakaduJ2kReader::loadTileFromCache	(	ossim_uint32	x,
		ossim_uint32	y,
		const ossimIrect &	clipRect
	)

private

Loads a block of data to theCacheTile from the cache.

Parameters

x	Starting x position of block to load.
y	Starting y position of block to load.
clipRect	The rectangle to fill.

Returns: true on success, false on error.

Note: x and y are zero based relative to the upper left corner so any sub image offset should be subtracted off.

Definition at line 719 of file ossimKakaduJ2kReader.cpp.

References ossimIrect::clipToRect(), ossimRefPtr< T >::get(), ossimImageData::getBuf(), ossimImageData::getImageRectangle(), ossimAppFixedTileCache::getTile(), ossimAppFixedTileCache::instance(), ossimImageData::loadTile(), OSSIM_BSQ, theCacheId, theTile, ossimRefPtr< T >::valid(), x, and y.

Referenced by getTile().

 {
    bool result = false;
 
    ossimIpt origin(x, y);
 
    ossimRefPtr<ossimImageData> tempTile =
       ossimAppFixedTileCache::instance()->getTile(theCacheId, origin);
 
    if (tempTile.valid())
    {
       //---
       // Note: Clip the cache j2k tile to the image clipRect since
       // there are j2k tiles that go beyond the image dimensions, i.e.,
       // edge tiles.
       //---
       ossimIrect cr =
          tempTile->getImageRectangle().clipToRect(clipRect);
       
       theTile->loadTile(tempTile.get()->getBuf(),
                         tempTile->getImageRectangle(),
                         cr,
                         OSSIM_BSQ);
       result = true;
    }
    return result;
 }

◆ open()

bool ossimKakaduJ2kReader::open ( )

virtual

Open method.

Returns: true on success, false on error.

Implements ossimImageHandler.

Definition at line 223 of file ossimKakaduJ2kReader.cpp.

Referenced by loadState().

 {
    static const char MODULE[] = "ossimKakaduJ2kReader::open";
 
    if (traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << MODULE << " entered...\n";
    }
    
    bool result = false;
    
    if(isOpen())
    {
       closeEntry();
    }
 
    // Open up a stream to the file.
    theFileStr.open(theImageFile.c_str(), ios::in | ios::binary);
    if ( theFileStr.good() )
    {
       //---
       // Check for the Start Of Codestream (SOC) and Size (SIZ) markers which
       // are required as first and second fields in the main header.
       //---
       ossim_uint16 soc;
       ossim_uint16 siz;
       theFileStr.read((char*)&soc,  2);
       theFileStr.read((char*)&siz,  2);
       
       if (ossim::byteOrder() == OSSIM_LITTLE_ENDIAN) // Alway big endian.
       {
          ossimEndian().swap(soc);
          ossimEndian().swap(siz);
       }
 
       const ossim_uint16 SOC_MARKER = 0xff4f; // start of codestream marker
       const ossim_uint16 SIZ_MARKER = 0xff51; // size maker
 
       if ( (soc == SOC_MARKER) && (siz == SIZ_MARKER) )
       {
          // Read in and store the size record.
          theSizRecord.parseStream(theFileStr);
 
          // Position to start of code stream prior to create call.
          theFileStr.seekg(0);
  
          //---
          // Initialize the codestream.  The class ossimKakaduNitfReader is a
          // kdu_compressed source so we feed ourself to the codestream.
          //
          // TODO:  Currently no kdu_thread_env.  This should be implemented for
          // speed...
          //---
          
          //---
          // Construct multi-threaded processing environment if required.
          // Temp hard coded to a single thread.
          //---
          
          if (theThreadEnv)
          {
             theThreadEnv->terminate(NULL, true);
             theThreadEnv->destroy();
          }
          else
          {
             theThreadEnv = new kdu_core::kdu_thread_env();
          }
          
          theThreadEnv->create(); // Creates the single "owner" thread
 
          // Check for threads in prefs file.
          ossim_uint32 threads = 1;
          const char* lookup = ossimPreferences::instance()->findPreference("kakadu_threads");
          if ( lookup )
          {
             threads = ossimString::toUInt32(lookup);
             if ( threads > 1 )
             {
                for (ossim_uint32 nt=1; nt < threads; ++nt)
                {
                   if ( !theThreadEnv->add_thread() )
                   {
                      if (traceDebug())
                      {
                         ossimNotify(ossimNotifyLevel_WARN)
                            << "Unable to create thread!\n";
                      }
                   }
                }
             }
          }
          
          theOpenTileThreadQueue = theThreadEnv->add_queue(NULL,NULL,"open_tile_q");
          
          theCodestream.create(this, theThreadEnv);
          
          if ( theCodestream.exists() )
          {
             //---
             // We have to store things here in this non-const method because
             // NONE of the kakadu methods are const.
             //---
             theMinDwtLevels = theCodestream.get_min_dwt_levels();
             
             theCodestream.set_persistent(); // ????
             theCodestream.enable_restart(); // ????
             
             kdu_core::kdu_dims region_of_interest;
             region_of_interest.pos.x = 0;
             region_of_interest.pos.y = 0;
             region_of_interest.size.x = getNumberOfSamples(0);
             region_of_interest.size.y = getNumberOfLines(0);
 
             theCodestream.apply_input_restrictions(
                0, // first_component
                0, // max_components (0 = all remaining will appear)
                0, // highest resolution level
                0, // max_layers (0 = all layers retained)
                &region_of_interest, // expanded out to block boundary.
                //KDU_WANT_CODESTREAM_COMPONENTS);
                kdu_core::KDU_WANT_OUTPUT_COMPONENTS);
             
             // Set the scalar:
             theScalarType = theSizRecord.getScalarType();
             if (theScalarType != OSSIM_SCALAR_UNKNOWN)
             {
                //---
                // NOTE: Please leave commented out code for now.
                //---
                // Capture the sub image offset.
                // theSubImageOffset.x = theSizRecord.theXOsiz;
                // theSubImageOffset.y = theSizRecord.theYOsiz;
                
                // Initialize the image rect.
                theImageRect = ossimIrect(0,
                                          0,
                                          theSizRecord.m_Xsiz-1,
                                          theSizRecord.m_Ysiz-1);
 
                // Initialize the cache.
                if (theCacheId != -1)
                {
                   ossimAppFixedTileCache::instance()->deleteCache(theCacheId);
                   theCacheId = -1;
                }
                ossimIpt tileSize(theSizRecord.m_XTsiz, theSizRecord.m_YTsiz);
 
                // Stretch to tile boundary for the cache.
                ossimIrect fullImgRect = theImageRect;
                fullImgRect.stretchToTileBoundary(tileSize);
                
                // Set up the tile cache.
                theCacheId = ossimAppFixedTileCache::instance()->
                   newTileCache(fullImgRect, tileSize);
 
                // Add the sub image rect after the 
                
                // Initialize the tile we will return.
                initializeTile();
 
                // Call the base complete open to pick up overviews.
                completeOpen();
                
                // We should be good now so set the return result to true.
                result = true;
 
                if (traceDebug())
                {
                   ossimNotify(ossimNotifyLevel_DEBUG)
                      << "\nSIZ marker segment"
                      << theSizRecord
                      << "theCodestream.get_num_components(false): "
                      << theCodestream.get_num_components(false)
                      << "\ntheCodestream.get_num_components(true): "
                      << theCodestream.get_num_components(true)
                      << "\ntheCodestream.get_bit_depth(0, true): "
                      << theCodestream.get_bit_depth(0, true)
                      << "\ntheCodestream.get_signed(0, true): "
                      << theCodestream.get_signed(0, true)
                      << "\ntheCodestream.get_min_dwt_levels(): "
                      << theCodestream.get_min_dwt_levels()
                      << "\ntheImageRect: " << theImageRect
                      << "\nFull image rect: " << fullImgRect
                      << "\nthreads: " << threads
                      << "\n";
                   
                   vector<ossimDpt> decimations;
                   getDecimationFactors(decimations);
                   for (ossim_uint32 i = 0; i < decimations.size(); ++i)
                   {
                      ossimNotify(ossimNotifyLevel_DEBUG)
                         << theCodestream.get_min_dwt_levels()
                         << "Decimation factor[" << i << "]: "
                         << decimations[i]
                         << "\nsamples[" << i << "]: "
                         << getNumberOfSamples(i)
                         << "\nlines[" << i << "]: "
                         << getNumberOfLines(i)
                         << std::endl;
                      
                   }
                }
             }
                
          } // matches: if ( theCodestream.exists() )
          
       } //  matches: if ( (soc == SOC_MARKER) && (siz == SIZ_MARKER) )
       
    } // matches: if ( theFileStr.good() )
    else
    {
       if(traceDebug())
       {
          ossimNotify(ossimNotifyLevel_DEBUG)
             << MODULE << " ERROR:"
             << "\nCannot open:  " << theImageFile.c_str() << endl;
       }
    }
 
    if (traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << MODULE << " exit status = " << (result?"true":"false\n")
          << std::endl;
    }
 
    return result;
 }

◆ read()

ossim_int32 ossimKakaduJ2kReader::read	(	kdu_core::kdu_byte *	buf,
		ossim_int32	num_bytes
	)

inlineprotectedvirtual

Read method.

Implements pure virtual kdu_compressed_source::read

Parameters

buf	Buffer to fill.
num_bytes	Bytes to read.

Returns: Actual bytes read.

Definition at line 321 of file ossimKakaduJ2kReader.h.

References theFileStr.

 {
    theFileStr.read((char*)buf, num_bytes);
    return theFileStr.gcount();
 }

◆ seek()

bool ossimKakaduJ2kReader::seek ( kdu_core::kdu_long offset )

inlineprotectedvirtual

Seek method.

Overrides kdu_compressed_source::seek

Parameters

offset Seek position relative to the start of code stream offset.

Returns: true on success, false on error.

Definition at line 328 of file ossimKakaduJ2kReader.h.

References theFileStr.

 {
    // If the last byte is read, the eofbit must be reset. 
    if ( theFileStr.eof() )
    {
       theFileStr.clear();
    }
 
    //---
    // All seeks are relative to the start of code stream.
    //---
    theFileStr.seekg(offset, ios_base::beg);
 
    return theFileStr.good();
 }

Member Data Documentation

◆ theCacheId

ossimAppFixedTileCache::ossimAppFixedCacheId ossimKakaduJ2kReader::theCacheId

private

Definition at line 311 of file ossimKakaduJ2kReader.h.

Referenced by closeEntry(), loadTile(), and loadTileFromCache().

◆ theCacheTile

ossimRefPtr<ossimImageData> ossimKakaduJ2kReader::theCacheTile

private

Definition at line 306 of file ossimKakaduJ2kReader.h.

Referenced by closeEntry(), getTile(), initializeTile(), and loadTile().

◆ theCodestream

kdu_core::kdu_codestream ossimKakaduJ2kReader::theCodestream

private

Definition at line 296 of file ossimKakaduJ2kReader.h.

Referenced by closeEntry(), and getOverviewTile().

◆ theFileStr

std::ifstream ossimKakaduJ2kReader::theFileStr

private

Definition at line 301 of file ossimKakaduJ2kReader.h.

Referenced by closeEntry(), get_pos(), read(), and seek().

◆ theImageRect

ossimIrect ossimKakaduJ2kReader::theImageRect

private

Definition at line 304 of file ossimKakaduJ2kReader.h.

Referenced by getTile().

◆ theMinDwtLevels

ossim_uint32 ossimKakaduJ2kReader::theMinDwtLevels

private

Definition at line 300 of file ossimKakaduJ2kReader.h.

Referenced by getDecimationFactor(), getNumberOfDecimationLevels(), and getOverviewTile().

◆ theOpenTileThreadQueue

kdu_core::kdu_thread_queue* ossimKakaduJ2kReader::theOpenTileThreadQueue

private

Definition at line 298 of file ossimKakaduJ2kReader.h.

Referenced by closeEntry(), and getOverviewTile().

◆ theScalarType

ossimScalarType ossimKakaduJ2kReader::theScalarType

private

Definition at line 303 of file ossimKakaduJ2kReader.h.

◆ theSizRecord

ossimJ2kSizRecord ossimKakaduJ2kReader::theSizRecord

private

Definition at line 302 of file ossimKakaduJ2kReader.h.

Referenced by getImageTileHeight(), getImageTileWidth(), getNumberOfInputBands(), getNumberOfLines(), getNumberOfOutputBands(), getNumberOfSamples(), and getOutputScalarType().

◆ theSourcePrecisionBits

ossim_uint32 ossimKakaduJ2kReader::theSourcePrecisionBits

private

Definition at line 299 of file ossimKakaduJ2kReader.h.

◆ theThreadEnv

kdu_core::kdu_thread_env* ossimKakaduJ2kReader::theThreadEnv

private

Definition at line 297 of file ossimKakaduJ2kReader.h.

Referenced by closeEntry(), and getOverviewTile().

◆ theTile

ossimRefPtr<ossimImageData> ossimKakaduJ2kReader::theTile

private

Definition at line 305 of file ossimKakaduJ2kReader.h.

Referenced by closeEntry(), getTile(), initializeTile(), isOpen(), and loadTileFromCache().

◆ theTileSizeX

ossim_uint32 ossimKakaduJ2kReader::theTileSizeX

private

Definition at line 307 of file ossimKakaduJ2kReader.h.

Referenced by closeEntry(), getTile(), initializeTile(), and loadTile().

◆ theTileSizeY

ossim_uint32 ossimKakaduJ2kReader::theTileSizeY

private

Definition at line 308 of file ossimKakaduJ2kReader.h.

Referenced by closeEntry(), getTile(), initializeTile(), and loadTile().

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ossimKakaduJ2kReader()

◆ ~ossimKakaduJ2kReader()

Member Function Documentation

◆ closeEntry()

◆ get_capabilities()

◆ get_pos()

◆ getClassName()

◆ getDecimationFactor()

◆ getDecimationFactors()

◆ getImageTileHeight()

◆ getImageTileWidth()

◆ getLongName()

◆ getNumberOfDecimationLevels()

◆ getNumberOfInputBands()

◆ getNumberOfLines()

◆ getNumberOfOutputBands()

◆ getNumberOfSamples()

◆ getOutputScalarType()

◆ getOverviewTile()

◆ getShortName()

◆ getTile()

◆ initializeTile()

◆ isOpen()

◆ loadState()

◆ loadTile()

◆ loadTileFromCache()

◆ open()

◆ read()

◆ seek()

Member Data Documentation

◆ theCacheId

◆ theCacheTile

◆ theCodestream

◆ theFileStr

◆ theImageRect

◆ theMinDwtLevels

◆ theOpenTileThreadQueue

◆ theScalarType

◆ theSizRecord

◆ theSourcePrecisionBits

◆ theThreadEnv

◆ theTile

◆ theTileSizeX

◆ theTileSizeY