#include <ossimGeneralRasterWriter.h>

Inheritance diagram for ossimGeneralRasterWriter:

Public Member Functions
	ossimGeneralRasterWriter ()
	default constructor More...

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

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	set_rr_level (ossim_uint32 rr)

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 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 bool	hasImageType (const ossimString &imageType) const
	bool hasImageType(const ossimString& imageType) const 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 void	setProperty (ossimRefPtr< ossimProperty > property)

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

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

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 ossimString	getShortName () const

virtual ossimString	getLongName () const

virtual ossimString	getClassName () const

virtual RTTItypeid	getType () const

virtual bool	canCastTo (ossimObject *obj) const

virtual bool	canCastTo (const RTTItypeid &id) const

virtual bool	canCastTo (const ossimString &parentClassName) const

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

Public Member Functions inherited from ossimReferenced
	ossimReferenced ()

	ossimReferenced (const ossimReferenced &)

ossimReferenced &	operator= (const ossimReferenced &)

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

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

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

int	referenceCount () const

Public Member Functions inherited from ossimListenerManager
	ossimListenerManager ()

virtual	~ossimListenerManager ()

virtual void	fireEvent (ossimEvent &event)

virtual bool	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...

virtual	~ossimGeneralRasterWriter ()
	Protected ( this is a ossimRefPtr) destructor. 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	writeToBip ()
	Writes image data to output file in BIP(Band Interleaved by Pixel) format. More...

bool	writeToBil ()
	Writes image data to output file in BIL(Band Interleaved by Line) format. More...

bool	writeToBsq ()
	Writes image data to output file in BSQ(Band Sequential) format. More...

void	writeHeader () const
	Writes an ossim header file which can be used to load file in ossim. More...

void	writeEnviHeader () const
	Writes an envi header file which can be used to load file in envi. More...

ossimString	getInterleaveString () const

Private Attributes
std::ostream *	theOutputStream

bool	theOwnsStreamFlag

ossim_uint32	theRlevel

ossimByteOrder	theOutputByteOrder

std::vector< double >	theMinPerBand
	Populated while writting the data. More...

std::vector< double >	theMaxPerBand

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

Definition at line 25 of file ossimGeneralRasterWriter.h.

Constructor & Destructor Documentation

◆ ossimGeneralRasterWriter()

ossimGeneralRasterWriter::ossimGeneralRasterWriter ( )

default constructor

Definition at line 35 of file ossimGeneralRasterWriter.cpp.

References ossimEndian::getSystemEndianType(), OSSIM_GENERAL_RASTER_BSQ, ossimImageFileWriter::setOutputImageType(), ossimImageFileWriter::setWriteExternalGeometryFlag(), and theOutputByteOrder.

    :
       ossimImageFileWriter(),
       theOutputStream(0),
       theOwnsStreamFlag(false),
       theRlevel(0),
       theOutputByteOrder(OSSIM_LITTLE_ENDIAN),
       theMinPerBand(0),
       theMaxPerBand(0)
 {
   setOutputImageType(OSSIM_GENERAL_RASTER_BSQ);
 
   // Since there is no internal geometry set the flag to write out one.
   setWriteExternalGeometryFlag(true);
   theOutputByteOrder = ossimEndian().getSystemEndianType();
 }

◆ ~ossimGeneralRasterWriter()

ossimGeneralRasterWriter::~ossimGeneralRasterWriter ( )

protectedvirtual

Protected ( this is a ossimRefPtr) destructor.

Definition at line 52 of file ossimGeneralRasterWriter.cpp.

References close(), and isOpen().

 {
    if(isOpen())
    {
      close();
    }
 }

Member Function Documentation

◆ close()

void ossimGeneralRasterWriter::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 93 of file ossimGeneralRasterWriter.cpp.

References theOutputStream, and theOwnsStreamFlag.

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

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

◆ getExtension()

ossimString ossimGeneralRasterWriter::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 819 of file ossimGeneralRasterWriter.cpp.

 {
    return "ras";
    //return getInterleaveString();
 }

◆ getImageTypeList()

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

virtual

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

Appends this writer image types to list "imageTypeList".

This writer has the following types: general_raster_bip general_raster_bil general_raster_bsq

Parameters

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

Implements ossimImageFileWriter.

Definition at line 825 of file ossimGeneralRasterWriter.cpp.

 {
    imageTypeList.push_back(ossimString("general_raster_bip"));
    imageTypeList.push_back(ossimString("general_raster_bil"));
    imageTypeList.push_back(ossimString("general_raster_bsq"));
    imageTypeList.push_back(ossimString("general_raster_bip_envi"));
    imageTypeList.push_back(ossimString("general_raster_bil_envi"));
    imageTypeList.push_back(ossimString("general_raster_bsq_envi"));
 }

◆ getInterleaveString()

ossimString ossimGeneralRasterWriter::getInterleaveString ( ) const

private

Returns: The interleave as a string of either: bil, bip, or bsq

Definition at line 835 of file ossimGeneralRasterWriter.cpp.

References ossimImageFileWriter::theOutputImageType.

 {
    ossimString interleaveType = "unknown";
    if ( (theOutputImageType == "general_raster_bip") ||
         (theOutputImageType == "general_raster_bip_envi") )
    {
       interleaveType = "bip";
    }
    else if ( (theOutputImageType == "general_raster_bil") ||
              (theOutputImageType == "general_raster_bil_envi") )
    {
       interleaveType = "bil";
    }
    else if ( (theOutputImageType == "general_raster_bsq") ||
              (theOutputImageType == "general_raster_bsq_envi") )
    {
       interleaveType = "bsq";
    }
    return interleaveType;
 }

◆ isOpen()

bool ossimGeneralRasterWriter::isOpen ( ) const

virtual

Implements ossimOutputSource.

Definition at line 60 of file ossimGeneralRasterWriter.cpp.

References theOutputStream.

Referenced by writeFile(), and ~ossimGeneralRasterWriter().

 {
    return ( theOutputStream ? true : false );
 }

◆ loadState()

bool ossimGeneralRasterWriter::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 651 of file ossimGeneralRasterWriter.cpp.

References ossimKeywordNames::BYTE_ORDER_KW, ossim::byteOrder(), ossimKeywordNames::FILENAME_KW, ossimKeywordlist::find(), ossimEndian::getSystemEndianType(), ossimKeywordNames::INPUT_RR_LEVEL_KW, ossimImageFileWriter::loadState(), OSSIM_BIG_ENDIAN, OSSIM_LITTLE_ENDIAN, ossimImageFileWriter::setFilename(), theOutputByteOrder, ossimImageFileWriter::theOutputImageType, and theRlevel.

 {
    const char* value;
    
    value = kwl.find(prefix, ossimKeywordNames::FILENAME_KW);
    if(value)
    {
       setFilename(ossimFilename(value));
    }
    
    value = kwl.find(prefix, ossimKeywordNames::INPUT_RR_LEVEL_KW);
    if(value)
    {
       theRlevel = atoi(value);
    }
 
    if(ossimImageFileWriter::loadState(kwl, prefix))
    {
       if( (theOutputImageType!="general_raster_bip")      &&
           (theOutputImageType!="general_raster_bil")      &&
           (theOutputImageType!="general_raster_bsq")      &&
           (theOutputImageType!="general_raster_bip_envi") &&
           (theOutputImageType!="general_raster_bil_envi") &&
           (theOutputImageType!="general_raster_bsq_envi")
          )
       {
          theOutputImageType = "general_raster_bsq";
       }
    }
    else
    {
       return false;
    }
    const char* outputByteOrder = kwl.find(prefix, ossimKeywordNames::BYTE_ORDER_KW);
    theOutputByteOrder = ossimEndian().getSystemEndianType();
    if(outputByteOrder)
    {
       ossimString byteOrder = outputByteOrder;
       byteOrder = byteOrder.downcase();
       if(byteOrder.contains("little"))
       {
          theOutputByteOrder = OSSIM_LITTLE_ENDIAN;
       }
       else if(byteOrder.contains("big"))
       {
          theOutputByteOrder = OSSIM_BIG_ENDIAN;
       }
    }
    
    return true;
 }

◆ open()

bool ossimGeneralRasterWriter::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 65 of file ossimGeneralRasterWriter.cpp.

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

Referenced by writeFile().

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

◆ saveState()

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

virtual

saves the state of the object.

Reimplemented from ossimImageFileWriter.

Definition at line 640 of file ossimGeneralRasterWriter.cpp.

References ossimKeywordlist::add(), ossimKeywordNames::BYTE_ORDER_KW, OSSIM_LITTLE_ENDIAN, ossimImageFileWriter::saveState(), and theOutputByteOrder.

 {
    kwl.add(prefix,
            ossimKeywordNames::BYTE_ORDER_KW,
            ((theOutputByteOrder==OSSIM_LITTLE_ENDIAN)?"little_endian":"big_endian"),
            true);
    return ossimImageFileWriter::saveState(kwl,
                                       prefix);
 }

◆ set_rr_level()

virtual void ossimGeneralRasterWriter::set_rr_level ( ossim_uint32 rr )

inlinevirtual

Definition at line 56 of file ossimGeneralRasterWriter.h.

56 { theRlevel = rr; }

ossimGeneralRasterWriter::theRlevel

ossim_uint32 theRlevel

Definition: ossimGeneralRasterWriter.h:145

◆ setOutputStream()

bool ossimGeneralRasterWriter::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 856 of file ossimGeneralRasterWriter.cpp.

References theOutputStream, and theOwnsStreamFlag.

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

◆ writeEnviHeader()

void ossimGeneralRasterWriter::writeEnviHeader ( ) const

private

Writes an envi header file which can be used to load file in envi.

If the output image file is "foo.ras" then the ossim header file will be "foo.hdr".

Definition at line 789 of file ossimGeneralRasterWriter.cpp.

Referenced by writeFile().

 {
    static const char MODULE[] = "ossimGeneralRasterWriter::writeEnviHeader";
 
    if (traceDebug()) CLOG << " Entered..." << endl;
 
    if (!theInputConnection)
    {
       return;
    }
    
    // Make a header file name from the image file.
    ossimFilename headerFile = theFilename;
    headerFile.setExtension(".hdr"); // ossim meta data
 
    ossimString interleaveType = getInterleaveString();
    ossimKeywordlist kwl;
    kwl.add(ossimKeywordNames::INTERLEAVE_TYPE_KW, interleaveType.c_str());
 
    ossimRefPtr<ossimEnviHeaderFileWriter> hdr = new ossimEnviHeaderFileWriter;
    hdr->connectMyInputTo(0, theInputConnection.get());
    hdr->initialize();
    hdr->setFilename(headerFile);
    hdr->loadState(kwl);
    hdr->setAreaOfInterest(theAreaOfInterest);
    hdr->execute();
    
    if (traceDebug()) CLOG << " Exited..." << endl;
 }

◆ writeFile()

bool ossimGeneralRasterWriter::writeFile ( )

protectedvirtual

Write out the file.

Returns: true on success, false on error.

Implements ossimImageFileWriter.

Definition at line 107 of file ossimGeneralRasterWriter.cpp.

References close(), ossimString::contains(), ossimErrorStatusInterface::getErrorStatus(), ossimImageFileWriter::getSequencer(), ossimImageSourceSequencer::isMaster(), isOpen(), open(), ossimErrorCodes::OSSIM_OK, ossimImageFileWriter::theInputConnection, ossimImageFileWriter::theOutputImageType, ossimRefPtr< T >::valid(), writeEnviHeader(), writeHeader(), and writeStream().

 {
    bool result = false;
 
    if( theInputConnection.valid() && ( getErrorStatus() == ossimErrorCodes::OSSIM_OK ) )
    {
       //---
       // Make sure we can open the file.  Note only the master process is used for
       // writing...
       //---
       if(theInputConnection->isMaster())
       {
          if (!isOpen())
          {
             open();
          }
       }
 
       result = writeStream();
 
       if ( result )
       {
          // Do this only on the master process. Note left to right precedence!
          if (getSequencer() && getSequencer()->isMaster())
          {
             //---
             // Write the header out.  We do this last since we must
             // compute min max pixel while we are writting the image.
             // since the header is an external text file this is Ok
             // to do.
             //---
             writeHeader();
             
             if (theOutputImageType.contains("envi"))
             {
                writeEnviHeader();
             }
          }
       } 
 
       close();
    }
 
    return result;
    
 } // End: ossimGeneralRasterWriter::writeFile()

◆ writeHeader()

void ossimGeneralRasterWriter::writeHeader ( ) const

private

Writes an ossim header file which can be used to load file in ossim.

Returns true on success, false on error.

Definition at line 704 of file ossimGeneralRasterWriter.cpp.

Referenced by writeFile().

 {
    static const char MODULE[] = "ossimGeneralRasterWriter::writeHeader";
 
    if (traceDebug()) CLOG << " Entered..." << std::endl;
 
    // Make a header file name from the image file.
    ossimFilename headerFile = theFilename;
    headerFile.setExtension(".omd"); // ossim meta data
 
    std::ofstream os;
    os.open(headerFile.c_str(), ios::out);
    if (!os)
    {
       ossimNotify(ossimNotifyLevel_FATAL) << MODULE << " Error:\n"
            << "Could not open:  " << headerFile << std::endl;
       return;
    }
 
    ossimString interleaveType = getInterleaveString();
 
    ossimString scalar =
       ossimScalarTypeLut::instance()->getEntryString(theInputConnection->
                                                      getOutputScalarType());
    
    os << "// *** ossim meta data general raster header file ***\n"
       << ossimKeywordNames::FILENAME_KW << ": " 
       << theFilename.file().c_str() << "\n"
       << ossimKeywordNames::IMAGE_TYPE_KW << ": "
       << getOutputImageTypeString() << "\n"
       << ossimKeywordNames::INTERLEAVE_TYPE_KW << ": "
       << interleaveType.c_str() << "\n"
       << ossimKeywordNames::NUMBER_BANDS_KW << ":  "
       << theInputConnection->getNumberOfOutputBands() << "\n"
       << ossimKeywordNames::NUMBER_LINES_KW << ": "
       << (theAreaOfInterest.lr().y - theAreaOfInterest.ul().y + 1) << "\n"
       << ossimKeywordNames::NUMBER_SAMPLES_KW << ": "
       << (theAreaOfInterest.lr().x - theAreaOfInterest.ul().x + 1) << "\n"
       << ossimKeywordNames::SCALAR_TYPE_KW << ": "
       << scalar.c_str() << "\n"
       << ossimKeywordNames::BYTE_ORDER_KW <<": "
       << ((theOutputByteOrder==OSSIM_BIG_ENDIAN)?"big_endian":"little_endian")
       << "\n"
       << std::endl;
 
    // Output the null/min/max for each band.
    os << "\n// NOTE:  Bands are one based, band1 is the first band."
       << std::endl;
 
    for (ossim_uint32 i=0; i<theInputConnection->getNumberOfOutputBands(); ++i)
    {
       ossimString prefix = ossimKeywordNames::BAND_KW +
                            ossimString::toString(i+1) + ".";
       
       ossimString null_pix = ossimString::toString(theInputConnection->
                                                    getNullPixelValue(i));
       ossimString min_pix;
       ossimString max_pix;
 
       if(!theMinPerBand.size()||!theMaxPerBand.size())
       {
          min_pix  = ossimString::toString(theInputConnection->
                       getMinPixelValue(i));
          max_pix  =  ossimString::toString(theInputConnection->
                                            getMaxPixelValue(i));
       }
       else
       {
          min_pix   = ossimString::toString(theMinPerBand[i]);
          max_pix  = ossimString::toString(theMaxPerBand[i]);
       }
       
       os << prefix.c_str() << ossimKeywordNames::NULL_VALUE_KW << ":  "
          << null_pix.c_str() << "\n"
          << prefix << ossimKeywordNames::MIN_VALUE_KW << ":  "
          << min_pix.c_str() << "\n"
          << prefix << ossimKeywordNames::MAX_VALUE_KW << ":  "
          << max_pix.c_str() << std::endl;
    }
    
    os.close();
    
    if (traceDebug()) CLOG << " Exited..." << endl;
 }

◆ writeStream()

bool ossimGeneralRasterWriter::writeStream ( )

virtual

Method to write the image to a stream.

Callers must call setOutputStream(...) method prior to this.

Returns: true on success, false on error.

Reimplemented from ossimImageFileWriter.

Definition at line 154 of file ossimGeneralRasterWriter.cpp.

References ossimErrorStatusInterface::getErrorStatus(), ossimImageSourceSequencer::isMaster(), ossimErrorCodes::OSSIM_OK, ossimNotify(), ossimNotifyLevel_FATAL, ossimImageSourceSequencer::slaveProcessTiles(), ossimImageFileWriter::theInputConnection, ossimImageFileWriter::theOutputImageType, theOutputStream, ossimRefPtr< T >::valid(), writeToBil(), writeToBip(), and writeToBsq().

Referenced by writeFile().

 {
    static const char MODULE[] = "ossimGeneralRasterWriter::writeStream";
 
    bool result = false;
    
    if( theInputConnection.valid() && theOutputStream &&
        ( getErrorStatus() == ossimErrorCodes::OSSIM_OK ) )
    {
       if ( theInputConnection->isMaster() )
       {
          // Write the file with the image data.
          if ( (theOutputImageType == "general_raster_bip") ||
               (theOutputImageType == "general_raster_bip_envi") )
          {
             result = writeToBip();
          }
          else if ( (theOutputImageType == "general_raster_bil") ||
                    (theOutputImageType == "general_raster_bil_envi") )
          {
             result = writeToBil();
          }
          else if ( (theOutputImageType == "general_raster_bsq") ||
                    (theOutputImageType == "general_raster_bsq_envi") )
          {
             result = writeToBsq();
          }
          else
          {
             ossimNotify(ossimNotifyLevel_FATAL)
                << MODULE << " ERROR:"
                << "\nUnsupported output type:  " << theOutputImageType << std::endl;
             result = false;
          }
 
          if ( result )
          {
             // Flush the stream to disk...
             theOutputStream->flush();
          }
       }
       else // Matching else: if ( theInputConnection->isMaster() )
       {
          // Slave process:
          theInputConnection->slaveProcessTiles();
          result = true;
       }
    }
 
    return result;
    
 } // End: ossimGeneralRasterWriter::writeStream()

◆ writeToBil()

bool ossimGeneralRasterWriter::writeToBil ( )

private

Writes image data to output file in BIL(Band Interleaved by Line) format.

Returns: true on success, false on error.

Definition at line 354 of file ossimGeneralRasterWriter.cpp.

Referenced by writeStream().

 {
    ossimEndian endian;
    static const char* const MODULE = "ossimGeneralRasterWriter::writeToBil";
 
    if (traceDebug()) CLOG << " Entered." << std::endl;
 
    //***
    // Get an arbitrary tile just to get the size in bytes!
    // This should be changed later... An ossimImageSource should know
    // this.
    //***
    ossimRefPtr<ossimImageData> id;
    theInputConnection->setToStartOfSequence();
 
    ossim_uint64 bands     = theInputConnection->getNumberOfOutputBands();
    ossim_uint64 tilesWide = theInputConnection->getNumberOfTilesHorizontal();
    ossim_uint64 tilesHigh = theInputConnection->getNumberOfTilesVertical();
    ossim_uint64 tileHeight        = theInputConnection->getTileHeight();
    ossim_uint64 numberOfTiles     = theInputConnection->getNumberOfTiles();
    ossim_uint64 width             = theAreaOfInterest.width();
    ossim_uint64 bufferSizeInBytes = 0;
    ossim_uint64 bytesInLine       = 0;
    unsigned char* buffer    = NULL;
 
    // Start with a clean min/max.
    theMinPerBand.clear();
    theMaxPerBand.clear();
 
    ossim_uint64 tileNumber = 0;
    bool wroteSomethingOut = false;
    ossimScalarType scalarType = theInputConnection->getOutputScalarType();
    for(ossim_uint64 i = 0; ((i < tilesHigh)&&(!needsAborting())); ++i)
    {
       // Clear the buffer.
       // Clear the buffer.
       if(buffer)
       {
          memset(buffer, 0, bufferSizeInBytes);
       }
       
       ossimIrect bufferRect(theAreaOfInterest.ul().x,
                             theAreaOfInterest.ul().y + i*tileHeight,
                             theAreaOfInterest.ul().x + (width - 1),
                             theAreaOfInterest.ul().y + i *
                             tileHeight + (tileHeight - 1));
       
       // Tile loop in the sample (width) direction.
       for(ossim_uint64 j = 0; ((j < tilesWide)&&(!needsAborting())); ++j)
       {
          // Get the tile and copy it to the buffer.
          id = theInputConnection->getNextTile();
      if(id.valid())
          {
             id->computeMinMaxPix(theMinPerBand, theMaxPerBand);
             
             if(!buffer)
             {
                bytesInLine     = id->getScalarSizeInBytes() * width;
                
                // Buffer to hold one line x tileHeight
                bufferSizeInBytes = bytesInLine * tileHeight * bands;
                buffer = new unsigned char[bufferSizeInBytes];
                memset(buffer, 0, bufferSizeInBytes);
             }
             id->unloadTile(buffer,
                            bufferRect,
                            OSSIM_BIL);
          }
          ++tileNumber;
       }
       
       // Get the number of lines to write from the buffer.
       ossim_uint64 linesToWrite =
          min(tileHeight,
              static_cast<ossim_uint64>(theAreaOfInterest.lr().y -
                                        bufferRect.ul().y + 1));
       
       // Write the buffer out to disk.  
       ossim_uint8* buf = buffer;
       for (ossim_uint64 ii=0; ((ii<linesToWrite)&(!needsAborting())); ++ii)
       {
          for (ossim_uint64 band = 0;
               ((band < bands)&&(!needsAborting()));
               ++band)
          {
             wroteSomethingOut = true;
             if(endian.getSystemEndianType() != theOutputByteOrder)
             {
                endian.swap(scalarType,
                            buf,
                            bytesInLine/ossim::scalarSizeInBytes(scalarType));
             }
             theOutputStream->write((char*)buf, bytesInLine);
             if (theOutputStream->fail())
             {
                ossimNotify(ossimNotifyLevel_FATAL)
                   << MODULE << " ERROR:"
                   << "Error returned writing line!" << std::endl;
                setErrorStatus();
            if(buffer)
                {
                   // Free the memory.
                   delete [] buffer;
                }
                return false;
             }
 
             buf += bytesInLine;
          }
          
       } // End of loop to write lines from buffer to tiff file.
 
       double tile = tileNumber;
       double numTiles = numberOfTiles;
       setPercentComplete(tile / numTiles * 100);
 
       if(needsAborting())
       {
          setPercentComplete(100.0);
       }
 
    } // End of loop in the line (height) direction.
 
    if(buffer)
    {
       // Free the memory.
       delete [] buffer;
    }
    
    if (traceDebug()) CLOG << " Exited." << std::endl;
 
    return wroteSomethingOut;
 }

◆ writeToBip()

bool ossimGeneralRasterWriter::writeToBip ( )

private

Writes image data to output file in BIP(Band Interleaved by Pixel) format.

Returns: true on success, false on error.

Definition at line 207 of file ossimGeneralRasterWriter.cpp.

Referenced by writeStream().

 {
    ossimEndian endian;
    static const char* const MODULE = "ossimGeneralRasterWriter::writeToBip";
    
    if (traceDebug()) CLOG << " Entered." << std::endl;
    
    
    //---
    // Get an arbitrary tile just to get the size in bytes!
    // This should be changed later... An ossimImageSource should know
    // this.
    //---
    ossimRefPtr<ossimImageData> id;
    
    // Start the sequence at the first tile.
    theInputConnection->setToStartOfSequence();
    
    ossim_uint64 bands     = theInputConnection->getNumberOfOutputBands();
    ossim_uint64 tilesWide =  theInputConnection->getNumberOfTilesHorizontal();
    ossim_uint64 tilesHigh     = theInputConnection->getNumberOfTilesVertical();
    ossim_uint64 tileHeight    = theInputConnection->getTileHeight();
    ossim_uint64 numberOfTiles = theInputConnection->getNumberOfTiles();
    ossim_uint64 width         = theAreaOfInterest.width();
 
    if (traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "\nossimGeneralRasterWriter::writeToBip DEBUG:"
          << "\nbands:          " << bands
          << "\ntilesWide:      " << tilesWide
          << "\ntilesHigh:      " << tilesHigh
          << "\ntileHeight:     " << tileHeight
          << "\nnumberOfTiles:  " << numberOfTiles
          << "\nwidth:          " << width
          << std::endl;
    }
    
    //---
    // Buffer to hold one line x tileHeight
    //---
    ossim_uint64 bufferSizeInBytes = 0;
    ossim_uint64 bytesInLine       = 0;
    unsigned char* buffer = NULL;
    
    theMinPerBand.clear();
    theMaxPerBand.clear();
    ossim_uint64 tileNumber = 0;
    bool wroteSomethingOut = false;
    ossimScalarType scalarType = theInputConnection->getOutputScalarType();
    for(ossim_uint64 i = 0; ((i < tilesHigh)&&(!needsAborting())); ++i)
    {
       // Clear the buffer.
       if(buffer)
       {
      memset(buffer, 0, bufferSizeInBytes);
       }
       
       ossimIrect bufferRect(theAreaOfInterest.ul().x,
                 theAreaOfInterest.ul().y + i*tileHeight,
                 theAreaOfInterest.ul().x + (width - 1),
                 theAreaOfInterest.ul().y + i*tileHeight + (tileHeight - 1));
       // Tile loop in the sample (width) direction.
       for(ossim_uint64 j = 0; ((j < tilesWide)&&(!needsAborting())); ++j)
       {
          // Get the tile and copy it to the buffer.
          id = theInputConnection->getNextTile();
      if(id.valid())
          {
             id->computeMinMaxPix(theMinPerBand, theMaxPerBand);
             if(!buffer)
             {
                bytesInLine     = id->getScalarSizeInBytes() * width * bands;
                
                //---
                // Buffer to hold one line x tileHeight
                //---
                bufferSizeInBytes = bytesInLine * tileHeight;
                buffer = new unsigned char[bufferSizeInBytes];
                memset(buffer, 0, bufferSizeInBytes);
             }
             id->unloadTile(buffer,
                            bufferRect,
                            OSSIM_BIP);
          }
          ++tileNumber;
       }
       
       // Get the number of lines to write from the buffer.
       ossim_uint64 linesToWrite =
          min(tileHeight,
              static_cast<ossim_uint64>(theAreaOfInterest.lr().y -
                                        bufferRect.ul().y + 1));
       // Write the buffer out to disk.  
       ossim_uint8* buf = buffer;
       if(buf)
       {
          for (ossim_uint64 ii=0; ((ii<linesToWrite)&&(!needsAborting())); ++ii)
          {
             std::streamsize lineBytes = bytesInLine;
             wroteSomethingOut = true;
 
             if(endian.getSystemEndianType() != theOutputByteOrder)
             {
                endian.swap(scalarType,
                            buf,
                            lineBytes/ossim::scalarSizeInBytes(scalarType));
             }
             theOutputStream->write((char*)buf, lineBytes);
             if (theOutputStream->fail())
             {
                ossimNotify(ossimNotifyLevel_FATAL)
                   << MODULE << " ERROR:"
                   << "Error returned writing line!" << std::endl;
                setErrorStatus();
                if(buffer)
                {
                   // Free the memory.
                   delete [] buffer;
                }
                return false;
             }
         
             buf += bytesInLine;
         
          } // End of loop to write lines from buffer to tiff file.
       }
       double tile = tileNumber;
       double numTiles = numberOfTiles;
       setPercentComplete(tile / numTiles * 100);
       if(needsAborting())
       {
          setPercentComplete(100.0);
       }
       
    } // End of loop in the line (height) direction.
    if(buffer)
    {
       // Free the memory.
       delete [] buffer;
    }
    
    if (traceDebug()) CLOG << " Exited." << std::endl;
    
    return wroteSomethingOut;
 }

◆ writeToBsq()

bool ossimGeneralRasterWriter::writeToBsq ( )

private

Writes image data to output file in BSQ(Band Sequential) format.

Returns: true on success, false on error.

Definition at line 489 of file ossimGeneralRasterWriter.cpp.

Referenced by writeStream().

 {
    ossimEndian endian;
    static const char* const MODULE = "ossimGeneralRasterWriter::writeToBsq";
 
    if (traceDebug()) CLOG << " Entered." << std::endl;
 
    //***
    // Get an arbitrary tile just to get the size in bytes!
    // This should be changed later... An ossimImageSource should know
    // this.
    //***
    ossimRefPtr<ossimImageData> id;
 
    // Start the sequence at the first tile.
    theInputConnection->setToStartOfSequence();
 
    ossim_uint64 bands     = theInputConnection->getNumberOfOutputBands();
    ossim_uint64 tilesWide = theInputConnection->getNumberOfTilesHorizontal();
    ossim_uint64 tilesHigh = theInputConnection->getNumberOfTilesVertical();
    ossim_uint64 tileHeight      = theInputConnection->getTileHeight();
    ossim_uint64 numberOfTiles   = theInputConnection->getNumberOfTiles();
    ossim_uint64 width           = theAreaOfInterest.width();
    ossim_uint64 height          = theAreaOfInterest.height();
 
    ossim_uint64 bytesInLine     = 0;
    ossim_uint64 buf_band_offset = 0;
    
    // Use the system "streampos" typedef for future 64 bit seeks (long long).
    streampos file_band_offset = 0;
    
    //***
    // Buffer to hold one line x tileHeight
    //***
    ossim_uint64 bufferSizeInBytes = 0;
    unsigned char* buffer = NULL;
       
    theMinPerBand.clear();
    theMaxPerBand.clear();
 
    ossim_uint64 tileNumber = 0;
    bool wroteSomethingOut = false;
    ossimScalarType scalarType = theInputConnection->getOutputScalarType();
    for(ossim_uint64 i = 0; ((i < tilesHigh)&&(!needsAborting())); ++i)
    {
       if(buffer)
       {
      // Clear the buffer.
      memset(buffer, 0, bufferSizeInBytes);
       }
       
       ossimIrect bufferRect(theAreaOfInterest.ul().x,
                 theAreaOfInterest.ul().y + i*tileHeight,
                 theAreaOfInterest.ul().x + (width - 1),
                 theAreaOfInterest.ul().y + i *
                             tileHeight + (tileHeight - 1));
       
       // Tile loop in the sample (width) direction.
       for(ossim_uint64 j = 0; ((j < tilesWide)&&(!needsAborting())); ++j)
       {
          // Get the tile and copy it to the buffer.
          id = theInputConnection->getNextTile();
      if(id.valid())
          {
             id->computeMinMaxPix(theMinPerBand, theMaxPerBand);
             if(!buffer)
             {
                bytesInLine     = id->getScalarSizeInBytes() * width;
                buf_band_offset = bytesInLine * tileHeight;
                file_band_offset = height * bytesInLine;
                bufferSizeInBytes = bytesInLine * tileHeight * bands;
                buffer = new unsigned char[bufferSizeInBytes];
                memset(buffer, 0, bufferSizeInBytes);
             }
             id->unloadTile(buffer,
                            bufferRect,
                            OSSIM_BSQ);
          }
          ++tileNumber;
       }
       
       // Get the number of lines to write from the buffer.
       ossim_uint64 linesToWrite =
          min(tileHeight,
              static_cast<ossim_uint64>(theAreaOfInterest.lr().y -
                                        bufferRect.ul().y + 1));
       
       // Write the buffer out to disk.  
       ossim_uint64 start_line =
          static_cast<ossim_uint64>(bufferRect.ul().y -
                                    theAreaOfInterest.ul().y);
       for (ossim_uint64 band = 0; ((band < bands)&&(!needsAborting())); ++band)
       {
          ossim_uint8* buf = buffer;
          buf += buf_band_offset * band;
          
          // Put the file pointer in the right spot.
          streampos pos = file_band_offset * band + start_line * bytesInLine;
          theOutputStream->seekp(pos, ios::beg);
          if (theOutputStream->fail())
          {
             ossimNotify(ossimNotifyLevel_FATAL) << MODULE << " ERROR:"
                  << "Error returned seeking to image data position!" << std::endl;
             setErrorStatus();
             return false;
          }
          
          for (ossim_uint64 ii=0; ((ii<linesToWrite)&&(!needsAborting())); ++ii)
          {
             wroteSomethingOut = true;
             if(endian.getSystemEndianType() != theOutputByteOrder)
             {
                endian.swap(scalarType,
                            buf,
                            bytesInLine/ossim::scalarSizeInBytes(scalarType));
             }
 
             theOutputStream->write((char*)buf, bytesInLine);
             
             if (theOutputStream->fail())
             {
                ossimNotify(ossimNotifyLevel_FATAL) << MODULE << " ERROR:"
                     << "Error returned writing line!" << std::endl;
                setErrorStatus();
                return false;
             }
             
             buf += bytesInLine;
          }
          
       } // End of loop to write lines from buffer to tiff file.
       
       double tile = tileNumber;
       double numTiles = numberOfTiles;
       setPercentComplete(tile / numTiles * 100);
 
       if(needsAborting())
       {
          setPercentComplete(100.0);
       }
       
    } // End of loop in the line (height) direction.
    
    // Free the memory.
    delete [] buffer;
    
    if (traceDebug()) CLOG << " Exited." << std::endl;
    
    return wroteSomethingOut;
 }