#include <ossimPngWriter.h>

Inheritance diagram for ossimPngWriter:

Public Member Functions
	ossimPngWriter ()

virtual	~ossimPngWriter ()

virtual ossimString	getShortName () const

virtual ossimString	getLongName () const

virtual ossimString	getClassName () const

virtual ossimString	getExtension () const
	Returns a 3-letter extension from the image type descriptor (theOutputImageType) that can be used for image file extensions. More...

virtual void	getImageTypeList (std::vector< ossimString > &imageTypeList) const
	void getImageTypeList(std::vector<ossimString>& imageTypeList)const More...

virtual bool	isOpen () const

virtual bool	open ()

virtual void	close ()

virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const
	saves the state of the object. 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 void	setProperty (ossimRefPtr< ossimProperty > property)
	Will set the property whose name matches the argument "property->getName()". More...

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

virtual void	getPropertyNames (std::vector< ossimString > &propertyNames) const
	Pushes this's names onto the list of property names. More...

bool	hasImageType (const ossimString &imageType) const
	bool hasImageType(const ossimString& imageType) const More...

void	setLut (const ossimNBandLutDataObject &lut)

ossimString	getCompressionLevel () const
	Get the png compression level as a string. More...

bool	setCompressionLevel (const ossimString &level)
	Set the png compression level from a string. More...

bool	getAlphaChannelFlag (void) const
	Retrieve the writer's setting for whether or not to add an alpha channel to the output png image. More...

void	setAlphaChannelFlag (bool flag)
	Set the writer to add an alpha channel to the output png image. More...

virtual bool	writeStream ()
	Method to write the image to a stream. More...

virtual bool	setOutputStream (std::ostream &stream)
	Sets the output stream to write to. More...

Public Member Functions inherited from ossimImageFileWriter
	ossimImageFileWriter (const ossimFilename &filename=ossimFilename(), ossimImageSource inputSource=0, ossimObject owner=0)
	The writer will own the sequencer. More...

virtual	~ossimImageFileWriter ()

virtual ossimObject *	getObject ()

virtual const ossimObject *	getObject () const

virtual bool	getOutputHasInternalOverviews (void) const
	Examples of writers that always generate internal overviews are ossim_kakadu_jp2 and ossim_kakadu_nitf_j2k. More...

virtual void	setTileSize (const ossimIpt &tileSize)
	Sets the output image tiling size if supported by the writer. More...

virtual bool	writeEnviHeaderFile ()
	Will write an envi header file. More...

virtual bool	writeErsHeaderFile ()
	Will write an ER Mapper header file. More...

virtual bool	writeExternalGeometryFile ()
	Will write an external geometry file. More...

virtual bool	writeFgdcFile ()
	Will write an fgdc file. More...

virtual bool	writeHistogramFile ()
	Returns true on success, false on error. More...

virtual bool	writeJpegWorldFile ()
	Will write a jpeg world file. More...

virtual bool	writeOverviewFile (ossim_uint16 tiff_compress_type=1, ossim_int32 jpeg_compress_quality=75, bool includeR0=false)
	Write out an ossim overview file from the source_file. More...

virtual bool	writeReadmeFile ()
	Will write a readme file. More...

virtual bool	writeTiffWorldFile ()
	Will write a world file. More...

virtual bool	writeWorldFile ()
	Will write a world file. More...

virtual bool	writeMetaDataFiles ()
	Convenience method that calls meta data write methods that are flagged to be called. More...

virtual void	setAreaOfInterest (const ossimIrect &inputRect)

virtual void	changeSequencer (ossimImageSourceSequencer *sequencer)
	Sets the sequencer and connects it to the input of this. More...

virtual ossimImageSourceSequencer *	getSequencer ()

virtual void	initialize ()
	Initialize method. More...

virtual bool	execute ()
	Calls: writeFile() writeMetaDataFiles() More...

virtual bool	setOutputStream (ossimRefPtr< ossimOStream > stream)
	Sets the output stream to write to. More...

virtual ossimRefPtr< ossimOStream >	getOutputStream () const
	Method to return the stream attached to output. More...

virtual void	setPercentComplete (double percentComplete)

virtual void	setOutputImageType (ossim_int32 type)

virtual void	setOutputImageType (const ossimString &type)

virtual ossim_int32	getOutputImageType () const

virtual ossimString	getOutputImageTypeString () const

virtual void	setOutputName (const ossimString &outputName)

virtual void	setFilename (const ossimFilename &file)

virtual const ossimFilename &	getFilename () const

virtual bool	canConnectMyInputTo (ossim_int32 inputIndex, const ossimConnectableObject *object) const
	required to be overriden by derived classes More...

virtual void	disconnectInputEvent (ossimConnectionEvent &event)

virtual void	connectInputEvent (ossimConnectionEvent &event)

virtual void	propertyEvent (ossimPropertyEvent &event)

virtual bool	getWriteImageFlag () const
	Control flags... More...

virtual bool	getWriteHistogramFlag () const

virtual bool	getWriteOverviewFlag () const

virtual bool	getScaleToEightBitFlag () const

virtual bool	getWriteEnviHeaderFlag () const

virtual bool	getWriteErsHeaderFlag () const

virtual bool	getWriteExternalGeometryFlag () const

virtual bool	getWriteFgdcFlag () const

virtual bool	getWriteJpegWorldFileFlag () const

virtual bool	getWriteReadmeFlag () const

virtual bool	getWriteTiffWorldFileFlag () const

virtual bool	getWriteWorldFileFlag () const

virtual void	setWriteImageFlag (bool flag)

virtual void	setWriteOverviewFlag (bool flag)

virtual void	setWriteHistogramFlag (bool flag)

virtual void	setScaleToEightBitFlag (bool flag)

virtual void	setWriteEnviHeaderFlag (bool flag)

virtual void	setWriteErsHeaderFlag (bool flag)

virtual void	setWriteExternalGeometryFlag (bool flag)

virtual void	setWriteFgdcFlag (bool flag)

virtual void	setWriteJpegWorldFile (bool flag)

virtual void	setWriteReadme (bool flag)

virtual void	setWriteTiffWorldFile (bool flag)

virtual void	setWriteWorldFile (bool flag)

virtual ossim_uint16	getOverviewCompressType () const

virtual ossim_int32	getOverviewJpegCompressQuality () const

virtual void	setOverviewCompressType (ossim_uint16 type)

virtual void	setOverviewJpegCompressQuality (ossim_int32 quality)

virtual bool	addListener (ossimListener *listener)
	Overrides base "addListener" this will capture the pointer and then call the base class "addListener". More...

virtual bool	removeListener (ossimListener *listener)
	Overrides base "removeListener". More...

virtual void	setPixelType (ossimPixelType type)
	If "point" the coordinate tie points are relative to the center of the pixel. More...

virtual void	setPixelType (const ossimString &type)
	If "point" the coordinate tie points are relative to the center of the pixel. More...

virtual ossimPixelType	getPixelType () const

virtual void	getPixelTypeString (ossimString &type) const

Public Member Functions inherited from ossimImageWriter
	ossimImageWriter (ossimObject *owner=NULL)

	ossimImageWriter (ossimObject *owner, ossim_uint32 numberOfInputs, ossim_uint32 numberOfOutputs, bool inputListIsFixed, bool outputListIsFixed)

virtual	~ossimImageWriter ()

virtual bool	setViewingRect (const ossimIrect &aRect)

virtual ossimIrect	getAreaOfInterest () const

Public Member Functions inherited from ossimOutputSource
	ossimOutputSource (ossimObject *owner=NULL)

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

virtual	~ossimOutputSource ()

virtual bool	open (const ossimString &outputName)

virtual const ossimString &	getOutputName ()

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	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

Public Member Functions inherited from ossimProcessInterface
	ossimProcessInterface ()

virtual	~ossimProcessInterface ()

virtual void	abort ()

bool	needsAborting () const

bool	isAbortRequested () const

bool	isAborted () const

bool	isExecuting () const

ossimProcessStatus	getProcessStatus () const

virtual void	setProcessStatus (ossimProcessStatus processStatus)

virtual double	getPercentComplete () const

virtual ossimListenerManager *	getManager ()

void	enableEvents ()

void	disableEvents ()

void	setCurrentMessage (const ossimString &message)

virtual std::ostream &	print (std::ostream &out) const

Public Member Functions inherited from ossimConnectableObjectListener
	ossimConnectableObjectListener ()

virtual	~ossimConnectableObjectListener ()

virtual void	processEvent (ossimEvent &event)
	ProcessEvent. More...

virtual void	objectDestructingEvent (ossimObjectDestructingEvent &)

virtual void	connectionEvent (ossimConnectionEvent &)

virtual void	disconnectOutputEvent (ossimConnectionEvent &)

virtual void	connectOutputEvent (ossimConnectionEvent &)

virtual void	addObjectEvent (ossimContainerEvent &)

virtual void	removeObjectEvent (ossimContainerEvent &)

virtual void	containerEvent (ossimContainerEvent &)

virtual void	refreshEvent (ossimRefreshEvent &)

Public Member Functions inherited from ossimListener
	ossimListener ()

virtual	~ossimListener ()

void	enableListener ()

void	disableListener ()

void	setListenerEnableFlag (bool flag)

bool	isListenerEnabled () const

bool	getListenerEnableFlag () const

Private Member Functions
virtual bool	writeFile ()
	Writes the file to disk or a stream. More...

bool	doSwap (ossimScalarType outputScalar) const

bool	isLutEnabled () const

void	writeOptionalChunks (png_structp pp, png_infop info)
	writes optionial chunks. More...

void	writeTransparentColorChunk (png_structp pp, png_infop info)
	Write transparent color chunk (tRNS) Location: Multiple: More...

void	writeGammaChunk (png_structp pp, png_infop info)
	Write gamm chunk (gAMMA) Location: Before PLTE, before first IDAT. More...

void	writeBackgroundColorChunk (png_structp pp, png_infop info)
	Write background color chunk (bKGD) Location: After PLTE, before first IDAT. More...

void	writeTimeStampChunk (png_structp pp, png_infop info)
	Write time stamp chunk (tIME). More...

void	writeLatinTextChunk (png_structp pp, png_infop info)
	Write any text (tEXt, zTXt). More...

void	writeInternationalTextChunk (png_structp pp, png_infop info)
	Write any text (iTXt). More...

void	writeHistogram (png_structp pp, png_infop info)
	Write histogram (hIST) Location: after PLTE, before first IDAT Multiple: no. More...

void	writeSuggestedPalette (png_structp pp, png_infop info)
	Write suggested palette (sPLT) Location: before first IDAT Multiple: yes. More...

void	writeSignificantBits (png_structp pp, png_infop info)
	Write significant bits (sBIT) Location: before PLTE and first IDAT Multiple: no. More...

void	writePhysicalPixelDimensions (png_structp pp, png_infop info)
	Write physical pixel dimensions (pHYs) Location: before first IDAT Multiple: no. More...

void	writePhysicalScale (png_structp pp, png_infop info)
	Write physical scale (sCAL) Location: before first IDAT Multiple: no. More...

void	writeImageOffset (png_structp pp, png_infop info)
	Write image offset (oFFs) Location: before first IDAT Multiple: no. More...

void	writePixelCalibration (png_structp pp, png_infop info)
	Write pixel calibration (pCAL) Location: after PLTE, before first IDAT Multiple: no. More...

void	writeFractalParameters (png_structp pp, png_infop info)
	Write fractal parameters (fRAc) Location: anywhere Multiple: yes. More...

ossim_int32	getColorType (ossim_int32 bands) const
	Get the png color type. More...

ossim_int32	getBitDepth (ossimScalarType outputScalar) const

Static Private Member Functions
static void	pngWriteData (png_structp png_ptr, png_bytep data, png_size_t length)
	Callback method for writing to stream. More...

static void	pngFlush (png_structp png_ptr)
	Callback method for a flush. More...

Private Attributes
std::ostream *	theOutputStream

bool	theOwnsStreamFlag

ossim_int32	theCompressionLevel
	Compression level from zlib.h: Z_NO_COMPRESSION 0 Z_BEST_SPEED 1 Z_BEST_COMPRESSION 9 Z_DEFAULT_COMPRESSION (-1) More...

ossim_int32	theInterlaceSupport
	Interlace support: PNG_INTERLACE_ADAM7 PNG_INTERLACE_NONE. More...

ossim_int32	theCompressionStratagy
	Z_FILTERED 1 Z_HUFFMAN_ONLY 2 Z_RLE 3 Z_FIXED 4 Z_DEFAULT_STRATEGY 0. More...

ossim_int32	thePngFilter
	PNG_NO_FILTERS 0x00 PNG_FILTER_NONE 0x08 PNG_FILTER_SUB 0x10 PNG_FILTER_UP 0x20 PNG_FILTER_AVG 0x40 PNG_FILTER_PAETH 0x80. More...

bool	theGammaFlag
	For gamma support. More...

ossim_float64	theGamma

bool	theTimeFlag
	Time support, either on or off. More...

bool	theAlphaChannelFlag
	For alpha channel support. More...

bool	theBackgroundFlag
	For background support. More...

ossim_uint16	theBackgroundRed

ossim_uint16	theBackgroundGreen

ossim_uint16	theBackgroundBlue

ossim_uint16	theBackgroundGray

bool	theTransparentFlag
	For transparent color support. More...

ossim_uint16	theTransparentRed

ossim_uint16	theTransparentGreen

ossim_uint16	theTransparentBlue

ossim_uint16	theTransparentGray

Additional Inherited Members
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 Types inherited from ossimProcessInterface
enum	ossimProcessStatus { PROCESS_STATUS_UNKNOWN = 0, PROCESS_STATUS_EXECUTING = 1, PROCESS_STATUS_ABORTED = 2, PROCESS_STATUS_ABORT_REQUEST = 3, PROCESS_STATUS_NOT_EXECUTING = 4 }

Protected Member Functions inherited from ossimImageFileWriter
bool	writeWorldFile (const ossimFilename &file)
	Common world file writer method. More...

Protected Member Functions inherited from ossimSource
	ossimSource (const ossimSource &rhs)

const ossimSource &	operator= (const ossimSource &rhs)

Protected Member Functions inherited from ossimConnectableObject
ossimConnectableObject *	findObjectOfType (ConnectableObjectList *connectableList, ossimVisitor &visitor)

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Member Functions inherited from ossimListenerManager
	ossimListenerManager (const ossimListenerManager &rhs)

Protected Attributes inherited from ossimImageFileWriter
ossimRefPtr< ossimImageSourceSequencer >	theInputConnection

ossimRefPtr< ossimViewController >	theViewController

ossimListener *	theProgressListener

ossimFilename	theFilename

ossimString	theOutputImageType

bool	theWriteImageFlag

bool	theWriteOverviewFlag

bool	theWriteHistogramFlag

bool	theScaleToEightBitFlag

ossim_uint16	theOverviewCompressType

ossim_int32	theOverviewJpegCompressQuality

bool	theWriteEnviHeaderFlag
	External meta data writer flags. More...

bool	theWriteErsHeaderFlag

bool	theWriteExternalGeometryFlag

bool	theWriteFgdcFlag

bool	theWriteJpegWorldFileFlag

bool	theWriteReadmeFlag

bool	theWriteTiffWorldFileFlag

bool	theWriteWorldFileFlag

bool	theAutoCreateDirectoryFlag

ossimUnitType	theLinearUnits
	If not a geographic projection this allows the user to set the linear units of the output tag to be: More...

ossimPixelType	thePixelType
	OSSIM_PIXEL_IS_POINT = 0, OSSIM_PIXEL_IS_AREA = 1. More...

Protected Attributes inherited from ossimImageWriter
ossimIrect	theAreaOfInterest

Protected Attributes inherited from ossimOutputSource
ossimString	theOutputName

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

Protected Attributes inherited from ossimProcessInterface
double	thePercentComplete

ossimProcessStatus	theProcessStatus

ossimString	theMessage

bool	theEventFlag

Protected Attributes inherited from ossimListener
bool	theListenerEnableFlag

Detailed Description

Definition at line 23 of file ossimPngWriter.h.

Constructor & Destructor Documentation

◆ ossimPngWriter()

ossimPngWriter::ossimPngWriter ( )

Definition at line 52 of file ossimPngWriter.cpp.

    : ossimImageFileWriter(),
      theOutputStream(0),
      theOwnsStreamFlag(false),
      theCompressionLevel(Z_BEST_COMPRESSION),
      theInterlaceSupport(PNG_INTERLACE_NONE),
      theCompressionStratagy(Z_FILTERED),
      thePngFilter(PNG_FILTER_NONE),
      theGammaFlag(false),
      theGamma(0.0),
      theTimeFlag(true),
      theAlphaChannelFlag(false),     
      theBackgroundFlag(false),
      theBackgroundRed(0),
      theBackgroundGreen(0),
      theBackgroundBlue(0),
      theBackgroundGray(0),
      theTransparentFlag(false),
      theTransparentRed(0),
      theTransparentGreen(0),
      theTransparentBlue(0),
      theTransparentGray(0)
 
 {
    if (traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "ossimPngWriter::ossimPngWriter entered" << std::endl;
 #if OSSIM_ID_ENABLED
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "OSSIM_ID:  "
          << OSSIM_ID
          << std::endl;
 #endif
    }
 
    // Since there is no internal geometry set the flag to write out one.
    setWriteExternalGeometryFlag(true);
 
    theOutputImageType = "ossim_png";
 }

◆ ~ossimPngWriter()

ossimPngWriter::~ossimPngWriter ( )

virtual

Definition at line 94 of file ossimPngWriter.cpp.

References close().

 {
    // This will flush stream and delete it if we own it.
    close();
 }

Member Function Documentation

◆ close()

void ossimPngWriter::close ( )

virtual

Generic interface to allow one to close a consumer. For displays this might minimize the window and free up internal pointers for file writers it will make sure the file stream is closed and flushed.

Implements ossimOutputSource.

Definition at line 547 of file ossimPngWriter.cpp.

References theOutputStream, and theOwnsStreamFlag.

Referenced by open(), and ~ossimPngWriter().

 {
    if (theOutputStream)      
    {
       theOutputStream->flush();
 
       if (theOwnsStreamFlag)
       {
          delete theOutputStream;
          theOutputStream = 0;
          theOwnsStreamFlag = false;
       }
    }
 }

◆ doSwap()

bool ossimPngWriter::doSwap ( ossimScalarType outputScalar ) const

private

Returns: true is swapping should be performed, false if not.

Definition at line 633 of file ossimPngWriter.cpp.

References ossim::byteOrder(), OSSIM_LITTLE_ENDIAN, and OSSIM_UINT8.

 {
    bool result = false;
    if (outputScalar != OSSIM_UINT8)
    {
       if(ossim::byteOrder() == OSSIM_LITTLE_ENDIAN)
       {
          result = true;
       }
    }
    return result;
 }

◆ getAlphaChannelFlag()

bool ossimPngWriter::getAlphaChannelFlag ( void ) const

Retrieve the writer's setting for whether or not to add an alpha channel to the output png image.

Returns: true if the writer is configured to create an alpha channel.

Definition at line 995 of file ossimPngWriter.cpp.

References theAlphaChannelFlag.

 {
    return theAlphaChannelFlag;
 }

◆ getBitDepth()

ossim_int32 ossimPngWriter::getBitDepth ( ossimScalarType outputScalar ) const

private

Definition at line 908 of file ossimPngWriter.cpp.

References OSSIM_SINT16, OSSIM_UINT16, OSSIM_UINT8, and OSSIM_USHORT11.

 {
    // Can be 1, 2, 4, 8, or 16 bits/channel (from IHDR)
    ossim_int32 bitDepth = 0;
    
    switch(outputScalar)
    {
       case OSSIM_UINT8:
          bitDepth = 8;
          break;
       case OSSIM_SINT16:
       case OSSIM_UINT16:
       case OSSIM_USHORT11:
          bitDepth = 16;
          break;
       default:
          break;
    }
 
    return bitDepth;
 }

◆ getClassName()

ossimString ossimPngWriter::getClassName ( ) const

virtual

Returns: "ossimPngWriter"

Reimplemented from ossimObject.

Definition at line 110 of file ossimPngWriter.cpp.

 {
    return ossimString("ossimPngWriter");
 }

◆ getColorType()

ossim_int32 ossimPngWriter::getColorType ( ossim_int32 bands ) const

private

Get the png color type.

Returns: png color type. One of: PNG_COLOR_TYPE_GRAY PNG_COLOR_TYPE_PALETTE PNG_COLOR_TYPE_RGB PNG_COLOR_TYPE_RGB_ALPHA PNG_COLOR_TYPE_GRAY_ALPHA

Definition at line 879 of file ossimPngWriter.cpp.

References theAlphaChannelFlag.

 {
    //---
    // 
    //---
    ossim_int32 colorType = PNG_COLOR_TYPE_RGB;
 
    if(theAlphaChannelFlag)
    {
       if(bands == 1)
       {
          colorType = PNG_COLOR_TYPE_GRAY_ALPHA;
       }
       else
       {
          colorType = PNG_COLOR_TYPE_RGB_ALPHA;
       }
    }
    else
    {
       if (bands == 1)
       {
          colorType = PNG_COLOR_TYPE_GRAY;
       }
    }
 
    return colorType;
 }

◆ getCompressionLevel()

ossimString ossimPngWriter::getCompressionLevel ( ) const

Get the png compression level as a string.

Returns: The level which will be one of: z_no_compression z_best_speed z_best_compression z_default_compression

Definition at line 930 of file ossimPngWriter.cpp.

References theCompressionLevel.

 {
    ossimString result = ossimString("z_default_compression");
    
    switch (theCompressionLevel)
    {
       case Z_NO_COMPRESSION:
          result = ossimString("z_no_compression");
          break;
          
       case Z_BEST_SPEED:
          result = ossimString("z_best_speed");
          break;
          
       case Z_BEST_COMPRESSION:
          result = ossimString("z_best_compression");
          break;
 
       default:
          break;
    }
    return result;
 }

◆ getExtension()

ossimString ossimPngWriter::getExtension ( ) const

virtual

Returns a 3-letter extension from the image type descriptor (theOutputImageType) that can be used for image file extensions.

Parameters

imageType string representing image type.

Returns: the 3-letter string extension.

Reimplemented from ossimImageFileWriter.

Definition at line 567 of file ossimPngWriter.cpp.

 {
    return ossimString("png");
 }

◆ getImageTypeList()

void ossimPngWriter::getImageTypeList ( std::vector< ossimString > & imageTypeList ) const

virtual

void getImageTypeList(std::vector<ossimString>& imageTypeList)const

Appends this writer image types to list "imageTypeList".

This writer only has one type "png".

Parameters

imageTypeList stl::vector<ossimString> list to append to.

Implements ossimImageFileWriter.

Definition at line 562 of file ossimPngWriter.cpp.

Referenced by ossimPngWriterFactory::getImageTypeList().

 {
    imageTypeList.push_back(ossimString("ossim_png"));
 }

◆ getLongName()

ossimString ossimPngWriter::getLongName ( ) const

virtual

Returns: "ossim png writer"

Reimplemented from ossimObject.

Definition at line 105 of file ossimPngWriter.cpp.

 {
    return ossimString("ossim png writer");
 }

◆ getProperty()

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

virtual

Parameters

name	Name of property to return.

Returns: A pointer to a property object which matches "name".

Reimplemented from ossimImageFileWriter.

Definition at line 604 of file ossimPngWriter.cpp.

 {
    if (name == COMPRESSION_LEVEL_KW)
    {
       ossimStringProperty* stringProp =
          new ossimStringProperty(name,
                                  getCompressionLevel(),
                                  false); // editable flag
       stringProp->addConstraint(ossimString("z_no_compression"));
       stringProp->addConstraint(ossimString("z_best_speed"));
       stringProp->addConstraint(ossimString("z_best_compression"));
       stringProp->addConstraint(ossimString("z_default_compression"));
       return stringProp;
    }
    else if (name == ADD_ALPHA_CHANNEL_KW)
    {
       return new ossimBooleanProperty(ADD_ALPHA_CHANNEL_KW,
                                       theAlphaChannelFlag);
    }
    return ossimImageFileWriter::getProperty(name);
 }

◆ getPropertyNames()

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

virtual

Pushes this's names onto the list of property names.

Parameters

propertyNames array to add this's property names to.

Reimplemented from ossimImageFileWriter.

Definition at line 626 of file ossimPngWriter.cpp.

 {
    propertyNames.push_back(ossimString(COMPRESSION_LEVEL_KW));
    propertyNames.push_back(ossimString(ADD_ALPHA_CHANNEL_KW));
    ossimImageFileWriter::getPropertyNames(propertyNames);
 }

◆ getShortName()

ossimString ossimPngWriter::getShortName ( ) const

virtual

Returns: "png writer"

Reimplemented from ossimObject.

Definition at line 100 of file ossimPngWriter.cpp.

 {
    return ossimString("ossim_png_writer");
 }

◆ hasImageType()

bool ossimPngWriter::hasImageType ( const ossimString & imageType ) const

virtual

bool hasImageType(const ossimString& imageType) const

Parameters

imageType string representing image type.

Returns: true if "imageType" is supported by writer.

Reimplemented from ossimImageFileWriter.

Definition at line 572 of file ossimPngWriter.cpp.

 {
    if ( (imageType == "ossim_png") || (imageType == "image/png") )
    {
       return true;
    }
 
    return false;
 }

◆ isLutEnabled()

bool ossimPngWriter::isLutEnabled ( ) const

private

Definition at line 646 of file ossimPngWriter.cpp.

 {
    // Temp drb...
    return false;
 }

◆ isOpen()

bool ossimPngWriter::isOpen ( ) const

virtual

Implements ossimOutputSource.

Definition at line 513 of file ossimPngWriter.cpp.

References theOutputStream.

Referenced by writeFile().

 {
    if (theOutputStream)
    {
      return true;
    }
    return false;
 }

◆ loadState()

bool ossimPngWriter::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 ossimImageFileWriter.

Definition at line 497 of file ossimPngWriter.cpp.

References ossimKeywordlist::find().

 {
    const char* value;
 
    value = kwl.find(prefix, ADD_ALPHA_CHANNEL_KW);
    if(value)
    {
       setAlphaChannelFlag( ossimString(value).toBool() );
    }
 
    theOutputImageType = "png";
 
    return ossimImageFileWriter::loadState(kwl, prefix);
 }

◆ open()

bool ossimPngWriter::open ( )

virtual

Allows a generic interface to open a consumer for writing. If you are a display writer then you would probably show the window or init the device context for writing.

Implements ossimOutputSource.

Definition at line 522 of file ossimPngWriter.cpp.

References ossimString::c_str(), close(), ossimString::empty(), ossimImageFileWriter::theFilename, theOutputStream, and theOwnsStreamFlag.

Referenced by writeFile().

 {
    close();
 
    // Check for empty filenames.
    if (theFilename.empty())
    {
       return false;
    }
 
    // ossimOFStream* os = new ossimOFStream();
    std::ofstream* os = new std::ofstream();
    os->open(theFilename.c_str(), ios::out | ios::binary);
    if(os->is_open())
    {
       theOutputStream = os;
       theOwnsStreamFlag = true;
       return true;
    }
    delete os;
    os = 0;
 
    return false;
 }

◆ pngFlush()

void ossimPngWriter::pngFlush ( png_structp png_ptr )

staticprivate

Callback method for a flush.

This is a required method for png_set_write_fn.

Definition at line 480 of file ossimPngWriter.cpp.

 {
    std::ostream* fp = (std::ostream*)png_get_io_ptr(png_ptr);
    fp->flush();
 }

◆ pngWriteData()

void ossimPngWriter::pngWriteData	(	png_structp	png_ptr,
		png_bytep	data,
		png_size_t	length
	)

staticprivate

Callback method for writing to stream.

This allows us to choose the stream; hence, writing to a file or memory. This will be passed to libpng's png_set_write_fn.

Definition at line 471 of file ossimPngWriter.cpp.

 {
    std::ostream* fp = (std::ostream*)png_get_io_ptr(png_ptr);
 
    fp->write((char*)data, length);
 }

◆ saveState()

bool ossimPngWriter::saveState	(	ossimKeywordlist &	kwl,
		const char *	prefix = `0`
	)		const

virtual

saves the state of the object.

Reimplemented from ossimImageFileWriter.

Definition at line 486 of file ossimPngWriter.cpp.

References ossimKeywordlist::add().

 {
    kwl.add( prefix,
             ADD_ALPHA_CHANNEL_KW,
             ossimString::toString( theAlphaChannelFlag ),
             true );
 
    return ossimImageFileWriter::saveState(kwl, prefix);
 }

◆ setAlphaChannelFlag()

void ossimPngWriter::setAlphaChannelFlag ( bool flag )

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

Parameters

flag	true to create an alpha channel.

Definition at line 1000 of file ossimPngWriter.cpp.

References theAlphaChannelFlag.

 {
    theAlphaChannelFlag = flag;
 }

◆ setCompressionLevel()

bool ossimPngWriter::setCompressionLevel ( const ossimString & level )

Set the png compression level from a string.

Parameters

level Should be one of: z_no_compression z_best_speed z_best_compression z_default_compression

Returns: true on success, false if level is not accepted.

Definition at line 954 of file ossimPngWriter.cpp.

References ossimString::downcase(), status, and theCompressionLevel.

 {
    bool status = true;
 
    ossimString s = level;
    s.downcase();
 
    if(s == "z_no_compression")
    {
       theCompressionLevel = Z_NO_COMPRESSION;
    }
    else if(s == "z_best_speed")
    {
       theCompressionLevel = Z_BEST_SPEED;
    }
    else if(s == "z_best_compression")
    {
       theCompressionLevel = Z_BEST_COMPRESSION;
    }
    else if(s == "z_default_compression")
    {
       theCompressionLevel = Z_DEFAULT_COMPRESSION;
    }
    else
    {
       status = false;
    }
 
    if (traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "DEBUG:"
          << "\nossimPngWriter::setCompressionLevel DEBUG"
          << "passed in level:  " << level.c_str()
          << "writer level: " << getCompressionLevel().c_str()
          << endl;
    }
 
    return status;
 }

◆ setLut()

void ossimPngWriter::setLut ( const ossimNBandLutDataObject & lut )

◆ setOutputStream()

bool ossimPngWriter::setOutputStream ( std::ostream & stream )

virtual

Sets the output stream to write to.

The stream will not be closed/deleted by this object.

Parameters

output The stream to write to.

Reimplemented from ossimImageFileWriter.

Definition at line 1005 of file ossimPngWriter.cpp.

References theOutputStream, and theOwnsStreamFlag.

 {
    if (theOwnsStreamFlag && theOutputStream)
    {
       delete theOutputStream;
    }
    theOutputStream = &stream;
    theOwnsStreamFlag = false;
    return true;
 }

◆ setProperty()

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

virtual

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

Parameters

property Object containing property to set.

Reimplemented from ossimImageFileWriter.

Definition at line 582 of file ossimPngWriter.cpp.

References ossimProperty::getName().

 {
    if (!property)
    {
       return;
    }
 
    if (property->getName() == COMPRESSION_LEVEL_KW)
    {
       setCompressionLevel(property->valueToString());
    }
    else
    if (property->getName() == ADD_ALPHA_CHANNEL_KW)
    {
       setAlphaChannelFlag( property->valueToString().toBool() );
    }
    else
    {
       ossimImageFileWriter::setProperty(property);
    }
 }

◆ writeBackgroundColorChunk()

void ossimPngWriter::writeBackgroundColorChunk	(	png_structp	pp,
		png_infop	info
	)

private

Write background color chunk (bKGD) Location: After PLTE, before first IDAT.

Multiple: no

Definition at line 778 of file ossimPngWriter.cpp.

References theBackgroundBlue, theBackgroundFlag, theBackgroundGray, theBackgroundGreen, and theBackgroundRed.

Referenced by writeOptionalChunks().

 {
    if(theBackgroundFlag)
    {
       png_color_16 background;
       background.red   = theBackgroundRed;
       background.green = theBackgroundGreen;
       background.blue  = theBackgroundBlue;
       background.gray  = theBackgroundGray;
       png_set_bKGD( pp, info, &background );
    }
 }

◆ writeFile()

bool ossimPngWriter::writeFile ( )

privatevirtual

Writes the file to disk or a stream.

Returns: true on success, false on error.

Implements ossimImageFileWriter.

Definition at line 115 of file ossimPngWriter.cpp.

References ossimErrorStatusInterface::getErrorStatus(), ossimImageSourceSequencer::isMaster(), isOpen(), open(), ossimErrorCodes::OSSIM_OK, ossimImageFileWriter::theInputConnection, and writeStream().

 {
    if( !theInputConnection || (getErrorStatus() != ossimErrorCodes::OSSIM_OK) )
    {
       return false;
    }
 
    //---
    // Make sure we can open the file.  Note only the master process is used for
    // writing...
    //---
    if(theInputConnection->isMaster())
    {
       if (!isOpen())
       {
          open();
       }
    }
 
    return writeStream();
 }

◆ writeFractalParameters()

void ossimPngWriter::writeFractalParameters	(	png_structp	pp,
		png_infop	info
	)

private

Write fractal parameters (fRAc) Location: anywhere Multiple: yes.

Definition at line 875 of file ossimPngWriter.cpp.

Referenced by writeOptionalChunks().

877 {}

◆ writeGammaChunk()

void ossimPngWriter::writeGammaChunk	(	png_structp	pp,
		png_infop	info
	)

private

Write gamm chunk (gAMMA) Location: Before PLTE, before first IDAT.

Multiple: no

Definition at line 791 of file ossimPngWriter.cpp.

References theGamma, and theGammaFlag.

Referenced by writeOptionalChunks().

 {
    if(theGammaFlag)
    {
       png_set_gAMA(pp, info, theGamma);
    }
 }

◆ writeHistogram()

void ossimPngWriter::writeHistogram	(	png_structp	pp,
		png_infop	info
	)

private

Write histogram (hIST) Location: after PLTE, before first IDAT Multiple: no.

Definition at line 820 of file ossimPngWriter.cpp.

Referenced by writeOptionalChunks().

822 {}

◆ writeImageOffset()

void ossimPngWriter::writeImageOffset	(	png_structp	pp,
		png_infop	info
	)

private

Write image offset (oFFs) Location: before first IDAT Multiple: no.

Definition at line 867 of file ossimPngWriter.cpp.

Referenced by writeOptionalChunks().

869 {}

◆ writeInternationalTextChunk()

void ossimPngWriter::writeInternationalTextChunk	(	png_structp	pp,
		png_infop	info
	)

private

Write any text (iTXt).

Location: anywhere Multiple: yes

Definition at line 816 of file ossimPngWriter.cpp.

Referenced by writeOptionalChunks().

818 {}

◆ writeLatinTextChunk()

void ossimPngWriter::writeLatinTextChunk	(	png_structp	pp,
		png_infop	info
	)

private

Write any text (tEXt, zTXt).

Location: anywhere Multiple: yes

Definition at line 812 of file ossimPngWriter.cpp.

Referenced by writeOptionalChunks().

814 {}

◆ writeOptionalChunks()

void ossimPngWriter::writeOptionalChunks	(	png_structp	pp,
		png_infop	info
	)

private

writes optionial chunks.

Definition at line 652 of file ossimPngWriter.cpp.

References writeBackgroundColorChunk(), writeFractalParameters(), writeGammaChunk(), writeHistogram(), writeImageOffset(), writeInternationalTextChunk(), writeLatinTextChunk(), writePhysicalPixelDimensions(), writePhysicalScale(), writePixelCalibration(), writeSignificantBits(), writeSuggestedPalette(), writeTimeStampChunk(), and writeTransparentColorChunk().

 {
    //---
    // NOTE:
    // Per PNG spec
    // Chunks with no explicit restrictions (``anywhere'') are nonetheless
    // implicitly constrained to come after the PNG signature and IHDR
    // chunk, before the IEND chunk, and not to fall between multiple
    // IDAT chunks.
    //---
 
    //---
    // Write gamma chunk (gAMMA)
    // Location:   Before first IDAT and PLTE
    // Multiple:   no
    //---
    writeGammaChunk(pp, info);
 
    //---
    // Write significant bits (sBIT)
    // Location: before PLTE and first IDAT
    // Multiple: no
    //---
    writeSignificantBits(pp, info);
 
    // Set the palette png_set_PLTE()
 
    //---
    // Write transparent color chunk (tRNS)
    // Location: After PLTE, before first IDAT.
    // Multiple: 
    //---
    writeTransparentColorChunk(pp, info);
 
    //---
    // Write background color chunk (bKGD)
    // Location: After PLTE, before first IDAT.
    // Multiple: no
    //---
    writeBackgroundColorChunk(pp, info);
    
    //---
    // Write time stamp chunk (tIME).
    // Location: anywhere
    // Multiple: no
    // 
    //---
    writeTimeStampChunk(pp, info);
    
    //---
    // Write any text (tEXt, zTXt).
    // Location: anywhere
    // Multiple: yes
    //---
    writeLatinTextChunk(pp, info);
    
    //---
    // Write any text (iTXt).
    // Location: anywhere
    // Multiple: yes
    //---
    writeInternationalTextChunk(pp, info);
    
    //---
    // Write histogram (hIST)
    // Location: after PLTE, before first IDAT
    // Multiple: no
    //---
    writeHistogram(pp, info);
 
    //---
    // Write suggested palette (sPLT)
    // Location: before first IDAT
    // Multiple: yes
    //---
    writeSuggestedPalette(pp, info);
    
    //---
    // Write physical pixel dimensions (pHYs)
    // Location: before first IDAT
    // Multiple: no
    //---
    writePhysicalPixelDimensions(pp, info);
    
    //---
    // Write physical scale (sCAL)
    // Location: before first IDAT
    // Multiple: no
    //---
    writePhysicalScale(pp, info);
    
    //---
    // Write image offset (oFFs)
    // Location: before first IDAT
    // Multiple: no
    //---
    writeImageOffset(pp, info);
    
    //---
    // Write pixel calibration (pCAL)
    // Location: after PLTE, before first IDAT
    // Multiple: no
    //---
    writePixelCalibration(pp, info);
    
    //---
    // Write fractal parameters (fRAc)
    // Location: anywhere
    // Multiple: yes
    //---
    writeFractalParameters(pp, info);
 }

◆ writePhysicalPixelDimensions()

void ossimPngWriter::writePhysicalPixelDimensions	(	png_structp	pp,
		png_infop	info
	)

private

Write physical pixel dimensions (pHYs) Location: before first IDAT Multiple: no.

Definition at line 859 of file ossimPngWriter.cpp.

Referenced by writeOptionalChunks().

861 {}

◆ writePhysicalScale()

void ossimPngWriter::writePhysicalScale	(	png_structp	pp,
		png_infop	info
	)

private

Write physical scale (sCAL) Location: before first IDAT Multiple: no.

Definition at line 863 of file ossimPngWriter.cpp.

Referenced by writeOptionalChunks().

865 {}

◆ writePixelCalibration()

void ossimPngWriter::writePixelCalibration	(	png_structp	pp,
		png_infop	info
	)

private

Write pixel calibration (pCAL) Location: after PLTE, before first IDAT Multiple: no.

Definition at line 871 of file ossimPngWriter.cpp.

Referenced by writeOptionalChunks().

873 {}

◆ writeSignificantBits()

void ossimPngWriter::writeSignificantBits	(	png_structp	pp,
		png_infop	info
	)

private

Write significant bits (sBIT) Location: before PLTE and first IDAT Multiple: no.

Definition at line 824 of file ossimPngWriter.cpp.

References ossimImageSourceSequencer::getMaxPixelValue(), ossimImageSourceSequencer::getOutputScalarType(), max, OSSIM_UINT8, and ossimImageFileWriter::theInputConnection.

Referenced by writeOptionalChunks().

 {
    // Must be called before PLTE and first IDAT.  No multiple sBIT chunks.
    if (theInputConnection->getOutputScalarType() != OSSIM_UINT8)
    {
       ossim_float64 max = theInputConnection->getMaxPixelValue();
       if (max <= 65535)
       {
          ossim_uint16 max16 = static_cast<ossim_uint16>(max);
          png_byte bits      = 16;
          ossim_uint16 s     = 0xffff;
          while ( (s != 0x0001) && (s >= max16) )
          {
             s = s >> 1;
             if (s < max) break;
             --bits;
          }
          
          // destroyed by png_destroy_write_struct ??? (drb)
          png_color_8* sig_bit = new png_color_8; 
          sig_bit->red   = bits;
          sig_bit->green = bits;
          sig_bit->blue  = bits;
          sig_bit->gray  = bits;
          sig_bit->alpha = bits;
          png_set_sBIT(pp, info, sig_bit);
       }
    }
 }

◆ writeStream()

bool ossimPngWriter::writeStream ( )

virtual

Method to write the image to a stream.

Returns: true on success, false on error.

Reimplemented from ossimImageFileWriter.

Definition at line 137 of file ossimPngWriter.cpp.

References ossimImageFileWriter::theInputConnection.

Referenced by writeFile().

 {
    static const char MODULE[] = "ossimPngWriter::write";
    
    if (!theInputConnection) // Must have a sequencer...
    {
       if (traceDebug())
       {
          ossimNotify(ossimNotifyLevel_DEBUG)
             << MODULE << " DEBUG:\ntheInputConnection is NULL!" << endl;
       }
       return false;
    }
    
    //---
    // Make sure we have a stream.  Note only the master process is used for
    // writing...
    //---
    if(theInputConnection->isMaster())
    {
       if (!theOutputStream)         
       {
          ossimNotify(ossimNotifyLevel_WARN)
             << MODULE << " ERROR:"
             << "\nNULL output stream!"
             << "\nReturning from method." << std::endl;
 
          return false;
       }
    }
    
    // make sure we have a region of interest
    if(theAreaOfInterest.hasNans())
    {
       theInputConnection->initialize();
       theAreaOfInterest = theInputConnection->getAreaOfInterest();
    }
    else
    {
       theInputConnection->setAreaOfInterest(theAreaOfInterest);
    }
 
    if(theAreaOfInterest.hasNans()) // Must have an area of interest...
    {
       if (traceDebug())
       {
          ossimNotify(ossimNotifyLevel_DEBUG)
             << MODULE << " ERROR:  Area of interest has nans!"
             << "Area of interest:  "
             << theAreaOfInterest
             << "\nReturning..." << endl;
       }
 
       return false;
    }
 
    // Get the number of bands.  Must be one or three for this writer.
    ossim_int32 bands = theInputConnection->getNumberOfOutputBands();
    if (bands != 1 && bands != 3)
    {
       ossimNotify(ossimNotifyLevel_WARN)
          << MODULE << " Range Error:"
          << "\nInvalid number of input bands!  Must be one or three."
          << "\nInput bands = " << bands
          << "\nReturning from method." << endl;
       
       return false;
    }
 
    //---
    // PNG only supports unsigned 8 and 16 bit images, so scale if needed.
    // Note: This needs to be done on all processes.
    //---
    ossimScalarType inputScalar = theInputConnection->getOutputScalarType();
    if( ( (inputScalar != OSSIM_UINT8)  &&
          (inputScalar != OSSIM_UINT16) &&
          (inputScalar != OSSIM_USHORT11) ) ||
        ( (inputScalar != OSSIM_UINT8) && theScaleToEightBitFlag )
       )
    {
       if (traceDebug())
       {
          ossimNotify(ossimNotifyLevel_WARN)
             << " WARNING:"
             << "\nData is being scaled to 8 bit!"
             << "\nOriginal scalar type:  "
             << ossimScalarTypeLut::instance()->
             getEntryString(inputScalar).c_str()
             << std::endl;
       }
 
       //---
       // Attach a scalar remapper to the end of the input chain.  This will
       // need to be unattached and deleted at the end of this.
       //---
       ossimImageSource* inputSource = new ossimScalarRemapper;
       inputSource->connectMyInputTo(0, theInputConnection->getInput(0));
       theInputConnection->connectMyInputTo(0, inputSource);
       theInputConnection->initialize();
    }
 
    setProcessStatus(ossimProcessInterface::PROCESS_STATUS_EXECUTING);
    setPercentComplete(0.0);
 
    if(theInputConnection->isMaster())
    {
       ossimScalarType outputScalar = theInputConnection->getOutputScalarType();
       bool swapFlag = doSwap(outputScalar);
       ossim_int32 imageHeight
          = theAreaOfInterest.lr().y - theAreaOfInterest.ul().y + 1;
       ossim_int32 imageWidth
          = theAreaOfInterest.lr().x - theAreaOfInterest.ul().x + 1;
       ossim_int32 bands = theInputConnection->getNumberOfOutputBands();
       ossim_int32 tileHeight    = theInputConnection->getTileHeight();
       ossim_int32 bytesPerPixel = ossim::scalarSizeInBytes(outputScalar);
       ossim_int32 bytesPerRow   = bands*imageWidth*bytesPerPixel;
       ossim_int32 colorType     = getColorType(bands);
 
       if ( bands == 1 )
       {
          theTransparentGray = static_cast<ossim_uint16>( theInputConnection->getNullPixelValue() );
       }
       else
       if ( bands == 3 )
       {
          theTransparentRed  = static_cast<ossim_uint16>( theInputConnection->getNullPixelValue(0) );
          theTransparentGray = static_cast<ossim_uint16>( theInputConnection->getNullPixelValue(1) );
          theTransparentBlue = static_cast<ossim_uint16>( theInputConnection->getNullPixelValue(2) );
       }
 
       if ( theAlphaChannelFlag == true )
       {
          bands += 1; // add in the alpha channel
          bytesPerRow += imageWidth*bytesPerPixel;
       }
 
       // Allocate a buffer (tile) to hold a row of bip-format tiles.
       ossimRefPtr<ossimImageData> bipTile =
          new ossimImageData(0,
                             outputScalar,
                             bands,
                             imageWidth,
                             tileHeight);
       bipTile->initialize();
 
       //---
       // Begin of png related stuff.
       //---
       png_structp pp   = png_create_write_struct (PNG_LIBPNG_VER_STRING, 0, 0, 0);
       png_infop   info = png_create_info_struct (pp);
 
       if ( setjmp( png_jmpbuf(pp) ) )
       {
          ossimNotify(ossimNotifyLevel_WARN)
             << "Error writing image:  " << theFilename.c_str()
             << std::endl;
          return false;
       }
 
       //---
       // Pass the static write and flush to libpng to allow us to use our
       // stream instead of doing "png_init_io (pp, theOutputFilePtr);"
       //---
       png_set_write_fn( pp,
                         (png_voidp)theOutputStream,
                         (png_rw_ptr) &ossimPngWriter::pngWriteData,
                         (png_flush_ptr)&ossimPngWriter::pngFlush);
 
       // Set the compression level.
       png_set_compression_level(pp, theCompressionLevel);
 
       //---
       // Set the filtering.
       // Note that palette images should usually not be filtered.
       if (isLutEnabled())
       {
          png_set_filter(pp, PNG_FILTER_TYPE_BASE, PNG_FILTER_NONE);
          png_set_compression_strategy(pp, Z_DEFAULT_STRATEGY);
       }
       else
       {
          // leave default filter selection alone
          png_set_compression_strategy(pp, Z_FILTERED);
       }
 
       if (traceDebug())
       {
          ossimNotify(ossimNotifyLevel_DEBUG)
             << MODULE << " DEBUG: "
             << "\nInput scalar:  "
             << ossimScalarTypeLut::instance()->
             getEntryString(inputScalar).c_str()
             << "\nOutput scalar: "
             <<  ossimScalarTypeLut::instance()->
             getEntryString(outputScalar).c_str()
             << "\nOutput Rect:  " << theAreaOfInterest
             << "\nSwap flag:  " << swapFlag
             << "\nbytesPerRow:         " << bytesPerRow
             << "\nimageWidth:          " << imageWidth
             << "\nimageHeight:         " << imageHeight
             << "\ngitDepth:            " << getBitDepth(outputScalar)
             << "\ngetColorType(bands): " << colorType
             << endl;
       }
 
       png_set_IHDR(pp,
                    info,
                    imageWidth,
                    imageHeight,
                    getBitDepth(outputScalar),
                    colorType,
                    theInterlaceSupport,
                    PNG_COMPRESSION_TYPE_DEFAULT,
                    PNG_FILTER_TYPE_DEFAULT);
 
       // Set the palette png_set_PLTE() in writeOptionalChunks()
       writeOptionalChunks(pp, info);
 
       png_write_info(pp, info);
 
       // png_set_packing(pp);
 
       // Write the image.
       if(theInterlaceSupport) // interlaced...
       {
          // Requires reading whole image into memory...
          ossimNotify(ossimNotifyLevel_WARN)
             << "Interlace support not implemented yet!"
             << std::endl;
          return false;
       }
       else // not interlaced...
       {
          theInputConnection->setAreaOfInterest(theAreaOfInterest);
          theInputConnection->setToStartOfSequence();
          ossim_uint32 maxY = theInputConnection->getNumberOfTilesVertical();
 
          //---
          // Loop through and grab a row of tiles and copy to the buffer.
          // Then write the buffer to the png file.
          // Get the next row of tiles ... until finished.
          //---
 
          // Row loop, in line direction...
          for (ossim_uint32 i=0; ( (i<maxY) && (!needsAborting()) ); ++i)
          {
             ossimIrect buf_rect = theAreaOfInterest;
             buf_rect.set_uly(theAreaOfInterest.ul().y+i*tileHeight);
             buf_rect.set_lry(buf_rect.ul().y + tileHeight - 1);
  
             bipTile->setImageRectangle(buf_rect);
             void* bipBuf = bipTile->getBuf();
 
             
             // Grab lines of data that span the entire width of the image.
             ossimRefPtr<ossimImageData> t = theInputConnection->getTile( buf_rect );
             if ( t.valid() )
             {
                if ( theAlphaChannelFlag )
                {
                   t->computeAlphaChannel();
                   t->unloadTileToBipAlpha(bipBuf, buf_rect, buf_rect);
                }
                else
                {
                   t->unloadTile( bipBuf, buf_rect, buf_rect, OSSIM_BIP);
                }
 
                // Copy the buffer to the png file.
                ossim_int32 lines_to_copy =
                   min( (buf_rect.lr().y-buf_rect.ul().y+1),
                        (theAreaOfInterest.lr().y-buf_rect.ul().y+1) );
                
                if (traceDebug())
                {
                   ossimNotify(ossimNotifyLevel_DEBUG)
                      << MODULE
                      << "buf_rect:       " << buf_rect
                      << "lines_to_copy:  " << lines_to_copy << endl;
                }
 
                if(!needsAborting())
                {
                   if(swapFlag)
                   {
                      ossimEndian endian;
                      endian.swap((ossim_uint16*)bipBuf,
                                  imageWidth*lines_to_copy*bands);
                   }
 
                   ossim_uint8* buf = (ossim_uint8*)bipBuf;
                   ossim_int32 buf_offset = 0;
                   for (ossim_int32 line=0; line<lines_to_copy; ++line)
                   {
                      png_bytep rowp = (png_bytep)&buf[buf_offset];
                      png_write_row(pp, rowp);
                      buf_offset += bytesPerRow;
                   }
 
                } // if ( !getProcessStatus() )
 
                double dPercentComplete = (100.0*(i+1)) / maxY;
                setPercentComplete( dPercentComplete );
  
             } // if ( t.valid() )
 
          } // End of loop through tiles in the y direction.
 
       } // Not interlace write block.
 
       png_write_end(pp, 0);
       png_destroy_write_struct(&pp, &info);
 
       close();
 
    } // End of if(theInputConnection->isMaster()) block.
 
    else   // slave process
    {
       theInputConnection->slaveProcessTiles();
    }
 
    if(needsAborting())
    {
       setProcessStatus(ossimProcessInterface::PROCESS_STATUS_ABORTED);
    }
    else
    {
       setProcessStatus(ossimProcessInterface::PROCESS_STATUS_NOT_EXECUTING);
    }
 
    return true;
 }

◆ writeSuggestedPalette()

void ossimPngWriter::writeSuggestedPalette	(	png_structp	pp,
		png_infop	info
	)

private

Write suggested palette (sPLT) Location: before first IDAT Multiple: yes.

Definition at line 855 of file ossimPngWriter.cpp.

Referenced by writeOptionalChunks().

857 {}

◆ writeTimeStampChunk()

void ossimPngWriter::writeTimeStampChunk	(	png_structp	pp,
		png_infop	info
	)

private

Write time stamp chunk (tIME).

Location: anywhere Multiple: no

Definition at line 799 of file ossimPngWriter.cpp.

References theTimeFlag.

Referenced by writeOptionalChunks().

 {
    if(theTimeFlag)
    {
       png_time  modtime;
       time_t t;
       time(&t);
       png_convert_from_time_t(&modtime, t);
       png_set_tIME(pp, info, &modtime); 
    }
 }

◆ writeTransparentColorChunk()

void ossimPngWriter::writeTransparentColorChunk	(	png_structp	pp,
		png_infop	info
	)

private

Write transparent color chunk (tRNS) Location:
Multiple:

Definition at line 765 of file ossimPngWriter.cpp.

References theTransparentBlue, theTransparentFlag, theTransparentGray, theTransparentGreen, and theTransparentRed.

Referenced by writeOptionalChunks().

 {
    if (theTransparentFlag)
    {
       png_color_16 transparent;
       transparent.red   = (png_uint_16)theTransparentRed;
       transparent.green = (png_uint_16)theTransparentGreen;
       transparent.blue  = (png_uint_16)theTransparentBlue;
       transparent.gray  = (png_uint_16)theTransparentGray;
       png_set_tRNS( pp, info, NULL, 0, &transparent );
    }
 }

Member Data Documentation

◆ theAlphaChannelFlag

bool ossimPngWriter::theAlphaChannelFlag

private

For alpha channel support.

Definition at line 375 of file ossimPngWriter.h.

Referenced by getAlphaChannelFlag(), getColorType(), and setAlphaChannelFlag().

◆ theBackgroundBlue

ossim_uint16 ossimPngWriter::theBackgroundBlue

private

Definition at line 381 of file ossimPngWriter.h.

Referenced by writeBackgroundColorChunk().

◆ theBackgroundFlag

bool ossimPngWriter::theBackgroundFlag

private

For background support.

Definition at line 378 of file ossimPngWriter.h.

Referenced by writeBackgroundColorChunk().

◆ theBackgroundGray

ossim_uint16 ossimPngWriter::theBackgroundGray

private

Definition at line 382 of file ossimPngWriter.h.

Referenced by writeBackgroundColorChunk().

◆ theBackgroundGreen

ossim_uint16 ossimPngWriter::theBackgroundGreen

private

Definition at line 380 of file ossimPngWriter.h.

Referenced by writeBackgroundColorChunk().

◆ theBackgroundRed

ossim_uint16 ossimPngWriter::theBackgroundRed

private

Definition at line 379 of file ossimPngWriter.h.

Referenced by writeBackgroundColorChunk().

◆ theCompressionLevel

ossim_int32 ossimPngWriter::theCompressionLevel

private

Compression level from zlib.h: Z_NO_COMPRESSION 0 Z_BEST_SPEED 1 Z_BEST_COMPRESSION 9 Z_DEFAULT_COMPRESSION (-1)

Defaulted to Z_BEST_COMPRESSION

Definition at line 323 of file ossimPngWriter.h.

Referenced by getCompressionLevel(), and setCompressionLevel().

◆ theCompressionStratagy

ossim_int32 ossimPngWriter::theCompressionStratagy

private

Z_FILTERED 1 Z_HUFFMAN_ONLY 2 Z_RLE 3 Z_FIXED 4 Z_DEFAULT_STRATEGY 0.

Default to Z_FILTERED if not palette image, Z_DEFAULT_STRATEGY if palette.

Definition at line 344 of file ossimPngWriter.h.

◆ theGamma

ossim_float64 ossimPngWriter::theGamma

private

Definition at line 369 of file ossimPngWriter.h.

Referenced by writeGammaChunk().

◆ theGammaFlag

bool ossimPngWriter::theGammaFlag

private

For gamma support.

gamma multiplied by 100,000 and rounded to the nearest integer. So if gamma is 1/2.2 (or 0.45454545...), the value in the gAMA chunk is 45,455.

There can be only one gAMA chunk, and it must appear before any IDATs and also before the PLTE chunk, if one is present.

Definition at line 368 of file ossimPngWriter.h.

Referenced by writeGammaChunk().

◆ theInterlaceSupport

ossim_int32 ossimPngWriter::theInterlaceSupport

private

Interlace support: PNG_INTERLACE_ADAM7 PNG_INTERLACE_NONE.

Defaulted to PNG_INTERLACE_NONE

Definition at line 332 of file ossimPngWriter.h.

◆ theOutputStream

std::ostream* ossimPngWriter::theOutputStream

private

Definition at line 311 of file ossimPngWriter.h.

Referenced by close(), isOpen(), open(), and setOutputStream().

◆ theOwnsStreamFlag

bool ossimPngWriter::theOwnsStreamFlag

private

Definition at line 312 of file ossimPngWriter.h.

Referenced by close(), open(), and setOutputStream().

◆ thePngFilter

ossim_int32 ossimPngWriter::thePngFilter

private

PNG_NO_FILTERS 0x00 PNG_FILTER_NONE 0x08 PNG_FILTER_SUB 0x10 PNG_FILTER_UP 0x20 PNG_FILTER_AVG 0x40 PNG_FILTER_PAETH 0x80.

Defaulted to PNG_FILTER_NONE if palette; If not palette this is left up to zlib to decide unless the user overrides it.

Definition at line 357 of file ossimPngWriter.h.

◆ theTimeFlag

bool ossimPngWriter::theTimeFlag

private

Time support, either on or off.

Default = on.

Definition at line 372 of file ossimPngWriter.h.

Referenced by writeTimeStampChunk().

◆ theTransparentBlue

ossim_uint16 ossimPngWriter::theTransparentBlue

private

Definition at line 388 of file ossimPngWriter.h.

Referenced by writeTransparentColorChunk().

◆ theTransparentFlag

bool ossimPngWriter::theTransparentFlag

private

For transparent color support.

Definition at line 385 of file ossimPngWriter.h.

Referenced by writeTransparentColorChunk().

◆ theTransparentGray

ossim_uint16 ossimPngWriter::theTransparentGray

private

Definition at line 389 of file ossimPngWriter.h.

Referenced by writeTransparentColorChunk().

◆ theTransparentGreen

ossim_uint16 ossimPngWriter::theTransparentGreen

private

Definition at line 387 of file ossimPngWriter.h.

Referenced by writeTransparentColorChunk().

◆ theTransparentRed

ossim_uint16 ossimPngWriter::theTransparentRed

private

Definition at line 386 of file ossimPngWriter.h.

Referenced by writeTransparentColorChunk().

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

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ossimPngWriter()

◆ ~ossimPngWriter()

Member Function Documentation

◆ close()

◆ doSwap()

◆ getAlphaChannelFlag()

◆ getBitDepth()

◆ getClassName()

◆ getColorType()

◆ getCompressionLevel()

◆ getExtension()

◆ getImageTypeList()

◆ getLongName()

◆ getProperty()

◆ getPropertyNames()

◆ getShortName()

◆ hasImageType()

◆ isLutEnabled()

◆ isOpen()

◆ loadState()

◆ open()

◆ pngFlush()

◆ pngWriteData()

◆ saveState()

◆ setAlphaChannelFlag()

◆ setCompressionLevel()

◆ setLut()

◆ setOutputStream()

◆ setProperty()

◆ writeBackgroundColorChunk()

◆ writeFile()

◆ writeFractalParameters()

◆ writeGammaChunk()

◆ writeHistogram()

◆ writeImageOffset()

◆ writeInternationalTextChunk()

◆ writeLatinTextChunk()

◆ writeOptionalChunks()

◆ writePhysicalPixelDimensions()

◆ writePhysicalScale()

◆ writePixelCalibration()

◆ writeSignificantBits()

◆ writeStream()

◆ writeSuggestedPalette()

◆ writeTimeStampChunk()

◆ writeTransparentColorChunk()

Member Data Documentation

◆ theAlphaChannelFlag

◆ theBackgroundBlue

◆ theBackgroundFlag

◆ theBackgroundGray

◆ theBackgroundGreen

◆ theBackgroundRed

◆ theCompressionLevel

◆ theCompressionStratagy

◆ theGamma

◆ theGammaFlag

◆ theInterlaceSupport

◆ theOutputStream

◆ theOwnsStreamFlag

◆ thePngFilter

◆ theTimeFlag

◆ theTransparentBlue

◆ theTransparentFlag

◆ theTransparentGray

◆ theTransparentGreen

◆ theTransparentRed