Class for writing a "ENVI" style header. More...

#include <ossimEnviHeaderFileWriter.h>

Inheritance diagram for ossimEnviHeaderFileWriter:

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

virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)
	Initializes the state of the writer. More...

virtual void	getMetadatatypeList (std::vector< ossimString > &metadatatypeList) const
	Satisfies pure virtual from ossimMetadataWriter base. More...

virtual bool	hasMetadataType (const ossimString &metadataType) const
	Satisfies pure virtual from ossimMetadataWriter base. More...

Public Member Functions inherited from ossimMetadataFileWriter
	ossimMetadataFileWriter ()

virtual ossimObject *	getObject ()

virtual const ossimObject *	getObject () const

virtual void	initialize ()

virtual bool	execute ()

virtual void	setPercentComplete (double percentComplete)

virtual void	setFilename (const ossimFilename &file)

const ossimFilename &	getFilename () const

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 void	setPixelType (ossimPixelType pixelType)
	Ossim uses a concept of "pixel is point" internally. More...

virtual ossimPixelType	getPixelType () const

virtual void	setAreaOfInterest (const ossimIrect &areaOfInterest)
	Sets the area of interest to write the meta data for. More...

virtual ossimIrect	getAreaOfInterest () const

virtual void	setProperty (ossimRefPtr< ossimProperty > property)

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

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

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 bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const

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 std::ostream &	print (std::ostream &out) const
	Generic print method. More...

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	addListener (ossimListener *listener)

virtual bool	removeListener (ossimListener *listener)

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 ossimProcessInterface
	ossimProcessInterface ()

virtual	~ossimProcessInterface ()

virtual void	abort ()

bool	needsAborting () const

bool	isAbortRequested () const

bool	isAborted () const

bool	isExecuting () const

ossimProcessStatus	getProcessStatus () const

virtual void	setProcessStatus (ossimProcessStatus processStatus)

virtual double	getPercentComplete () const

virtual ossimListenerManager *	getManager ()

void	enableEvents ()

void	disableEvents ()

void	setCurrentMessage (const ossimString &message)

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

Public Member Functions inherited from ossimConnectableObjectListener
	ossimConnectableObjectListener ()

virtual	~ossimConnectableObjectListener ()

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

virtual void	objectDestructingEvent (ossimObjectDestructingEvent &)

virtual void	connectionEvent (ossimConnectionEvent &)

virtual void	disconnectOutputEvent (ossimConnectionEvent &)

virtual void	connectOutputEvent (ossimConnectionEvent &)

virtual void	addObjectEvent (ossimContainerEvent &)

virtual void	removeObjectEvent (ossimContainerEvent &)

virtual void	containerEvent (ossimContainerEvent &)

virtual void	refreshEvent (ossimRefreshEvent &)

Public Member Functions inherited from ossimListener
	ossimListener ()

virtual	~ossimListener ()

void	enableListener ()

void	disableListener ()

void	setListenerEnableFlag (bool flag)

bool	isListenerEnabled () const

bool	getListenerEnableFlag () const

Protected Member Functions
virtual	~ossimEnviHeaderFileWriter ()
	virtual destructor More...

Protected Member Functions inherited from ossimMetadataFileWriter
virtual	~ossimMetadataFileWriter ()

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

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

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

Private Member Functions
virtual bool	writeFile ()
	Write out the file. More...

Private Attributes
ossimEnviHeader	theHdr

Additional Inherited Members
Public Types inherited from ossimConnectableObject
enum	ossimConnectableObjectDirectionType { CONNECTABLE_DIRECTION_NONE = 0, CONNECTABLE_DIRECTION_INPUT = 1, CONNECTABLE_DIRECTION_OUTPUT = 2 }

typedef std::vector< ossimRefPtr< ossimConnectableObject > >	ConnectableObjectList

Public Types inherited from ossimProcessInterface
enum	ossimProcessStatus { PROCESS_STATUS_UNKNOWN = 0, PROCESS_STATUS_EXECUTING = 1, PROCESS_STATUS_ABORTED = 2, PROCESS_STATUS_ABORT_REQUEST = 3, PROCESS_STATUS_NOT_EXECUTING = 4 }

Protected Attributes inherited from ossimMetadataFileWriter
ossimImageSource *	theInputConnection

ossimFilename	theFilename

ossimPixelType	thePixelType

ossimIrect	theAreaOfInterest

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 ossimProcessInterface
double	thePercentComplete

ossimProcessStatus	theProcessStatus

ossimString	theMessage

bool	theEventFlag

Protected Attributes inherited from ossimListener
bool	theListenerEnableFlag

Detailed Description

Class for writing a "ENVI" style header.

Definition at line 29 of file ossimEnviHeaderFileWriter.h.

Constructor & Destructor Documentation

◆ ossimEnviHeaderFileWriter()

ossimEnviHeaderFileWriter::ossimEnviHeaderFileWriter ( )

default constructor

◆ ~ossimEnviHeaderFileWriter()

ossimEnviHeaderFileWriter::~ossimEnviHeaderFileWriter ( )

protectedvirtual

virtual destructor

Definition at line 39 of file ossimEnviHeaderFileWriter.cpp.

40 {

41 }

Member Function Documentation

◆ getMetadatatypeList()

void ossimEnviHeaderFileWriter::getMetadatatypeList ( std::vector< ossimString > & metadatatypeList ) const

virtual

Satisfies pure virtual from ossimMetadataWriter base.

Appends the writers image types to the "metadatatypeList".

Parameters

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

Note: Appends to the list, does not clear it first.

Implements ossimMetadataFileWriter.

Definition at line 91 of file ossimEnviHeaderFileWriter.cpp.

 {
    metadatatypeList.push_back(ossimString("envi_header")); 
 }

◆ hasMetadataType()

bool ossimEnviHeaderFileWriter::hasMetadataType ( const ossimString & metadataType ) const

virtual

Satisfies pure virtual from ossimMetadataWriter base.

Parameters

imageType string representing image type.

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

Implements ossimMetadataFileWriter.

Definition at line 97 of file ossimEnviHeaderFileWriter.cpp.

 {
    return (metadataType == "envi_header");
 }

◆ loadState()

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

virtual

Initializes the state of the writer.

Users should use this to set the envi header fields that are not taken from theInputConnection prior to calling execute.

Returns: true on success, false on failure.

Reimplemented from ossimMetadataFileWriter.

Definition at line 43 of file ossimEnviHeaderFileWriter.cpp.

References ossimMetadataFileWriter::loadState(), ossimEnviHeader::loadState(), and theHdr.

 {
    bool result = false;
    
    if (ossimMetadataFileWriter::loadState(kwl, prefix))
    {
       result = theHdr.loadState(kwl, prefix);
    }
    
    return result;
 }

◆ writeFile()

bool ossimEnviHeaderFileWriter::writeFile ( )

privatevirtual

Write out the file.

Returns: true on success, false on error.

Implements ossimMetadataFileWriter.

Definition at line 63 of file ossimEnviHeaderFileWriter.cpp.

References ossimMapProjectionInfo::getGeom(), ossimImageSource::getImageGeometry(), ossimImageSource::getNumberOfOutputBands(), ossimImageGeometry::getProjection(), ossimIrect::height(), PTR_CAST, ossimEnviHeader::setBands(), ossimEnviHeader::setLines(), ossimEnviHeader::setMapInfo(), ossimEnviHeader::setSamples(), ossimMetadataFileWriter::theAreaOfInterest, ossimMetadataFileWriter::theFilename, theHdr, ossimMetadataFileWriter::theInputConnection, ossimRefPtr< T >::valid(), ossimIrect::width(), and ossimEnviHeader::writeFile().

 {
    theHdr.setLines(theAreaOfInterest.height());
    theHdr.setSamples(theAreaOfInterest.width());
    theHdr.setBands(theInputConnection->getNumberOfOutputBands());
    
    // Get the geometry from the input.
    // Get the geometry from the input.
    ossimMapProjection* mapProj = 0;
    ossimRefPtr<ossimImageGeometry> inputGeom = theInputConnection->getImageGeometry();
    if ( inputGeom.valid() ) mapProj = PTR_CAST(ossimMapProjection, inputGeom->getProjection());
    if (mapProj)
    {
       // Create the projection info.
       ossimRefPtr<ossimMapProjectionInfo> projectionInfo
          = new ossimMapProjectionInfo(mapProj, theAreaOfInterest);
 
       // Set the tie points in the keyword list.
       ossimKeywordlist kwl;
       projectionInfo->getGeom(kwl);
 
       // Pass it on to envi header to set the map info string from geometry.
       theHdr.setMapInfo(kwl);
    }
 
    return theHdr.writeFile(theFilename);
 }

Member Data Documentation

◆ theHdr

ossimEnviHeader ossimEnviHeaderFileWriter::theHdr

private

Definition at line 74 of file ossimEnviHeaderFileWriter.h.

Referenced by loadState(), and writeFile().

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ossimEnviHeaderFileWriter()

◆ ~ossimEnviHeaderFileWriter()

Member Function Documentation

◆ getMetadatatypeList()

◆ hasMetadataType()

◆ loadState()

◆ writeFile()

Member Data Documentation

◆ theHdr