ossimKakaduNitfReader Class Reference

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

#include <ossimKakaduNitfReader.h>

Inheritance diagram for ossimKakaduNitfReader:

Public Types
enum	{ SIGNATURE_BOX_SIZE = 12 }
	Anonymous enumerations: More...
Public Types inherited from ossimNitfTileSource
enum	ReadMode {   READ_MODE_UNKNOWN = 0, READ_BIB_BLOCK = 1, READ_BIP_BLOCK = 2, READ_BIR_BLOCK = 3,   READ_BSQ_BLOCK = 4, READ_BIB = 5, READ_BIP = 6, READ_BIR = 7,   READ_JPEG_BLOCK = 8 }
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

Public Member Functions
	ossimKakaduNitfReader ()
	default construtor More...
virtual	~ossimKakaduNitfReader ()
	virtural destructor More...
virtual ossimString	getShortName () const
	Returns short name. More...
virtual ossimString	getLongName () const
	Returns long name. 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 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_float64	getMinPixelValue (ossim_uint32 band=0) const
virtual ossim_float64	getMaxPixelValue (ossim_uint32 band=0) const
virtual ossim_float64	getNullPixelValue (ossim_uint32 band=0) const
Public Member Functions inherited from ossimNitfTileSource
	ossimNitfTileSource ()
virtual bool	open ()
	Returns true if the image_file can be opened and is a valid nitf file. More...
bool	open (std::shared_ptr< ossim::istream > &str, const std::string &connectionString)
	This open takes a stream and stores/captures the shared pointer on success. More...
virtual void	close ()
	Closes file and destroys all memory allocated. More...
virtual ossimRefPtr< ossimImageData >	getTile (const ossimIrect &tileRect, ossim_uint32 resLevel=0)
virtual ossim_uint32	getNumberOfInputBands () const
virtual ossim_uint32	getNumberOfOutputBands () const
virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const
	Method to save the state of an object to a keyword list. More...
virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)
	Method to the load (recreate) the state of an object from a keyword list. More...
virtual ossimScalarType	getOutputScalarType () const
	Returns the output pixel type of the tile source. More...
virtual ossim_uint32	getTileWidth () const
	Returns the width of the output tile. More...
virtual ossim_uint32	getTileHeight () const
	Returns the height of the output tile. More...
virtual ossim_uint32	getImageTileWidth () const
	Returns the tile width of the image or 0 if the image is not tiled. More...
virtual ossim_uint32	getImageTileHeight () const
	Returns the tile width of the image or 0 if the image is not tiled. More...
virtual bool	isOpen () const
	Derived classes must implement this method to be concrete. More...
virtual ossim_uint32	getCurrentEntry () const
virtual void	getEntryList (std::vector< ossim_uint32 > &entryList) const
ossim_uint32	getNumberOfEntries () const
virtual bool	setCurrentEntry (ossim_uint32 entryIdx)
virtual ossimRefPtr< ossimProperty >	getProperty (const ossimString &name) const
virtual void	setProperty (ossimRefPtr< ossimProperty > property)
virtual void	getPropertyNames (std::vector< ossimString > &propertyNames) const
ossimString	getSecurityClassification () const
bool	getCacheEnabledFlag () const
void	setCacheEnabledFlag (bool flag)
const ossimNitfFileHeader *	getFileHeader () const
ossimNitfFileHeader *	getFileHeader ()
const ossimNitfImageHeader *	getCurrentImageHeader () const
ossimNitfImageHeader *	getCurrentImageHeader ()
virtual bool	getRgbBandList (std::vector< ossim_uint32 > &bandList) const
	Convenience method to get the zero based rgb output band 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 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 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	getNumberOfReducedResSets () const
	This method is obsolete. More...
virtual void	setFilename (const ossimFilename &filename)
	Sets the filename. More...
virtual const ossimFilename &	getFilename () const
	Returns the filename. More...
virtual bool	isValidRLevel (ossim_uint32 resLevel) const
	Determines if the passed in reslution level is valid. More...
bool	canConnectMyInputTo (ossim_int32 inputIndex, const ossimConnectableObject *object) const
	Connection rule. More...
virtual void	getValidImageVertices (vector< ossimIpt > &validVertices, ossimVertexOrdering ordering=OSSIM_CLOCKWISE_ORDER, ossim_uint32 resLevel=0) const
	ordering specifies how the vertices should be arranged. More...
virtual bool	isBandSelector () const
	Indicates whether or not the image handler can control output band selection via the setOutputBandList method. More...
virtual bool	setOutputBandList (const std::vector< ossim_uint32 > &band_list)
	If the image handler "isBandSeletor()" then the band selection of the output chip can be controlled. More...
virtual bool	setOutputToInputBandList ()
	If the image handler "isBandSeletor()" then the band selection of the output are set to input or identity. More...
virtual bool	isIdentityBandList (const std::vector< ossim_uint32 > &bandList) const
	Convenience method to see if band list is identity. More...
virtual bool	isImageTiled () const
	Indicates whether or not the image is tiled internally. More...
virtual bool	hasMetaData () const
virtual ossimRefPtr< ossimNBandLutDataObject >	getLut () const
virtual bool	hasLut () const
virtual void	loadMetaData ()
	There is an external file with an omd extension. 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
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...
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 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	getClassName () const
virtual RTTItypeid	getType () const
virtual bool	canCastTo (ossimObject *obj) const
virtual bool	canCastTo (const RTTItypeid &id) const
virtual bool	canCastTo (const ossimString &parentClassName) const
virtual bool	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const
Public Member Functions inherited from ossimReferenced
	ossimReferenced ()
	ossimReferenced (const ossimReferenced &)
ossimReferenced &	operator= (const ossimReferenced &)
void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
int	referenceCount () const
Public Member Functions inherited from ossimListenerManager
	ossimListenerManager ()
virtual	~ossimListenerManager ()
virtual void	fireEvent (ossimEvent &event)
virtual bool	addListener (ossimListener *listener)
virtual bool	removeListener (ossimListener *listener)
virtual bool	findListener (ossimListener *listener)
Public Member Functions inherited from ossimPropertyInterface
	ossimPropertyInterface ()
virtual	~ossimPropertyInterface ()
virtual ossimString	getPropertyValueAsString (const ossimString &name) const
void	getPropertyList (std::vector< ossimRefPtr< ossimProperty > > &propertyList) const
void	setProperties (std::vector< ossimRefPtr< ossimProperty > > &propertyList)
Public Member Functions inherited from ossimErrorStatusInterface
	ossimErrorStatusInterface ()
virtual	~ossimErrorStatusInterface ()
virtual ossimErrorCode	getErrorStatus () const
virtual ossimString	getErrorStatusString () const
virtual void	setErrorStatus (ossimErrorCode error_status) const
virtual void	setErrorStatus () const
virtual void	clearErrorStatus () const
bool	hasError () const

Protected Member Functions
virtual bool	getOverviewTile (ossim_uint32 resLevel, ossimImageData *result)
	Gets an overview tile. More...
virtual bool	loadBlock (ossim_uint32 x, ossim_uint32 y)
	Loads a block of data to theCacheTile. More...
virtual bool	parseFile ()
	Parses "theImageFile" and initializes all nitf headers. More...
virtual bool	allocate ()
	Allocates everything for current entry. More...
virtual bool	allocateBuffers ()
	Allocates buffers for current entry. More...
virtual bool	canUncompress (const ossimNitfImageHeader *hdr) const
	Checks header to see is we can decompress entry. More...
virtual void	initializeReadMode ()
	Initializes the data member "theReadMode" from the current entry. More...
virtual bool	scanForJpegBlockOffsets ()
	This method simply checks for Start of Codestream (SOC) marker as the Kakadu library handles finding tiles for us. More...
virtual void	initializeSwapBytesFlag ()
	Sets the "theSwapBytesFlag" from the current entry. More...
virtual void	initializeCacheTileInterLeaveType ()
	Initializes the data member "theCacheTileInterLeaveType". 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 ossimNitfTileSource
virtual	~ossimNitfTileSource ()
void	setBoundingRectangle (const ossimIrect &imageRect)
	ossimNitfTileSource (const ossimNitfTileSource &obj)
	Copy constructor, disallow... More...
ossimNitfTileSource &	operator= (const ossimNitfTileSource &rhs)
	Operator=, disallow... More...
bool	loadTile (const ossimIrect &clipRect)
	Returns true on success, false on error. More...
ossim_uint32	getBlockNumber (const ossimIpt &block_origin) const
void	destroy ()
	Deletes all memory allocated by this object. More...
virtual void	initializeScalarType ()
	Initializes the data member "theScalarType" from the current entry. More...
void	initializeBandCount ()
	Initializes the data member "theNumberOfBands" from the current entry. More...
bool	initializeBlockSize ()
	Initializes the data member "theBlockSize" from the current entry. More...
virtual bool	initializeImageRect ()
	Initializes the data members "theImageRect" and "theBlockRect" from the current entry. More...
void	initializeCacheSize ()
	Initializes the data member "theCacheSize". More...
void	initializeCacheTile ()
	Initializes the cache tile size(width and height). More...
virtual void	initializeCompressedBuf ()
	Initializes the data member theCompressedBuf. More...
virtual void	initializeOutputTile ()
	Initializes the output tile size(width and height). More...
void	initializeLut ()
	Initializes "theLut" if applicable. More...
bool	loadBlockFromCache (ossim_uint32 x, ossim_uint32 y, const ossimIrect &clipRect)
	Loads a block of data to theCacheTile. More...
bool	getPosition (std::streamoff &position, ossim_uint32 x, ossim_uint32 y, ossim_uint32 band) const
ossim_uint32	getNumberOfBlocks () const
std::streampos	getBandOffset () const
std::streampos	getBlockOffset () const
void	explodePackedBits (ossimRefPtr< ossimImageData > packedBuffer) const
void	convertTransparentToNull (ossimRefPtr< ossimImageData > tile) const
ossim_uint32	getPartialReadSize (const ossimIpt &blockOrigin) const
bool	isVqCompressed (const ossimString &compressionCode) const
void	vqUncompressC4 (ossimRefPtr< ossimImageData > destination, ossim_uint8 *source)
	Uncompresses Vector Quantization unmasked image data. More...
void	vqUncompressM4 (ossimRefPtr< ossimImageData > destination, ossim_uint8 *source)
	Uncompresses Vector Quantization masked image data. More...
void	lutUncompress (ossimRefPtr< ossimImageData > destination, ossim_uint8 *source)
virtual bool	uncompressJpegBlock (ossim_uint32 x, ossim_uint32 y)
	Uncompresses a jpeg block using the jpeg-6b library. More...
bool	loadJpegQuantizationTables (jpeg_decompress_struct &cinfo) const
	Loads one of the default tables based on COMRAT value. More...
bool	loadJpegHuffmanTables (jpeg_decompress_struct &cinfo) const
	Loads default huffman tables. More...
virtual void	establishDecimationFactors ()
	Virtual method determines the decimation factors at each resolution level. More...
Protected Member Functions inherited from ossimImageHandler
virtual ossimRefPtr< ossimImageGeometry >	getExternalImageGeometry () const
	Returns the image geometry object associated with this tile source or NULL if non defined. More...
virtual ossimRefPtr< ossimImageGeometry >	getInternalImageGeometry () const
bool	initVertices (const char *file)
	Opens file and attempts to initialize the valid image vertices. More...
virtual void	completeOpen ()
	Will complete the opening process. More...
void	initImageParameters (ossimImageGeometry *geom) const
	Convenience method to set things needed in the image geometry from the image handler. More...
virtual bool	setOutputBandList (const std::vector< ossim_uint32 > &inBandList, std::vector< ossim_uint32 > &outBandList)
	Convenience method to set output band list. More...
void	getFilenameWithNoExtension (ossimFilename &f) const
	Get filename with no extension, using supplentary directory for dirname if set. More...
Protected Member Functions inherited from ossimImageSource
	ossimImageSource (const ossimImageSource &rhs)
const ossimImageSource &	operator= (const ossimImageSource &)
Protected Member Functions inherited from ossimSource
	ossimSource (const ossimSource &rhs)
const ossimSource &	operator= (const ossimSource &rhs)
Protected Member Functions inherited from ossimConnectableObject
ossimConnectableObject *	findObjectOfType (ConnectableObjectList *connectableList, ossimVisitor &visitor)
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()
Protected Member Functions inherited from ossimListenerManager
	ossimListenerManager (const ossimListenerManager &rhs)

Private Member Functions
bool	isEntryJ2k () const
	Checks current entry image header to see if it is j2k. More...
bool	checkJp2Signature ()
	Checks for jp2 signature block. More...
void	configureChannelMapping ()
	Initializes m_channels to be used with copyRegionToTile if it makes sense. More...
std::ostream &	dumpTiles (std::ostream &out)
	Method to print out tile info. More...

Private Attributes
std::streamoff	m_startOfCodestreamOffset
kdu_supp::jp2_family_src *	m_jp2FamilySrc
kdu_supp::jp2_source *	m_jp2Source
kdu_supp::kdu_channel_mapping *	m_channels
kdu_core::kdu_codestream	m_codestream
kdu_core::kdu_thread_env *	m_threadEnv
kdu_core::kdu_thread_queue *	m_openTileThreadQueue
ossim_uint32	m_sourcePrecisionBits
ossim_uint32	m_minDwtLevels
std::vector< ossimIrect >	m_imageDims
	Image dimensions for each level. More...
ossim_float64	m_minSampleValue
	min/max/null These are class attributes so that when behaving as an overview the owner or base image handler can pass its min/max/null to us. More...
ossim_float64	m_maxSampleValue
ossim_float64	m_nullSampleValue

Additional Inherited Members
Protected Attributes inherited from ossimNitfTileSource
ossimRefPtr< ossimImageData >	theTile
ossimRefPtr< ossimImageData >	theCacheTile
ossimRefPtr< ossimNitfFile >	theNitfFile
std::vector< ossimRefPtr< ossimNitfImageHeader > >	theNitfImageHeader
ReadMode	theReadMode
ossimScalarType	theScalarType
bool	theSwapBytesFlag
ossim_uint32	theNumberOfInputBands
ossim_uint32	theNumberOfOutputBands
ossim_uint32	theBlockSizeInBytes
ossim_uint32	theReadBlockSizeInBytes
ossim_uint32	theNumberOfImages
ossim_uint32	theCurrentEntry
ossimIrect	theImageRect
std::shared_ptr< ossim::istream >	theFileStr
std::vector< ossim_uint32 >	theSelectorBandList
std::vector< ossim_uint32 >	theOutputBandList
ossimIpt	theCacheSize
ossimInterleaveType	theCacheTileInterLeaveType
bool	theCacheEnabledFlag
std::vector< ossim_uint32 >	theEntryList
ossimAppFixedTileCache::ossimAppFixedCacheId	theCacheId
bool	thePackedBitsFlag
ossimIrect	theBlockImageRect
std::vector< ossim_uint8 >	theCompressedBuf
std::vector< std::streamoff >	theNitfBlockOffset
std::vector< ossim_uint32 >	theNitfBlockSize
bool	m_jpegOffsetsDirty
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

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

Definition at line 44 of file ossimKakaduNitfReader.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Anonymous enumerations:

Enumerator
SIGNATURE_BOX_SIZE

Definition at line 50 of file ossimKakaduNitfReader.h.

   {
      SIGNATURE_BOX_SIZE = 12
   };

Constructor & Destructor Documentation

ossimKakaduNitfReader()

ossimKakaduNitfReader::ossimKakaduNitfReader

(

)

default construtor

~ossimKakaduNitfReader()

ossimKakaduNitfReader::~ossimKakaduNitfReader ( )

virtual

virtural destructor

Definition at line 76 of file ossimKakaduNitfReader.cpp.

References ossimNitfTileSource::close(), m_channels, m_codestream, m_jp2FamilySrc, m_jp2Source, m_openTileThreadQueue, m_threadEnv, ossimNotify(), and ossimNotifyLevel_WARN.

{
   // Kakadu kdu_thread_entity::terminate throws exceptions...
   try
   {
      // Cleanup processing environment
      if ( m_threadEnv )
      {
         m_threadEnv->terminate(m_openTileThreadQueue, true);

         // Terminates background codestream processing.
         m_threadEnv->cs_terminate(m_codestream);

         m_threadEnv->destroy();
         delete m_threadEnv;
         m_threadEnv = 0; 
      }
   
      if ( m_codestream.exists() )
      {
         m_codestream.destroy();
      }
      
      if ( m_openTileThreadQueue )
      {
         m_openTileThreadQueue = 0;
      }
      if ( m_jp2Source )
      {
         delete m_jp2Source;
         m_jp2Source = 0;
      }
      if ( m_jp2FamilySrc )
      {
         delete m_jp2FamilySrc;
         m_jp2FamilySrc = 0;
      }
      if ( m_channels )
      {
         m_channels->clear();
         delete m_channels;
         m_channels = 0;
      }
   }
   catch ( kdu_core::kdu_exception exc )
   {
      // kdu_exception is an int typedef.
      if ( m_threadEnv != 0 )
      {
         m_threadEnv->handle_exception(exc);
      }
      ostringstream e;
      e << "ossimKakaduNitfReader::~ossimKakaduNitfReader\n"
        << "Caught exception from kdu_region_decompressor: " << exc << "\n";
      ossimNotify(ossimNotifyLevel_WARN) << e.str() << std::endl;
   }
   catch ( std::bad_alloc& )
   {
      if ( m_threadEnv != 0 )
      {
         m_threadEnv->handle_exception(KDU_MEMORY_EXCEPTION);
      }
      std::string e =
         "Caught exception from kdu_region_decompressor: std::bad_alloc";
      ossimNotify(ossimNotifyLevel_WARN) << e << std::endl;
   }
   catch( ... )
   {
      std::string e =
         "Caught unhandled exception from kdu_region_decompressor";
      ossimNotify(ossimNotifyLevel_WARN) << e << std::endl;
   }
   
   ossimNitfTileSource::close();
}

Member Function Documentation

allocate()

bool ossimKakaduNitfReader::allocate ( )

protectedvirtual

Allocates everything for current entry.

This is called on an open() or a entry change to an already open nitf file.

This does not allocate buffers and tiles to keep open and setCurrentEntry times to a minimum. Buffers are allocated on first grab of pixel data by allocatBuffers method.

Overrides ossimNitfTileSource::allocate

Returns

True on success, false on error.

Reimplemented from ossimNitfTileSource.

Definition at line 528 of file ossimKakaduNitfReader.cpp.

{
   static const char MODULE[] = "ossimKakaduNitfReader::allocate";

   if (traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG) << MODULE << " entered...\n";
      
   }

   bool result = ossimNitfTileSource::allocate();

   if ( isEntryJ2k() && result )
   {
      // This only finds "Start Of Codestream" (SOC) so it's fast.
      result = scanForJpegBlockOffsets();

      if (traceDebug())
      {
         const ossimNitfImageHeader* hdr = getCurrentImageHeader();
         if( hdr )
         {
            ossimNotify(ossimNotifyLevel_DEBUG)
               << "start_of_data: " << hdr->getDataLocation() << "\n";
         }
         ossimNotify(ossimNotifyLevel_DEBUG)
            << "start_of_codestream: " << m_startOfCodestreamOffset << "\n";
      }
      
      if ( result )
      {
         // Kakadu throws exceptions so wrap in try block.
         try
         {
            // Position to start of code stream prior to create call.
            theFileStr->seekg(m_startOfCodestreamOffset, ios_base::beg);
            
            //---
            // Initialize the codestream.  The class ossimKakaduNitfReader is a
            // kdu_compressed source so we feed ourself to the codestream.
            //---
            
            // Construct multi-threaded processing environment if required.
            if ( m_threadEnv )
            {
               m_threadEnv->terminate(NULL, true);
               m_threadEnv->cs_terminate(m_codestream);
               m_threadEnv->destroy();
            }
            
            if( m_codestream.exists() )
            {
               m_codestream.destroy();
            }
            
            if ( !m_threadEnv )
            {
               m_threadEnv = new kdu_thread_env();
            }
            
            m_threadEnv->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 ( !m_threadEnv->add_thread() )
                     {
                        if (traceDebug())
                        {
                           ossimNotify(ossimNotifyLevel_WARN) << "Unable to create thread!\n";
                        }
                     }
                  }
               }
            }
            
            m_openTileThreadQueue = m_threadEnv->add_queue(NULL,NULL,"open_tile_q");
            
            if ( checkJp2Signature() )
            {
               // Note we must be at the JP2 signature block at this point for the open call.
               m_jp2FamilySrc = new jp2_family_src();
               m_jp2FamilySrc->open(this);
               
               if (m_jp2FamilySrc->exists())
               {
                  m_jp2Source = new kdu_supp::jp2_source();
                  
                  m_jp2Source->open(m_jp2FamilySrc);
                  m_jp2Source->read_header();

                  if (traceDebug())
                  {
                     jp2_colour colour = m_jp2Source->access_colour();
                     if ( colour.exists() )
                     {
                        ossimNotify(ossimNotifyLevel_DEBUG)
                           << "jp2 color space: " << colour.get_space() << endl;
                     }
                  }
               }
               m_codestream.create(m_jp2Source, m_threadEnv);
            }
            else
            {
               m_codestream.create(this, m_threadEnv);
            }

            if ( m_codestream.exists() )
            {
               //---
               // We have to store things here in this non-const method because
               // NONE of the kakadu methods are const.
               //---
               m_minDwtLevels = m_codestream.get_min_dwt_levels();

               //---
               // NOTE:  ossimNitfTileSource::allocate() calls open overview
               // before the number of levels is known.
               // Set the starting res level for the overview now that the levels
               // are known.
               //--- 
               if ( theOverview.valid() )
               {
                  theOverview->setStartingResLevel(m_minDwtLevels+1);
               }
         
               // ASSUMPTION:  All bands same bit depth.
               m_sourcePrecisionBits = m_codestream.get_bit_depth(0, true);
         
               m_codestream.set_persistent(); // ????
               m_codestream.enable_restart(); // ????

               // Get the image and tile dimensions.
               std::vector<ossimIrect> tileDims;
               if ( ossim::getCodestreamDimensions(m_codestream,
                                                   m_imageDims,
                                                   tileDims) == false )
               {
                  ossimNotify(ossimNotifyLevel_WARN)
                     << __FILE__ << " " << __LINE__ << " " << MODULE
                     << "Could not ascertain dimensions!" << std::endl;
                  result = false;
               }

               kdu_dims region_of_interest;
               region_of_interest.pos.x = 0;
               region_of_interest.pos.y = 0;
               region_of_interest.size.x = m_imageDims[0].width();
               region_of_interest.size.y = m_imageDims[0].height();
         
               m_codestream.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_OUTPUT_COMPONENTS);

               // Configure the kdu_channel_mapping if it makes sense.
               configureChannelMapping();

               if (traceDebug())
               {
                  ossimNotify(ossimNotifyLevel_DEBUG)
                     << "m_codestream.get_num_components(false): "
                     << m_codestream.get_num_components(false)
                     << "\nm_codestream.get_num_components(true): "
                     << m_codestream.get_num_components(true)
                     << "\nm_codestream.get_bit_depth(0, true): "
                     << m_codestream.get_bit_depth(0, true)
                     << "\nm_codestream.get_signed(0, true): "
                     << m_codestream.get_signed(0, true)
                     << "\nm_codestream.get_min_dwt_levels(): "
                     << m_codestream.get_min_dwt_levels()
                     << "\ntheNumberOfInputBands: "
                     << theNumberOfInputBands
                     << "\ntheNumberOfOutputBands: "
                     << theNumberOfOutputBands
                     << "\nthreads: " << threads
                     << "\n";
                  for ( std::vector<ossimIrect>::size_type i = 0; i < m_imageDims.size(); ++i )
                  {
                     ossimNotify(ossimNotifyLevel_DEBUG)
                        << "m_imageDims[" << i << "]: " << m_imageDims[i] << "\n";
                  }
               }
            }
            else // if ( m_codestream.exists() )
            {
               result = false;
            }

         } // End: try block
         catch( const ossimException& e )
         {
            result = false;         
            if (traceDebug())
            {
               ossimNotify(ossimNotifyLevel_WARN)
                  << MODULE << " Caught exception: " << e.what() << std::endl;
            }
         }
         catch( ... )
         {
            result = false;
            if (traceDebug())
            {
               ossimNotify(ossimNotifyLevel_WARN)
                  << MODULE << " Caught unknown exception!" << std::endl;
            }
         }
      
      } // Matches: if ( result )

   } // Matches:    if ( isEntryJ2k() && result )

   if (traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << MODULE << " exit status = " << (result?"true":"false\n")
         << std::endl;
   }

   return result;
   
} // End: ossimKakaduNitfReader::allocate()

allocateBuffers()

bool ossimKakaduNitfReader::allocateBuffers ( )

protectedvirtual

Allocates buffers for current entry.

This is called on first getTile().

Overrides ossimNitfTileSource::allocateBuffers

Returns

True on success, false on error.

Reimplemented from ossimNitfTileSource.

Definition at line 763 of file ossimKakaduNitfReader.cpp.

References ossimNitfTileSource::allocateBuffers(), ossimNitfTileSource::getNumberOfOutputBands(), ossim::isnan(), m_maxSampleValue, m_minSampleValue, m_nullSampleValue, ossimImageData::setMaxPix(), ossimImageData::setMinPix(), ossimImageData::setNullPix(), ossimNitfTileSource::theCacheTile, ossimNitfTileSource::theTile, and ossimRefPtr< T >::valid().

{
   bool result = ossimNitfTileSource::allocateBuffers();
   if ( result )
   {
      //---
      // The ossimImageHandler::openOverview can set our min, max and null before we
      // have our tiles allocated.
      // 
      // Set the min, max, and null in case we're being used as an overview handler
      // and it is out of sync with the base image.  Example is dted null is -32767
      // not default -32768.
      //---
      const ossim_uint32 BANDS = getNumberOfOutputBands();
      for (ossim_uint32 band = 0; band < BANDS; ++band)
      {
         if ( theTile.valid() )
         {
            if ( !ossim::isnan(m_maxSampleValue) )
            {
               theTile->setMaxPix(m_maxSampleValue,   band);
            }
            if ( !ossim::isnan(m_minSampleValue) )
            {
               theTile->setMinPix(m_minSampleValue,   band);
            }
            if ( !ossim::isnan(m_nullSampleValue) )
            {
               theTile->setNullPix(m_nullSampleValue, band);
            }
         }
         if ( theCacheTile.valid() )
         {
            if ( !ossim::isnan(m_maxSampleValue) )
            {
               theCacheTile->setMaxPix(m_maxSampleValue,   band);
            }
            if ( !ossim::isnan(m_minSampleValue) )
            {
               theCacheTile->setMinPix(m_minSampleValue,   band);
            }
            if ( !ossim::isnan(m_nullSampleValue) )
            {
               theCacheTile->setNullPix(m_nullSampleValue, band);
            }
         } 
      }
   }
   return result;
   
} // End: ossimKakaduNitfReader::allocateBuffer()

canUncompress()

bool ossimKakaduNitfReader::canUncompress ( const ossimNitfImageHeader *  hdr ) const

protectedvirtual

Checks header to see is we can decompress entry.

If compression code is not "C8" calls base canUncompress as you could have a J2k entry and a jpeg entry.

Overrides ossimNitfTileSource::canUncompress

Parameters

hdr	Pointer to image header.

Returns

true if reader can uncompress nitf.

Reimplemented from ossimNitfTileSource.

Definition at line 815 of file ossimKakaduNitfReader.cpp.

References ossimNitfTileSource::canUncompress(), and ossimNitfImageHeader::getCompressionCode().

{
   bool result = false;
   if (hdr)
   {
      if (hdr->getCompressionCode() == "C8") // j2k
      {
         result = true;
      }
      else
      {
         result = ossimNitfTileSource::canUncompress(hdr);
      }
   }
   return result;
}

checkJp2Signature()

bool ossimKakaduNitfReader::checkJp2Signature ( )

private

Checks for jp2 signature block.

Note the stream is repositioned to start of data after the check so that the jp2 open code does not have to reposition.

Returns

true if jp2, false if not.

Definition at line 973 of file ossimKakaduNitfReader.cpp.

References ossimNitfTileSource::getCurrentImageHeader(), ossimNitfImageHeader::getDataLocation(), SIGNATURE_BOX_SIZE, and ossimNitfTileSource::theFileStr.

Referenced by scanForJpegBlockOffsets().

{
   bool result = false;
   const ossimNitfImageHeader* hdr = getCurrentImageHeader();
   if( hdr )
   {
      std::streamoff startOfDataPos = hdr->getDataLocation();

      // Seek to the start of data.
      theFileStr->seekg(startOfDataPos, ios_base::beg);
      if ( theFileStr->good() )
      {
         const ossim_uint8 J2K_SIGNATURE_BOX[SIGNATURE_BOX_SIZE] = 
            {0x00,0x00,0x00,0x0c,0x6a,0x50,0x20,0x20,0x0d,0x0a,0x87,0x0a};
         
         ossim_uint8 box[SIGNATURE_BOX_SIZE];
         
         // Read in the box.
         theFileStr->read((char*)box, SIGNATURE_BOX_SIZE);
         result = true;
         for (ossim_uint32 i = 0; i < SIGNATURE_BOX_SIZE; ++i)
         {
            if (box[i] != J2K_SIGNATURE_BOX[i])
            {
               result = false;
               break;
            }
         }
      }
      
      // Seek back to the start of data.
      theFileStr->seekg(startOfDataPos, ios_base::beg);
   }
   
   return result;
}

configureChannelMapping()

void ossimKakaduNitfReader::configureChannelMapping ( )

private

Initializes m_channels to be used with copyRegionToTile if it makes sense.

Definition at line 1010 of file ossimKakaduNitfReader.cpp.

References m_channels, m_codestream, m_jp2Source, and ossimNitfTileSource::theNumberOfOutputBands.

{
   bool result = false;
   
   if ( m_channels )
   {
      m_channels->clear();
   }
   else
   {
      m_channels = new kdu_channel_mapping;
   }
            
   if ( m_jp2Source )
   {
      // Currently ignoring alpha:
      result = m_channels->configure(m_jp2Source, false);
   }
   else
   {
      result = m_channels->configure(m_codestream);
   }
   
   if ( result )
   {
      // If we the mapping doesn't have all our bands we don't use it.
      if ( m_channels->get_num_colour_channels() != static_cast<int>(theNumberOfOutputBands) )
      {
         result = false;
      }
   }

   if ( !result )
   {
      m_channels->clear();
      delete m_channels;
      m_channels = 0;
   }
}

dumpTiles()

std::ostream & ossimKakaduNitfReader::dumpTiles ( std::ostream &  out )

private

Method to print out tile info.

For debug only.

Definition at line 1050 of file ossimKakaduNitfReader.cpp.

References ossimNitfTileSource::getCurrentImageHeader(), ossimNitfImageHeader::getNumberOfBlocksPerCol(), ossimNitfImageHeader::getNumberOfBlocksPerRow(), m_startOfCodestreamOffset, ossimJ2kSizRecord::parseStream(), ossimJ2kSotRecord::parseStream(), ossimJ2kTlmRecord::parseStream(), ossimJ2kCodRecord::parseStream(), ossimJ2kCodRecord::print(), ossimJ2kSotRecord::print(), ossimJ2kSizRecord::print(), ossimJ2kTlmRecord::print(), ossimNitfTileSource::theFileStr, and ossimJ2kSotRecord::thePsot.

{
   //---
   // NOTE:
   // SOC = 0xff4f Start of Codestream
   // SOT = 0xff90 Start of tile
   // SOD = 0xff93 Last marker in each tile
   // EOC = 0xffd9 End of Codestream
   //---
   
   const ossimNitfImageHeader* hdr = getCurrentImageHeader();
   if(hdr)
   {
      // Capture the starting position.
      std::streampos currentPos = theFileStr->tellg();
      
      // Seek to the first block.
      theFileStr->seekg(m_startOfCodestreamOffset, ios_base::beg);
      if (theFileStr->good())
      {
         out << "offset to codestream: " << m_startOfCodestreamOffset << "\n";
         
         //---
         // Read the first two bytes and test for SOC (Start Of Codestream)
         // marker.
         //---
         ossim_uint8 markerField[2];
         theFileStr->read( (char*)markerField, 2);

         bool foundSot = false;
         if ( (markerField[0] == 0xff) && (markerField[1] == 0x4f) )
         {
            // Get the SIZ marker and dump it.
            theFileStr->read( (char*)markerField, 2);
            if ( (markerField[0] == 0xff) && (markerField[1] == 0x51) )
            {
               ossimJ2kSizRecord siz;
               siz.parseStream( *theFileStr );
               siz.print(out);
            }
            
            // Find the firt tile marker.
            char c;
            while ( theFileStr->get(c) )
            {
               if (static_cast<ossim_uint8>(c) == 0xff)
               {
                  if ( theFileStr->get(c) )
                  {
                     out << "marker: 0xff" << hex << (ossim_uint16)c << dec << endl;
                     
                     if (static_cast<ossim_uint8>(c) == 0x52)
                     {
                        out << "\nFound COD...\n\n" << endl;
                        ossimJ2kCodRecord cod;
                        cod.parseStream( *theFileStr );
                        cod.print(out);

                     }
                     else if (static_cast<ossim_uint8>(c) == 0x55)
                     {
                        out << "\nFound TLM...\n\n" << endl;
                        ossimJ2kTlmRecord tlm;
                        tlm.parseStream( *theFileStr );
                        tlm.print(out);
                     }
                     else if (static_cast<ossim_uint8>(c) == 0x90)
                     {
                        foundSot = true;
                        break;
                     }
                  }
               }
            }
         }

         if (foundSot) // At SOT marker...
         {
            const ossim_uint32 BLOCKS =
               hdr->getNumberOfBlocksPerRow() * hdr->getNumberOfBlocksPerCol();
            for (ossim_uint32 i = 0; i < BLOCKS; ++i)
            {
               std::streamoff pos = theFileStr->tellg();
               out << "sot pos: " << pos << endl;
               ossimJ2kSotRecord sotRecord;
               sotRecord.parseStream( *theFileStr );
               pos += sotRecord.thePsot;
               sotRecord.print(out);
               theFileStr->seekg(pos, ios_base::beg);
            }
         }
      }

      // If the last byte is read, the eofbit must be reset. 
      if ( theFileStr->eof() )
      {
         theFileStr->clear();
      }
      
      // Put the stream back to the where it was.
      theFileStr->seekg(currentPos);
   }

   return out;
}

get_capabilities()

ossim_int32 ossimKakaduNitfReader::get_capabilities ( )

inlineprotectedvirtual

Gets kdu source capability.

Overrides kdu_compressed_source::get_capabilities

Returns

KDU_SOURCE_CAP_SEEKABLE

Definition at line 369 of file ossimKakaduNitfReader.h.

{
   return ( KDU_SOURCE_CAP_SEEKABLE | KDU_SOURCE_CAP_SEQUENTIAL );
}

get_pos()

kdu_core::kdu_long ossimKakaduNitfReader::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 395 of file ossimKakaduNitfReader.h.

References m_startOfCodestreamOffset, and ossimNitfTileSource::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() - m_startOfCodestreamOffset );
}

getLongName()

ossimString ossimKakaduNitfReader::getLongName ( ) const

virtual

Returns long name.

Returns

"ossim kakadu nitf reader"

Reimplemented from ossimNitfTileSource.

Definition at line 157 of file ossimKakaduNitfReader.cpp.

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

getMaxPixelValue()

ossim_float64 ossimKakaduNitfReader::getMaxPixelValue ( ossim_uint32  band = 0 ) const

virtual

Returns

the max pixel value either from base class call or theMaxPixelValue if set.

Reimplemented from ossimNitfTileSource.

Definition at line 351 of file ossimKakaduNitfReader.cpp.

References ossimImageHandler::getMaxPixelValue(), ossim::isnan(), and m_maxSampleValue.

{
   if ( ossim::isnan(m_maxSampleValue) )
   {
      return ossimImageHandler::getMaxPixelValue(band);
   }
   return m_maxSampleValue;
}

getMinPixelValue()

ossim_float64 ossimKakaduNitfReader::getMinPixelValue ( ossim_uint32  band = 0 ) const

virtual

Returns

the min pixel value either from base class call or theMinPixelValue if set.

Reimplemented from ossimNitfTileSource.

Definition at line 342 of file ossimKakaduNitfReader.cpp.

References ossimImageHandler::getMinPixelValue(), ossim::isnan(), and m_minSampleValue.

{
   if ( ossim::isnan(m_minSampleValue) )
   {
      return ossimImageHandler::getMinPixelValue(band);
   }
   return m_minSampleValue;
}

getNullPixelValue()

ossim_float64 ossimKakaduNitfReader::getNullPixelValue ( ossim_uint32  band = 0 ) const

virtual

Returns

the null pixel value either from base class call or theNullPixelValue if set.

Reimplemented from ossimNitfTileSource.

Definition at line 360 of file ossimKakaduNitfReader.cpp.

References ossimImageHandler::getNullPixelValue(), ossim::isnan(), and m_nullSampleValue.

{
   if ( ossim::isnan(m_nullSampleValue) )
   {
      return ossimImageHandler::getNullPixelValue(band);
   }
   return m_nullSampleValue;
}

getNumberOfDecimationLevels()

ossim_uint32 ossimKakaduNitfReader::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 162 of file ossimKakaduNitfReader.cpp.

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

{
   ossim_uint32 result = 1; // Add r0
   if ( isEntryJ2k() )
   {
      if (m_minDwtLevels)
      {
         //---
         // Add internal overviews.
         //---
         result += m_minDwtLevels;
      }

      if (theOverview.valid())
      {
         result += theOverview->getNumberOfDecimationLevels();
      }
   }
   else
   {
      result = ossimNitfTileSource::getNumberOfDecimationLevels();
   }
   return result;
}

getNumberOfLines()

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

virtual

Gets number of lines for res level.

Overrides ossimNitfTileSource::getNumberOfLines

Parameters

resLevel

Reduced resolution level to return lines of. Default = 0

Returns

The number of lines for specified reduced resolution level.

Reimplemented from ossimNitfTileSource.

Definition at line 187 of file ossimKakaduNitfReader.cpp.

References ossimNitfTileSource::getNumberOfLines(), ossimImageHandler::getNumberOfLines(), isEntryJ2k(), ossimImageHandler::isValidRLevel(), m_imageDims, m_minDwtLevels, ossimImageHandler::theOverview, ossimImageHandler::theStartingResLevel, and ossimRefPtr< T >::valid().

{
   ossim_uint32 result = 0;
   if ( isEntryJ2k() )
   {
      if ( isValidRLevel(resLevel) )
      {
         ossim_uint32 level = resLevel;
         
         if (theStartingResLevel) // This is an overview.
         {
            //---
            // Adjust the level to be relative to the reader using this as
            // overview.
            //---
            level = resLevel - theStartingResLevel;
         }
         
         if (level <= m_minDwtLevels)
         {
            result = m_imageDims[level].height();
         }
         else if ( theOverview.valid() )
         {
            // Note the non-adjusted resLevel is passed to this by design.
            result = theOverview->getNumberOfLines(resLevel);
         }
      }
   }
   else // Not our entry.
   {
      result = ossimNitfTileSource::getNumberOfLines(resLevel);
   }
   return result;
}

getNumberOfSamples()

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

virtual

Gets the number of samples for res level.

Overrides ossimNitfTileSource::getNumberOfSamples

Parameters

resLevel

Reduced resolution level to return samples of. Default = 0

Returns

The number of samples for specified reduced resolution level.

Reimplemented from ossimNitfTileSource.

Definition at line 224 of file ossimKakaduNitfReader.cpp.

References ossimNitfTileSource::getNumberOfSamples(), ossimImageHandler::getNumberOfSamples(), isEntryJ2k(), ossimImageHandler::isValidRLevel(), m_imageDims, m_minDwtLevels, ossimImageHandler::theOverview, ossimImageHandler::theStartingResLevel, and ossimRefPtr< T >::valid().

{
   ossim_uint32 result = 0;
   if ( isEntryJ2k() )
   {
      if ( isValidRLevel(resLevel) )
      {
         ossim_uint32 level = resLevel;
         
         if (theStartingResLevel) // This is an overview.
         {
            //---
            // Adjust the level to be relative to the reader using this as
            // overview.
            //---
            level = resLevel - theStartingResLevel;
         }

         if (level <= m_minDwtLevels)
         {
            result = m_imageDims[level].width();
         }
         else if ( theOverview.valid() )
         {
            // Note the non-adjusted resLevel is passed to this by design.
            result = theOverview->getNumberOfSamples(resLevel);
         }
      }
   }
   else // Not our entry.
   {
      result = ossimNitfTileSource::getNumberOfSamples(resLevel);
   }
   return result;
}

getOverviewTile()

bool ossimKakaduNitfReader::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 369 of file ossimKakaduNitfReader.cpp.

References ossim::copyRegionToTile(), ossimImageData::getImageRectangle(), ossimImageData::getNumberOfBands(), ossimNitfTileSource::getNumberOfOutputBands(), ossimImageHandler::getOverviewTile(), ossimImageSource::getTile(), isEntryJ2k(), ossimImageHandler::isValidRLevel(), m_channels, m_codestream, m_minDwtLevels, m_openTileThreadQueue, m_threadEnv, ossimNotify(), ossimNotifyLevel_WARN, status, ossimImageHandler::theOverview, ossimImageHandler::theStartingResLevel, ossimRefPtr< T >::valid(), and ossimException::what().

Referenced by loadBlock().

{
   bool status = false;

   // static bool traced = false;
   
   // Must be j2k entry, not past number of levels, bands must match.
   if ( isEntryJ2k() )
   {
      if ( isValidRLevel(resLevel) && result &&
           (result->getNumberOfBands() == getNumberOfOutputBands()) )
      {
         ossim_uint32 level = resLevel - theStartingResLevel;

#if 0 /* please leave for debug */
         cout << "ovr get tile res level: " << resLevel
              << " start level: " << theStartingResLevel
              << "\nlevel: " << level
              << "\nrect3: " << result->getImageRectangle() << endl;
#endif

         if (level <= m_minDwtLevels)
         {
            // Internal overviews...
            try
            {
               if ( m_channels )
               {
                  status = ossim::copyRegionToTile(m_channels,
                                                   m_codestream,
                                                   static_cast<int>(level),
                                                   m_threadEnv,
                                                   m_openTileThreadQueue,
                                                   result);
               }
               else
               {
                  status = ossim::copyRegionToTile(m_codestream,
                                                   static_cast<int>(level),
                                                   m_threadEnv,
                                                   m_openTileThreadQueue,
                                                   result);
               }
            }
            catch(const ossimException& e)
            {
               ossimNotify(ossimNotifyLevel_WARN)
                  << __FILE__ << ":" << __LINE__ << " caught exception\n"
                  << e.what() << std::endl;
               status = false;
            }

         } // matches:  if (resLevel <= m_minDwtLevels)
         else if ( theOverview.valid() )
         {
            //---
            // Note: Passing non-adjusted "resLevel" to get tile by design.
            //---
            status = theOverview->getTile(result, resLevel);
         }
      }
      else // Failed range check.
      {
         ossimNotify(ossimNotifyLevel_WARN)
            << __FILE__ << " " << __LINE__
            << "Range error." << std::endl;
         status = false;
      }
         
   } // matches:  if ( isEntryJ2k() )
   else
   {
      // Not our entry, call the base.
      status = ossimNitfTileSource::getOverviewTile(resLevel, result);
   }

   return status;
   
} // End:  bool ossimKakaduNitfReader::getOverviewTile( ... ) 

getShortName()

ossimString ossimKakaduNitfReader::getShortName ( ) const

virtual

Returns short name.

Returns

"ossim_kakadu_nitf_reader"

Reimplemented from ossimNitfTileSource.

Definition at line 152 of file ossimKakaduNitfReader.cpp.

{
   return ossimString("ossim_kakadu_nitf_reader");
}

initializeCacheTileInterLeaveType()

void ossimKakaduNitfReader::initializeCacheTileInterLeaveType ( )

protectedvirtual

Initializes the data member "theCacheTileInterLeaveType".

Overrides ossimNitfTileSource::initializeCacheTileInterLeaveType

Reimplemented from ossimNitfTileSource.

Definition at line 946 of file ossimKakaduNitfReader.cpp.

References ossimNitfTileSource::initializeCacheTileInterLeaveType(), isEntryJ2k(), OSSIM_BSQ, and ossimNitfTileSource::theCacheTileInterLeaveType.

{
   if ( isEntryJ2k() )
   {
      // Always band separate here.
      theCacheTileInterLeaveType = OSSIM_BSQ;
   }
   else
   {
      ossimNitfTileSource::initializeCacheTileInterLeaveType();
   }
}

initializeReadMode()

void ossimKakaduNitfReader::initializeReadMode ( )

protectedvirtual

Initializes the data member "theReadMode" from the current entry.

Overrides ossimNitfTileSource::initializeReadMode

Reimplemented from ossimNitfTileSource.

Definition at line 832 of file ossimKakaduNitfReader.cpp.

References ossimNitfImageHeader::getCompressionCode(), ossimNitfTileSource::getCurrentImageHeader(), ossimNitfImageHeader::getIMode(), ossimNitfTileSource::initializeReadMode(), ossimNitfTileSource::READ_JPEG_BLOCK, ossimNitfTileSource::READ_MODE_UNKNOWN, and ossimNitfTileSource::theReadMode.

{
   theReadMode = READ_MODE_UNKNOWN;
   const ossimNitfImageHeader* hdr = getCurrentImageHeader();
   if (hdr)
   {
      if (hdr->getCompressionCode() == "C8") // j2k
      {
         if ( (hdr->getIMode() == "B") && (hdr->getCompressionCode()== "C8") )
         {
            theReadMode = READ_JPEG_BLOCK; 
         }
      }
      else
      {
         ossimNitfTileSource::initializeReadMode();
      }
   }
}

initializeSwapBytesFlag()

void ossimKakaduNitfReader::initializeSwapBytesFlag ( )

protectedvirtual

Sets the "theSwapBytesFlag" from the current entry.

Overrides ossimNitfTileSource::initializeSwapBytesFlag

Reimplemented from ossimNitfTileSource.

Definition at line 933 of file ossimKakaduNitfReader.cpp.

References ossimNitfTileSource::initializeSwapBytesFlag(), isEntryJ2k(), and ossimNitfTileSource::theSwapBytesFlag.

{
   if ( isEntryJ2k() )
   {
      // Kakadu library handles.
      theSwapBytesFlag = false;
   }
   else
   {
      ossimNitfTileSource::initializeSwapBytesFlag();
   }
}

isEntryJ2k()

bool ossimKakaduNitfReader::isEntryJ2k ( ) const

private

Checks current entry image header to see if it is j2k.

Returns

true if j2k, false if not.

Definition at line 959 of file ossimKakaduNitfReader.cpp.

References ossimNitfImageHeader::getCompressionCode(), and ossimNitfTileSource::getCurrentImageHeader().

Referenced by getNumberOfDecimationLevels(), getNumberOfLines(), getNumberOfSamples(), getOverviewTile(), initializeCacheTileInterLeaveType(), initializeSwapBytesFlag(), and loadBlock().

{
   bool result = false;
   const ossimNitfImageHeader* hdr = getCurrentImageHeader();
   if (hdr)
   {
      if (hdr->getCompressionCode() == "C8") // j2k
      {
         result = true;
      }
   }
   return result;
}

loadBlock()

bool ossimKakaduNitfReader::loadBlock ( ossim_uint32  x, ossim_uint32  y  )

protectedvirtual

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.

Reimplemented from ossimNitfTileSource.

Definition at line 450 of file ossimKakaduNitfReader.cpp.

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

{
   
   bool result = true;

   if ( isEntryJ2k() )
   {
      ossimIpt ul(x, y);
      
      ossimIpt lr(ul.x + theCacheSize.x - 1,
                  ul.y + theCacheSize.y - 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__
            << "\nossimKakaduNitfReader::loadBlock failed!"
            << std::endl;
         result = false;
      }
   }
   else
   {
      result = ossimNitfTileSource::loadBlock(x, y);
   }
   
   return result;
}

parseFile()

bool ossimKakaduNitfReader::parseFile ( )

protectedvirtual

Parses "theImageFile" and initializes all nitf headers.

Overrides ossimNitfTileSource::parseFile

Returns

True on success, false on error.

Reimplemented from ossimNitfTileSource.

Definition at line 488 of file ossimKakaduNitfReader.cpp.

{
   static const char MODULE[] = "ossimKakaduNitfReader::parseFile";

   if (traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG) << MODULE << " entered...\n";
   }

   bool result = ossimNitfTileSource::parseFile();

   if (result)
   {
      //---
      // Look through the entries to see if any are j2k; if not, set result to
      // false so the ossimNitfTileSource will pick this file up instead of
      // ossimKakaduNitfReader.
      //---

      result = false; // Must prove we have a j2k entry.
      
      for (ossim_uint32 i = 0; i < theNumberOfImages; ++i)
      {
         if (theNitfImageHeader[i]->getCompressionCode() == "C8") // j2k
         {
            result = true;
            break;
         }
      }
   }

   if (traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << MODULE << " exit status = " << (result?"true\n":"false\n");
   }

   return result;
}

read()

ossim_int32 ossimKakaduNitfReader::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 374 of file ossimKakaduNitfReader.h.

References ossimNitfTileSource::theFileStr.

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

scanForJpegBlockOffsets()

bool ossimKakaduNitfReader::scanForJpegBlockOffsets ( )

protectedvirtual

This method simply checks for Start of Codestream (SOC) marker as the Kakadu library handles finding tiles for us.

Overrides ossimNitfTileSource::scanForJpegBlockOffsets

Returns

true on success, false on error.

Reimplemented from ossimNitfTileSource.

Definition at line 852 of file ossimKakaduNitfReader.cpp.

References checkJp2Signature(), ossimNitfTileSource::getCurrentImageHeader(), ossimNitfImageHeader::getDataLocation(), m_startOfCodestreamOffset, and ossimNitfTileSource::theFileStr.

{
   bool result = false;

   const ossimNitfImageHeader* hdr = getCurrentImageHeader();
   if( hdr )
   {  
      // Capture the start of data.  This is start of j2k main header.
      m_startOfCodestreamOffset = hdr->getDataLocation();

      if ( checkJp2Signature() )
      {
         result = true;
      }
      else
      {
         //---
         // Kakadu library finds j2k tiles.  We only find the "Start Of Codestream"(SOC)
         // which should be at getDataLocation() but not in all cases.
         //---
         
         // Seek to the first block.
         theFileStr->seekg(m_startOfCodestreamOffset, ios_base::beg);
         if ( theFileStr->good() )
         {
            //---
            // Read the first two bytes and test for SOC (Start Of Codestream)
            // marker.
            //---
            ossim_uint8 markerField[2];
            theFileStr->read( (char*)markerField, 2);
         
            if ( (markerField[0] == 0xff) && (markerField[1] == 0x4f) )
            {
               result = true;
            }
            else
            {
               //---
               // Scan the file from the beginning for SOC.  This handles cases
               // where the data does not fall on "hdr->getDataLocation()".
               //
               // Changed for multi-enty nitf where first entry is j2k, second is
               // uncompressed. Need to test at site. 02 August 2013 (drb)
               //---
               // theFileStr->seekg(0, ios_base::beg);
               theFileStr->seekg(m_startOfCodestreamOffset, ios_base::beg);
               char c;
               while ( theFileStr->get(c) )
               {
                  if (static_cast<ossim_uint8>(c) == 0xff)
                  {
                     if (  theFileStr->get(c) )
                     {
                        if (static_cast<ossim_uint8>(c) == 0x4f)
                        {
                           m_startOfCodestreamOffset = theFileStr->tellg();
                           m_startOfCodestreamOffset -= 2;
                           result = true;
                           break;
                        }
                     }
                  }
               }
            }
            
            if ( (result == true) && traceDump() )
            {
               dumpTiles(ossimNotify(ossimNotifyLevel_DEBUG));
            }
            
         } // matches: if (theFileStr->good())
         
      }  // if ( isJp2() ) ... else {

   } // matches: if (hdr)

   return result;
   
} // End: bool ossimKakaduNitfReader::scanForJpegBlockOffsets()

seek()

bool ossimKakaduNitfReader::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 380 of file ossimKakaduNitfReader.h.

References m_startOfCodestreamOffset, and ossimNitfTileSource::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+m_startOfCodestreamOffset, ios_base::beg);
   return theFileStr->good();
}

setMaxPixelValue()

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

virtual

convenience method to set max pixel value.

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

Parameters

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

Reimplemented from ossimImageHandler.

Definition at line 280 of file ossimKakaduNitfReader.cpp.

References m_maxSampleValue, ossimImageData::setMaxPix(), ossimImageHandler::setMaxPixelValue(), ossimNitfTileSource::theCacheTile, ossimNitfTileSource::theTile, and ossimRefPtr< T >::valid().

{
   //---
   // Store and call base ossimImageHandler::setMaxPixelValue in case someone
   // does a save state on the ossimImageHandler::theMetaData.
   //---
   m_maxSampleValue  = pix;
   ossimImageHandler::setMaxPixelValue(band, pix);
   if ( theTile.valid() )
   {
      theTile->setMaxPix(pix, band);
   }
   if ( theCacheTile.valid() )
   {
      theCacheTile->setMaxPix(pix, band);
   }   
}

setMinPixelValue()

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

virtual

convenience method to set min pixel value.

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

Parameters

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

Reimplemented from ossimImageHandler.

Definition at line 261 of file ossimKakaduNitfReader.cpp.

References m_minSampleValue, ossimImageData::setMinPix(), ossimImageHandler::setMinPixelValue(), ossimNitfTileSource::theCacheTile, ossimNitfTileSource::theTile, and ossimRefPtr< T >::valid().

{
   //---
   // Store and call base ossimImageHandler::setMinPixelValue in case someone
   // does a save state on the ossimImageHandler::theMetaData.
   //---
   m_minSampleValue = pix;
   ossimImageHandler::setMinPixelValue(band, pix);
   if ( theTile.valid() )
   {
      theTile->setMinPix(pix, band);
   }
   if ( theCacheTile.valid() )
   {
      theCacheTile->setMinPix(pix, band);
   }
}

setNullPixelValue()

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

virtual

convenience method to set null pixel value.

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

Parameters

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

Reimplemented from ossimImageHandler.

Definition at line 299 of file ossimKakaduNitfReader.cpp.

References ossimImageData::getNullPix(), m_nullSampleValue, ossimImageData::makeBlank(), OSSIM_STATUS_UNKNOWN, ossimDataObject::setDataObjectStatus(), ossimImageData::setNullPix(), ossimImageHandler::setNullPixelValue(), ossimNitfTileSource::theCacheTile, ossimNitfTileSource::theTile, and ossimRefPtr< T >::valid().

{
   //---
   // NOTES:
   //
   // 1) If the null pixel value has changed a makeBlank must be performed or the validate
   // method will not work correctly.
   // 
   // 2) Must set the tile status to unknown prior to the makeBlank or it won't
   // do anything.
   //
   // 3) It would be nice to do this after all the calls to setNullPixelValue are finished
   // with a dirty flag or something.  In reality though the makeBlank will only be called
   // once as this only happens(usually) with elevation data which is one band.
   //---
   
   //---
   // Store and call base ossimImageHandler::setNullPixelValue in case someone
   // does a save state on the ossimImageHandler::theMetaData.
   //---
   m_nullSampleValue = pix;
   ossimImageHandler::setNullPixelValue(band, pix);
   if ( theTile.valid() )
   {
      if ( theTile->getNullPix(band) != pix )
      {
         theTile->setNullPix(pix, band);
         theTile->setDataObjectStatus(OSSIM_STATUS_UNKNOWN);
         theTile->makeBlank();
      }
   }
   if ( theCacheTile.valid() )
   {
      if ( theCacheTile->getNullPix(band) != pix )
      {
         theCacheTile->setNullPix(pix, band);
         theCacheTile->setDataObjectStatus(OSSIM_STATUS_UNKNOWN);
         theCacheTile->makeBlank();
      }
   }   
}

Member Data Documentation

m_channels

kdu_supp::kdu_channel_mapping* ossimKakaduNitfReader::m_channels

private

Definition at line 345 of file ossimKakaduNitfReader.h.

Referenced by configureChannelMapping(), getOverviewTile(), and ~ossimKakaduNitfReader().

m_codestream

kdu_core::kdu_codestream ossimKakaduNitfReader::m_codestream

private

Definition at line 346 of file ossimKakaduNitfReader.h.

Referenced by configureChannelMapping(), getOverviewTile(), and ~ossimKakaduNitfReader().

m_imageDims

std::vector<ossimIrect> ossimKakaduNitfReader::m_imageDims

private

Image dimensions for each level.

Definition at line 354 of file ossimKakaduNitfReader.h.

Referenced by getNumberOfLines(), and getNumberOfSamples().

m_jp2FamilySrc

kdu_supp::jp2_family_src* ossimKakaduNitfReader::m_jp2FamilySrc

private

Definition at line 343 of file ossimKakaduNitfReader.h.

Referenced by ~ossimKakaduNitfReader().

m_jp2Source

kdu_supp::jp2_source* ossimKakaduNitfReader::m_jp2Source

private

Definition at line 344 of file ossimKakaduNitfReader.h.

Referenced by configureChannelMapping(), and ~ossimKakaduNitfReader().

m_maxSampleValue

ossim_float64 ossimKakaduNitfReader::m_maxSampleValue

private

Definition at line 363 of file ossimKakaduNitfReader.h.

Referenced by allocateBuffers(), getMaxPixelValue(), and setMaxPixelValue().

m_minDwtLevels

ossim_uint32 ossimKakaduNitfReader::m_minDwtLevels

private

Definition at line 351 of file ossimKakaduNitfReader.h.

Referenced by getNumberOfDecimationLevels(), getNumberOfLines(), getNumberOfSamples(), and getOverviewTile().

m_minSampleValue

ossim_float64 ossimKakaduNitfReader::m_minSampleValue

private

min/max/null These are class attributes so that when behaving as an overview the owner or base image handler can pass its min/max/null to us.

For non eight bit data this is critical so that the data gets stretched exactly as the base handler. Did NOT make these a vector the size of bands as it was not needed at time of coding.

Definition at line 362 of file ossimKakaduNitfReader.h.

Referenced by allocateBuffers(), getMinPixelValue(), and setMinPixelValue().

m_nullSampleValue

ossim_float64 ossimKakaduNitfReader::m_nullSampleValue

private

Definition at line 364 of file ossimKakaduNitfReader.h.

Referenced by allocateBuffers(), getNullPixelValue(), and setNullPixelValue().

m_openTileThreadQueue

kdu_core::kdu_thread_queue* ossimKakaduNitfReader::m_openTileThreadQueue

private

Definition at line 348 of file ossimKakaduNitfReader.h.

Referenced by getOverviewTile(), and ~ossimKakaduNitfReader().

m_sourcePrecisionBits

ossim_uint32 ossimKakaduNitfReader::m_sourcePrecisionBits

private

Definition at line 350 of file ossimKakaduNitfReader.h.

m_startOfCodestreamOffset

std::streamoff ossimKakaduNitfReader::m_startOfCodestreamOffset

private

Definition at line 341 of file ossimKakaduNitfReader.h.

Referenced by dumpTiles(), get_pos(), scanForJpegBlockOffsets(), and seek().

m_threadEnv

kdu_core::kdu_thread_env* ossimKakaduNitfReader::m_threadEnv

private

Definition at line 347 of file ossimKakaduNitfReader.h.

Referenced by getOverviewTile(), and ~ossimKakaduNitfReader().

---

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

• ossimKakaduNitfReader.h
• ossimKakaduNitfReader.cpp