ossimKakaduCompressorInterface Class Reference

#include <ossimKakaduCompressorInterface.h>

Inheritance diagram for ossimKakaduCompressorInterface:

Public Types
enum	ossimKakaduCompressionQuality {   OKP_UNKNOWN = 0, OKP_USER_DEFINED = 1, OKP_NUMERICALLY_LOSSLESS = 2, OKP_VISUALLY_LOSSLESS = 3,   OKP_LOSSY = 4, OKP_LOSSY2 = 5, OKP_LOSSY3 = 6, OKP_EPJE = 7 }

Public Member Functions
	ossimKakaduCompressorInterface ()
	GP: I had to add this or windows would not link with the latest compiler. More...
virtual void	create (ossim::ostream *os, ossimScalarType scalar, ossim_uint32 bands, const ossimIrect &imageRect, const ossimIpt &tileSize, ossim_uint32 tilesToWrite, bool jp2)=0
	Create method. More...
virtual bool	writeTile (ossimImageData &srcTile)=0
	Write tile method. More...
virtual void	finish ()=0
	Finish method. More...
virtual void	setAlphaChannelFlag (bool flag)=0
	Set the writer to add an alpha channel to the output. More...
virtual void	setLevels (ossim_int32 levels)=0
	Sets the number of levels. More...
virtual bool	setProperty (ossimRefPtr< ossimProperty > property)=0
	Will set the property whose name matches the argument "property->getName()". More...
virtual void	setQualityType (ossimKakaduCompressionQuality type)=0
	Sets the quality type. More...

Detailed Description

Definition at line 29 of file ossimKakaduCompressorInterface.h.

Member Enumeration Documentation

ossimKakaduCompressionQuality

enum ossimKakaduCompressorInterface::ossimKakaduCompressionQuality

Enumerator
OKP_UNKNOWN
OKP_USER_DEFINED
OKP_NUMERICALLY_LOSSLESS
OKP_VISUALLY_LOSSLESS
OKP_LOSSY
OKP_LOSSY2
OKP_LOSSY3
OKP_EPJE

Definition at line 34 of file ossimKakaduCompressorInterface.h.

   {
      // Prefixed with OKP for OSSIM Kakadu Plugin to avoid clashes.
      OKP_UNKNOWN              = 0,
      OKP_USER_DEFINED         = 1,
      OKP_NUMERICALLY_LOSSLESS = 2,
      OKP_VISUALLY_LOSSLESS    = 3,
      OKP_LOSSY                = 4,
      OKP_LOSSY2               = 5,
      OKP_LOSSY3               = 6,
      OKP_EPJE                 = 7,  // Exploitation Preferred J2K Encoding      
   };

Constructor & Destructor Documentation

ossimKakaduCompressorInterface()

ossimKakaduCompressorInterface::ossimKakaduCompressorInterface

(

)

GP: I had to add this or windows would not link with the latest compiler.

Also had to put in dot.cpp for debug mode(again windows). (drb)

Definition at line 18 of file ossimKakaduCompressorInterface.cpp.

{
}

Member Function Documentation

create()

virtual void ossimKakaduCompressorInterface::create ( ossim::ostream *  os, ossimScalarType  scalar, ossim_uint32  bands, const ossimIrect &  imageRect, const ossimIpt &  tileSize, ossim_uint32  tilesToWrite, bool  jp2  )

pure virtual

Create method.

Parameters

os	Stream to write to.
scalar	Scalar type of source tiles to be fed to compressor.
bands	Number of bands in source tiles to be fed to compressor.
imageRect	The image rectangle.
tileSize	The size of a tile.
tilesTileWrite	The number of tiles to be written. If zero, the tlm marker segment will not be used.
jp2	If true jp2 header and jp2 geotiff block will be written out.

Note

Throws ossimException on error.

Implemented in ossimKakaduCompressor.

finish()

virtual void ossimKakaduCompressorInterface::finish ( )

pure virtual

Finish method.

Every call to "create" should be matched by a "finish". Note the destructor calls finish.

Implemented in ossimKakaduCompressor.

setAlphaChannelFlag()

virtual void ossimKakaduCompressorInterface::setAlphaChannelFlag ( bool  flag )

pure virtual

Set the writer to add an alpha channel to the output.

Parameters

flag	true to create an alpha channel.

Implemented in ossimKakaduCompressor.

setLevels()

virtual void ossimKakaduCompressorInterface::setLevels ( ossim_int32  levels )

pure virtual

Sets the number of levels.

This must be positive and at least 1. Default = 5 ( r0 - r5 )

Parameters

levels

Levels to set.

Implemented in ossimKakaduCompressor.

setProperty()

virtual bool ossimKakaduCompressorInterface::setProperty ( ossimRefPtr< ossimProperty >  property )

pure virtual

Will set the property whose name matches the argument "property->getName()".

Parameters

property

Object containing property to set.

Returns

true if property was consumed, false if not.

Implemented in ossimKakaduCompressor.

setQualityType()

virtual void ossimKakaduCompressorInterface::setQualityType ( ossimKakaduCompressionQuality  type )

pure virtual

Sets the quality type.

Type enumerations: OKP_UNKNOWN = 0, OKP_USER_DEFINED = 1, OKP_NUMERICALLY_LOSSLESS = 2, OKP_VISUALLY_LOSSLESS = 3, OKP_EPJE = 4

Parameters

type	See enumeration for types.

Implemented in ossimKakaduCompressor.

writeTile()

virtual bool ossimKakaduCompressorInterface::writeTile ( ossimImageData &  srcTile )

pure virtual

Write tile method.

Writes tiles stream provided to create method. Note that tiles should be fed to compressor in left to right, top to bottom order.

Parameters

srcTile

The source tile to write.

Returns

true on success, false on error.

Implemented in ossimKakaduCompressor.

---

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

• ossimKakaduCompressorInterface.h
• ossimKakaduCompressorInterface.cpp