Pure virtual base class for image file writers. More...

#include <ossimImageFileWriter.h>

Inheritance diagram for ossimImageFileWriter:

Public Member Functions
	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 void	getImageTypeList (std::vector< ossimString > &imageTypeList) const =0
	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 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	writeStream ()
	Method to write the image to a stream. More...

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

virtual bool	setOutputStream (std::ostream &str)
	tmp drb 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	saveState (ossimKeywordlist &kwl, const char *prefix=0) const

virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)

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	isOpen () const =0

virtual bool	open ()=0

virtual bool	open (const ossimString &outputName)

virtual const ossimString &	getOutputName ()

virtual void	close ()=0

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
bool	writeWorldFile (const ossimFilename &file)
	Common world file writer method. More...

virtual bool	writeFile ()=0
	Write out the file. More...

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

const ossimSource &	operator= (const ossimSource &rhs)

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

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

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

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

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 }

Detailed Description

Pure virtual base class for image file writers.

There is normally one subclass of this class for each format supported for writing. This class roughly corresponds to the ImageHandler class used for reading images. Format specific ossimImageWriter's are normally instantiated by the ossimImageWriterFactory::createWriterInstance() method. ossimImageWriters should not be directly instantiated by application code.

Definition at line 34 of file ossimImageFileWriter.h.

Constructor & Destructor Documentation

◆ ossimImageFileWriter()

ossimImageFileWriter::ossimImageFileWriter	(	const ossimFilename &	filename = `ossimFilename()`,
		ossimImageSource *	inputSource = `0`,
		ossimObject *	owner = `0`
	)

The writer will own the sequencer.

Definition at line 65 of file ossimImageFileWriter.cpp.

    : ossimImageWriter(owner,
                       1,
                       0,
                       true,
                       false),
      ossimProcessInterface(),
      ossimConnectableObjectListener(),
      theViewController(NULL),
      theProgressListener(NULL),
      theFilename(file),
      theOutputImageType(ossimImageTypeLut().getEntryString(OSSIM_IMAGE_TYPE_UNKNOWN)),
      theWriteImageFlag(true),
      theWriteOverviewFlag(false),
      theWriteHistogramFlag(false),
      theScaleToEightBitFlag(false),
      theOverviewCompressType(COMPRESSION_NONE),
      theOverviewJpegCompressQuality(75),
      theWriteEnviHeaderFlag(false),
      theWriteErsHeaderFlag(false),     
      theWriteExternalGeometryFlag(false),
      theWriteFgdcFlag(false),
      theWriteJpegWorldFileFlag(false),
      theWriteReadmeFlag(false),
      theWriteTiffWorldFileFlag(false),
      theWriteWorldFileFlag(false),
      theAutoCreateDirectoryFlag(true),
      theLinearUnits(OSSIM_UNIT_UNKNOWN),
      thePixelType(OSSIM_PIXEL_IS_POINT)
 {
    if (traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "ossimImageFileWriter::ossimImageFileWriter entered..."
          << std::endl;
 #ifdef OSSIM_ID_ENABLED
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "OSSIM_ID:  " << OSSIM_ID << std::endl;
 #endif
    }
 
    theInputConnection = new ossimImageSourceSequencer(inputSource);
 
    // now map the sequencer to the same input
    connectMyInputTo(0, inputSource);
    initialize();
 
    // make sure we listen to our input changes so we can change
    // it for the sequencer as well.
    ossimImageWriter::addListener((ossimConnectableObjectListener*)this);
 
    theInputConnection->connectMyInputTo(0, inputSource, false);
    theAreaOfInterest.makeNan();
 }

◆ ~ossimImageFileWriter()

ossimImageFileWriter::~ossimImageFileWriter ( )

virtual

Definition at line 122 of file ossimImageFileWriter.cpp.

References removeListener(), theInputConnection, and theProgressListener.

 {
    theInputConnection = 0;
    theProgressListener = NULL;
    removeListener((ossimConnectableObjectListener*)this);
 }

Member Function Documentation

◆ addListener()

bool ossimImageFileWriter::addListener ( ossimListener * listener )

virtual

Overrides base "addListener" this will capture the pointer and then call the base class "addListener".

If overview building is enabled, the listener will be passed to the overview builder::addListener, and subsequently removed from the overview builder after the build overview call is complete. This it transparent to the caller of this method.

Parameters

listener The listener to add.

Returns: Currently always returns true.

Note: Callers still should call "removeListener" after the writing process is complete.; If called more than once, theProgressListener will contain the latest listener.

Reimplemented from ossimListenerManager.

Definition at line 1523 of file ossimImageFileWriter.cpp.

References ossimListenerManager::addListener(), and theProgressListener.

Referenced by ossimChipProcTool::execute(), main(), and ossimIgen::writeToFile().

 {
    theProgressListener = listener;
    return ossimImageWriter::addListener(listener);
 }

◆ canConnectMyInputTo()

bool ossimImageFileWriter::canConnectMyInputTo	(	ossim_int32	myInputIndex,
		const ossimConnectableObject *	object
	)		const

virtual

required to be overriden by derived classes

Implements ossimConnectableObject.

Definition at line 1227 of file ossimImageFileWriter.cpp.

References PTR_CAST.

 {
    return (object&&
            ( (PTR_CAST(ossimImageSource, object)&&inputIndex == 0)||
              (PTR_CAST(ossimViewController, object)&&inputIndex == 1)) );
 }

◆ changeSequencer()

void ossimImageFileWriter::changeSequencer ( ossimImageSourceSequencer * sequencer )

virtual

Sets the sequencer and connects it to the input of this.

This does not set the area of interest. Note stored as an ossimRefPtr.

Parameters

sequencer Pointer to a sequencer.

Definition at line 160 of file ossimImageFileWriter.cpp.

References ossimConnectableObject::connectMyInputTo(), ossimConnectableObject::getInput(), and theInputConnection.

Referenced by ossimIgen::outputProduct().

 {
    if( sequencer )
    {
       theInputConnection = sequencer;
       theInputConnection->connectMyInputTo(0, getInput(0));
    }
 }

◆ connectInputEvent()

void ossimImageFileWriter::connectInputEvent ( ossimConnectionEvent & event )

virtual

Reimplemented from ossimConnectableObjectListener.

Definition at line 824 of file ossimImageFileWriter.cpp.

References ossimConnectableObject::connectMyInputTo(), ossimConnectableObject::getInput(), initialize(), PTR_CAST, theInputConnection, and theViewController.

 {
    theInputConnection->connectMyInputTo((ossim_int32)0,
                                         getInput(0),
                                         false);
    theViewController = PTR_CAST(ossimViewController, getInput(1));
    initialize();
 }

◆ disconnectInputEvent()

void ossimImageFileWriter::disconnectInputEvent ( ossimConnectionEvent & event )

virtual

Reimplemented from ossimConnectableObjectListener.

Definition at line 813 of file ossimImageFileWriter.cpp.

References ossimConnectableObject::disconnectMyInput(), ossimConnectableObject::getInput(), initialize(), PTR_CAST, theInputConnection, and theViewController.

 {
    if(!getInput(0))
    {
       theInputConnection->disconnectMyInput((ossim_int32)0, false);
    }
    theViewController = PTR_CAST(ossimViewController, getInput(1));
 
    initialize();
 }

◆ execute()

bool ossimImageFileWriter::execute ( )

virtual

Calls: writeFile() writeMetaDataFiles()

Returns: true on success, false on error.

Implements ossimProcessInterface.

Definition at line 1016 of file ossimImageFileWriter.cpp.

References theInputConnection.

Referenced by ossimDemTool::doOMG(), ossimPointCloudTool::execute(), ossimChipProcTool::execute(), ossimKmlSuperOverlayWriter::generateTile(), main(), ATP::AtpAnnotatedImage::write(), writeRaster(), and ossimHlzTool::writeSlopeImage().

 {
    static const char MODULE[] = "ossimImageFileWriter::execute";
    
    if (!theInputConnection) // Must have a sequencer...
    {
       if (traceDebug())
       {
          ossimNotify(ossimNotifyLevel_DEBUG)
             << MODULE << " DEBUG:\ntheInputConnection is NULL!" << endl;
       }
       return false;
    }
    
    if (theFilename == "") // Must have a filename...
    {
       if (traceDebug())
       {
          ossimNotify(ossimNotifyLevel_DEBUG)
             << MODULE << " DEBUG:\ntheFilename is empty!" << endl;
       }
       return false;
    }
    
    
    // make sure we have a region of interest
    if(theAreaOfInterest.hasNans())
    {
       theInputConnection->initialize();
       theAreaOfInterest = theInputConnection->getAreaOfInterest();
    }
    else
    {
       theInputConnection->setAreaOfInterest(theAreaOfInterest);
    }
 
    if(theAreaOfInterest.hasNans()) // Must have an area of interest...
    {
       if (traceDebug())
       {
          ossimNotify(ossimNotifyLevel_DEBUG)
             << MODULE << " ERROR:  Area of interest has nans!"
             << "Area of interest:  "
             << theAreaOfInterest
             << "\nReturning..." << endl;
       }
 
       return false;
    }
 
    if (traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << MODULE << " DEBUG:\n"
          << "Area of interest:  " << theAreaOfInterest << endl;
    }
    
    ossimRefPtr<ossimImageSource> savedInput;
    if (theScaleToEightBitFlag)
    {
       if(theInputConnection->getOutputScalarType() != OSSIM_UINT8)
       {
          savedInput = new ossimScalarRemapper;
          
          savedInput->connectMyInputTo(0, theInputConnection->getInput(0));
          theInputConnection->connectMyInputTo(0, savedInput.get());
          theInputConnection->initialize();
       }
    }
 
    ossimFilename path = theFilename.path();
    if (!path.empty() && !path.exists() )
    {
       path.createDirectory(true);
    }
    setProcessStatus(ossimProcessInterface::PROCESS_STATUS_EXECUTING);
    //setPercentComplete(0.0); let writeFile set the precent complete
    bool wroteFile = true;
    bool result    = true;
    if (theWriteImageFlag)
    {
       wroteFile = writeFile();
    }
   
    /*
    if(needsAborting())
    {
       setProcessStatus(ossimProcessInterface::PROCESS_STATUS_ABORTED);
    }
    else
    {
       setProcessStatus(ossimProcessInterface::PROCESS_STATUS_NOT_EXECUTING);
    }
    */
    if (theWriteOverviewFlag&&!needsAborting())
    {
       // Writing overviews has been mpi'd so do on all processes.
       if (!writeOverviewFile(theOverviewCompressType,
                              theOverviewJpegCompressQuality))
       {
          if(traceDebug())
          {
             ossimNotify(ossimNotifyLevel_WARN)
             << "Write of overview file failed!" << endl;
          }
       }
    }
 
    if(!needsAborting())
    {
       // Do these only on the master process. Note left to right precedence!
       if (getSequencer() && getSequencer()->isMaster())
       {
          if (wroteFile)
          {
             if (writeMetaDataFiles() == false)
             {
                if(traceDebug())
                {
                   ossimNotify(ossimNotifyLevel_WARN)
                   << "Write of metadata file failed!" << endl;
                }
                result = false;
             }
          }
          
       } // End of "if (getSequencer() && getSequencer()->isMaster()))
    }
 
    if(savedInput.valid())
    {
       ossimConnectableObject* obj = theInputConnection->getInput(0);
       if(obj)
       {
          theInputConnection->connectMyInputTo(0, obj->getInput(0));
       }
    }
    if(!needsAborting())
    {
       setProcessStatus(ossimProcessInterface::PROCESS_STATUS_NOT_EXECUTING);
    }
    else 
    {
       setProcessStatus(ossimProcessInterface::PROCESS_STATUS_ABORTED);   
    }
 
    savedInput = 0;
    return result;
 }

◆ getExtension()

ossimString ossimImageFileWriter::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 in ossimTiffWriter, ossimKakaduNitfWriter, ossimNitfWriterBase, ossimKmlSuperOverlayWriter, ossimOpjJp2Writer, ossimKakaduJp2Writer, ossimJpegWriter, ossimGpkgWriter, ossimPdfWriter, ossimWriter, ossimArcInfoGridWriter, ossimGeneralRasterWriter, ossimGdalWriter, and ossimPngWriter.

Definition at line 1491 of file ossimImageFileWriter.cpp.

 {
    // default unknown file extension
    return ossimString("ext");
 }

◆ getFilename()

const ossimFilename & ossimImageFileWriter::getFilename ( ) const

virtual

Definition at line 1222 of file ossimImageFileWriter.cpp.

References theFilename.

Referenced by ossimIgen::outputProduct().

 {
    return theFilename;
 }

◆ getImageTypeList()

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

pure virtual

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

pure virtual

Appends the writers image types to the "imageTypeList".

This is the actual image type name. So for example, ossimTiffWriter has several image types. Some of these include TIFF_TILED, TIFF_TILED_BAND_SEPARATE ... etc. The ossimGdalWriter may include GDAL_IMAGINE_HFA, GDAL_RGB_NITF, GDAL_JPEG20000, ... etc.

Parameters

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

Note: All writers should append to the list, not, clear it and then add their types.

Implemented in ossimGpkgWriter, ossimPdfWriter, ossimWriter, ossimPngWriter, ossimTiffWriter, ossimKmlSuperOverlayWriter, ossimOpjJp2Writer, ossimNitfWriter, ossimKakaduNitfWriter, ossimNitf20Writer, ossimKakaduJp2Writer, ossimGeneralRasterWriter, ossimGdalWriter, and ossimJpegWriter.

Referenced by ossimImageWriterFactory::getImageTypeList(), ossimKmlSuperOverlayWriterFactory::getImageTypeList(), getProperty(), hasImageType(), and ossimImageWriterFactoryRegistry::printWriterProps().

◆ getObject() [1/2]

ossimObject * ossimImageFileWriter::getObject ( )

virtual

Implements ossimProcessInterface.

Definition at line 982 of file ossimImageFileWriter.cpp.

 {
    return this;
 }

◆ getObject() [2/2]

const ossimObject * ossimImageFileWriter::getObject ( ) const

virtual

Implements ossimProcessInterface.

Definition at line 987 of file ossimImageFileWriter.cpp.

 {
    return this;
 }

◆ getOutputHasInternalOverviews()

bool ossimImageFileWriter::getOutputHasInternalOverviews ( void ) const

virtual

Examples of writers that always generate internal overviews are ossim_kakadu_jp2 and ossim_kakadu_nitf_j2k.

Returns: true if the output of the writer will have internal overviews. The default is false.

Reimplemented in ossimKakaduNitfWriter, ossimOpjJp2Writer, and ossimKakaduJp2Writer.

Definition at line 1497 of file ossimImageFileWriter.cpp.

 {
    // default value: don't assume internal overviews will
    // be generated by image writers.
    return false;
 }

◆ getOutputImageType()

ossim_int32 ossimImageFileWriter::getOutputImageType ( ) const

virtual

Definition at line 855 of file ossimImageFileWriter.cpp.

References ossimLookUpTable::getEntryNumber(), and theOutputImageType.

 {
    ossimImageTypeLut lut;
    return lut.getEntryNumber(theOutputImageType);
 }

◆ getOutputImageTypeString()

ossimString ossimImageFileWriter::getOutputImageTypeString ( ) const

virtual

Definition at line 849 of file ossimImageFileWriter.cpp.

References theOutputImageType.

 {
    return theOutputImageType;
 
 }

◆ getOutputStream()

ossimRefPtr< ossimOStream > ossimImageFileWriter::getOutputStream ( ) const

virtual

Method to return the stream attached to output.

This implementation in this class does nothing and returns an empty ossimRefPtr<ossimOStream>. Derived classed should implement as needed.

Returns: The stream wrapped around a ref pointer.

Definition at line 1175 of file ossimImageFileWriter.cpp.

 {
    //---
    // Not implemented in this class. Derived classed should implement if
    // they can write to a stream.
    //--- 
    return ossimRefPtr<ossimOStream>();  
 }

◆ getOverviewCompressType()

ossim_uint16 ossimImageFileWriter::getOverviewCompressType ( ) const

virtual

Definition at line 1235 of file ossimImageFileWriter.cpp.

References theOverviewCompressType.

 {
    return theOverviewCompressType;
 }

◆ getOverviewJpegCompressQuality()

ossim_int32 ossimImageFileWriter::getOverviewJpegCompressQuality ( ) const

virtual

Definition at line 1240 of file ossimImageFileWriter.cpp.

References theOverviewJpegCompressQuality.

 {
    return theOverviewJpegCompressQuality;
 }

◆ getPixelType()

ossimPixelType ossimImageFileWriter::getPixelType ( ) const

virtual

Returns: The pixel type as either OSSIM_PIXEL_IS_POINT or OSSIM_PIXEL_IS_AREA.

Definition at line 1557 of file ossimImageFileWriter.cpp.

References thePixelType.

Referenced by ossimKakaduJp2Writer::writeGeotiffBox().

 {
    return thePixelType;
 }

◆ getPixelTypeString()

void ossimImageFileWriter::getPixelTypeString ( ossimString & type ) const

virtual

Parameters

type	ossimString to initialize which will either be "point" or "area".

Definition at line 1562 of file ossimImageFileWriter.cpp.

References OSSIM_PIXEL_IS_POINT, and thePixelType.

 {
    if (thePixelType == OSSIM_PIXEL_IS_POINT)
    {
       type = "point";
    }
    else
    {
       type = "area";
    }
 }

◆ getProperty()

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

virtual

Reimplemented from ossimSource.

Reimplemented in ossimWriter, ossimPdfWriter, ossimTiffWriter, ossimGpkgWriter, ossimPngWriter, ossimKmlSuperOverlayWriter, ossimOpjJp2Writer, ossimKakaduNitfWriter, ossimKakaduJp2Writer, ossimJpegWriter, ossimGdalWriter, ossimNitfWriterBase, ossimNitfWriter, and ossimNitf20Writer.

Definition at line 1343 of file ossimImageFileWriter.cpp.

References ossimKeywordNames::FILENAME_KW, getImageTypeList(), ossimKeywordNames::IMAGE_TYPE_KW, ossimFilenameProperty::ossimFilenamePropertyIoType_OUTPUT, ossimProperty::ossimPropertyChangeType_AFFECTS_OTHERS, ossimProperty::setChangeType(), ossimStringProperty::setConstraints(), ossimFilenameProperty::setIoType(), ossimProperty::setReadOnlyFlag(), theFilename, and theOutputImageType.

Referenced by ossimNitf20Writer::getProperty(), ossimJpegWriter::getProperty(), ossimKakaduJp2Writer::getProperty(), ossimKmlSuperOverlayWriter::getProperty(), ossimGpkgWriter::getProperty(), ossimTiffWriter::getProperty(), ossimPdfWriter::getProperty(), and ossimImageWriterFactoryRegistry::printWriterProps().

 {
    if(name == ossimKeywordNames::FILENAME_KW)
    {
       ossimFilenameProperty* filenameProp =
          new ossimFilenameProperty(name, theFilename);
 
       filenameProp->setIoType(ossimFilenameProperty::ossimFilenamePropertyIoType_OUTPUT);
 
       return filenameProp;
    }
    else if(name == ossimKeywordNames::IMAGE_TYPE_KW)
    {
       ossimStringProperty* prop =  new ossimStringProperty(name, theOutputImageType, false);
       std::vector<ossimString> typeList;
       getImageTypeList(typeList);
       if(typeList.size() > 1)
       {
          prop->setReadOnlyFlag(false);
          prop->setConstraints(typeList);
          prop->setChangeType(ossimProperty::ossimPropertyChangeType_AFFECTS_OTHERS);
       }
       else
       {
          prop->setReadOnlyFlag(true);
       }
       return prop;
    }
    else if(name == AUTO_CREATE_DIRECTORY_KW)
    {
       return new ossimBooleanProperty(name, theAutoCreateDirectoryFlag);
    }
    else if (name == "create_envi_hdr")
    {
       return new ossimBooleanProperty(name, theWriteEnviHeaderFlag);
    }
    else if (name == "create_ers_hdr")
    {
       return new ossimBooleanProperty(name, theWriteErsHeaderFlag);
    }
    else if (name == ossimKeywordNames::CREATE_EXTERNAL_GEOMETRY_KW)
    {
       return new ossimBooleanProperty(name, theWriteExternalGeometryFlag);
    }
    else if (name == "create_fgdc")
    {
       return new ossimBooleanProperty(name, theWriteFgdcFlag);
    }
    else if (name == "create_jpeg_world_file")
    {
       return new ossimBooleanProperty(name, theWriteJpegWorldFileFlag);
    }
    else if (name == "create_readme")
    {
       return new ossimBooleanProperty(name, theWriteReadmeFlag);
    }
    else if (name == "create_tiff_world_file")
    {
       return new ossimBooleanProperty(name, theWriteTiffWorldFileFlag);
    }
    else if (name == "create_world_file")
    {
       return new ossimBooleanProperty(name, theWriteWorldFileFlag);
    }
    else if (name == ossimKeywordNames::CREATE_IMAGE_KW)
    {
       return new ossimBooleanProperty(name, theWriteImageFlag);
    }
    else if (name == ossimKeywordNames::CREATE_OVERVIEW_KW)
    {
       return new ossimBooleanProperty(name, theWriteOverviewFlag);
    }
    else if (name == ossimKeywordNames::CREATE_HISTOGRAM_KW)
    {
       return new ossimBooleanProperty(name, theWriteHistogramFlag);
    }
    else if (name == SCALE_TO_EIGHT_BIT_KW)
    {
       return new ossimBooleanProperty(name, theScaleToEightBitFlag);
    }
    else if (name == "linear_units")
    {
       // property value
       ossimString value = ossimUnitTypeLut::instance()->
          getEntryString(theLinearUnits);
       
       //---
       // theLinearUnits is set to unknown as a default.  This keys the
       // writer to use whatever makes sense for the given output.
       // Since "unknown" is a bad name to present to users, we will
       // use "default" if theLinearUnits is == "unknown".
       //---
       if (value == "unknown")
       {
          value = "default";
       }
       
       // constraint list
       vector<ossimString> constraintList;
       constraintList.push_back(ossimString("default"));
       constraintList.push_back(ossimString("meters"));
       constraintList.push_back(ossimString("feet"));
       constraintList.push_back(ossimString("us_survey_feet"));
       
       return new ossimStringProperty(name,
                                      value,
                                      false, // not editable
                                      constraintList);
    }
    else if (name == ossimKeywordNames::PIXEL_TYPE_KW)
    {
       ossimString value;
       getPixelTypeString(value);
       ossimStringProperty* stringProp =
          new ossimStringProperty(name,
                                  value,
                                  false); // editable flag
       stringProp->addConstraint(ossimString("point"));
       stringProp->addConstraint(ossimString("area"));
       return stringProp;
    }
 
    return ossimImageWriter::getProperty(name);
 }

◆ getPropertyNames()

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

virtual

Reimplemented from ossimSource.

Reimplemented in ossimWriter, ossimPdfWriter, ossimTiffWriter, ossimGpkgWriter, ossimPngWriter, ossimKmlSuperOverlayWriter, ossimOpjJp2Writer, ossimKakaduNitfWriter, ossimKakaduJp2Writer, ossimJpegWriter, ossimGdalWriter, ossimNitfWriterBase, ossimNitfWriter, and ossimNitf20Writer.

Definition at line 1468 of file ossimImageFileWriter.cpp.

References ossimKeywordNames::CREATE_EXTERNAL_GEOMETRY_KW, ossimKeywordNames::CREATE_HISTOGRAM_KW, ossimKeywordNames::CREATE_IMAGE_KW, ossimKeywordNames::CREATE_OVERVIEW_KW, ossimKeywordNames::FILENAME_KW, and ossimSource::getPropertyNames().

Referenced by ossimNitf20Writer::getPropertyNames(), ossimNitfWriterBase::getPropertyNames(), ossimJpegWriter::getPropertyNames(), ossimKakaduJp2Writer::getPropertyNames(), ossimKmlSuperOverlayWriter::getPropertyNames(), ossimTiffWriter::getPropertyNames(), ossimPdfWriter::getPropertyNames(), and ossimImageWriterFactoryRegistry::printWriterProps().

 {
    ossimImageWriter::getPropertyNames(propertyNames);
 
    propertyNames.push_back(ossimString(ossimKeywordNames::FILENAME_KW));
    propertyNames.push_back(ossimString("create_envi_hdr"));  
    propertyNames.push_back(ossimString(ossimKeywordNames::CREATE_EXTERNAL_GEOMETRY_KW));
    propertyNames.push_back(ossimString("create_fgdc"));
    propertyNames.push_back(ossimString("create_jpeg_world_file"));
    propertyNames.push_back(ossimString("create_readme"));
    propertyNames.push_back(ossimString("create_tiff_world_file"));
    propertyNames.push_back(ossimString("create_world_file"));   
    propertyNames.push_back(ossimString(ossimKeywordNames::CREATE_IMAGE_KW));
    propertyNames.push_back(ossimString(ossimKeywordNames::CREATE_OVERVIEW_KW));
    propertyNames.push_back(ossimString(ossimKeywordNames::CREATE_HISTOGRAM_KW));
    propertyNames.push_back(ossimString(AUTO_CREATE_DIRECTORY_KW));
    propertyNames.push_back(ossimString(SCALE_TO_EIGHT_BIT_KW));
    propertyNames.push_back(ossimString("linear_units"));
    propertyNames.push_back(ossimString(ossimKeywordNames::PIXEL_TYPE_KW));
    propertyNames.push_back(ossimString(ossimKeywordNames::IMAGE_TYPE_KW));
 
 }

◆ getScaleToEightBitFlag()

bool ossimImageFileWriter::getScaleToEightBitFlag ( ) const

virtual

Definition at line 877 of file ossimImageFileWriter.cpp.

References theScaleToEightBitFlag.

 {
    return theScaleToEightBitFlag;
 }

◆ getSequencer()

ossimImageSourceSequencer * ossimImageFileWriter::getSequencer ( )

virtual

Definition at line 1011 of file ossimImageFileWriter.cpp.

References ossimRefPtr< T >::get(), and theInputConnection.

Referenced by ossimGeneralRasterWriter::writeFile().

 {
    return theInputConnection.get();
 }

◆ getWriteEnviHeaderFlag()

bool ossimImageFileWriter::getWriteEnviHeaderFlag ( ) const

virtual

Definition at line 882 of file ossimImageFileWriter.cpp.

References theWriteEnviHeaderFlag.

 {
    return theWriteEnviHeaderFlag;
 }

◆ getWriteErsHeaderFlag()

bool ossimImageFileWriter::getWriteErsHeaderFlag ( ) const

virtual

Definition at line 887 of file ossimImageFileWriter.cpp.

References theWriteErsHeaderFlag.

 {
    return theWriteErsHeaderFlag;
 }

◆ getWriteExternalGeometryFlag()

bool ossimImageFileWriter::getWriteExternalGeometryFlag ( ) const

virtual

Definition at line 892 of file ossimImageFileWriter.cpp.

References theWriteExternalGeometryFlag.

 {
    return theWriteExternalGeometryFlag;
 }

◆ getWriteFgdcFlag()

bool ossimImageFileWriter::getWriteFgdcFlag ( ) const

virtual

Definition at line 897 of file ossimImageFileWriter.cpp.

References theWriteFgdcFlag.

 {
    return theWriteFgdcFlag;
 }

◆ getWriteHistogramFlag()

bool ossimImageFileWriter::getWriteHistogramFlag ( ) const

virtual

Definition at line 867 of file ossimImageFileWriter.cpp.

References theWriteHistogramFlag.

 {
    return theWriteHistogramFlag;
 }

◆ getWriteImageFlag()

bool ossimImageFileWriter::getWriteImageFlag ( ) const

virtual

Control flags...

Definition at line 862 of file ossimImageFileWriter.cpp.

References theWriteImageFlag.

 {
    return theWriteImageFlag;
 }

◆ getWriteJpegWorldFileFlag()

bool ossimImageFileWriter::getWriteJpegWorldFileFlag ( ) const

virtual

Definition at line 902 of file ossimImageFileWriter.cpp.

References theWriteJpegWorldFileFlag.

 {
    return theWriteJpegWorldFileFlag;
 }

◆ getWriteOverviewFlag()

bool ossimImageFileWriter::getWriteOverviewFlag ( ) const

virtual

Definition at line 872 of file ossimImageFileWriter.cpp.

References theWriteOverviewFlag.

 {
    return theWriteOverviewFlag;
 }

◆ getWriteReadmeFlag()

bool ossimImageFileWriter::getWriteReadmeFlag ( ) const

virtual

Definition at line 907 of file ossimImageFileWriter.cpp.

References theWriteReadmeFlag.

 {
    return theWriteReadmeFlag;
 }

◆ getWriteTiffWorldFileFlag()

bool ossimImageFileWriter::getWriteTiffWorldFileFlag ( ) const

virtual

Definition at line 912 of file ossimImageFileWriter.cpp.

References theWriteTiffWorldFileFlag.

 {
    return theWriteTiffWorldFileFlag;
 }

◆ getWriteWorldFileFlag()

bool ossimImageFileWriter::getWriteWorldFileFlag ( ) const

virtual

Definition at line 917 of file ossimImageFileWriter.cpp.

References theWriteWorldFileFlag.

 {
    return theWriteWorldFileFlag;
 }

◆ hasImageType()

bool ossimImageFileWriter::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 in ossimTiffWriter, ossimPdfWriter, ossimOpjJp2Writer, ossimGpkgWriter, ossimKmlSuperOverlayWriter, ossimKakaduJp2Writer, ossimPngWriter, ossimJpegWriter, ossimKakaduNitfWriter, ossimWriter, and ossimGdalWriter.

Definition at line 1504 of file ossimImageFileWriter.cpp.

References getImageTypeList().

Referenced by ossimGdalImageWriterFactory::createWriter(), ossimImageWriterFactory::createWriter(), ossimSqliteWriterFactory::createWriter(), ossimPngWriterFactory::createWriter(), ossimOpjWriterFactory::createWriter(), ossimKakaduWriterFactory::createWriter(), ossimGdalWriter::hasImageType(), ossimJpegWriter::hasImageType(), and ossimTiffWriter::hasImageType().

 {
    std::vector<ossimString> imageTypeList;
    getImageTypeList(imageTypeList);
 
    std::vector<ossimString>::const_iterator i = imageTypeList.begin();
 
    while (i != imageTypeList.end())
    {
       if ( (*i) == imageType )
       {
          return true;
       }
       ++i;
    }
 
    return false; // not found...
 }

◆ initialize()

void ossimImageFileWriter::initialize ( )

virtual

Initialize method.

Calls theInputConnection->initialize() then syncs area of interest(AOI) with ossimImageWriter::theAreaOfInterest taking precedence over ossimImageSourceSequencer::theAreaOfInterest.

Reimplemented from ossimSource.

Definition at line 129 of file ossimImageFileWriter.cpp.

References ossimImageSourceSequencer::getBoundingRect(), ossimIrect::hasNans(), ossimImageSourceSequencer::initialize(), ossimImageSourceSequencer::setAreaOfInterest(), ossimImageWriter::theAreaOfInterest, theInputConnection, and ossimRefPtr< T >::valid().

Referenced by connectInputEvent(), disconnectInputEvent(), ossimIgen::outputProduct(), propertyEvent(), and ATP::AtpAnnotatedImage::write().

 {
    if(theInputConnection.valid())
    {
       theInputConnection->initialize();
 
       //---
       // Area Of Interest(AOI):
       // There are two AOIs to keep in sync.
       // One owned by this base: ossimImageWriter::theAreaOfInterest
       // One owned by the theInputConntion: ossimImageSourceSequencer::theAreaOfInterest
       //---
       if ( theAreaOfInterest.hasNans() == false )
       {
          //---
          // ossimImageSourceSequencer::setAreaOfInterest does more than just set the
          // variable, so only call if out of sync to avoid wasted cycles.
          //--- 
          if ( theAreaOfInterest != theInputConnection->getBoundingRect() )
          {
             theInputConnection->setAreaOfInterest( theAreaOfInterest );
          }
       }
       else
       {
          // Set this AOI to bounding rect of input.
          theAreaOfInterest = theInputConnection->getBoundingRect();
       }
    }
 }

◆ loadState()

bool ossimImageFileWriter::loadState	(	const ossimKeywordlist &	kwl,
		const char *	prefix = `0`
	)

virtual

Method to the load (recreate) the state of the object from a keyword list. Return true if ok or false on error.

Reimplemented from ossimImageWriter.

Reimplemented in ossimWriter, ossimPdfWriter, ossimTiffWriter, ossimNitfWriterBase, ossimGpkgWriter, ossimNitfWriter, ossimNitf20Writer, ossimPngWriter, ossimKmlSuperOverlayWriter, ossimOpjJp2Writer, ossimGeneralRasterWriter, ossimGdalWriter, ossimKakaduNitfWriter, ossimKakaduJp2Writer, ossimJpegWriter, and ossimArcInfoGridWriter.

Definition at line 288 of file ossimImageFileWriter.cpp.

References ossimKeywordNames::CREATE_EXTERNAL_GEOMETRY_KW, ossimKeywordNames::CREATE_HISTOGRAM_KW, ossimKeywordNames::CREATE_IMAGE_KW, ossimKeywordNames::CREATE_OVERVIEW_KW, ossimKeywordNames::FILENAME_KW, ossimKeywordNames::FILEPATH_KW, ossimKeywordlist::find(), ossimUnitTypeLut::instance(), ossimSource::loadState(), OSSIM_FEET, OSSIM_METERS, OSSIM_PIXEL_IS_AREA, OSSIM_PIXEL_IS_POINT, OSSIM_US_SURVEY_FEET, ossimKeywordNames::PIXEL_TYPE_KW, setFilename(), theLinearUnits, thePixelType, theScaleToEightBitFlag, theWriteEnviHeaderFlag, theWriteErsHeaderFlag, theWriteExternalGeometryFlag, theWriteFgdcFlag, theWriteHistogramFlag, theWriteImageFlag, theWriteJpegWorldFileFlag, theWriteOverviewFlag, theWriteReadmeFlag, theWriteTiffWorldFileFlag, theWriteWorldFileFlag, and ossimString::toBool().

Referenced by ossimGdalImageWriterFactory::createWriter(), ossimImageWriterFactory::createWriter(), ossimSqliteWriterFactory::createWriter(), ossimOpjWriterFactory::createWriter(), ossimPngWriterFactory::createWriter(), ossimKakaduWriterFactory::createWriter(), ossimKmlSuperOverlayWriterFactory::createWriter(), ossimArcInfoGridWriter::loadState(), ossimJpegWriter::loadState(), ossimKakaduJp2Writer::loadState(), ossimGdalWriter::loadState(), ossimGeneralRasterWriter::loadState(), ossimKmlSuperOverlayWriter::loadState(), ossimGpkgWriter::loadState(), ossimPdfWriter::loadState(), and ossimWriter::loadState().

 {
    // Load the state of the base class.
    bool result = ossimSource::loadState(kwl, prefix);
 
    // Get the filename...
    const char* lookup = kwl.find(prefix, ossimKeywordNames::FILENAME_KW);
    if(lookup)
    {
       ossimString filename = lookup;
 
       lookup =  kwl.find(prefix, ossimKeywordNames::FILEPATH_KW);
       if(lookup)
       {
          filename = ossimString(lookup) + filename;
       }
 
       setFilename(filename);
    }
 
    lookup = kwl.find(prefix, ossimKeywordNames::PIXEL_TYPE_KW);
    if(lookup)
    {
       if(ossimString(lookup).downcase().contains("area"))
       {
          thePixelType = OSSIM_PIXEL_IS_AREA;
       }
       else
       {
          thePixelType = OSSIM_PIXEL_IS_POINT;
       }
    }
 
    lookup = kwl.find(prefix, "linear_units");
    if(lookup)
    {
       ossimUnitType units = (ossimUnitType)ossimUnitTypeLut::instance()->
          getEntryNumber(lookup, true);
       if ( (units == OSSIM_METERS) ||
            (units == OSSIM_FEET)   ||
            (units == OSSIM_US_SURVEY_FEET) )
       {
          theLinearUnits = units;
       }
    }
 
    lookup = kwl.find(prefix, ossimKeywordNames::CREATE_EXTERNAL_GEOMETRY_KW);
    if(lookup)
    {
       ossimString s = lookup;
       theWriteExternalGeometryFlag = s.toBool();
    }
    
    lookup = kwl.find(prefix, "create_envi_hdr");
    if(lookup)
    {
       ossimString s = lookup;
       theWriteEnviHeaderFlag = s.toBool();
    }
    
    lookup = kwl.find(prefix, "create_ers_hdr");
    if(lookup)
    {
       ossimString s = lookup;
       theWriteErsHeaderFlag = s.toBool();
    }
 
    lookup = kwl.find(prefix, "create_fgdc");
    if(lookup)
    {
       ossimString s = lookup;
       theWriteFgdcFlag = s.toBool();
    }
    
    lookup = kwl.find(prefix, "create_jpeg_world_file");
    if(lookup)
    {
       ossimString s = lookup;
       theWriteJpegWorldFileFlag = s.toBool();
    }
    
    lookup = kwl.find(prefix, "create_readme");
    if(lookup)
    {
       ossimString s = lookup;
       theWriteReadmeFlag = s.toBool();
    }
    
    lookup = kwl.find(prefix, "create_tiff_world_file");
    if(lookup)
    {
       ossimString s = lookup;
       theWriteTiffWorldFileFlag = s.toBool();
    }
 
    lookup = kwl.find(prefix, "create_world_file");
    if(lookup)
    {
       ossimString s = lookup;
       theWriteWorldFileFlag = s.toBool();
    }
 
    lookup = kwl.find(prefix, ossimKeywordNames::CREATE_IMAGE_KW);
    if(lookup)
    {
       ossimString s = lookup;
       theWriteImageFlag = s.toBool();
    }
 
    lookup = kwl.find(prefix, ossimKeywordNames::CREATE_OVERVIEW_KW);
    if(lookup)
    {
       ossimString s = lookup;
       theWriteOverviewFlag = s.toBool();
    }
 
    lookup = kwl.find(prefix, ossimKeywordNames::CREATE_HISTOGRAM_KW);
    if(lookup)
    {
       ossimString s = lookup;
       theWriteHistogramFlag = s.toBool();
    }
 
    lookup = kwl.find(prefix, SCALE_TO_EIGHT_BIT_KW);
    if(lookup)
    {
       ossimString s = lookup;
       theScaleToEightBitFlag = s.toBool();
    }
 
    lookup = kwl.find(prefix, AUTO_CREATE_DIRECTORY_KW);
    if(lookup)
    {
       theAutoCreateDirectoryFlag = ossimString(lookup).toBool();
    }
    lookup = kwl.find(prefix, ossimKeywordNames::OVERVIEW_COMPRESSION_TYPE_KW);
    if(lookup)
    {
       ossimString s = lookup;
       theOverviewCompressType = static_cast<ossim_uint16>(s.toUInt32());
    }
 
    lookup = kwl.find(prefix, ossimKeywordNames::OVERVIEW_COMPRESSION_QUALITY_KW);
    if(lookup)
    {
       ossimString s = lookup;
       theOverviewJpegCompressQuality = s.toInt32();
    }
 
    const char* outputImageType = kwl.find(prefix, ossimKeywordNames::IMAGE_TYPE_KW);
    if(outputImageType)
    {
       theOutputImageType = outputImageType;
    }
 
    if(theInputObjectList.size() != 2)
    {
       theInputObjectList.resize(2);
       theInputListIsFixedFlag = true;
    }
 
    theOutputListIsFixedFlag = false;
 
    return result;
 }

◆ propertyEvent()

void ossimImageFileWriter::propertyEvent ( ossimPropertyEvent & event )

virtual

Reimplemented from ossimConnectableObjectListener.

Definition at line 833 of file ossimImageFileWriter.cpp.

References initialize().

 {
    initialize();
 }

◆ removeListener()

bool ossimImageFileWriter::removeListener ( ossimListener * listener )

virtual

Overrides base "removeListener".

Calls base "removeListener which will find and removes the listener. If "theProgressListener" pointer matches listener "theProgressListener" will be set to NULL.

Parameters

listener The listener to remove.

Returns: Currently always returns true.

Reimplemented from ossimListenerManager.

Definition at line 1529 of file ossimImageFileWriter.cpp.

References ossimListenerManager::removeListener(), and theProgressListener.

Referenced by ossimChipProcTool::execute(), main(), and ~ossimImageFileWriter().

 {
    if (listener == theProgressListener)
    {
       theProgressListener = NULL;
    }
    return ossimImageWriter::removeListener(listener);
 }

◆ saveState()

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

virtual

Method to save the state of the object to a keyword list. Return true if ok or false on error.

Reimplemented from ossimImageWriter.

Reimplemented in ossimWriter, ossimPdfWriter, ossimTiffWriter, ossimGpkgWriter, ossimNitfWriterBase, ossimNitfWriter, ossimNitf20Writer, ossimPngWriter, ossimKmlSuperOverlayWriter, ossimOpjJp2Writer, ossimGeneralRasterWriter, ossimGdalWriter, ossimKakaduNitfWriter, ossimKakaduJp2Writer, ossimJpegWriter, and ossimArcInfoGridWriter.

Definition at line 169 of file ossimImageFileWriter.cpp.

References ossimKeywordlist::add(), ossimString::c_str(), ossimKeywordNames::CREATE_EXTERNAL_GEOMETRY_KW, ossimKeywordNames::CREATE_HISTOGRAM_KW, ossimKeywordNames::CREATE_IMAGE_KW, ossimKeywordNames::CREATE_OVERVIEW_KW, ossimKeywordNames::FILENAME_KW, ossimObject::getClassName(), theFilename, theScaleToEightBitFlag, theWriteEnviHeaderFlag, theWriteErsHeaderFlag, theWriteExternalGeometryFlag, theWriteFgdcFlag, theWriteHistogramFlag, theWriteImageFlag, theWriteJpegWorldFileFlag, theWriteOverviewFlag, theWriteReadmeFlag, theWriteTiffWorldFileFlag, theWriteWorldFileFlag, and ossimKeywordNames::TYPE_KW.

Referenced by ossimArcInfoGridWriter::saveState(), ossimJpegWriter::saveState(), ossimKakaduJp2Writer::saveState(), ossimGeneralRasterWriter::saveState(), ossimKmlSuperOverlayWriter::saveState(), ossimGpkgWriter::saveState(), ossimPdfWriter::saveState(), and ossimWriter::saveState().

 {
    kwl.add(prefix,
            ossimKeywordNames::TYPE_KW,
            getClassName(),
            true);
 
    kwl.add(prefix,
            ossimKeywordNames::FILENAME_KW,
            theFilename.c_str(),
            true);
 
    kwl.add(prefix,
            "create_envi_hdr",
            (ossim_uint32)theWriteEnviHeaderFlag,
            true);
 
    kwl.add(prefix,
            "create_ers_hdr",
            (ossim_uint32)theWriteErsHeaderFlag,
            true);
 
    kwl.add(prefix,
            ossimKeywordNames::CREATE_EXTERNAL_GEOMETRY_KW,
            (ossim_uint32)theWriteExternalGeometryFlag,
            true);
 
    kwl.add(prefix,
            "create_fgdc",
            (ossim_uint32)theWriteFgdcFlag,
            true);
    
    kwl.add(prefix,
            "create_jpeg_world_file",
            (ossim_uint32)theWriteJpegWorldFileFlag,
            true);
 
    kwl.add(prefix,
            "create_readme",
            (ossim_uint32)theWriteReadmeFlag,
            true);
    
    kwl.add(prefix,
            "create_tiff_world_file",
            (ossim_uint32)theWriteTiffWorldFileFlag,
            true);
 
    kwl.add(prefix,
            "create_world_file",
            (ossim_uint32)theWriteWorldFileFlag,
            true);
 
    kwl.add(prefix,
            ossimKeywordNames::CREATE_IMAGE_KW,
            (ossim_uint32)theWriteImageFlag,
            true);
 
    kwl.add(prefix,
            ossimKeywordNames::CREATE_OVERVIEW_KW,
            (ossim_uint32)theWriteOverviewFlag,
            true);
 
    kwl.add(prefix,
            ossimKeywordNames::CREATE_HISTOGRAM_KW,
            (ossim_uint32)theWriteHistogramFlag,
            true);
 
    kwl.add(prefix,
            SCALE_TO_EIGHT_BIT_KW,
            (ossim_uint32)theScaleToEightBitFlag,
            true);
    kwl.add(prefix,
            AUTO_CREATE_DIRECTORY_KW,
            theAutoCreateDirectoryFlag,
            true);
    kwl.add(prefix,
            ossimKeywordNames::OVERVIEW_COMPRESSION_TYPE_KW,
            theOverviewCompressType,
            true);
 
    kwl.add(prefix,
            ossimKeywordNames::OVERVIEW_COMPRESSION_QUALITY_KW,
            theOverviewJpegCompressQuality,
            true);
 
    ossimImageTypeLut lut;
    kwl.add(prefix,
            ossimKeywordNames::IMAGE_TYPE_KW,
            theOutputImageType,
            true);
 
    //---
    // When "theLinearUnits" == "unknown" that is a key to the writer to just
    // use whatever units makes sense for the projection.  Since "unknown"
    // doesn't look good to the average user in a spec file, change to
    // "default" if "unknown".  When read back in by the lookup table since
    // "default" is not a valid "string" theLinearUnits will remain "unknown".
    // Kind of a hack but it works:)  (drb)
    //---
    ossimString os = ossimUnitTypeLut::instance()->
       getEntryString(theLinearUnits);
    if (os == "unknown")
    {
       os = "default";  // Avoid saving as unknown for user readability.
    }
    kwl.add(prefix, "linear_units", os, true);
 
    // Set the pixel type.
    ossimString pixelType;
    getPixelTypeString(pixelType);
    kwl.add(prefix,
            ossimKeywordNames::PIXEL_TYPE_KW,
            pixelType.c_str(),
            true);
 
    return ossimSource::saveState(kwl, prefix);
 }

◆ setAreaOfInterest()

void ossimImageFileWriter::setAreaOfInterest ( const ossimIrect & inputRect )

virtual

Reimplemented from ossimImageWriter.

Definition at line 992 of file ossimImageFileWriter.cpp.

References ossimImageSourceSequencer::getBoundingRect(), ossimImageWriter::setAreaOfInterest(), ossimImageSourceSequencer::setAreaOfInterest(), ossimImageWriter::theAreaOfInterest, theInputConnection, and ossimRefPtr< T >::valid().

Referenced by ossimChipProcTool::execute(), ossimKmlSuperOverlayWriter::generateTile(), ossimIgen::outputProduct(), ATP::AtpAnnotatedImage::write(), and ossimHlzTool::writeSlopeImage().

 {
    // This sets "theAreaOfInterest".
    ossimImageWriter::setAreaOfInterest(inputRect);
    
    if( theInputConnection.valid() )
    {
       //---
       // ossimImageSourceSequencer::setAreaOfInterest does more than just set the
       // variable, so only call if out of sync to avoid wasted cycles.
       //--- 
       if ( theAreaOfInterest != theInputConnection->getBoundingRect() )
       {
          // Set the sequencer area of interest.
          theInputConnection->setAreaOfInterest(inputRect);
       }
    }
 }

◆ setFilename()

void ossimImageFileWriter::setFilename ( const ossimFilename & file )

virtual

Definition at line 1217 of file ossimImageFileWriter.cpp.

References theFilename.

Referenced by ossimImageWriterFactoryRegistry::createWriter(), ossimKmlSuperOverlayWriter::generateTile(), ossimGeneralRasterWriter::loadState(), loadState(), main(), ossimIgen::outputProduct(), setOutputName(), ATP::AtpAnnotatedImage::write(), writeRaster(), and ossimHlzTool::writeSlopeImage().

 {
    theFilename = file;
 }

◆ setOutputImageType() [1/2]

void ossimImageFileWriter::setOutputImageType ( ossim_int32 type )

virtual

Definition at line 843 of file ossimImageFileWriter.cpp.

References ossimLookUpTable::getEntryString(), and theOutputImageType.

Referenced by ossimImageWriterFactory::createFromMimeType(), ossimImageWriterFactory::createWriter(), ossimImageWriterFactory::createWriterFromExtension(), ossimGeneralRasterWriter::ossimGeneralRasterWriter(), ossimKmlSuperOverlayWriter::ossimKmlSuperOverlayWriter(), and ossimGdalWriter::setOutputImageType().

 {
    ossimImageTypeLut lut;
    theOutputImageType = lut.getEntryString(type);
 }

◆ setOutputImageType() [2/2]

void ossimImageFileWriter::setOutputImageType ( const ossimString & type )

virtual

Reimplemented in ossimGdalWriter.

Definition at line 838 of file ossimImageFileWriter.cpp.

References theOutputImageType.

 {
    theOutputImageType = type;
 }

◆ setOutputName()

void ossimImageFileWriter::setOutputName ( const ossimString & outputName )

virtual

This is a generic interface to allow one to set the output name of the writer. If its a Visual display this could be used to set the title. If this is a file output then this could be a directory or a file name.

Reimplemented from ossimOutputSource.

Definition at line 1211 of file ossimImageFileWriter.cpp.

References setFilename(), and ossimOutputSource::setOutputName().

 {
    ossimImageWriter::setOutputName(outputName);
    setFilename(ossimFilename(outputName));
 }

◆ setOutputStream() [1/2]

bool ossimImageFileWriter::setOutputStream ( ossimRefPtr< ossimOStream > stream )

virtual

Sets the output stream to write to.

This implementation in this class does nothing and returns false. Derived classed should implement as needed.

Parameters

stream The stream to write to.

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

Definition at line 1184 of file ossimImageFileWriter.cpp.

Referenced by ossimIgen::outputProduct().

 {
    //---
    // Not implemented in this class. Derived classed should implement if
    // they can write to a stream.
    //---
    return false;
 }

◆ setOutputStream() [2/2]

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

virtual

tmp drb

Reimplemented in ossimPngWriter, ossimPdfWriter, ossimOpjJp2Writer, ossimKakaduJp2Writer, ossimKakaduNitfWriter, ossimWriter, and ossimGeneralRasterWriter.

Definition at line 1194 of file ossimImageFileWriter.cpp.

 {
    //---
    // Not implemented in this class. Derived classed should implement if
    // they can write to a stream.
    //---
    return false;
 }

◆ setOverviewCompressType()

void ossimImageFileWriter::setOverviewCompressType ( ossim_uint16 type )

virtual

Definition at line 1245 of file ossimImageFileWriter.cpp.

References theOverviewCompressType.

 {
    theOverviewCompressType = type;
 }

◆ setOverviewJpegCompressQuality()

void ossimImageFileWriter::setOverviewJpegCompressQuality ( ossim_int32 quality )

virtual

Definition at line 1250 of file ossimImageFileWriter.cpp.

References theOverviewJpegCompressQuality.

 {
    theOverviewJpegCompressQuality = quality;
 }

◆ setPercentComplete()

void ossimImageFileWriter::setPercentComplete ( double percentComplete )

virtual

Reimplemented from ossimProcessInterface.

Definition at line 1204 of file ossimImageFileWriter.cpp.

References ossimListenerManager::fireEvent(), and ossimProcessInterface::setPercentComplete().

Referenced by while(), ossimNitf20Writer::writeBlockBandSeparate(), ossimNitfWriter::writeBlockBandSeparate(), ossimNitf20Writer::writeBlockBandSequential(), and ossimNitfWriter::writeBlockBandSequential().

 {
    ossimProcessInterface::setPercentComplete(percentComplete);
    ossimProcessProgressEvent event(this, percentComplete);
    fireEvent(event);
 }

◆ setPixelType() [1/2]

void ossimImageFileWriter::setPixelType ( ossimPixelType type )

virtual

If "point" the coordinate tie points are relative to the center of the pixel.

If "area" the coordinate tie points are relative to the upper left corner of the pixel.

For image types that are keyed, tiff for instance, this will set the geotiff key: GTRasterTypeGeoKey

If meta data writers are enabled, world file writers for instance, this will also be propagated to them.

Default in this writer is: OSSIM_PIXEL_IS_POINT

Parameters

type	OSSIM_PIXEL_IS_POINT = center of pixel OSSIM_PIXEL_IS_AREA = upper left corner of pixel

Definition at line 1538 of file ossimImageFileWriter.cpp.

References thePixelType.

Referenced by setPixelType().

 {
    thePixelType = type;
 }

◆ setPixelType() [2/2]

void ossimImageFileWriter::setPixelType ( const ossimString & type )

virtual

If "point" the coordinate tie points are relative to the center of the pixel.

If "area" the coordinate tie points are relative to the upper left corner of the pixel.

For image types that are keyed, tiff for instance, this will set the geotiff key: GTRasterTypeGeoKey

If meta data writers are enabled, world file writers for instance, this will also be propagated to them.

Default in this writer is: OSSIM_PIXEL_IS_POINT

Parameters

type	"point" = center of pixel "area" = upper left corner of pixel

Note: If the downcased "type" is not equal to "point" or "area" pixel type will remain unchanged.

Definition at line 1543 of file ossimImageFileWriter.cpp.

References ossimString::downcase(), OSSIM_PIXEL_IS_AREA, OSSIM_PIXEL_IS_POINT, and setPixelType().

 {
    ossimString s = type;
    s.downcase();
    if (s == "point")
    {
       setPixelType(OSSIM_PIXEL_IS_POINT);
    }
    else if (s == "area")
    {
       setPixelType(OSSIM_PIXEL_IS_AREA);
    }
 }

◆ setProperty()

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

virtual

Reimplemented from ossimSource.

Reimplemented in ossimWriter, ossimPdfWriter, ossimTiffWriter, ossimGpkgWriter, ossimPngWriter, ossimKmlSuperOverlayWriter, ossimOpjJp2Writer, ossimKakaduNitfWriter, ossimGdalWriter, ossimKakaduJp2Writer, ossimJpegWriter, ossimNitfWriter, ossimNitfWriterBase, and ossimNitf20Writer.

Definition at line 1255 of file ossimImageFileWriter.cpp.

References ossimKeywordNames::CREATE_EXTERNAL_GEOMETRY_KW, ossimKeywordNames::CREATE_HISTOGRAM_KW, ossimKeywordNames::CREATE_IMAGE_KW, ossimKeywordNames::CREATE_OVERVIEW_KW, ossimKeywordNames::FILENAME_KW, ossimProperty::getName(), theFilename, theScaleToEightBitFlag, theWriteEnviHeaderFlag, theWriteErsHeaderFlag, theWriteExternalGeometryFlag, theWriteFgdcFlag, theWriteHistogramFlag, theWriteImageFlag, theWriteJpegWorldFileFlag, theWriteOverviewFlag, theWriteReadmeFlag, theWriteTiffWorldFileFlag, and theWriteWorldFileFlag.

Referenced by ossimNitf20Writer::setProperty(), ossimJpegWriter::setProperty(), ossimKakaduJp2Writer::setProperty(), ossimGdalWriter::setProperty(), ossimKmlSuperOverlayWriter::setProperty(), ossimTiffWriter::setProperty(), and ossimPdfWriter::setProperty().

 {
    if(!property) return;
    
    if(property->getName() == ossimKeywordNames::FILENAME_KW)
    {
       theFilename = property->valueToString();
    }
    else if (property->getName() == "create_envi_hdr")
    {
       theWriteEnviHeaderFlag = property->valueToString().toBool();
    }
    else if (property->getName() == "create_ers_hdr")
    {
       theWriteErsHeaderFlag = property->valueToString().toBool();
    }
    else if (property->getName() ==
             ossimKeywordNames::CREATE_EXTERNAL_GEOMETRY_KW)
    {
       theWriteExternalGeometryFlag = property->valueToString().toBool();
    }
    else if (property->getName() == "create_fgdc")
    {
       theWriteFgdcFlag = property->valueToString().toBool();
    }
    else if (property->getName() == "create_jpeg_world_file")
    {
       theWriteJpegWorldFileFlag = property->valueToString().toBool();
    }
    else if (property->getName() == "create_readme")
    {
       theWriteReadmeFlag = property->valueToString().toBool();
    }
    else if (property->getName() == "create_tiff_world_file")
    {
       theWriteTiffWorldFileFlag = property->valueToString().toBool();
    }
    else if (property->getName() == "create_world_file")
    {
       theWriteWorldFileFlag = property->valueToString().toBool();
    }
    else if (property->getName() == ossimKeywordNames::CREATE_IMAGE_KW)
    {
       theWriteImageFlag = property->valueToString().toBool();
    }
    else if (property->getName() == ossimKeywordNames::CREATE_OVERVIEW_KW)
    {
       theWriteOverviewFlag = property->valueToString().toBool();
    }
    else if (property->getName() == ossimKeywordNames::CREATE_HISTOGRAM_KW)
    {
       theWriteHistogramFlag = property->valueToString().toBool();
    }
    else if (property->getName() == SCALE_TO_EIGHT_BIT_KW)
    {
       theScaleToEightBitFlag = property->valueToString().toBool();
    }
    else if(property->getName() == AUTO_CREATE_DIRECTORY_KW)
    {
       theAutoCreateDirectoryFlag = property->valueToString().toBool();
    }
    else if (property->getName() == "linear_units")
    {
       theLinearUnits = (ossimUnitType)
          (ossimUnitTypeLut::instance()->
           getEntryNumber(property->valueToString()));
    }
    else if(property->getName() == ossimKeywordNames::IMAGE_TYPE_KW)
    {
       setOutputImageType(property->valueToString());
    }
    else if(property->getName() == ossimKeywordNames::PIXEL_TYPE_KW)
    {
       ossimStringProperty* stringProperty = PTR_CAST(ossimStringProperty,
                                                      property.get());
       if (stringProperty)
       {
          ossimString s;
          stringProperty->valueToString(s);
          setPixelType(s);
       }
    }
    else
    {
       ossimImageWriter::setProperty(property);
    }
 }

◆ setScaleToEightBitFlag()

void ossimImageFileWriter::setScaleToEightBitFlag ( bool flag )

virtual

Definition at line 937 of file ossimImageFileWriter.cpp.

References theScaleToEightBitFlag.

 {
    theScaleToEightBitFlag = flag;
 }

◆ setTileSize()

void ossimImageFileWriter::setTileSize ( const ossimIpt & tileSize )

virtual

Sets the output image tiling size if supported by the writer.

If not supported this simply sets the sequencer(input) tile size.

Reimplemented in ossimWriter, ossimNitfWriter, and ossimTiffWriter.

Definition at line 1574 of file ossimImageFileWriter.cpp.

References ossimImageSourceSequencer::setTileSize(), theInputConnection, and ossimRefPtr< T >::valid().

 {
    if (theInputConnection.valid())
    {
       theInputConnection->setTileSize(tileSize);
    }
 }

◆ setWriteEnviHeaderFlag()

void ossimImageFileWriter::setWriteEnviHeaderFlag ( bool flag )

virtual

Definition at line 942 of file ossimImageFileWriter.cpp.

References theWriteEnviHeaderFlag.

 {
    theWriteEnviHeaderFlag = flag;
 }

◆ setWriteErsHeaderFlag()

void ossimImageFileWriter::setWriteErsHeaderFlag ( bool flag )

virtual

Definition at line 947 of file ossimImageFileWriter.cpp.

References theWriteErsHeaderFlag.

 {
    theWriteErsHeaderFlag = flag;
 }

◆ setWriteExternalGeometryFlag()

void ossimImageFileWriter::setWriteExternalGeometryFlag ( bool flag )

virtual

Definition at line 952 of file ossimImageFileWriter.cpp.

References theWriteExternalGeometryFlag.

Referenced by ossimGeneralRasterWriter::ossimGeneralRasterWriter(), and ossimNitf20Writer::ossimNitf20Writer().

 {
    theWriteExternalGeometryFlag = flag;
 }

◆ setWriteFgdcFlag()

void ossimImageFileWriter::setWriteFgdcFlag ( bool flag )

virtual

Definition at line 957 of file ossimImageFileWriter.cpp.

References theWriteFgdcFlag.

 {
    theWriteFgdcFlag = flag;
 }

◆ setWriteHistogramFlag()

void ossimImageFileWriter::setWriteHistogramFlag ( bool flag )

virtual

Definition at line 932 of file ossimImageFileWriter.cpp.

References theWriteHistogramFlag.

 {
    theWriteHistogramFlag = flag;
 }

◆ setWriteImageFlag()

void ossimImageFileWriter::setWriteImageFlag ( bool flag )

virtual

Definition at line 927 of file ossimImageFileWriter.cpp.

References theWriteImageFlag.

 {
    theWriteImageFlag = flag;
 }

◆ setWriteJpegWorldFile()

void ossimImageFileWriter::setWriteJpegWorldFile ( bool flag )

virtual

Definition at line 962 of file ossimImageFileWriter.cpp.

References theWriteJpegWorldFileFlag.

 {
    theWriteJpegWorldFileFlag  = flag;
 }

◆ setWriteOverviewFlag()

void ossimImageFileWriter::setWriteOverviewFlag ( bool flag )

virtual

Definition at line 922 of file ossimImageFileWriter.cpp.

References theWriteOverviewFlag.

 {
    theWriteOverviewFlag = flag;
 }

◆ setWriteReadme()

void ossimImageFileWriter::setWriteReadme ( bool flag )

virtual

Definition at line 967 of file ossimImageFileWriter.cpp.

References theWriteReadmeFlag.

 {
    theWriteReadmeFlag = flag;
 }

◆ setWriteTiffWorldFile()

void ossimImageFileWriter::setWriteTiffWorldFile ( bool flag )

virtual

Definition at line 972 of file ossimImageFileWriter.cpp.

References theWriteTiffWorldFileFlag.

 {
    theWriteTiffWorldFileFlag  = flag;
 }

◆ setWriteWorldFile()

void ossimImageFileWriter::setWriteWorldFile ( bool flag )

virtual

Definition at line 977 of file ossimImageFileWriter.cpp.

References theWriteWorldFileFlag.

 {
    theWriteWorldFileFlag  = flag;
 }

◆ writeEnviHeaderFile()

bool ossimImageFileWriter::writeEnviHeaderFile ( )

virtual

Will write an envi header file.

If "theFilename" is "foo.tif" then this will write out "foo.hdr".

Definition at line 500 of file ossimImageFileWriter.cpp.

References ossimConnectableObject::connectMyInputTo(), ossimMetadataFileWriter::execute(), ossimRefPtr< T >::get(), ossimIrect::hasNans(), ossimMetadataFileWriter::initialize(), ossimMetadataFileWriter::setAreaOfInterest(), ossimFilename::setExtension(), ossimMetadataFileWriter::setFilename(), ossimMetadataFileWriter::setPixelType(), ossimImageWriter::theAreaOfInterest, theFilename, theInputConnection, and thePixelType.

Referenced by writeMetaDataFiles().

 {
    if( (theFilename == "") || !theInputConnection ||
        theAreaOfInterest.hasNans())
    {
       return false;
    }
 
    // Make the file name.
    ossimFilename outputFile = theFilename;
    outputFile.setExtension(ossimString("hdr"));
 
    // Make the writer.
    ossimRefPtr<ossimMetadataFileWriter> writer =
       new ossimEnviHeaderFileWriter();
    
    // Set things up.
    writer->connectMyInputTo(0, theInputConnection.get());
    writer->initialize();
    writer->setFilename(outputFile);
    writer->setPixelType(thePixelType);
    writer->setAreaOfInterest(theAreaOfInterest);
    
    // Write it to disk.
    return writer->execute();
 }

◆ writeErsHeaderFile()

bool ossimImageFileWriter::writeErsHeaderFile ( )

virtual

Will write an ER Mapper header file.

If "theFilename" is "foo.tif" then this will write out "foo.hdr".

Definition at line 527 of file ossimImageFileWriter.cpp.

References ossimConnectableObject::connectMyInputTo(), ossimMetadataFileWriter::execute(), ossimRefPtr< T >::get(), ossimIrect::hasNans(), ossimMetadataFileWriter::initialize(), ossimMetadataFileWriter::setAreaOfInterest(), ossimFilename::setExtension(), ossimMetadataFileWriter::setFilename(), ossimMetadataFileWriter::setPixelType(), ossimImageWriter::theAreaOfInterest, theFilename, theInputConnection, and thePixelType.

Referenced by writeMetaDataFiles().

 {
    if( (theFilename == "") || !theInputConnection ||
        theAreaOfInterest.hasNans())
    {
       return false;
    }
    
    // Make the file name.
    ossimFilename outputFile = theFilename;
    outputFile.setExtension(ossimString("ers"));
 
    // Make the writer.
    ossimRefPtr<ossimMetadataFileWriter> writer =
        new ossimERSFileWriter();
    
    // Set things up.
    writer->connectMyInputTo(0, theInputConnection.get());
    writer->initialize();
    writer->setFilename(outputFile);
    writer->setPixelType(thePixelType);
    writer->setAreaOfInterest(theAreaOfInterest);
    
    // Write it to disk.
    return writer->execute();
 }

◆ writeExternalGeometryFile()

bool ossimImageFileWriter::writeExternalGeometryFile ( )

virtual

Will write an external geometry file.

If "theFilename" is "foo.tif" then this will write out "foo.geom".

Definition at line 554 of file ossimImageFileWriter.cpp.

References ossimConnectableObject::connectMyInputTo(), ossimMetadataFileWriter::execute(), ossimRefPtr< T >::get(), ossimIrect::hasNans(), ossimMetadataFileWriter::initialize(), ossimMetadataFileWriter::setAreaOfInterest(), ossimFilename::setExtension(), ossimMetadataFileWriter::setFilename(), ossimMetadataFileWriter::setPixelType(), ossimImageWriter::theAreaOfInterest, theFilename, theInputConnection, and thePixelType.

Referenced by writeMetaDataFiles().

 {
    if( (theFilename == "") || !theInputConnection ||
        theAreaOfInterest.hasNans())
    {
       return false;
    }
 
    // Make the file name.
    ossimFilename geomFile = theFilename;
    geomFile.setExtension(ossimString("geom"));
 
    // Make the writer.
    ossimRefPtr<ossimMetadataFileWriter> writer = new ossimGeomFileWriter();
 
    // Set things up.
 //   writer->connectMyInputTo(0, theInputConnection.get());
    writer->connectMyInputTo(0, theInputConnection.get());
    writer->setFilename(geomFile);
    writer->initialize();
    writer->setPixelType(thePixelType);
    writer->setAreaOfInterest(theAreaOfInterest);
 
    // Write it to disk.
    return writer->execute();
 }

◆ writeFgdcFile()

bool ossimImageFileWriter::writeFgdcFile ( )

virtual

Will write an fgdc file.

If "theFilename" is "foo.tif" then this will write out "foo.xml".

Definition at line 581 of file ossimImageFileWriter.cpp.

References ossimConnectableObject::connectMyInputTo(), ossimMetadataFileWriter::execute(), ossimRefPtr< T >::get(), ossimIrect::hasNans(), ossimMetadataFileWriter::initialize(), ossimMetadataFileWriter::setAreaOfInterest(), ossimFilename::setExtension(), ossimMetadataFileWriter::setFilename(), ossimMetadataFileWriter::setPixelType(), ossimImageWriter::theAreaOfInterest, theFilename, theInputConnection, and thePixelType.

 {
    if( (theFilename == "") || !theInputConnection ||
        theAreaOfInterest.hasNans())
    {
       return false;
    }
 
    // Make the file name.
    ossimFilename outputFile = theFilename;
    outputFile.setExtension(ossimString("xml"));
 
    // Make the writer.
    ossimRefPtr<ossimMetadataFileWriter> writer = new ossimFgdcFileWriter();
    
    // Set things up.
    writer->connectMyInputTo(0, theInputConnection.get());
    writer->initialize();
    writer->setFilename(outputFile);
    writer->setPixelType(thePixelType);
    writer->setAreaOfInterest(theAreaOfInterest);
    
    // Write it to disk.
    return writer->execute();
 }

◆ writeFile()

virtual bool ossimImageFileWriter::writeFile ( )

protectedpure virtual

Write out the file.

Returns: true on success, false on error.

Implemented in ossimGpkgWriter, ossimPngWriter, ossimPdfWriter, ossimOpjJp2Writer, ossimWriter, ossimTiffWriter, ossimNitfWriter, ossimKakaduNitfWriter, ossimKakaduJp2Writer, ossimKmlSuperOverlayWriter, ossimJpegWriter, ossimGeneralRasterWriter, ossimNitf20Writer, ossimGdalWriter, and ossimArcInfoGridWriter.

◆ writeHistogramFile()

bool ossimImageFileWriter::writeHistogramFile ( )

virtual

Returns true on success, false on error.

Definition at line 780 of file ossimImageFileWriter.cpp.

References ossimListenerManager::addListener(), ossimConnectableObject::connectMyInputTo(), ossimConnectableObject::disconnect(), ossimSource::enableSource(), ossimHistogramWriter::execute(), ossimRefPtr< T >::get(), ossimImageHandlerRegistry::instance(), ossimProcessInterface::needsAborting(), ossimOutputSource::open(), ossimFilename::setExtension(), ossimHistogramWriter::setFilename(), ossimImageHistogramSource::setMaxNumberOfRLevels(), theFilename, and theStdOutProgress.

 {
    if(needsAborting()) return false;
    if(theFilename == "") return false;
 
    ossimFilename histogram_file = theFilename;
    histogram_file.setExtension(ossimString("his"));
 
    ossimRefPtr<ossimImageHandler> handler = ossimImageHandlerRegistry::instance()->
       open(theFilename);
 
    if (!handler)
    {
       return false;
    }
 
    ossimRefPtr<ossimImageHistogramSource> histoSource = new ossimImageHistogramSource;
 
    ossimRefPtr<ossimHistogramWriter> writer = new ossimHistogramWriter;
    histoSource->setMaxNumberOfRLevels(1); // Only compute for r0.
    histoSource->connectMyInputTo(0, handler.get());
    histoSource->enableSource();
    writer->connectMyInputTo(0, histoSource.get());
    writer->setFilename(histogram_file);
    writer->addListener(&theStdOutProgress);
    writer->execute();
    writer->disconnect();
    histoSource->disconnect();
    handler->disconnect();
    writer = 0; histoSource = 0; handler = 0;
    return true;
 }

◆ writeJpegWorldFile()

bool ossimImageFileWriter::writeJpegWorldFile ( )

virtual

Will write a jpeg world file.

If "theFilename" is "foo.tif" then this will write out "foo.jpw".

Definition at line 607 of file ossimImageFileWriter.cpp.

References ossimFilename::setExtension(), theFilename, and writeWorldFile().

 {
    if(theFilename == "")
    {
       return false;
    }
    
    // Make the file name.
    ossimFilename file = theFilename;
    file.setExtension(ossimString("jpw")); // jpw???
 
    return writeWorldFile(file);
 }

◆ writeMetaDataFiles()

bool ossimImageFileWriter::writeMetaDataFiles ( )

virtual

Convenience method that calls meta data write methods that are flagged to be called.

Attempts to write all files flagged to be written even if one file writer returns false.

Currently calls these methods if flagged: writeEnviHeaderFile writeExternalGeometryFile writeFgdcFile writeJpegWorldFile writeReadmeFile writeTiffWorldFile writeOverviewFile writeHistogramFile

Returns: true if all files flagged are written, false if not.

Definition at line 663 of file ossimImageFileWriter.cpp.

References ossimProcessInterface::needsAborting(), ossimNotify(), ossimNotifyLevel_WARN, status, theWriteEnviHeaderFlag, theWriteErsHeaderFlag, theWriteExternalGeometryFlag, writeEnviHeaderFile(), writeErsHeaderFile(), and writeExternalGeometryFile().

 {
    bool status = true;
    
    if(theWriteEnviHeaderFlag&&!needsAborting())
    {
       if(writeEnviHeaderFile() == false)
       {
          status = false;
 
          ossimNotify(ossimNotifyLevel_WARN)
             << "Write of envi header file failed!" << endl;
       }
    }
 
    if(theWriteErsHeaderFlag&&!needsAborting())
    {
       if(writeErsHeaderFile() == false)
       {
          status = false;
 
          ossimNotify(ossimNotifyLevel_WARN)
             << "Write of ers header file failed!" << endl;
       }
    }
 
    if (theWriteExternalGeometryFlag&&!needsAborting())
    {
       if( writeExternalGeometryFile() == false)
       {
          status = false;
          if(traceDebug())
          {
             ossimNotify(ossimNotifyLevel_WARN)
             << "Write of geometry file failed!" << endl;
          }
       }
    }
    if(theWriteFgdcFlag&&!needsAborting())
    {
       if(writeFgdcFile() == false)
       {
          status = false;
          if(traceDebug())
          {
             ossimNotify(ossimNotifyLevel_WARN)
             << "Write of fgdc file failed!" << endl;
          }
       }
    }
    if(theWriteJpegWorldFileFlag&&!needsAborting())
    {
       if(writeJpegWorldFile() == false)
       {
          status = false;
          if(traceDebug())
          {
             ossimNotify(ossimNotifyLevel_WARN)
             << "Write of jpeg world file failed!" << endl;
          }
       }
    }
    if(theWriteReadmeFlag&&!needsAborting())
    {
       if(writeReadmeFile() == false)
       {
          status = false;
          
          if(traceDebug())
          {
             ossimNotify(ossimNotifyLevel_WARN)
             << "Write of readme file failed!" << endl;
          }
       }
    }
    if(theWriteTiffWorldFileFlag&&!needsAborting())
    {
       if(writeTiffWorldFile() == false)
       {
          status = false;
          if(traceDebug())
          {
             ossimNotify(ossimNotifyLevel_WARN)
             << "Write of tiff world file failed!" << endl;
          }
       }
    }
 
    if(theWriteWorldFileFlag&&!needsAborting())
    {
       if(writeWorldFile() == false)
       {
          status = false;
          if(traceDebug())
          {
             ossimNotify(ossimNotifyLevel_WARN)
             << "Write of world file failed!" << endl;
          }
       }
    }
    
    if (theWriteHistogramFlag&&!needsAborting())
    {
       if (!writeHistogramFile())
       {
          status = false;
          if(traceDebug())
          {
             ossimNotify(ossimNotifyLevel_WARN)
             << "Write of histogram file failed!" << endl;
          }
       }
    }
 
    return status;
 }

◆ writeOverviewFile()

bool ossimImageFileWriter::writeOverviewFile	(	ossim_uint16	tiff_compress_type = `1`,
		ossim_int32	jpeg_compress_quality = `75`,
		bool	includeR0 = `false`
	)

virtual

Write out an ossim overview file from the source_file.

If source file is "foo.tif", this will create a "foo.ovr" in the same directory.

Parameters

source_file	The file to create overview from.
tiff_compress_type	valid types: COMPRESSION_JPEG COMPRESSION_DEFLATE COMPRESSION_PACKBITS COMPRESSION_NONE=1 (default)
jpeg_compress_quality	Compression quality. Only valid with COMPRESSION_JPEG. Range 1 to 100 with 100 being the best. default = 75

Returns: true on success, false on error.

Definition at line 455 of file ossimImageFileWriter.cpp.

References ossimListenerManager::addListener(), ossimTiffOverviewBuilder::execute(), ossimRefPtr< T >::get(), ossimImageHandlerRegistry::instance(), ossimImageHandlerRegistry::open(), ossimListenerManager::removeListener(), ossimTiffOverviewBuilder::setCompressionType(), ossimTiffOverviewBuilder::setCopyAllFlag(), ossimFilename::setExtension(), ossimTiffOverviewBuilder::setInputSource(), ossimTiffOverviewBuilder::setJpegCompressionQuality(), ossimTiffOverviewBuilder::setOutputFile(), theFilename, theProgressListener, and ossimRefPtr< T >::valid().

 {
    if(theFilename == "") return false;
 
    // Get an image handler for the source file.
    ossimRefPtr<ossimImageHandler> ih
       = ossimImageHandlerRegistry::instance()->open(theFilename);
 
    if (ih.valid() == false)
    {
       // Set the error...
       return false;
    }
 
    ossimRefPtr<ossimTiffOverviewBuilder> ob = new ossimTiffOverviewBuilder();
    
    if ( ob->setInputSource(ih.get()) )
    {
       // Give the listener to the overview builder if set.
       if (theProgressListener)
       {
          ob->addListener(theProgressListener);
       }
       
       // Build a new file name for the overview.
       ossimFilename overview_file = theFilename;
       overview_file.setExtension(ossimString("ovr"));
       ob->setCompressionType(tiff_compress_type);
       ob->setJpegCompressionQuality(jpeg_compress_quality);
       ob->setOutputFile(overview_file);
       ob->setCopyAllFlag(includeR0);
       ob->execute();
 
       // Remove the listener from the overview builder.
       if (theProgressListener)
       {
          ob->removeListener(theProgressListener);
       }
    }
 
    return true;
 }

◆ writeReadmeFile()

bool ossimImageFileWriter::writeReadmeFile ( )

virtual

Will write a readme file.

If "theFilename" is "foo.tif" then this will write out "foo_readme.txt".

Definition at line 621 of file ossimImageFileWriter.cpp.

References ossimConnectableObject::connectMyInputTo(), ossimMetadataFileWriter::execute(), ossimRefPtr< T >::get(), ossimIrect::hasNans(), ossimMetadataFileWriter::initialize(), ossimFilename::noExtension(), ossimMetadataFileWriter::setAreaOfInterest(), ossimMetadataFileWriter::setFilename(), ossimMetadataFileWriter::setPixelType(), ossimImageWriter::theAreaOfInterest, theFilename, theInputConnection, and thePixelType.

 {
    if( (theFilename == "") || !theInputConnection ||
        theAreaOfInterest.hasNans())
    {
       return false;
    }
 
    // Make the file name.
    ossimFilename outputFile = theFilename.noExtension();
    
    outputFile += "_readme.txt";
 
    // Make the writer.
    ossimRefPtr<ossimMetadataFileWriter> writer =
       new ossimReadmeFileWriter();
    
    // Set things up.
    writer->connectMyInputTo(0, theInputConnection.get());
    writer->initialize();
    writer->setFilename(outputFile);
    writer->setPixelType(thePixelType);
    writer->setAreaOfInterest(theAreaOfInterest);
    
    // Write it to disk.
    return writer->execute();
 }

◆ writeStream()

bool ossimImageFileWriter::writeStream ( )

virtual

Method to write the image to a stream.

This implementation does nothing and returns false. Derived classed should implement as needed.

Returns: true on success, false on error.

Reimplemented in ossimPngWriter, ossimPdfWriter, ossimOpjJp2Writer, ossimKmlSuperOverlayWriter, ossimKakaduJp2Writer, ossimKakaduNitfWriter, ossimWriter, and ossimGeneralRasterWriter.

Definition at line 1166 of file ossimImageFileWriter.cpp.

 {
    //---
    // Not implemented in this class. Derived classed should implement if
    // they can write to a stream.
    //--- 
    return false;
 }

◆ writeTiffWorldFile()

bool ossimImageFileWriter::writeTiffWorldFile ( )

virtual

Will write a world file.

If "theFilename" is "foo.tif" then this will write out "foo.tfw".

Definition at line 649 of file ossimImageFileWriter.cpp.

References ossimFilename::setExtension(), theFilename, and writeWorldFile().

 {
    if(theFilename == "")
    {
       return false;
    }
    
    // Make the file name.
    ossimFilename file = theFilename;
    file.setExtension(ossimString("tfw"));
 
    return writeWorldFile(file);
 }

◆ writeWorldFile() [1/2]

bool ossimImageFileWriter::writeWorldFile ( )

virtual

Will write a world file.

The extension will be derived from the image extension.

Currently handles the following image extensions:

"tif" or "tiff" -> "tfw" "jpg" of "jpeg" -> "jpw" "png" -> "pgw" "sid" -> "sdw"

If extension does not match one of the above no file will be written and false will be returned.

Returns: true on success false on error.

Definition at line 1582 of file ossimImageFileWriter.cpp.

References ossimString::downcase(), ossimFilename::ext(), ossimNotify(), ossimNotifyLevel_WARN, ossimFilename::setExtension(), ossimString::size(), and theFilename.

Referenced by writeJpegWorldFile(), and writeTiffWorldFile().

 {
    bool result = false;
    
    if( theFilename.size() )
    {
       // Make the file name.
       ossimFilename file = theFilename;
       ossimString ext = file.ext().downcase();
       
       ossimString wfExt = ""; // World file extension.
       
       if ( ( ext == "tif" ) || ( ext == "tiff" ) )
       {
          wfExt = "tfw";
       }
       else if ( ( ext == "jpg" ) || ( ext == "jpeg" ) )
       {
          wfExt = "jpw";
       }
       else if ( ext == "png" )
       {
          wfExt = "pgw";
       }
       else if ( ext == "sid" )
       {
          wfExt = "sdw";
       }
       
       if ( ext.size() )
       {
          file.setExtension(wfExt);
          
          result = writeWorldFile(file);
       }
       else
       {
          ossimNotify(ossimNotifyLevel_WARN)
             << "Could not derive world file extension for: " << theFilename << "\n"; 
       }
    }
    
    if ( !result )
    {
       ossimNotify(ossimNotifyLevel_WARN)
          << "Write of world file failed!\n";
    }   
    
    return result;
 }

◆ writeWorldFile() [2/2]

bool ossimImageFileWriter::writeWorldFile ( const ossimFilename & file )

protected

Common world file writer method.

Parameters

file	The file to write like "foo.tfw" or "foo.jpw".

Returns: true on success, false on error.

Definition at line 1633 of file ossimImageFileWriter.cpp.

References ossimConnectableObject::connectMyInputTo(), ossimMetadataFileWriter::execute(), ossimRefPtr< T >::get(), ossimIrect::hasNans(), ossimMetadataFileWriter::initialize(), ossimMetadataFileWriter::setAreaOfInterest(), ossimMetadataFileWriter::setFilename(), ossimWorldFileWriter::setLinearUnits(), ossimMetadataFileWriter::setPixelType(), ossimImageWriter::theAreaOfInterest, theInputConnection, theLinearUnits, and thePixelType.

 {
    if( !theInputConnection || theAreaOfInterest.hasNans())
    {
       return false;
    }
 
    // Make the writer.
    ossimRefPtr<ossimWorldFileWriter> writer = new ossimWorldFileWriter();
    
    // Set things up.
    writer->connectMyInputTo(0, theInputConnection.get());
    writer->initialize();
    writer->setFilename(file);
    writer->setAreaOfInterest(theAreaOfInterest);
    writer->setLinearUnits(theLinearUnits);
    writer->setPixelType(thePixelType);
    
    // Write it to disk.
    return writer->execute(); 
 }

Member Data Documentation

◆ theAutoCreateDirectoryFlag

bool ossimImageFileWriter::theAutoCreateDirectoryFlag

protected

Definition at line 478 of file ossimImageFileWriter.h.

◆ theFilename

ossimFilename ossimImageFileWriter::theFilename

protected

Definition at line 456 of file ossimImageFileWriter.h.

Referenced by ossimKmlSuperOverlayWriter::generateRootKml(), ossimKmlSuperOverlayWriter::getExtension(), getFilename(), getProperty(), ossimPdfWriter::getTitle(), ossimArcInfoGridWriter::isOpen(), ossimKmlSuperOverlayWriter::isOpen(), ossimArcInfoGridWriter::open(), ossimNitf20Writer::open(), ossimNitfWriter::open(), ossimJpegWriter::open(), ossimKakaduJp2Writer::open(), ossimKakaduNitfWriter::open(), ossimGeneralRasterWriter::open(), ossimKmlSuperOverlayWriter::open(), ossimPngWriter::open(), ossimWriter::open(), ossimPdfWriter::open(), ossimGpkgWriter::open(), ossimTiffWriter::openTiff(), ossimGdalWriter::postProcessOutput(), saveState(), setFilename(), setProperty(), ossimArcInfoGridWriter::writeBinaryAigBounds(), ossimArcInfoGridWriter::writeBinaryAigHeader(), ossimArcInfoGridWriter::writeBinaryAigStats(), ossimGdalWriter::writeBlockFile(), writeEnviHeaderFile(), writeErsHeaderFile(), writeExternalGeometryFile(), writeFgdcFile(), ossimArcInfoGridWriter::writeFile(), ossimJpegWriter::writeFile(), ossimKakaduJp2Writer::writeGeotiffBox(), writeHistogramFile(), writeJpegWorldFile(), writeOverviewFile(), writeReadmeFile(), writeTiffWorldFile(), and writeWorldFile().

◆ theInputConnection

ossimRefPtr<ossimImageSourceSequencer> ossimImageFileWriter::theInputConnection

protected

Definition at line 453 of file ossimImageFileWriter.h.

Referenced by ossimGpkgWriter::addLevels(), ossimGdalWriter::allocateGdalDriverOptions(), ossimGdalWriter::buildGdalOverviews(), changeSequencer(), ossimGdalWriter::checkColorLut(), ossimTiffWriter::checkColorLut(), connectInputEvent(), disconnectInputEvent(), execute(), getSequencer(), ossimWriter::getTiffSampleFormat(), initialize(), ossimGdalWriter::isInputDataIndexed(), ossimWriter::needsMinMax(), ossimTiffWriter::openTiff(), ossimKmlSuperOverlayWriter::propagateViewChange(), ossimGpkgWriter::reInitializeCombiners(), ossimGpkgWriter::reInitializeCutters(), setAreaOfInterest(), setTileSize(), ossimPdfWriter::setupInputChain(), ossimGpkgWriter::setView(), while(), ossimArcInfoGridWriter::writeBinaryAigBounds(), ossimArcInfoGridWriter::writeBinaryAigHeader(), ossimArcInfoGridWriter::writeBinaryAigStats(), ossimNitf20Writer::writeBlockBandSeparate(), ossimNitfWriter::writeBlockBandSeparate(), ossimNitf20Writer::writeBlockBandSequential(), ossimNitfWriter::writeBlockBandSequential(), ossimGdalWriter::writeBlockFile(), ossimGpkgWriter::writeEntry(), writeEnviHeaderFile(), writeErsHeaderFile(), writeExternalGeometryFile(), writeFgdcFile(), ossimArcInfoGridWriter::writeFile(), ossimNitf20Writer::writeFile(), ossimGeneralRasterWriter::writeFile(), ossimJpegWriter::writeFile(), ossimKmlSuperOverlayWriter::writeFile(), ossimKakaduJp2Writer::writeFile(), ossimKakaduNitfWriter::writeFile(), ossimNitfWriter::writeFile(), ossimWriter::writeFile(), ossimPngWriter::writeFile(), ossimNitfWriterBase::writeGeometry(), ossimKakaduJp2Writer::writeGeotiffBox(), ossimKakaduJp2Writer::writeGmlBox(), ossimWriter::writeMinMaxTiffTags(), ossimGdalWriter::writeProjectionInfo(), writeReadmeFile(), ossimPngWriter::writeSignificantBits(), ossimWriter::writeSMinSMaxTiffTags(), ossimGeneralRasterWriter::writeStream(), ossimWriter::writeStream(), ossimPngWriter::writeStream(), ossimWriter::writeTiffTags(), ossimTiffWriter::writeTiffTags(), ossimGpkgWriter::writeTiles(), writeWorldFile(), and ~ossimImageFileWriter().

◆ theLinearUnits

ossimUnitType ossimImageFileWriter::theLinearUnits

protected

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

meters (default) us_survey_feet feet

This will be propagated to writers that can switch types and to the associated metadata writers.

Definition at line 491 of file ossimImageFileWriter.h.

Referenced by ossimTiffWriter::getUnitType(), loadState(), and writeWorldFile().

◆ theOutputImageType

ossimString ossimImageFileWriter::theOutputImageType

protected

◆ theOverviewCompressType

ossim_uint16 ossimImageFileWriter::theOverviewCompressType

protected

Definition at line 462 of file ossimImageFileWriter.h.

Referenced by getOverviewCompressType(), and setOverviewCompressType().

◆ theOverviewJpegCompressQuality

ossim_int32 ossimImageFileWriter::theOverviewJpegCompressQuality

protected

Definition at line 463 of file ossimImageFileWriter.h.

Referenced by getOverviewJpegCompressQuality(), and setOverviewJpegCompressQuality().

◆ thePixelType

ossimPixelType ossimImageFileWriter::thePixelType

protected

OSSIM_PIXEL_IS_POINT = 0, OSSIM_PIXEL_IS_AREA = 1.

Definition at line 494 of file ossimImageFileWriter.h.

Referenced by getPixelType(), getPixelTypeString(), loadState(), setPixelType(), writeEnviHeaderFile(), writeErsHeaderFile(), writeExternalGeometryFile(), writeFgdcFile(), writeReadmeFile(), and writeWorldFile().

◆ theProgressListener

ossimListener* ossimImageFileWriter::theProgressListener

protected

Definition at line 455 of file ossimImageFileWriter.h.

Referenced by addListener(), removeListener(), writeOverviewFile(), and ~ossimImageFileWriter().

◆ theScaleToEightBitFlag

bool ossimImageFileWriter::theScaleToEightBitFlag

protected

Definition at line 461 of file ossimImageFileWriter.h.

Referenced by getScaleToEightBitFlag(), loadState(), saveState(), setProperty(), and setScaleToEightBitFlag().

◆ theViewController

ossimRefPtr<ossimViewController> ossimImageFileWriter::theViewController

protected

Definition at line 454 of file ossimImageFileWriter.h.

Referenced by connectInputEvent(), and disconnectInputEvent().

◆ theWriteEnviHeaderFlag

bool ossimImageFileWriter::theWriteEnviHeaderFlag

protected

External meta data writer flags.

Not really part of an image writer, put here for convenience. If true the writer will do the connection work for you.

Definition at line 470 of file ossimImageFileWriter.h.

Referenced by getWriteEnviHeaderFlag(), loadState(), saveState(), setProperty(), setWriteEnviHeaderFlag(), and writeMetaDataFiles().

◆ theWriteErsHeaderFlag

bool ossimImageFileWriter::theWriteErsHeaderFlag

protected

Definition at line 471 of file ossimImageFileWriter.h.

Referenced by getWriteErsHeaderFlag(), loadState(), saveState(), setProperty(), setWriteErsHeaderFlag(), and writeMetaDataFiles().

◆ theWriteExternalGeometryFlag

bool ossimImageFileWriter::theWriteExternalGeometryFlag

protected

Definition at line 472 of file ossimImageFileWriter.h.

Referenced by getWriteExternalGeometryFlag(), loadState(), saveState(), setProperty(), setWriteExternalGeometryFlag(), and writeMetaDataFiles().

◆ theWriteFgdcFlag

bool ossimImageFileWriter::theWriteFgdcFlag

protected

Definition at line 473 of file ossimImageFileWriter.h.

Referenced by getWriteFgdcFlag(), loadState(), saveState(), setProperty(), and setWriteFgdcFlag().

◆ theWriteHistogramFlag

bool ossimImageFileWriter::theWriteHistogramFlag

protected

Definition at line 460 of file ossimImageFileWriter.h.

Referenced by getWriteHistogramFlag(), loadState(), saveState(), setProperty(), and setWriteHistogramFlag().

◆ theWriteImageFlag

bool ossimImageFileWriter::theWriteImageFlag

protected

Definition at line 458 of file ossimImageFileWriter.h.

Referenced by getWriteImageFlag(), loadState(), saveState(), setProperty(), and setWriteImageFlag().

◆ theWriteJpegWorldFileFlag

bool ossimImageFileWriter::theWriteJpegWorldFileFlag

protected

Definition at line 474 of file ossimImageFileWriter.h.

Referenced by getWriteJpegWorldFileFlag(), loadState(), saveState(), setProperty(), and setWriteJpegWorldFile().

◆ theWriteOverviewFlag

bool ossimImageFileWriter::theWriteOverviewFlag

protected

Definition at line 459 of file ossimImageFileWriter.h.

Referenced by getWriteOverviewFlag(), loadState(), saveState(), setProperty(), and setWriteOverviewFlag().

◆ theWriteReadmeFlag

bool ossimImageFileWriter::theWriteReadmeFlag

protected

Definition at line 475 of file ossimImageFileWriter.h.

Referenced by getWriteReadmeFlag(), loadState(), saveState(), setProperty(), and setWriteReadme().

◆ theWriteTiffWorldFileFlag

bool ossimImageFileWriter::theWriteTiffWorldFileFlag

protected

Definition at line 476 of file ossimImageFileWriter.h.

Referenced by getWriteTiffWorldFileFlag(), loadState(), saveState(), setProperty(), and setWriteTiffWorldFile().

◆ theWriteWorldFileFlag

bool ossimImageFileWriter::theWriteWorldFileFlag

protected

Definition at line 477 of file ossimImageFileWriter.h.

Referenced by getWriteWorldFileFlag(), loadState(), saveState(), setProperty(), and setWriteWorldFile().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ossimImageFileWriter()

◆ ~ossimImageFileWriter()

Member Function Documentation

◆ addListener()

◆ canConnectMyInputTo()

◆ changeSequencer()

◆ connectInputEvent()

◆ disconnectInputEvent()

◆ execute()

◆ getExtension()

◆ getFilename()

◆ getImageTypeList()

◆ getObject() [1/2]

◆ getObject() [2/2]

◆ getOutputHasInternalOverviews()

◆ getOutputImageType()

◆ getOutputImageTypeString()

◆ getOutputStream()

◆ getOverviewCompressType()

◆ getOverviewJpegCompressQuality()

◆ getPixelType()

◆ getPixelTypeString()

◆ getProperty()

◆ getPropertyNames()

◆ getScaleToEightBitFlag()

◆ getSequencer()

◆ getWriteEnviHeaderFlag()

◆ getWriteErsHeaderFlag()

◆ getWriteExternalGeometryFlag()

◆ getWriteFgdcFlag()

◆ getWriteHistogramFlag()

◆ getWriteImageFlag()

◆ getWriteJpegWorldFileFlag()

◆ getWriteOverviewFlag()

◆ getWriteReadmeFlag()

◆ getWriteTiffWorldFileFlag()

◆ getWriteWorldFileFlag()

◆ hasImageType()

◆ initialize()

◆ loadState()

◆ propertyEvent()

◆ removeListener()

◆ saveState()

◆ setAreaOfInterest()

◆ setFilename()

◆ setOutputImageType() [1/2]

◆ setOutputImageType() [2/2]

◆ setOutputName()

◆ setOutputStream() [1/2]

◆ setOutputStream() [2/2]

◆ setOverviewCompressType()

◆ setOverviewJpegCompressQuality()

◆ setPercentComplete()

◆ setPixelType() [1/2]

◆ setPixelType() [2/2]

◆ setProperty()

◆ setScaleToEightBitFlag()

◆ setTileSize()

◆ setWriteEnviHeaderFlag()

◆ setWriteErsHeaderFlag()

◆ setWriteExternalGeometryFlag()

◆ setWriteFgdcFlag()

◆ setWriteHistogramFlag()

◆ setWriteImageFlag()

◆ setWriteJpegWorldFile()

◆ setWriteOverviewFlag()

◆ setWriteReadme()

◆ setWriteTiffWorldFile()

◆ setWriteWorldFile()

◆ writeEnviHeaderFile()

◆ writeErsHeaderFile()

◆ writeExternalGeometryFile()

◆ writeFgdcFile()

◆ writeFile()