ossimWriter Class Reference

ossimWriter - Generic image writer. More...

#include <ossimWriter.h>

Inheritance diagram for ossimWriter:

Public Member Functions
	ossimWriter ()
	default constructor More...
virtual	~ossimWriter ()
	virtual destructor More...
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
	getImageTypeList method. More...
virtual bool	isOpen () const
	isOpen More...
virtual bool	open ()
	open More...
virtual void	close ()
	close Flushes and deletes stream if we own it. More...
bool	hasImageType (const ossimString &imageType) const
	bool hasImageType(const ossimString& imageType) const More...
virtual bool	writeStream ()
	Method to write the image to a stream. More...
virtual bool	setOutputStream (std::ostream &str)
	Sets the output stream to write to. More...
virtual void	setTileSize (const ossimIpt &tileSize)
	Sets the output tile size for tiled formats. More...
virtual const ossimIpt &	getOutputTileSize () const
	Gets the tile size. More...
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...
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 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

Protected Member Functions
virtual bool	writeFile ()
	Write out the file. More...
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)

Private Member Functions
bool	writeStreamTtbs ()
	Writes a tiled tiff band separate to stream. More...
bool	writeTiffHdr ()
	Writes tiff header to stream. More...
bool	writeTiffTags (const std::vector< ossim_uint64 > &tile_offsets, const std::vector< ossim_uint64 > &tile_byte_counts, const std::vector< ossim_float64 > &minBands, const std::vector< ossim_float64 > &maxBands)
	Writes tags to image file directory(IFD). More...
bool	writeMinMaxTiffTags (std::streamoff &arrayWritePos)
	Writes tags TIFFTAG_MINSAMPLEVALUE(280) and TIFFTAG_MAXSAMPLEVALUE(281). More...
bool	writeSMinSMaxTiffTags (const std::vector< ossim_float64 > &minBands, const std::vector< ossim_float64 > &maxBands, std::streamoff &arrayWritePos)
	Writes tags TIFFTAG_SMINSAMPLEVALUE(340) and TIFFTAG_SMAXSAMPLEVALUE(341). More...
template<class T >
void	writeTiffTag (ossim_uint16 tag, ossim_uint16 type, ossim_uint64 count, const T *value, std::streamoff &arrayWritePos)
	Writes tiff tag to image file directory(IFD). More...
bool	writeTiffTilesBandSeparate (std::vector< ossim_uint64 > &tile_offsets, std::vector< ossim_uint64 > &tile_byte_counts, std::vector< ossim_float64 > &minBands, std::vector< ossim_float64 > &maxBands)
	Writes image data to stream. More...
ossim_uint16	getTiffSampleFormat () const
	Gets the tiff sample format based on scalar type. More...
bool	isTiled () const
bool	getAlignTilesFlag () const
ossim_int64	getBlockSize () const
bool	getFlushTilesFlag () const
bool	getWriteBlanksFlag () const
bool	needsMinMax () const

Private Attributes
std::ostream *	m_str
bool	m_ownsStreamFlag
ossimRefPtr< ossimKeywordlist >	m_kwl
	Hold all options. More...
ossimIpt	m_outputTileSize

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

ossimWriter - Generic image writer.

Please do NOT add any external library dependencies. drb - 26 May 2016

Definition at line 28 of file ossimWriter.h.

Constructor & Destructor Documentation

ossimWriter()

ossimWriter::ossimWriter

(

)

default constructor

Definition at line 37 of file ossimWriter.cpp.

References ossimKeywordlist::addPair(), ossim::defaultTileSize(), m_kwl, and m_outputTileSize.

   : ossimImageFileWriter(),
     m_str(0),
     m_ownsStreamFlag(false),
     m_kwl(new ossimKeywordlist()),
     m_outputTileSize(OSSIM_DEFAULT_TILE_WIDTH, OSSIM_DEFAULT_TILE_HEIGHT)
{
   // Set default options:
   ossim::defaultTileSize(m_outputTileSize);
   
   m_kwl->addPair( ALIGN_TILES_KW, TRUE_KW );
   m_kwl->addPair( BLOCK_SIZE_KW, "4096" );
   m_kwl->addPair( FLUSH_TILES_KW, TRUE_KW );
   m_kwl->addPair( INCLUDE_BLANK_TILES_KW, TRUE_KW );
   m_kwl->addPair( TILE_SIZE_KW, m_outputTileSize.toString().string() );
}

~ossimWriter()

ossimWriter::~ossimWriter ( )

virtual

virtual destructor

Definition at line 54 of file ossimWriter.cpp.

References close(), and m_kwl.

{
   close();

   // Not a leak, ref ptr.
   m_kwl = 0;
}

Member Function Documentation

close()

void ossimWriter::close ( )

virtual

close Flushes and deletes stream if we own it.

Implements ossimOutputSource.

Definition at line 62 of file ossimWriter.cpp.

References m_ownsStreamFlag, and m_str.

Referenced by open(), writeFile(), and ~ossimWriter().

{
   if (m_str)      
   {
      m_str->flush();

      if (m_ownsStreamFlag)
      {
         delete m_str;
         m_str = 0;
         m_ownsStreamFlag = false;
      }
   }
}

getAlignTilesFlag()

bool ossimWriter::getAlignTilesFlag ( ) const

private

Returns

Value of options key: "align_tiles". If true, aligns tile addresses to 4096 boundary. default=true

Definition at line 1219 of file ossimWriter.cpp.

References ossimKeywordlist::findKey(), and m_kwl.

{
   bool result = true; // default
   std::string value = m_kwl->findKey( ALIGN_TILES_KW );
   if ( value.size() )
   {
      result = ossimString(value).toBool();
   }
   return result;
}

getBlockSize()

ossim_int64 ossimWriter::getBlockSize ( ) const

private

Returns

Value of options key: "flush_tiles". If true, aligns tile addresses to block boundary. default=true

Definition at line 1230 of file ossimWriter.cpp.

References ossimKeywordlist::findKey(), and m_kwl.

{
   ossim_int64 result = 4096; // default
   std::string value = m_kwl->findKey( BLOCK_SIZE_KW );
   if ( value.size() )
   {
      result = ossimString(value).toInt64();

      // Disallow anything not on 1024 boundary.
      if ( result % 1024 )
      {
         result = 4096;
         ossimNotify(ossimNotifyLevel_DEBUG)
                  << "ossimWriter::getBlockSize ERROR:"
                  << "\nBlock size MUST be a multiple of 1024!"
                  << "\nBlock size remains:  " << result
                  << std::endl;
      }
   }
   return result;
}

getClassName()

ossimString ossimWriter::getClassName ( ) const

virtual

Returns

"ossimWriter"

Reimplemented from ossimObject.

Definition at line 87 of file ossimWriter.cpp.

{
   return ossimString("ossimWriter");
}

getExtension()

ossimString ossimWriter::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 92 of file ossimWriter.cpp.

References ossimImageFileWriter::theOutputImageType.

{
   ossimString result = "";
   if ( theOutputImageType == "ossim_ttbs" ) // tiled tiff band separate
   {
      result = "tif";
   }
   return result;
}

getFlushTilesFlag()

bool ossimWriter::getFlushTilesFlag ( ) const

private

Returns

Value of options key: "flush_tiles". If true, ostream::flush() is called after each tile write. default=true

Definition at line 1252 of file ossimWriter.cpp.

References ossimKeywordlist::findKey(), and m_kwl.

{
   bool result = true; // default
   std::string value = m_kwl->findKey( FLUSH_TILES_KW );
   if ( value.size() )
   {
      result = ossimString(value).toBool();
   }
   return result;
}

getImageTypeList()

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

virtual

getImageTypeList method.

Satisfies ossimImageFileWriter::getImageTypeList pure virtual.

Appends the writers image types to the "imageTypeList".

Current write type: ossim_ttbs - tiled tiff band separate, big tiff format.

Parameters

imageTypeList

list to append to.

Implements ossimImageFileWriter.

Definition at line 102 of file ossimWriter.cpp.

{
   // imageTypeList.push_back(ossimString("tiff_tiled_band_separate"));
   imageTypeList.push_back(ossimString("ossim_ttbs")); // tmp drb
}

getLongName()

ossimString ossimWriter::getLongName ( ) const

virtual

Returns

"ossim writer"

Reimplemented from ossimObject.

Definition at line 82 of file ossimWriter.cpp.

{
   return ossimString("ossim writer");
}

getOutputTileSize()

const ossimIpt & ossimWriter::getOutputTileSize ( ) const

virtual

Gets the tile size.

Returns

Reference to tile size.

Definition at line 1008 of file ossimWriter.cpp.

References m_outputTileSize.

{
   return m_outputTileSize;
}

getProperty()

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

virtual

Parameters

name	Name of property to return.

Returns

A pointer to a property object which matches "name". Returns NULL if no match is found.

Reimplemented from ossimImageFileWriter.

Definition at line 1113 of file ossimWriter.cpp.

References ossimString::string().

{
   ossimRefPtr<ossimProperty> prop = 0;

   if ( name.string() == ALIGN_TILES_KW )
   {
      std::string value = m_kwl->findKey( ALIGN_TILES_KW );
      ossimRefPtr<ossimBooleanProperty> boolProp =
         new ossimBooleanProperty(name, ossimString(value).toBool());
      prop = boolProp.get();
   }
   else if( name == BLOCK_SIZE_KW )
   {
      // Property a single int, e.g.: 4096
      ossim_int64 blockSize = getBlockSize();
      ossimRefPtr<ossimStringProperty> stringProp =
         new ossimStringProperty(name, ossimString::toString(blockSize), false); // editable flag
      prop = stringProp.get();
   }
   else if ( name.string() == FLUSH_TILES_KW )
   {
      std::string value = m_kwl->findKey( FLUSH_TILES_KW );
      ossimRefPtr<ossimBooleanProperty> boolProp =
         new ossimBooleanProperty(name, ossimString(value).toBool());
      prop = boolProp.get();
   }
   else if ( name.string() == INCLUDE_BLANK_TILES_KW )
   {
      std::string value = m_kwl->findKey( INCLUDE_BLANK_TILES_KW );
      ossimRefPtr<ossimBooleanProperty> boolProp =
         new ossimBooleanProperty(name, ossimString(value).toBool());
      prop = boolProp.get();
   }
   else if( name == TILE_SIZE_KW )
   {
      // Property a single int, e.g.: 256
      ossimRefPtr<ossimStringProperty> stringProp =
         new ossimStringProperty(name, ossimString::toString(m_outputTileSize.x), false); // editable flag
      stringProp->setReadOnlyFlag(false);
      stringProp->setChangeType(ossimProperty::ossimPropertyChangeType_AFFECTS_OTHERS);
      stringProp->addConstraint(ossimString("16"));
      stringProp->addConstraint(ossimString("32"));
      stringProp->addConstraint(ossimString("64"));
      stringProp->addConstraint(ossimString("128"));
      stringProp->addConstraint(ossimString("256"));      
      stringProp->addConstraint(ossimString("512"));      
      stringProp->addConstraint(ossimString("1024"));      
      stringProp->addConstraint(ossimString("2048"));
      prop = stringProp.get();
   }
   else
   {
      prop = ossimImageFileWriter::getProperty(name);
   }
   return prop;
}

getPropertyNames()

void ossimWriter::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 1170 of file ossimWriter.cpp.

{
   propertyNames.push_back(ossimString(ALIGN_TILES_KW));
   propertyNames.push_back(ossimString(BLOCK_SIZE_KW));
   propertyNames.push_back(ossimString(FLUSH_TILES_KW));   
   propertyNames.push_back(ossimString(INCLUDE_BLANK_TILES_KW));
   propertyNames.push_back(ossimString(TILE_SIZE_KW));
   ossimImageFileWriter::getPropertyNames(propertyNames);
}

getShortName()

ossimString ossimWriter::getShortName ( ) const

virtual

Returns

"ossim_writer"

Reimplemented from ossimObject.

Definition at line 77 of file ossimWriter.cpp.

{
   return ossimString("ossim_writer");
}

getTiffSampleFormat()

ossim_uint16 ossimWriter::getTiffSampleFormat ( ) const

private

Gets the tiff sample format based on scalar type.

E.g SAMPLEFORMAT_UINT, SAMPLEFORMAT_INT or SAMPLEFORMAT_IEEEFP.

Returns

TIFF sample format or 0 if not mapped to a scalar type.

Definition at line 1180 of file ossimWriter.cpp.

References ossimImageSourceSequencer::getOutputScalarType(), ossim::OSAMPLEFORMAT_IEEEFP, ossim::OSAMPLEFORMAT_INT, ossim::OSAMPLEFORMAT_UINT, OSSIM_FLOAT32, OSSIM_FLOAT64, OSSIM_NORMALIZED_DOUBLE, OSSIM_NORMALIZED_FLOAT, OSSIM_SINT16, OSSIM_UINT16, OSSIM_UINT32, OSSIM_UINT8, OSSIM_USHORT11, OSSIM_USHORT12, OSSIM_USHORT13, OSSIM_USHORT14, OSSIM_USHORT15, and ossimImageFileWriter::theInputConnection.

Referenced by writeTiffTags().

{
   ossim_uint16 result = 0;
   switch( theInputConnection->getOutputScalarType() )
   {
      case OSSIM_UINT8:
      case OSSIM_USHORT11:
      case OSSIM_USHORT12:
      case OSSIM_USHORT13:
      case OSSIM_USHORT14:
      case OSSIM_USHORT15:
      case OSSIM_UINT16:
      case OSSIM_UINT32:
         result = ossim::OSAMPLEFORMAT_UINT;
         break;

      case OSSIM_SINT16:
         result = ossim::OSAMPLEFORMAT_INT;
         break;

      case OSSIM_FLOAT32:
      case OSSIM_FLOAT64:
      case OSSIM_NORMALIZED_FLOAT:
      case OSSIM_NORMALIZED_DOUBLE:
         result = ossim::OSAMPLEFORMAT_IEEEFP;
         break;

      default:
         break;
   }

   return result;
}

getWriteBlanksFlag()

bool ossimWriter::getWriteBlanksFlag ( ) const

private

Returns

Value of options key: "include_blank_tiles". If true, empty/blank tiles will be written; if false, the tile will not be written, the tile offset and byte count will be set to zero. default=true (write blanks).

Definition at line 1263 of file ossimWriter.cpp.

References ossimKeywordlist::findKey(), and m_kwl.

{
   bool result = true; // default
   std::string value = m_kwl->findKey( INCLUDE_BLANK_TILES_KW );
   if ( value.size() )
   {
      result = ossimString(value).toBool();
   }
   return result;
}

hasImageType()

bool ossimWriter::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 139 of file ossimWriter.cpp.

Referenced by open().

{
   bool result = false;
   if ( (imageType == "ossim_ttbs") || (imageType == "image/tif") )
   {
      result = true;
   }
   return result;
}

isOpen()

bool ossimWriter::isOpen ( ) const

virtual

isOpen

Returns

true if open; else, false.

Implements ossimOutputSource.

Definition at line 108 of file ossimWriter.cpp.

References m_str.

Referenced by writeFile(), and writeStream().

{
   return ( m_str ? true : false );
}

isTiled()

bool ossimWriter::isTiled ( ) const

private

Returns

true if the output type is tiled, false if not.

Definition at line 1214 of file ossimWriter.cpp.

References ossimImageFileWriter::theOutputImageType.

Referenced by writeTiffTags().

{
   return ( theOutputImageType == "ossim_ttbs" );
}

loadState()

bool ossimWriter::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 1020 of file ossimWriter.cpp.

References ossimKeywordlist::findKey(), ossimImageFileWriter::loadState(), and ossimImageFileWriter::theOutputImageType.

{
   bool result = false;
   if ( ossimImageFileWriter::loadState(kwl, prefix) )
   {
      if ( theOutputImageType!="ossim_ttbs")
      {
         result = true;
         
         std::string pfx = prefix?prefix:"";  
         std::string value;

         value = kwl.findKey( pfx, ALIGN_TILES_KW );
         if ( value.size() )
         {
            m_kwl->addPair( ALIGN_TILES_KW, value, true );
         }

         value = kwl.findKey( pfx, BLOCK_SIZE_KW );
         if ( value.size() )
         {
            m_kwl->addPair( BLOCK_SIZE_KW, value, true );
         }

         value = kwl.findKey( pfx, FLUSH_TILES_KW );
         if ( value.size() )
         {
            m_kwl->addPair( FLUSH_TILES_KW, value, true );
         }

         value = kwl.findKey( pfx, INCLUDE_BLANK_TILES_KW );
         if ( value.size() )
         {
            m_kwl->addPair( INCLUDE_BLANK_TILES_KW, value, true );
         }

         value = kwl.findKey( pfx, TILE_SIZE_KW );
         if ( value.size() )
         {
            m_outputTileSize.toPoint(value);
            m_kwl->addPair( TILE_SIZE_KW, m_outputTileSize.toString().string(), true );
         }
      }
   }

   return result;
}

needsMinMax()

bool ossimWriter::needsMinMax ( ) const

private

Definition at line 1274 of file ossimWriter.cpp.

References ossimImageSourceSequencer::getOutputScalarType(), OSSIM_FLOAT32, OSSIM_FLOAT64, OSSIM_NORMALIZED_DOUBLE, OSSIM_NORMALIZED_FLOAT, OSSIM_SINT16, OSSIM_UINT32, and ossimImageFileWriter::theInputConnection.

{
   bool result = false;
   switch( theInputConnection->getOutputScalarType() )
   {
      case OSSIM_SINT16: 
      case OSSIM_UINT32:
      case OSSIM_FLOAT32:
      case OSSIM_FLOAT64:
      case OSSIM_NORMALIZED_FLOAT:
      case OSSIM_NORMALIZED_DOUBLE:
      {
         result = true;
         break;
      }
      default:
      {
         break;
      }
   }
   return result;
}

open()

bool ossimWriter::open ( )

virtual

open

Returns

true on success, false on error.

Implements ossimOutputSource.

Definition at line 113 of file ossimWriter.cpp.

References ossimString::c_str(), close(), hasImageType(), m_ownsStreamFlag, m_str, ossimString::size(), status, ossimImageFileWriter::theFilename, and ossimImageFileWriter::theOutputImageType.

Referenced by writeFile().

{
   bool status = false;
   
   close();

   if ( theFilename.size() && hasImageType( theOutputImageType ) )
   {
      std::ofstream* os = new std::ofstream();
      os->open( theFilename.c_str(), ios::out | ios::binary );
      if( os->is_open() )
      {
         m_str = os;
         m_ownsStreamFlag = true;
         status = true;
      }
      else
      {
         delete os;
         os = 0;
      }
   }

   return status;
}

saveState()

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

virtual

Saves the state of the object.

Reimplemented from ossimImageFileWriter.

Definition at line 1013 of file ossimWriter.cpp.

References ossimKeywordlist::add(), ossimRefPtr< T >::get(), m_kwl, and ossimImageFileWriter::saveState().

{
   // Lazy man save state...
   kwl.add( prefix, *(m_kwl.get()), true );
   return ossimImageFileWriter::saveState(kwl, prefix);
}

setOutputStream()

bool ossimWriter::setOutputStream ( std::ostream &  str )

virtual

Sets the output stream to write to.

This sets the stream and sets m_ownsStreamFlag to false. So destructor will not delete the stream if this method is used.

Parameters

stream

The stream to write to.

Returns

true if object can write to stream, false if not.

Reimplemented from ossimImageFileWriter.

Definition at line 975 of file ossimWriter.cpp.

References m_ownsStreamFlag, and m_str.

{
   if (m_ownsStreamFlag && m_str)
   {
      delete m_str;
   }
   m_str = &stream;
   m_ownsStreamFlag = false;
   return true;
}

setProperty()

void ossimWriter::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 1068 of file ossimWriter.cpp.

References ossimRefPtr< T >::valid().

{
   if( property.valid() )
   {
      // See if it's one of our properties:
      std::string key = property->getName().string();

      if ( traceDebug() )
      {
         ossimString value;
         property->valueToString(value);

         ossimNotify(ossimNotifyLevel_DEBUG)
            << "ossimWriter::setProperty DEBUG:"
            << "\nkey:   " << key
            << "\nvalue: " << value << "\n";
      }
      
      if ( ( key == ALIGN_TILES_KW ) ||
           ( key == BLOCK_SIZE_KW )  ||
           ( key == FLUSH_TILES_KW ) ||
           ( key == INCLUDE_BLANK_TILES_KW ) )
      {
         ossimString value;
         property->valueToString(value);
         m_kwl->addPair( key, value.string(), true );
      }
      else if ( key == TILE_SIZE_KW )
      {
         // Comes in as a single int, e.g.: 256
         ossimString value;
         property->valueToString(value);
         m_outputTileSize.x = value.toInt32();
         m_outputTileSize.y = m_outputTileSize.x;

         // Store in keywordlist / save state as a point, e.g.: ( 256, 256 )
         m_kwl->addPair( key,  m_outputTileSize.toString().string(), true );
      }
      else
      {
         ossimImageFileWriter::setProperty(property);
      }
   }
}

setTileSize()

void ossimWriter::setTileSize ( const ossimIpt &  tileSize )

virtual

Sets the output tile size for tiled formats.

Parameters

tileSize

Must be a multiple of 16.

Reimplemented from ossimImageFileWriter.

Definition at line 986 of file ossimWriter.cpp.

References ossimIpt::x, and ossimIpt::y.

{
   if ( (tileSize.x % 16) || (tileSize.y % 16) )
   {
      if(traceDebug())
      {
         ossimNotify(ossimNotifyLevel_DEBUG)
                  << "ossimWriter::setTileSize ERROR:"
                  << "\nTile size must be a multiple of 16!"
                  << "\nSize remains:  " << m_outputTileSize
                  << std::endl;
      }
   }
   else
   {
      m_outputTileSize = tileSize;

      // For save state:
      m_kwl->addPair( TILE_SIZE_KW, m_outputTileSize.toString().string() );
   }
}

writeFile()

bool ossimWriter::writeFile ( )

protectedvirtual

Write out the file.

Returns

true on success, false on error.

Implements ossimImageFileWriter.

Definition at line 149 of file ossimWriter.cpp.

References close(), ossimErrorStatusInterface::getErrorStatus(), ossimImageSourceSequencer::isMaster(), isOpen(), open(), ossimErrorCodes::OSSIM_OK, status, ossimImageFileWriter::theInputConnection, ossimRefPtr< T >::valid(), and writeStream().

{
   bool status = true;
   
   if( theInputConnection.valid() &&
       (getErrorStatus() == ossimErrorCodes::OSSIM_OK) )
   {
      //---
      // Check for stream if master process.
      // Note only the master process is used for writing...
      //---
      if( theInputConnection->isMaster() )
      {
         if (!isOpen())
         {
            status = open();
         }
      }

      if ( status )
      {
         status = writeStream();

         // Flush and close the stream.
         close();
      }
   }

   return status;
}

writeMinMaxTiffTags()

bool ossimWriter::writeMinMaxTiffTags ( std::streamoff &  arrayWritePos )

private

Writes tags TIFFTAG_MINSAMPLEVALUE(280) and TIFFTAG_MAXSAMPLEVALUE(281).

Only written if scalar type is an unsigned byte or short.

Returns

true on success, false on error.

Definition at line 632 of file ossimWriter.cpp.

References ossimImageSourceSequencer::getOutputScalarType(), OSSIM_UINT16, OSSIM_UINT8, OSSIM_USHORT11, OSSIM_USHORT12, OSSIM_USHORT13, OSSIM_USHORT14, OSSIM_USHORT15, ossim::OTIFF_SHORT, ossim::OTIFFTAG_MAXSAMPLEVALUE, ossim::OTIFFTAG_MINSAMPLEVALUE, status, and ossimImageFileWriter::theInputConnection.

Referenced by writeTiffTags().

{
   bool status = true;

   // DEFAULT for OSSIM_UINT32.
   ossim_uint16 minValue = 1;
   ossim_uint16 maxValue = 255;

   switch( theInputConnection->getOutputScalarType() )
   {
      case OSSIM_UINT8:
      {
         break; // defaulted above
      }
      case OSSIM_USHORT11:
      {
         maxValue = 2047;
         break;
      }
      case OSSIM_USHORT12:
      {
         maxValue = 4095;
         break;
      }
      case OSSIM_USHORT13:
      {
         maxValue = 8191;
         break;
      }
      case OSSIM_USHORT14:
      {
         maxValue = 16383;
         break;
      }
      case OSSIM_USHORT15:
      {
         maxValue = 32767;
         break;
      }
      case OSSIM_UINT16:
      {
         maxValue = 65535;
         break;
      }
      default:
         status = false;
   }
   
   if ( status )
   {
      writeTiffTag<ossim_uint16>( ossim::OTIFFTAG_MINSAMPLEVALUE,
                                  ossim::OTIFF_SHORT,
                                  1, &minValue, arrayWritePos );
      writeTiffTag<ossim_uint16>( ossim::OTIFFTAG_MAXSAMPLEVALUE,
                                  ossim::OTIFF_SHORT,
                                  1, &maxValue, arrayWritePos );
   }
   
   return status;
}

writeSMinSMaxTiffTags()

bool ossimWriter::writeSMinSMaxTiffTags ( const std::vector< ossim_float64 > &  minBands, const std::vector< ossim_float64 > &  maxBands, std::streamoff &  arrayWritePos  )

private

Writes tags TIFFTAG_SMINSAMPLEVALUE(340) and TIFFTAG_SMAXSAMPLEVALUE(341).

Only written if scalar type is not an unsigned byte or short.

Parameters

minBands	Array of min values from image write.
maxBands	Array of max values from image write.

Returns

true if tags are written, false if not. A false return is not necessarily an error, just means the tags were not written due to the scalar type.

Definition at line 693 of file ossimWriter.cpp.

References ossimImageSourceSequencer::getOutputScalarType(), OSSIM_FLOAT32, OSSIM_FLOAT64, OSSIM_NORMALIZED_DOUBLE, OSSIM_NORMALIZED_FLOAT, OSSIM_SINT16, OSSIM_UINT32, ossim::OTIFF_FLOAT, ossim::OTIFFTAG_SMAXSAMPLEVALUE, ossim::OTIFFTAG_SMINSAMPLEVALUE, status, and ossimImageFileWriter::theInputConnection.

Referenced by writeTiffTags().

{
   bool status = false;
   
   if(minBands.size() && maxBands.size())
   {
      ossim_float64 minValue = *std::min_element(minBands.begin(), minBands.end());
      ossim_float64 maxValue = *std::max_element(maxBands.begin(), maxBands.end());

      switch( theInputConnection->getOutputScalarType() )
      {
         case OSSIM_SINT16: 
         case OSSIM_UINT32:
         case OSSIM_FLOAT32:
         case OSSIM_FLOAT64:
         case OSSIM_NORMALIZED_FLOAT:
         case OSSIM_NORMALIZED_DOUBLE:
         {
            ossim_float32 v = static_cast<ossim_float32>(minValue);
            writeTiffTag<ossim_float32>( ossim::OTIFFTAG_SMINSAMPLEVALUE,
                                         ossim::OTIFF_FLOAT,
                                         1, &v, arrayWritePos );
            v = static_cast<ossim_float32>(maxValue);
            writeTiffTag<ossim_float32>( ossim::OTIFFTAG_SMAXSAMPLEVALUE,
                                         ossim::OTIFF_FLOAT,
                                         1, &v, arrayWritePos );
            status = true;
            break;
         }
         default:
         {
            break;
         }
      }
   }
   return status;
}

writeStream()

bool ossimWriter::writeStream ( )

virtual

Method to write the image to a stream.

Returns

true on success, false on error.

Reimplemented from ossimImageFileWriter.

Definition at line 180 of file ossimWriter.cpp.

References ossimImageSourceSequencer::getTileHeight(), ossimImageSourceSequencer::getTileWidth(), isOpen(), m_outputTileSize, ossimImageSourceSequencer::setTileSize(), status, ossimImageFileWriter::theInputConnection, ossimImageFileWriter::theOutputImageType, ossimRefPtr< T >::valid(), writeStreamTtbs(), ossimIpt::x, and ossimIpt::y.

Referenced by writeFile().

{
   //---
   // This can be called publically so we must to the same checks as the
   // writeFile method.
   //---
   bool status = false;

   // Must have a sequencer...
   if( theInputConnection.valid() )
   {
      if ( isOpen() )
      {
         if ( theOutputImageType == "ossim_ttbs" )
         {
            if ( (theInputConnection->getTileWidth()  !=
                  static_cast<ossim_uint32>(m_outputTileSize.x)) ||
                 (theInputConnection->getTileHeight() !=
                  static_cast<ossim_uint32>(m_outputTileSize.y)) )
            {
               theInputConnection->setTileSize(m_outputTileSize);
            }
            
            status = writeStreamTtbs();
         }
      }
   }
   
   return status;
}

writeStreamTtbs()

bool ossimWriter::writeStreamTtbs ( )

private

Writes a tiled tiff band separate to stream.

Returns

true on success, false on error.

Definition at line 211 of file ossimWriter.cpp.

References status, writeTiffHdr(), writeTiffTags(), and writeTiffTilesBandSeparate().

Referenced by writeStream().

{
   // Alway big tiff in native byte order.
   
   bool status = false;

   if ( writeTiffHdr() == true )
   {
      std::vector<ossim_uint64>  tile_offsets;
      std::vector<ossim_uint64>  tile_byte_counts;

      //---
      // Min/max arrays must start off empty for
      // ossimImageData::computeMinMaxPix code.
      //---
      std::vector<ossim_float64> minBands(0);
      std::vector<ossim_float64> maxBands(0);
      
      if ( writeTiffTilesBandSeparate(
              tile_offsets, tile_byte_counts, minBands, maxBands   ) == true )
      {
         status = writeTiffTags( tile_offsets, tile_byte_counts, minBands, maxBands );
      }
   }
   
   return status;
}

writeTiffHdr()

bool ossimWriter::writeTiffHdr ( )

private

Writes tiff header to stream.

Returns

true on success, false on error.

Definition at line 239 of file ossimWriter.cpp.

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

Referenced by writeStreamTtbs().

{
   //---
   // First two bytes, byte order indication.
   // "MM"(big endian) or "II"(little endian.
   //---
   std::string s;
   if ( ossim::byteOrder() == OSSIM_LITTLE_ENDIAN )
   {
      s = "II";
   }
   else
   {
      s = "MM";
   }
   m_str->write( s.c_str(), 2 );

   // Version, 42=classic tiff, 43=big tiff.
   ossim_uint16 us16 = 43;
   m_str->write( (const char*)&us16, 2 );

   // Byte size of offsets.
   us16 = 8;
   m_str->write( (const char*)&us16, 2 );

   // Always 0:
   us16 = 0;
   m_str->write( (const char*)&us16, 2 );

   // Offset to the IFD(image file directory).
   ossim_uint64 ul64 = 16;
   m_str->write( (const char*)&ul64, 8 );
   
   return m_str->good();
}

writeTiffTag()

template<class T >

void ossimWriter::writeTiffTag ( ossim_uint16  tag, ossim_uint16  type, ossim_uint64  count, const T *  value, std::streamoff &  arrayWritePos  )

private

Writes tiff tag to image file directory(IFD).

Parameters

tag
type
count
value(s)	or offset to array.
arrayWritePos	Position to write array to. This will be updated if array is written with new offset.

Definition at line 734 of file ossimWriter.cpp.

References m_str.

{
   m_str->write( (const char*)&tag, 2 );
   m_str->write( (const char*)&type, 2 );
   m_str->write( (const char*)&count, 8 );

   ossim_uint64 bytes = sizeof( T ) * count;
   
   if ( bytes <= 8 )
   {
      m_str->write( (const char*)value, bytes );
      if ( bytes < 8 )
      {
         // Fill remaining bytes with 0.
         char c = '\0';
         m_str->write( (const char*)&c, (8-bytes) );
      }
   }
   else // Greater than 8 bytes, must write at end of file.
   {
      // Store the offset to array:
      m_str->write( (const char*)&arrayWritePos, 8 );

      // Capture posistion:
      std::streamoff currentPos = m_str->tellp();

      // Seek to end:
      m_str->seekp( arrayWritePos, std::ios_base::beg );
      
      // Write:
      m_str->write( (const char*)value, bytes );

      // Capture new offset for next array write.
      arrayWritePos = m_str->tellp();

      // Seek back:
      m_str->seekp( currentPos, std::ios_base::beg );
   }
}

writeTiffTags()

bool ossimWriter::writeTiffTags ( const std::vector< ossim_uint64 > &  tile_offsets, const std::vector< ossim_uint64 > &  tile_byte_counts, const std::vector< ossim_float64 > &  minBands, const std::vector< ossim_float64 > &  maxBands  )

private

Writes tags to image file directory(IFD).

Parameters

tile_offsets
tile_byte_counts
minBands
maxBands

Returns

true on success, false on error.

Definition at line 275 of file ossimWriter.cpp.

References ossimEllipsoid::a(), ossimEllipsoid::b(), ossim::COMPRESSION_NONE, ossimDatum::ellipsoid(), ossimDatum::epsgCode(), ossimRefPtr< T >::get(), ossim::getBitsPerPixel(), ossimMapProjection::getDatum(), ossimMapProjection::getDecimalDegreesPerPixel(), ossimEllipsoid::getEpsgCode(), ossimImageSource::getImageGeometry(), ossimMapProjection::getMetersPerPixel(), ossimImageSource::getNumberOfOutputBands(), ossimImageSourceSequencer::getOutputScalarType(), ossimMapProjection::getPcsCode(), ossimImageGeometry::getProjection(), getTiffSampleFormat(), ossimIrect::height(), ossimMapProjection::isGeographic(), isTiled(), ossimGpt::lat, ossimMapProjection::lineSampleToEastingNorthing(), ossimMapProjection::lineSampleToWorld(), ossimGpt::lon, m_outputTileSize, m_str, ossim::OANGULAR_DEGREE, ossim::OGEO_DOUBLE_PARAMS_TAG, ossim::OGEO_KEY_DIRECTORY_TAG, ossim::OGEOG_ANGULAR_UNITS_GEO_KEY, ossim::OGEOG_ELLIPSOID_GEO_KEY, ossim::OGEOG_GEODETIC_DATUM_GEO_KEY, ossim::OGEOG_SEMI_MAJOR_AXIS, ossim::OGEOG_SEMI_MINOR_AXIS, ossim::OGEOGRAPHIC_TYPE_GEO_KEY, ossim::OGT_MODEL_TYPE_GEO_KEY, ossim::OGT_RASTER_TYPE_GEO_KEY, ossim::OLINEAR_METER, ossim::OMODEL_PIXEL_SCALE_TAG, ossim::OMODEL_TIE_POINT_TAG, ossim::OMODEL_TYPE_GEOGRAPHIC, ossim::OMODEL_TYPE_PROJECTED, ossim::OPHOTO_MINISBLACK, ossim::OPHOTO_RGB, ossim::OPIXEL_IS_POINT, ossim::OPROJ_LINEAR_UNITS_GEO_KEY, ossim::OPROJECTED_CS_TYPE_GEO_KEY, ossim::OPROJECTION_GEO_KEY, OSSIM_DEFAULT_MAX_PIX_UINT16, ossim::OTIFF_DOUBLE, ossim::OTIFF_LONG, ossim::OTIFF_LONG8, ossim::OTIFF_SHORT, ossim::OTIFFTAG_BITSPERSAMPLE, ossim::OTIFFTAG_COMPRESSION, ossim::OTIFFTAG_IMAGELENGTH, ossim::OTIFFTAG_IMAGEWIDTH, ossim::OTIFFTAG_PHOTOMETRIC, ossim::OTIFFTAG_PLANARCONFIG, ossim::OTIFFTAG_PLANARCONFIG_SEPARATE, ossim::OTIFFTAG_SAMPLEFORMAT, ossim::OTIFFTAG_SAMPLESPERPIXEL, ossim::OTIFFTAG_TILEBYTECOUNTS, ossim::OTIFFTAG_TILELENGTH, ossim::OTIFFTAG_TILEOFFSETS, ossim::OTIFFTAG_TILEWIDTH, status, ossimImageWriter::theAreaOfInterest, ossimImageFileWriter::theInputConnection, true, ossimIrect::ul(), ossimRefPtr< T >::valid(), ossimIrect::width(), writeMinMaxTiffTags(), writeSMinSMaxTiffTags(), ossimIpt::x, ossimDpt::x, ossimIpt::y, and ossimDpt::y.

Referenced by writeStreamTtbs().

{
   bool status = false;

   ossimRefPtr<ossimMapProjection> mapProj = 0;
   ossimRefPtr<ossimImageGeometry> geom = theInputConnection->getImageGeometry();
   if ( geom.valid() )
   {
      ossimRefPtr<ossimProjection> proj = geom->getProjection();
      mapProj = dynamic_cast<ossimMapProjection*>( proj.get() );
   }
   
   // Seek to the IFD.
   m_str->seekp( 16, std::ios_base::beg );
   
   // tag count, this will be rewritten at the end:
   ossim_uint64 tagCount = 0;
   m_str->write( (const char*)&tagCount, 8 );

   //---
   // This is where the tile offsets, tile byte counts and arrays bytes are
   // written. Starting at byte position 512 which gives from
   // 16 -> 512(496 bytes) to write tags.
   //---
   std::streamoff arrayWritePos = 512;

   // Used throughout:
   ossim_uint16 tag;
   ossim_uint16 type;
   ossim_uint64 count;
   ossim_uint16 value_ui16;
   ossim_uint32 value_ui32;
   
   // image width tag 256:
   tag   = ossim::OTIFFTAG_IMAGEWIDTH;
   count = 1;
   if ( theAreaOfInterest.width() <= OSSIM_DEFAULT_MAX_PIX_UINT16 )
   {
      type = ossim::OTIFF_SHORT;
      value_ui16 = (ossim_uint16)theAreaOfInterest.width();
      writeTiffTag<ossim_uint16>( tag, type, count, &value_ui16, arrayWritePos );
   }
   else
   {
      type = ossim::OTIFF_LONG;
      value_ui32 = theAreaOfInterest.width();
      writeTiffTag<ossim_uint32>( tag, type, count, &value_ui32, arrayWritePos );
   }
   ++tagCount;
   
   // image length tag 257:
   tag   = ossim::OTIFFTAG_IMAGELENGTH;
   count = 1;
   if ( theAreaOfInterest.height() <= OSSIM_DEFAULT_MAX_PIX_UINT16 )
   {
      type = ossim::OTIFF_SHORT;
      value_ui16 = (ossim_uint16)theAreaOfInterest.height();
      writeTiffTag<ossim_uint16>( tag, type, count, &value_ui16, arrayWritePos );
   }
   else
   {
      type = ossim::OTIFF_LONG;
      value_ui32 = theAreaOfInterest.height();
      writeTiffTag<ossim_uint32>( tag, type, count, &value_ui32, arrayWritePos );
   }
   ++tagCount;

   // bits per sample tag 258:
   tag   = ossim::OTIFFTAG_BITSPERSAMPLE;
   count = theInputConnection->getNumberOfOutputBands();
   type  = ossim::OTIFF_SHORT;
   value_ui16 = (ossim_uint16)ossim::getBitsPerPixel( theInputConnection->getOutputScalarType() );
   if ( count == 1 )
   {
      writeTiffTag<ossim_uint16>( tag, type, count, &value_ui16, arrayWritePos );
   }
   else
   {
      std::vector<ossim_uint16> v(count, value_ui16);
      writeTiffTag<ossim_uint16>( tag, type, count, &v.front(), arrayWritePos );
   }
   ++tagCount;

   // compression tag 259:
   tag   = ossim::OTIFFTAG_COMPRESSION;
   type  = ossim::OTIFF_SHORT;
   count = 1;
   value_ui16 = ossim::COMPRESSION_NONE; // tmp only uncompressed supported.
   writeTiffTag<ossim_uint16>( tag, type, count, &value_ui16, arrayWritePos );
   ++tagCount;
   
   // photo interpretation tag 262:
   tag   = ossim::OTIFFTAG_PHOTOMETRIC;
   type  = ossim::OTIFF_SHORT;
   count = 1;
   if ( theInputConnection->getNumberOfOutputBands() == 3 )
   {
      value_ui16 = ossim::OPHOTO_RGB;
   }
   else
   {
      value_ui16 = ossim::OPHOTO_MINISBLACK;
   }
   writeTiffTag<ossim_uint16>( tag, type, count, &value_ui16, arrayWritePos );
   ++tagCount;

   // samples per pixel tag 277:
   tag   = ossim::OTIFFTAG_SAMPLESPERPIXEL;
   type  = ossim::OTIFF_SHORT;
   count = 1;
   value_ui16 = theInputConnection->getNumberOfOutputBands();
   writeTiffTag<ossim_uint16>( tag, type, count, &value_ui16, arrayWritePos );
   ++tagCount;

   // Writes two tags 280 and 281:
   if ( writeMinMaxTiffTags( arrayWritePos ) == true )
   {
      tagCount += 2;  
   }
   
   // planar conf tag 284:
   tag   = ossim::OTIFFTAG_PLANARCONFIG;
   type  = ossim::OTIFF_SHORT;
   count = 1;
   value_ui16 = ossim::OTIFFTAG_PLANARCONFIG_SEPARATE;
   writeTiffTag<ossim_uint16>( tag, type, count, &value_ui16, arrayWritePos );
   ++tagCount;

   if ( isTiled() )
   {
      // tile width tag 322:
      tag   = ossim::OTIFFTAG_TILEWIDTH;
      count = 1;
      if (  m_outputTileSize.x <= OSSIM_DEFAULT_MAX_PIX_UINT16 )
      {
         type = ossim::OTIFF_SHORT;
         value_ui16 = (ossim_uint16)m_outputTileSize.x;
         writeTiffTag<ossim_uint16>( tag, type, count, &value_ui16, arrayWritePos );
      }
      else
      {
         type = ossim::OTIFF_LONG;
         value_ui32 = (ossim_uint32)m_outputTileSize.x;
         writeTiffTag<ossim_uint32>( tag, type, count, &value_ui32, arrayWritePos );
      }
      ++tagCount;
      
      // tile length tag 323:
      tag   = ossim::OTIFFTAG_TILELENGTH;
      count = 1;
      if (  m_outputTileSize.y <= OSSIM_DEFAULT_MAX_PIX_UINT16 )
      {
         type = ossim::OTIFF_SHORT;
         value_ui16 = (ossim_uint16)m_outputTileSize.y;
         writeTiffTag<ossim_uint16>( tag, type, count, &value_ui16, arrayWritePos );
      }
      else
      {
         type = ossim::OTIFF_LONG;
         value_ui32 = (ossim_uint32)m_outputTileSize.y;
         writeTiffTag<ossim_uint32>( tag, type, count, &value_ui32, arrayWritePos );
      }
      ++tagCount;
   }

   // tile offsets tag 324:
   tag   = ossim::OTIFFTAG_TILEOFFSETS;
   count = tile_offsets.size();
   type  = ossim::OTIFF_LONG8;
   writeTiffTag<ossim_uint64>( tag, type, count, &tile_offsets.front(), arrayWritePos );
   ++tagCount;

   // tile byte counts tag 325:
   tag   = ossim::OTIFFTAG_TILEBYTECOUNTS;
   count = tile_byte_counts.size();
   type  = ossim::OTIFF_LONG8;
   writeTiffTag<ossim_uint64>( tag, type, count, &tile_byte_counts.front(), arrayWritePos );
   ++tagCount;

   // sample format tag 339:
   tag   = ossim::OTIFFTAG_SAMPLEFORMAT;
   count = theInputConnection->getNumberOfOutputBands();
   type  = ossim::OTIFF_SHORT;
   value_ui16 = getTiffSampleFormat();
   if ( count == 1 )
   {
      writeTiffTag<ossim_uint16>( tag, type, count, &value_ui16, arrayWritePos );
   }
   else
   {
      std::vector<ossim_uint16> v(count, value_ui16);
      writeTiffTag<ossim_uint16>( tag, type, count, &v.front(), arrayWritePos );
   }
   ++tagCount;

   // Writes two tags 340 and 341 (conditional on scalar type):
   if ( writeSMinSMaxTiffTags( minBands, maxBands, arrayWritePos ) == true )
   {
      tagCount += 2;
   }

   // Write geo keys if valid map projection:
   if ( mapProj.valid() )
   {
      std::vector<ossim_float64> vf;
      ossimDpt scale;
      ossimDpt tie;
      
      if ( mapProj->isGeographic() )
      {
         ossimGpt gpt;
         mapProj->lineSampleToWorld( theAreaOfInterest.ul(), gpt );
         tie.x = gpt.lon;
         tie.y = gpt.lat;
         scale = mapProj->getDecimalDegreesPerPixel();
      }
      else
      {
         mapProj->lineSampleToEastingNorthing( theAreaOfInterest.ul(), tie );
         scale = mapProj->getMetersPerPixel();
      }
      
      // model pixel scale tag 33550:
      tag   = ossim::OMODEL_PIXEL_SCALE_TAG;
      count = 3; // x, y, z
      type  = ossim::OTIFF_DOUBLE;
      vf.resize( count );
      vf[0] = scale.x;
      vf[1] = scale.y;
      vf[2] = 0.0;
      writeTiffTag<ossim_float64>( tag, type, count, &vf.front(), arrayWritePos );
      ++tagCount;

      // model tie point tag 33992:
      tag   = ossim::OMODEL_TIE_POINT_TAG;
      count = 6; // x, y, z
      type  = ossim::OTIFF_DOUBLE;
      vf.resize( count );
      vf[0] = 0.0;   // x image point
      vf[1] = 0.0;   // y image point
      vf[2] = 0.0;   // z image point
      vf[3] = tie.x; // longitude or easting
      vf[4] = tie.y; // latitude of northing
      vf[5] = 0.0;
      writeTiffTag<ossim_float64>( tag, type, count, &vf.front(), arrayWritePos );
      ++tagCount;

      // geo key directory tag 34735:
      tag   = ossim::OGEO_KEY_DIRECTORY_TAG;
      count = 0; // set later.
      type  = ossim::OTIFF_SHORT;
      std::vector<ossim_uint16> vs(0);

      // No
      vs.push_back(1);
      vs.push_back(1);
      vs.push_back(0);
      vs.push_back(10); // Updated later.

      vs.push_back(ossim::OGT_MODEL_TYPE_GEO_KEY); // 1024
      vs.push_back(0);
      vs.push_back(1);
      vs.push_back(mapProj->isGeographic() ? ossim::OMODEL_TYPE_GEOGRAPHIC :
                   ossim::OMODEL_TYPE_PROJECTED);

      vs.push_back(ossim::OGT_RASTER_TYPE_GEO_KEY); // 1025
      vs.push_back(0);
      vs.push_back(1);
      vs.push_back(ossim::OPIXEL_IS_POINT);

      if ( mapProj->isGeographic() )
      {
         vs.push_back(ossim::OGEOGRAPHIC_TYPE_GEO_KEY); // 2048
         vs.push_back(0);
         vs.push_back(1);
         vs.push_back((ossim_uint16)(mapProj->getPcsCode()));
      }

      vs.push_back(ossim::OGEOG_GEODETIC_DATUM_GEO_KEY); // 2050
      vs.push_back(0);
      vs.push_back(1);
      vs.push_back((ossim_uint16)(mapProj->getDatum()->epsgCode()));

      if ( mapProj->isGeographic() )
      {
         vs.push_back(ossim::OGEOG_ANGULAR_UNITS_GEO_KEY); // 2054
         vs.push_back(0);
         vs.push_back(1);
         vs.push_back(ossim::OANGULAR_DEGREE);
      }
         
      vs.push_back(ossim::OGEOG_ELLIPSOID_GEO_KEY); // 2056
      vs.push_back(0);
      vs.push_back(1);
      vs.push_back((ossim_uint16)(mapProj->getDatum()->ellipsoid()->getEpsgCode()));

      // Stored in external OOGEO_DOUBLE_PARAMS_TAG
      vs.push_back(ossim::OGEOG_SEMI_MAJOR_AXIS); // 2057
      vs.push_back(ossim::OGEO_DOUBLE_PARAMS_TAG); 
      vs.push_back(1);
      vs.push_back(0);
         
      vs.push_back(ossim::OGEOG_SEMI_MINOR_AXIS); // 2058
      vs.push_back(ossim::OGEO_DOUBLE_PARAMS_TAG);
      vs.push_back(1);
      vs.push_back(1);

      vs.push_back(ossim::OPROJECTED_CS_TYPE_GEO_KEY); // 3072
      vs.push_back(0);
      vs.push_back(1);
      vs.push_back((ossim_uint16)(mapProj->getPcsCode()));

      vs.push_back(ossim::OPROJECTION_GEO_KEY); // 3074
      vs.push_back(0);
      vs.push_back(1);
      vs.push_back((ossim_uint16)(mapProj->getPcsCode()));

      if ( mapProj->isGeographic() == false )
      {
         vs.push_back(ossim::OPROJ_LINEAR_UNITS_GEO_KEY); // 3076
         vs.push_back(0);
         vs.push_back(1);
         vs.push_back(ossim::OLINEAR_METER);
      }
      
      count = vs.size();
      vs[3] = (count / 4) - 1;
      writeTiffTag<ossim_uint16>( tag, type, count, &vs.front(), arrayWritePos );
      ++tagCount;
       
      // geo double params tag 33550:
      tag   = ossim::OGEO_DOUBLE_PARAMS_TAG;
      count = 2; // ellipsoid major, minor axis
      type  = ossim::OTIFF_DOUBLE;
      vf.resize( count );
      vf[0] = mapProj->getDatum()->ellipsoid()->a();
      vf[1] = mapProj->getDatum()->ellipsoid()->b();
      writeTiffTag<ossim_float64>( tag, type, count, &vf.front(), arrayWritePos );
      ++tagCount;
   }

   // Write trailing zero indicading no more IFDs.
   ossim_uint64 offsetToNextIfd = 0;
   m_str->write( (const char*)&offsetToNextIfd, 8 );

   // Seek back and re-write the tag count.
   m_str->seekp( 16, std::ios_base::beg );
   m_str->write( (const char*)&tagCount, 8 );
   
   status =  m_str->good();
   
   return status;
}

writeTiffTilesBandSeparate()

bool ossimWriter::writeTiffTilesBandSeparate ( std::vector< ossim_uint64 > &  tile_offsets, std::vector< ossim_uint64 > &  tile_byte_counts, std::vector< ossim_float64 > &  minBands, std::vector< ossim_float64 > &  maxBands  )

private

Writes image data to stream.

Data is in a band separate tile layout(PLANARCONFIG_SEPARATE), i.e. all the red tiles, all the green tiles, all the blue tiles.

Parameters

tile_offsets	Initialized by this with offset for each tile.
tile_byte_counts	Initialized by this with the byte count of each tile.
minBands	Initialized by this with the min values for each band.
maxBands	Initialized by this with the max values for each band.

Returns

true on success, false on error.

Definition at line 776 of file ossimWriter.cpp.

Referenced by writeStreamTtbs().

{
   static const char* const MODULE = "ossimWriter::writeToTilesBandSeparate";
   if ( traceDebug() ) CLOG << " Entered...\n";

   // Start the sequence at the first tile.
   theInputConnection->setToStartOfSequence();

   // Control flags:
   bool alignTiles    = getAlignTilesFlag();
   bool flushTiles    = getFlushTilesFlag();
   bool writeBlanks   = getWriteBlanksFlag();
   bool computeMinMax = needsMinMax();

   // Block size for write:
   const std::streamsize BLOCK_SIZE = getBlockSize();
   
   const ossim_int32 BANDS       = (ossim_int32)theInputConnection->getNumberOfOutputBands();
   const ossim_int32 TILES_WIDE  = (ossim_int32)theInputConnection->getNumberOfTilesHorizontal();
   const ossim_int32 TILES_TOTAL = (ossim_int32)theInputConnection->getNumberOfTiles();

   if (traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "align tiles flag:     " << alignTiles
         << "\nflush tiles flag:     " << flushTiles
         << "\nwrite blanks flag:    " << writeBlanks
         << "\ncompute min max flag: " << computeMinMax
         << "\nwrite block size:     " << BLOCK_SIZE
         << "\nBANDS:                " << BANDS
         << "\nTILES_WIDE:           " << TILES_WIDE
         << "\nTILES_TOTAL:          " << TILES_TOTAL << "\n";
   }

   tile_offsets.resize( TILES_TOTAL*BANDS );
   tile_byte_counts.resize( TILES_TOTAL*BANDS );

   ossimDataObjectStatus tileStatus = OSSIM_STATUS_UNKNOWN;
   ossim_int64 ossimTileIndex    = 0;
   ossim_int64 tiffTileIndex     = 0;
   ossim_int64 tileSizeInBytes   = 0;
   ossim_int64 bandOffsetInBytes = 0;

   //---
   // Adjust the starting file position to make room for IFD tags, tile offset
   // and tile byte counts and arrays.
   //
   // Assuming:
   // IFD start = 16, end 512, gives 496 bytes for tags.
   // Array section start = 512, end is start + (16 * tile_count * bands) + 256 bytes
   // for geotiff array bytes.
   //---
   std::streamsize startPos = 512 + 16 * TILES_TOTAL * BANDS + 256;
   
   while ( ossimTileIndex < TILES_TOTAL )
   {
      ossimRefPtr<ossimImageData> id = theInputConnection->getNextTile();
      if(!id)
      {
         ossimNotify(ossimNotifyLevel_WARN)
            << MODULE << " ERROR:"
            << "Error returned writing tiff tile:  " << ossimTileIndex
            << "\nNULL Tile from input encountered"
            << std::endl;
         return false;
      }

      tileStatus = id->getDataObjectStatus();
      
      if ( ossimTileIndex == 0 )
      {
         tileSizeInBytes = (ossim_int64)id->getSizePerBandInBytes();
         bandOffsetInBytes = tileSizeInBytes * TILES_TOTAL;
      }

      if ( computeMinMax )
      {
         if ( (tileStatus == OSSIM_FULL) || (tileStatus == OSSIM_PARTIAL) )
         {
            // Compute running min, max.
            id->computeMinMaxPix(minBands, maxBands);
         }
      }
      
      // Band loop.
      for (ossim_int32 band=0; band < BANDS; ++band)
      {
         tiffTileIndex = ossimTileIndex + band * TILES_TOTAL;
         
         if ( (writeBlanks == true) || (tileStatus == OSSIM_FULL) || (tileStatus == OSSIM_PARTIAL) )
         {
            // Grab a pointer to the tile for the band.
            const char* data = (const char*)id->getBuf(band);
            
            // Compress data here(future maybe, i.e. jpeg, j2k...
            
            //---
            // Write the tile.
            // Note: tiles laid out, all the red tiles, all the green tiles all the
            // blue tiles.
            //---
            if(data)
            {
               // Compute the stream position:
               std::streampos pos = startPos + ossimTileIndex * tileSizeInBytes +
                  band * bandOffsetInBytes;
               
               if ( alignTiles )
               {
                  // Snap to block boundary:
                  std::streampos overflow = pos % BLOCK_SIZE;
                  if ( overflow > 0 )
                  {
                     pos += BLOCK_SIZE - overflow;
                  }
               }
               
               m_str->seekp( pos );
               
               if ( m_str->good() )
               { 
                  tile_offsets[ tiffTileIndex ] = (ossim_uint64)pos;
                  tile_byte_counts[ tiffTileIndex ] = (ossim_uint64)tileSizeInBytes;

                  // Write the tile to stream:
                  m_str->write( data, (std::streamsize)tileSizeInBytes);

                  if ( flushTiles )
                  {
                     m_str->flush();
                  }
                  
                  // Check stream:
                  if ( m_str->fail() == true )
                  {
                     ossimNotify(ossimNotifyLevel_DEBUG)
                        << MODULE << " ERROR:\nWrite error on tiff tile:  " << ossimTileIndex
                        << std::endl;
                     return false;
                  }
               }
               else
               {
                  ossimNotify(ossimNotifyLevel_DEBUG)
                     << MODULE << " ERROR:\nStream has gone bad!" << std::endl;
                  return false;
               }
               
            }
            else
            {
               ossimNotify(ossimNotifyLevel_WARN)
                  << MODULE << " ERROR:\nNull input tile:  " << ossimTileIndex
                  << std::endl;
               return false;
            }
         }
         else
         {
            //---
            // Writing sparse tiff.
            // Set the offset and byte count to 0 to indicate blank tile.
            //---
            if (traceDebug())
            {
               ossimNotify(ossimNotifyLevel_DEBUG)
                  << "sparse blank tile[" << tiffTileIndex << "]: " << tiffTileIndex << "\n";
            }
            tile_offsets[ tiffTileIndex ] = 0;
            tile_byte_counts[ tiffTileIndex ] = 0;
         }
         
      } // End of band loop.

      ++ossimTileIndex;

      if( needsAborting() )
      {
         setPercentComplete(100);
         break; // Get out...
      }
      else if ( ossimTileIndex % TILES_WIDE )
      {
         // Output percent complete every row of tiles.
         double tileNum = ossimTileIndex;
         double numTiles = TILES_TOTAL;
         setPercentComplete(tileNum / numTiles * 100.0);
      }
      
   } // End: while ( ossimTileIndex < TILES_TOTAL )

   if ( traceDebug() ) CLOG << " Exited...\n";
   
   return m_str->good();
}

Member Data Documentation

m_kwl

ossimRefPtr<ossimKeywordlist> ossimWriter::m_kwl

private

Hold all options.

Definition at line 293 of file ossimWriter.h.

Referenced by getAlignTilesFlag(), getBlockSize(), getFlushTilesFlag(), getWriteBlanksFlag(), ossimWriter(), saveState(), and ~ossimWriter().

m_outputTileSize

ossimIpt ossimWriter::m_outputTileSize

private

Definition at line 295 of file ossimWriter.h.

Referenced by getOutputTileSize(), ossimWriter(), writeStream(), and writeTiffTags().

m_ownsStreamFlag

bool ossimWriter::m_ownsStreamFlag

private

Definition at line 290 of file ossimWriter.h.

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

m_str

std::ostream* ossimWriter::m_str

private

Definition at line 289 of file ossimWriter.h.

Referenced by close(), isOpen(), open(), setOutputStream(), writeTiffHdr(), writeTiffTag(), and writeTiffTags().

---

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

• ossimWriter.h
• ossimWriter.cpp