#include <ossimNitfWriter.h>

Inheritance diagram for ossimNitfWriter:

Public Member Functions
	ossimNitfWriter (const ossimFilename &filename=ossimFilename(""), ossimImageSource inputSource=(ossimImageSource ) NULL)

virtual	~ossimNitfWriter ()

virtual bool	isOpen () const

virtual bool	open ()

virtual void	close ()

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

virtual void	setProperty (ossimRefPtr< ossimProperty > property)
	Set the properties. More...

virtual ossimRefPtr< ossimProperty >	getProperty (const ossimString &name) const
	Gets a property. More...

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

void	addRegisteredTag (ossimRefPtr< ossimNitfRegisteredTag > registeredTag, bool unique=true)

void	addRegisteredTag (ossimRefPtr< ossimNitfRegisteredTag > registeredTag, bool unique, const ossim_uint32 &ownerIndex, const ossimString &tagType)

virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const
	Saves the state of the writer to kwl with prefix then calls base class ossimImageFileWriter::saveState. More...

virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)
	Initializes the state of the writer from kwl with prefix then calls base class ossimImageFileWriter::loadState. More...

virtual bool	addTextToNitf (std::string &inputText)

virtual void	getTileSize (ossimIpt &size) const
	Gets the block size. More...

virtual void	setTileSize (const ossimIpt &tileSize)
	Sets the nitf output block size. More...

virtual ossimNitfImageHeaderV2_1 *	getImageHeader ()
	Get the image header used for export. More...

virtual ossimNitfFileHeaderV2_1 *	getFileHeader ()
	Get the file header used for export. More...

virtual void	addDataExtensionSegment (const ossimNitfDataExtensionSegmentV2_1 &des, bool allowTreOverflow)
	Add a DES to the file. More...

Public Member Functions inherited from ossimNitfWriterBase
	ossimNitfWriterBase ()
	default constructor More...

	ossimNitfWriterBase (const ossimFilename &filename, ossimImageSource *inputSource)
	Constructor that takes filename and input source. More...

virtual	~ossimNitfWriterBase ()

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

virtual void	addRegisteredTag (ossimRefPtr< ossimNitfRegisteredTag > registeredTag)

virtual void	setFileHeaderV2_1 (ossimRefPtr< ossimNitfFileHeaderV2_1 >, bool preferSource=false)

virtual void	setImageHeaderV2_1 (ossimRefPtr< ossimNitfImageHeaderV2_1 >, bool preferSource=false)

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

virtual	~ossimImageFileWriter ()

virtual ossimObject *	getObject ()

virtual const ossimObject *	getObject () const

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

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

virtual 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	canConnectMyInputTo (ossim_int32 inputIndex, const ossimConnectableObject *object) const
	required to be overriden by derived classes More...

virtual void	disconnectInputEvent (ossimConnectionEvent &event)

virtual void	connectInputEvent (ossimConnectionEvent &event)

virtual void	propertyEvent (ossimPropertyEvent &event)

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

virtual bool	getWriteHistogramFlag () const

virtual bool	getWriteOverviewFlag () const

virtual bool	getScaleToEightBitFlag () const

virtual bool	getWriteEnviHeaderFlag () const

virtual bool	getWriteErsHeaderFlag () const

virtual bool	getWriteExternalGeometryFlag () const

virtual bool	getWriteFgdcFlag () const

virtual bool	getWriteJpegWorldFileFlag () const

virtual bool	getWriteReadmeFlag () const

virtual bool	getWriteTiffWorldFileFlag () const

virtual bool	getWriteWorldFileFlag () const

virtual void	setWriteImageFlag (bool flag)

virtual void	setWriteOverviewFlag (bool flag)

virtual void	setWriteHistogramFlag (bool flag)

virtual void	setScaleToEightBitFlag (bool flag)

virtual void	setWriteEnviHeaderFlag (bool flag)

virtual void	setWriteErsHeaderFlag (bool flag)

virtual void	setWriteExternalGeometryFlag (bool flag)

virtual void	setWriteFgdcFlag (bool flag)

virtual void	setWriteJpegWorldFile (bool flag)

virtual void	setWriteReadme (bool flag)

virtual void	setWriteTiffWorldFile (bool flag)

virtual void	setWriteWorldFile (bool flag)

virtual ossim_uint16	getOverviewCompressType () const

virtual ossim_int32	getOverviewJpegCompressQuality () const

virtual void	setOverviewCompressType (ossim_uint16 type)

virtual void	setOverviewJpegCompressQuality (ossim_int32 quality)

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

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

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

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

virtual ossimPixelType	getPixelType () const

virtual void	getPixelTypeString (ossimString &type) const

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

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

virtual	~ossimImageWriter ()

virtual bool	setViewingRect (const ossimIrect &aRect)

virtual ossimIrect	getAreaOfInterest () const

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

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

virtual	~ossimOutputSource ()

virtual bool	open (const ossimString &outputName)

virtual const ossimString &	getOutputName ()

Public Member Functions inherited from ossimSource
	ossimSource (ossimObject *owner=0)

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

virtual	~ossimSource ()

virtual bool	isSourceEnabled () const

virtual void	enableSource ()

virtual void	disableSource ()

virtual bool	getEnableFlag () const

virtual void	setEnableFlag (bool flag)

virtual bool	isInitialized () const

virtual void	setInitializedFlag (bool flag)

virtual std::ostream &	print (std::ostream &out) const
	Outputs theErrorStatus as an ossimErrorCode and an ossimString. More...

Public Member Functions inherited from ossimConnectableObject
	ossimConnectableObject (ossimObject *owner=0)
	Base constructor of this object. More...

	ossimConnectableObject (ossimObject *owner, ossim_int32 inputListSize, ossim_int32 outputListSize, bool inputListIsFixedFlag=true, bool outputListIsFixedFlag=true)

virtual	~ossimConnectableObject ()

void	setId (const ossimId &id)
	All connectable objects will have id's. More...

const ossimId &	getId () const
	Will allow us to get this object's id. More...

const ossimObject *	getOwner () const
	Fetches the current owner, most likely a container but not limited to one. More...

virtual void	changeOwner (ossimObject *owner)
	Permits changing the object's owner. More...

virtual void	setDescription (const ossimString &description)

virtual ossimString	getDescription () const

virtual bool	isConnected (ossimConnectableObjectDirectionType direction=CONNECTABLE_DIRECTION_INPUT) const
	will check the direction specified to see if all slots are full. More...

	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findConnectableObject(const ossimId &id))

	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findObjectOfType(RTTItypeid typeId, ossimConnectableObjectDirectionType directionType, bool recurse=true))

	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findObjectOfType(const ossimString &obj, ossimConnectableObjectDirectionType directionType, bool recurse=true))

	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findInputObjectOfType(const ossimString &className))

virtual ossim_int32	findInputIndex (const ossimConnectableObject *object)
	Return a valid index of the input list if the passed in object is found else return -1. More...

virtual ossim_int32	findInputIndex (const ossimId &id)
	Return a valid index of the input list if the passed id is found else return -1. More...

virtual ossim_int32	findOutputIndex (const ossimConnectableObject *object)
	Return a valid index of the output list if the passed in object is found else return -1. More...

virtual ossim_int32	findOutputIndex (const ossimId &id)
	Return a valid index of the output list if the passed in object is found else return -1. More...

virtual ossim_int32	getMyInputIndexToConnectTo (ossimConnectableObject *object) const
	Should return the first available index to connect to. More...

virtual ossim_int32	getMyOutputIndexToConnectTo (ossimConnectableObject *object) const
	Should return the first available index to connect to. More...

virtual bool	canConnectMyOutputTo (ossim_int32 myOutputIndex, const ossimConnectableObject *object) const
	default implementation is to allow anyone to connect to us. More...

virtual void	disconnect (ossimConnectableObject *object=0)
	Will disconnect the object passed in. More...

virtual void	disconnect (const ossimId &id)
	Will disconnect the object passed in. More...

virtual ossimRefPtr< ossimConnectableObject >	disconnectMyInput (ossim_int32 inputIndex, bool disconnectOutputFlag=true, bool createEventFlag=true)
	Will disconnect the object at the given input index and generate a connection event. More...

virtual void	disconnectMyInput (ossimConnectableObject *input, bool disconnectOutputFlag=true, bool createEventFlag=true)
	Finds the index of the passed in input and calls disconnectMyInput(inputIndex, disconnectOutputFlag, createEventFlag);. More...

virtual void	disconnectMyInputs (ConnectableObjectList &inputList, bool disconnectOutputFlag=true, bool createEventFlag=true)

virtual ossimRefPtr< ossimConnectableObject >	disconnectMyOutput (ossim_int32 outputIndex, bool disconnectInputFlag=true, bool createEventFlag=true)
	Will disconnect the object at the given output index and generate a connection event. More...

virtual void	disconnectMyOutput (ossimConnectableObject *output, bool disconnectInputFlag=true, bool createEventFlag=true)
	Will disconnect the output object. More...

virtual void	disconnectMyOutputs (ConnectableObjectList &outputList, bool disconnectOutputFlag=true, bool createEventFlag=true)

virtual void	disconnectAllInputs ()
	Will disconnect all of the input objects. More...

virtual void	disconnectAllOutputs ()
	Will disconnect all of the output objects. More...

virtual ossim_int32	connectMyInputTo (ossimConnectableObject *inputObject, bool makeOutputConnection=true, bool createEventFlag=true)
	Will try to connect this objects input to the passed in object. More...

virtual ossim_int32	connectMyInputTo (ossim_int32 inputIndex, ossimConnectableObject *inputObject, bool makeOutputConnection=true, bool createEventFlag=true)
	Will connect the specified input to the passed in object. More...

virtual bool	connectMyInputTo (ConnectableObjectList &inputList, bool makeOutputConnection=true, bool createEventFlag=true)

virtual ossim_int32	connectMyOutputTo (ossimConnectableObject *outputObject, bool makeInputConnection=true, bool createEventFlag=true)
	Will try to connect this objects output to the passed in object. More...

virtual bool	connectMyOutputTo (ConnectableObjectList &outputList, bool makeInputConnection=true, bool createEventFlag=true)

virtual bool	connectInputList (ConnectableObjectList &inputList)
	Will disconnect itself from all inputs and reset to the passed in input list. More...

virtual bool	connectOutputList (ConnectableObjectList &outputList)
	Will disconnect itself from all outputs and reset to the passed in output list. More...

virtual ossim_uint32	getNumberOfInputs () const
	Returns the number of input objects. More...

virtual ossim_uint32	getNumberOfOutputs () const
	Return the number of output objects. More...

ossimConnectableObject *	getInput (ossim_uint32 index=0)
	returns the object at the specified index. More...

const ossimConnectableObject *	getInput (ossim_uint32 index=0) const
	returns the object at the specified index. More...

ossimConnectableObject *	getOutput (ossim_uint32 index=0)
	returns the object at the specified index. More...

const ossimConnectableObject *	getOutput (ossim_uint32 index=0) const
	returns the object at the specified index. More...

virtual void	setNumberOfInputs (ossim_int32 numberOfInputs)
	Will set the number of inputs. More...

virtual bool	getInputListIsFixedFlag () const

virtual bool	getOutputListIsFixedFlag () const

virtual void	setNumberOfOutputs (ossim_int32 numberOfInputs)
	Will set the number of outputs. More...

const ConnectableObjectList &	getInputList () const

const ConnectableObjectList &	getOutputList () const

ConnectableObjectList &	getInputList ()

ConnectableObjectList &	getOutputList ()

	OSSIM_DEPRECATE_METHOD (virtual void findAllObjectsOfType(ConnectableObjectList &result, const RTTItypeid &typeInfo, bool recurse=true))

	OSSIM_DEPRECATE_METHOD (virtual void findAllObjectsOfType(ConnectableObjectList &result, const ossimString &className, bool recurse=true))

virtual void	propagateEventToOutputs (ossimEvent &event)

virtual void	propagateEventToInputs (ossimEvent &event)

virtual void	setProperty (const ossimString &name, const ossimString &value)

virtual ossim_uint32	saveStateOfAllInputs (ossimKeywordlist &kwl, bool saveThisStateFlag=true, ossim_uint32 objectIndex=1, const char *prefix=0) const
	Save the state of all inputs to a keyword list. More...

virtual bool	fillContainer (ossimConnectableContainer &container)
	Inserts this object and all of its children and inputs into the container provided. More...

bool	moveInputUp (const ossimId &id)
	Moves the input connection matching id up one in the connection list. More...

bool	moveInputDown (const ossimId &id)
	Moves the input connection matching id down one in the connection list. More...

bool	moveInputToTop (const ossimId &id)
	Moves the input connection matching id to the top of the connection list. More...

bool	moveInputToBottom (const ossimId &id)
	Moves the input connection matching id to the bottom of the connection list. More...

virtual void	accept (ossimVisitor &visitor)
	We will add a visitor interface for all connectable objects. More...

Public Member Functions inherited from ossimObject
	ossimObject ()

virtual	~ossimObject ()

virtual ossimObject *	dup () const

virtual ossimString	getShortName () const

virtual ossimString	getLongName () const

virtual ossimString	getClassName () const

virtual RTTItypeid	getType () const

virtual bool	canCastTo (ossimObject *obj) const

virtual bool	canCastTo (const RTTItypeid &id) const

virtual bool	canCastTo (const ossimString &parentClassName) const

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

Public Member Functions inherited from ossimReferenced
	ossimReferenced ()

	ossimReferenced (const ossimReferenced &)

ossimReferenced &	operator= (const ossimReferenced &)

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

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

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

int	referenceCount () const

Public Member Functions inherited from ossimListenerManager
	ossimListenerManager ()

virtual	~ossimListenerManager ()

virtual void	fireEvent (ossimEvent &event)

virtual bool	findListener (ossimListener *listener)

Public Member Functions inherited from ossimPropertyInterface
	ossimPropertyInterface ()

virtual	~ossimPropertyInterface ()

virtual ossimString	getPropertyValueAsString (const ossimString &name) const

void	getPropertyList (std::vector< ossimRefPtr< ossimProperty > > &propertyList) const

void	setProperties (std::vector< ossimRefPtr< ossimProperty > > &propertyList)

Public Member Functions inherited from ossimErrorStatusInterface
	ossimErrorStatusInterface ()

virtual	~ossimErrorStatusInterface ()

virtual ossimErrorCode	getErrorStatus () const

virtual ossimString	getErrorStatusString () const

virtual void	setErrorStatus (ossimErrorCode error_status) const

virtual void	setErrorStatus () const

virtual void	clearErrorStatus () const

bool	hasError () const

Public Member Functions inherited from ossimProcessInterface
	ossimProcessInterface ()

virtual	~ossimProcessInterface ()

virtual void	abort ()

bool	needsAborting () const

bool	isAbortRequested () const

bool	isAborted () const

bool	isExecuting () const

ossimProcessStatus	getProcessStatus () const

virtual void	setProcessStatus (ossimProcessStatus processStatus)

virtual double	getPercentComplete () const

virtual ossimListenerManager *	getManager ()

void	enableEvents ()

void	disableEvents ()

void	setCurrentMessage (const ossimString &message)

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

Public Member Functions inherited from ossimConnectableObjectListener
	ossimConnectableObjectListener ()

virtual	~ossimConnectableObjectListener ()

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

virtual void	objectDestructingEvent (ossimObjectDestructingEvent &)

virtual void	connectionEvent (ossimConnectionEvent &)

virtual void	disconnectOutputEvent (ossimConnectionEvent &)

virtual void	connectOutputEvent (ossimConnectionEvent &)

virtual void	addObjectEvent (ossimContainerEvent &)

virtual void	removeObjectEvent (ossimContainerEvent &)

virtual void	containerEvent (ossimContainerEvent &)

virtual void	refreshEvent (ossimRefreshEvent &)

Public Member Functions inherited from ossimListener
	ossimListener ()

virtual	~ossimListener ()

void	enableListener ()

void	disableListener ()

void	setListenerEnableFlag (bool flag)

bool	isListenerEnabled () const

bool	getListenerEnableFlag () const

Protected Member Functions
virtual bool	writeFile ()

virtual bool	writeBlockBandSeparate ()
	write out block band separate More...

virtual bool	writeBlockBandSequential ()
	Outputs in band sequential format. More...

Protected Member Functions inherited from ossimNitfWriterBase
void	writeGeometry (ossimNitfImageHeaderV2_X hdr, ossimImageSourceSequencer seq)
	Populates tags with geometry info from projection. More...

void	addBlockaTag (ossimMapProjectionInfo &mapInfo, ossimNitfImageHeaderV2_X *hdr)
	Adds the BLOCKA tag. More...

void	addGeolobTag (const ossimMapProjection mapProj, ossimNitfImageHeaderV2_X hdr)
	Adds the GEOLOB tag. More...

void	addRpcbTag (const ossimIrect &rect, ossimProjection proj, ossimNitfImageHeaderV2_X hdr)
	Adds the RPC00B tag. More...

void	setComplexityLevel (std::streamoff, ossimNitfFileHeaderV2_X *hdr)
	Sets the complexity level of theFileHeader. More...

void	setComplexityLevel (ossimNitfFileHeaderV2_X *hdr, ossim_uint64 width=0, ossim_uint64 height=0)

virtual void	initializeDefaultsFromConfigFile (ossimNitfFileHeaderV2_X fileHdr, ossimNitfImageHeaderV2_X imgHdr)
	Sets file header and image header defaults from config file if found in preferences. More...

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

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

const ossimSource &	operator= (const ossimSource &rhs)

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

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

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

Protected Attributes
std::shared_ptr< ossim::ofstream >	m_str
	Currently disabled... More...

ossimRefPtr< ossimNitfFileHeaderV2_1 >	m_fileHeader

ossimRefPtr< ossimNitfImageHeaderV2_1 >	m_imageHeader

std::vector< ossimNitfDataExtensionSegmentV2_1 >	m_dataExtensionSegments

ossimRefPtr< ossimNitfTextHeaderV2_1 >	m_textHeader

std::string	m_textEntry

ossimIpt	m_blockSize

Protected Attributes inherited from ossimNitfWriterBase
bool	theEnableRpcbTagFlag
	If true user wants to set RPC00B tag. More...

bool	theEnableBlockaTagFlag
	If true user wants to set BLOCKA tag. More...

bool	theEnableGeolobTagFlag
	If true user wants to set GEOLOG tag. More...

Protected Attributes inherited from ossimImageFileWriter
ossimRefPtr< ossimImageSourceSequencer >	theInputConnection

ossimRefPtr< ossimViewController >	theViewController

ossimListener *	theProgressListener

ossimFilename	theFilename

ossimString	theOutputImageType

bool	theWriteImageFlag

bool	theWriteOverviewFlag

bool	theWriteHistogramFlag

bool	theScaleToEightBitFlag

ossim_uint16	theOverviewCompressType

ossim_int32	theOverviewJpegCompressQuality

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

bool	theWriteErsHeaderFlag

bool	theWriteExternalGeometryFlag

bool	theWriteFgdcFlag

bool	theWriteJpegWorldFileFlag

bool	theWriteReadmeFlag

bool	theWriteTiffWorldFileFlag

bool	theWriteWorldFileFlag

bool	theAutoCreateDirectoryFlag

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

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

Protected Attributes inherited from ossimImageWriter
ossimIrect	theAreaOfInterest

Protected Attributes inherited from ossimOutputSource
ossimString	theOutputName

Protected Attributes inherited from ossimSource
bool	theEnableFlag

bool	theInitializedFlag

Protected Attributes inherited from ossimConnectableObject
ossimId	theId

ossimString	theDescription

ossimObject *	theOwner

bool	theInputListIsFixedFlag
	Indicates whether the theInputObjectList is fixed. More...

bool	theOutputListIsFixedFlag
	Indicates whether the theOutputObjectList is fixed. More...

ConnectableObjectList	theInputObjectList
	Holds a list of input objects. More...

ConnectableObjectList	theOutputObjectList
	Holds a list of output objects. More...

Protected Attributes inherited from ossimListenerManager
std::list< ossimListener * >	theListenerList

bool	theEnabledFlag

std::list< ossimListener * >	theDelayedAdd

std::list< ossimListener * >	theDelayedRemove

bool	theFireEventFlag

Protected Attributes inherited from ossimErrorStatusInterface
ossimErrorCode	theErrorStatus

Protected Attributes inherited from ossimProcessInterface
double	thePercentComplete

ossimProcessStatus	theProcessStatus

ossimString	theMessage

bool	theEventFlag

Protected Attributes inherited from ossimListener
bool	theListenerEnableFlag

Private Member Functions
void	takeOverflowTags (bool useFileHeader, bool userDefinedTags)

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

Definition at line 32 of file ossimNitfWriter.h.

Constructor & Destructor Documentation

◆ ossimNitfWriter()

ossimNitfWriter::ossimNitfWriter	(	const ossimFilename &	filename = `ossimFilename("")`,
		ossimImageSource *	inputSource = `(ossimImageSource*)NULL`
	)

Definition at line 50 of file ossimNitfWriter.cpp.

References ossim::defaultTileSize(), ossimRefPtr< T >::get(), ossimNitfWriterBase::initializeDefaultsFromConfigFile(), m_blockSize, m_fileHeader, m_imageHeader, ossimNitfFileHeaderV2_X::setEncryption(), ossimNitfImageHeaderV2_X::setJustification(), and ossimImageFileWriter::theOutputImageType.

    : ossimNitfWriterBase(filename, inputSource),
      m_str(0),
      m_fileHeader(0),
      m_imageHeader(0),
      m_textHeader(0),
      m_textEntry(),
      m_blockSize(OSSIM_DEFAULT_TILE_WIDTH, OSSIM_DEFAULT_TILE_HEIGHT)
 {
    //---
    // Since the internal nitf tags are not very accurate, write an external
    // geometry out as default behavior.  Users can disable this via the
    // property interface or keyword list.
    //---
    // Added GEOLOB tag for geographic output. UTM is good with BLOCKA.
    // No longer needed. (drb - 30 March 2018)
    // setWriteExternalGeometryFlag(true);
    
    m_fileHeader       = new ossimNitfFileHeaderV2_1;
    m_imageHeader      = new ossimNitfImageHeaderV2_1;
 
    // m_textHeader is conditional so we will not new here.
    
    theOutputImageType = "nitf_block_band_separate";
 
    //---
    // The tile size can be set in the preferences via "tile_size" keyword.
    // This will get it if set; else, set to default.
    //---
    ossim::defaultTileSize(m_blockSize);
 
    // These are always set:
    m_fileHeader->setEncryption( ossimString("0") );
    m_imageHeader->setJustification( ossimString("R") );
 
    // Set any site defaults.
    initializeDefaultsFromConfigFile(
       dynamic_cast<ossimNitfFileHeaderV2_X*>(m_fileHeader.get()),
       dynamic_cast<ossimNitfImageHeaderV2_X*>(m_imageHeader.get()) );
 }

◆ ~ossimNitfWriter()

ossimNitfWriter::~ossimNitfWriter ( )

virtual

Definition at line 92 of file ossimNitfWriter.cpp.

References close(), m_fileHeader, m_imageHeader, and m_textHeader.

 {
    //---
    // This looks like a leak but it's not as both of these are ossimRefPtr's.
    //---
    m_fileHeader=0;
    m_imageHeader=0;
    m_textHeader=0;
 
    close();
 }

Member Function Documentation

◆ addDataExtensionSegment()

void ossimNitfWriter::addDataExtensionSegment	(	const ossimNitfDataExtensionSegmentV2_1 &	des,
		bool	allowTreOverflow
	)

virtual

Add a DES to the file.

Parameters

des	The DES to add to the file.

Definition at line 887 of file ossimNitfWriter.cpp.

References ossimNitfDataExtensionSegmentV2_1::DESID_KW, ossimNitfDataExtensionSegmentV2_1::getProperty(), m_dataExtensionSegments, ossimRefPtr< T >::valid(), and ossimProperty::valueToString().

Referenced by takeOverflowTags().

 {
    if (allowTreOverflow == false)
    {
       ossimRefPtr<ossimProperty> pId = des.getProperty(ossimNitfDataExtensionSegmentV2_1::DESID_KW);
       if ( !pId.valid() ||
            pId->valueToString() == "TRE_OVERFLOW" ||
            pId->valueToString() == "REGISTERED EXTENSIONS" ||
            pId->valueToString() == "CONTROLLED EXTENSIONS")
       {
          return;
       }
    }
 
    m_dataExtensionSegments.push_back(des);
 }

◆ addRegisteredTag() [1/2]

void ossimNitfWriter::addRegisteredTag	(	ossimRefPtr< ossimNitfRegisteredTag >	registeredTag,
		bool	unique = `true`
	)

virtual

Reimplemented from ossimNitfWriterBase.

Definition at line 749 of file ossimNitfWriter.cpp.

 {
    addRegisteredTag(registeredTag, unique, 1, ossimString("IXSHD"));
 }

◆ addRegisteredTag() [2/2]

void ossimNitfWriter::addRegisteredTag	(	ossimRefPtr< ossimNitfRegisteredTag >	registeredTag,
		bool	unique,
		const ossim_uint32 &	ownerIndex,
		const ossimString &	tagType
	)

virtual

Reimplemented from ossimNitfWriterBase.

Definition at line 755 of file ossimNitfWriter.cpp.

References ossimNitfImageHeader::addTag(), ossimNitfFileHeaderV2_1::addTag(), ossimRefPtr< T >::get(), m_fileHeader, m_imageHeader, ossimNitfTagInformation::setTagData(), and ossimNitfTagInformation::setTagType().

 {
    ossimNitfTagInformation tagInfo;
    tagInfo.setTagData(registeredTag.get());
    tagInfo.setTagType(tagType);
 
    switch (ownerIndex)
    {
       case 0:
       {
          m_fileHeader->addTag(tagInfo, unique);
          break;
       }
 
       case 1:
       {
          m_imageHeader->addTag(tagInfo, unique);
          break;
       }
 
       default:
       {
          // Do nothing
       }
    }
 }

◆ addTextToNitf()

bool ossimNitfWriter::addTextToNitf ( std::string & inputText )

virtual

Definition at line 783 of file ossimNitfWriter.cpp.

References m_textEntry, m_textHeader, and ossimRefPtr< T >::valid().

 {
    // Initialize the m_textHeader
    m_textEntry = inputText;
    if ( m_textHeader.valid() == false )
    {
       // Only created if we need it.
       m_textHeader = new ossimNitfTextHeaderV2_1;
    }
    return true;
 }

◆ close()

void ossimNitfWriter::close ( )

virtual

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

Implements ossimOutputSource.

Definition at line 134 of file ossimNitfWriter.cpp.

References m_str.

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

 {
    if(m_str)
    {
       m_str->close();
       m_str.reset();
    }
 }

◆ getFileHeader()

ossimNitfFileHeaderV2_1 * ossimNitfWriter::getFileHeader ( )

virtual

Get the file header used for export.

Warning: Many values will be overwritten at export time.

Returns: The file header.

Definition at line 882 of file ossimNitfWriter.cpp.

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

 {
    return m_fileHeader.get();
 }

◆ getImageHeader()

ossimNitfImageHeaderV2_1 * ossimNitfWriter::getImageHeader ( )

virtual

Get the image header used for export.

Warning: Many values will be overwritten at export time. This includes the ossimNitfImageBandV2_1, if the number of bands on the image header does not match that on the writer.

Returns: The image header.

Definition at line 877 of file ossimNitfWriter.cpp.

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

 {
    return m_imageHeader.get();
 }

◆ getImageTypeList()

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

virtual

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

Appends this writer image types to list "imageTypeList".

This writer has the following types: nitf_block_band_separate nitf_block_band_sequential

Parameters

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

Implements ossimImageFileWriter.

Definition at line 188 of file ossimNitfWriter.cpp.

 {
    imageTypeList.push_back(ossimString("nitf_block_band_separate"));
    imageTypeList.push_back(ossimString("nitf_block_band_sequential"));
 }

◆ getProperty()

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

virtual

Gets a property.

Parameters

The	name of the property to get.

Returns: The property if found.

Reimplemented from ossimNitfWriterBase.

Definition at line 235 of file ossimNitfWriter.cpp.

References ossimContainerProperty::addChildren(), ossimStringProperty::addConstraint(), ossimNitfWriterBase::getProperty(), ossimPropertyInterface::getPropertyList(), m_blockSize, m_fileHeader, m_imageHeader, ossimString::toString(), and ossimIpt::x.

 {
    ossimRefPtr<ossimProperty> result = 0;
    
    if(name == "file_header")
    {
       ossimContainerProperty* container = new ossimContainerProperty(name);
       std::vector<ossimRefPtr<ossimProperty> > propertyList;
       
       m_fileHeader->getPropertyList(propertyList);
       container->addChildren(propertyList);
       
       result = container;
    }
    else if(name == "image_header")
    {
       ossimContainerProperty* container = new ossimContainerProperty(name);
       std::vector<ossimRefPtr<ossimProperty> > propertyList;
       
       m_imageHeader->getPropertyList(propertyList);
       container->addChildren(propertyList);
       
       result = container;
    }
    else if(name == "des_header")
    {
       ossimContainerProperty* container = new ossimContainerProperty(name);
       std::vector<ossimRefPtr<ossimProperty> > propertyList;
 
       // Create a temporary DES in order to populate propertyList.
       ossimNitfDataExtensionSegmentV2_1 des;
       des.getPropertyList(propertyList);
       container->addChildren(propertyList);
 
       result = container;
    }
    else if(name == "block_size")
    {
       ossimStringProperty* stringProp =
          new ossimStringProperty(name,
                                  ossimString::toString(m_blockSize.x),
                                  false); // editable flag
       stringProp->addConstraint(ossimString("64"));
       stringProp->addConstraint(ossimString("128"));
       stringProp->addConstraint(ossimString("256"));      
       stringProp->addConstraint(ossimString("512"));      
       stringProp->addConstraint(ossimString("1024"));      
       stringProp->addConstraint(ossimString("2048"));      
       return stringProp;
    }
    else
    {
       return ossimNitfWriterBase::getProperty(name);
    }
 
    return result;
 }

◆ getPropertyNames()

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

virtual

Parameters

propertyNames Array to populate with property names.

Note: The following names are handled: file_header image_header des_header

Reimplemented from ossimNitfWriterBase.

Definition at line 293 of file ossimNitfWriter.cpp.

References ossimNitfWriterBase::getPropertyNames().

 {
    ossimNitfWriterBase::getPropertyNames(propertyNames);
 
    propertyNames.push_back("file_header");
    propertyNames.push_back("image_header");
    propertyNames.push_back("des_header");
    propertyNames.push_back("block_size");
 }

◆ getTileSize()

void ossimNitfWriter::getTileSize ( ossimIpt & size ) const

virtual

Gets the block size.

Definition at line 794 of file ossimNitfWriter.cpp.

References m_blockSize, and size.

 {
    size = m_blockSize;
 }

◆ isOpen()

bool ossimNitfWriter::isOpen ( ) const

virtual

Implements ossimOutputSource.

Definition at line 104 of file ossimNitfWriter.cpp.

References m_str.

Referenced by open(), and writeFile().

 {
    return (m_str ? m_str->is_open() : false);
 }

◆ loadState()

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

virtual

Initializes the state of the writer from kwl with prefix then calls base class ossimImageFileWriter::loadState.

Parameters

kwl	Keyword list to initialize from.
prefix	Usually something like: "object2."

Returns: true on success, false on failure.

Reimplemented from ossimNitfWriterBase.

Definition at line 871 of file ossimNitfWriter.cpp.

References ossimNitfWriterBase::loadState().

 {
    return ossimNitfWriterBase::loadState(kwl, prefix);
 }

◆ open()

bool ossimNitfWriter::open ( )

virtual

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

Implements ossimOutputSource.

Definition at line 109 of file ossimNitfWriter.cpp.

References ossimString::c_str(), close(), isOpen(), m_str, and ossimImageFileWriter::theFilename.

Referenced by writeFile().

 {
    bool result = true;
    if(isOpen())
    {
       close();
    }
    
    // there is a bug in gcc < 5.0 and we can't use constructors in the 
    // C++11 build.  Will refactor to do a new ifstream then use open
    //
    m_str = std::make_shared<ossim::ofstream>();
    m_str->open(theFilename.c_str(), ios::out|ios::binary);
    if(!m_str->is_open())
    {
       m_str.reset();
       result = false;
    }
    
    //new std::ofstream;
    //m_str->open(theFilename.c_str(), ios::out|ios::binary);
    
    return result;
 }

◆ saveState()

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

virtual

Saves the state of the writer to kwl with prefix then calls base class ossimImageFileWriter::saveState.

Parameters

kwl	Keyword list to save to.
prefix	Usually something like: "object2."

Returns: true on success, false on failure.

Reimplemented from ossimNitfWriterBase.

Definition at line 865 of file ossimNitfWriter.cpp.

References ossimNitfWriterBase::saveState().

 {
    return ossimNitfWriterBase::saveState(kwl, prefix);
 }

◆ setProperty()

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

virtual

Set the properties.

Parameters

property The property to set.

Reimplemented from ossimNitfWriterBase.

Definition at line 194 of file ossimNitfWriter.cpp.

References ossimRefPtr< T >::get(), ossimContainerProperty::getPropertyList(), m_fileHeader, m_imageHeader, PTR_CAST, ossimPropertyInterface::setProperties(), ossimNitfWriterBase::setProperty(), setTileSize(), ossimIpt::x, and ossimIpt::y.

 {
    if(!property) return;
    
    ossimString name = property->getName();
    
    if(name == "file_header")
    {
       ossimContainerProperty* containerProperty = PTR_CAST(ossimContainerProperty,
                                                            property.get());
       if(containerProperty)
       {
          std::vector<ossimRefPtr<ossimProperty> > propertyList;
          containerProperty->getPropertyList(propertyList);
          m_fileHeader->setProperties(propertyList);
       }
    }
    else if(name == "image_header")
    {
       ossimContainerProperty* containerProperty = PTR_CAST(ossimContainerProperty,
                                                            property.get());
       if(containerProperty)
       {
          std::vector<ossimRefPtr<ossimProperty> > propertyList;
          containerProperty->getPropertyList(propertyList);
          m_imageHeader->setProperties(propertyList);
       }
    }
    else if(name == "block_size")
    {
       ossimIpt blockSize;
       blockSize.x = property->valueToString().toInt32();
       blockSize.y = blockSize.x;
       setTileSize(blockSize);
    }
    else
    {
       ossimNitfWriterBase::setProperty(property);
    }
 }

◆ setTileSize()

void ossimNitfWriter::setTileSize ( const ossimIpt & tileSize )

virtual

Sets the nitf output block size.

Must be divisible by 16.

Note: This is not called setBlockSize just because there was already a virtual setTileSize.

Parameters

tileSize Block size.

Reimplemented from ossimImageFileWriter.

Definition at line 799 of file ossimNitfWriter.cpp.

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

Referenced by setProperty().

 {
    const ossim_int32 MIN_BLOCK_SIZE = 64;
    if ( (tileSize.x % MIN_BLOCK_SIZE) || (tileSize.y % MIN_BLOCK_SIZE) )
    {
       if(traceDebug())
       {
          ossimNotify(ossimNotifyLevel_DEBUG)
             << "ossimNitfWriter::setTileSize ERROR:"
             << "\nBlock size must be a multiple of " << MIN_BLOCK_SIZE
             << "\nSize remains:  " << m_blockSize
             << std::endl;
       }
    }
    else
    {
       m_blockSize = tileSize;
    }
 }

◆ takeOverflowTags()

void ossimNitfWriter::takeOverflowTags	(	bool	useFileHeader,
		bool	userDefinedTags
	)

private

Definition at line 903 of file ossimNitfWriter.cpp.

References addDataExtensionSegment(), ossimNitfDataExtensionSegment::DE_KW, ossimNitfDataExtensionSegmentV2_1::DESID_KW, ossimNitfDataExtensionSegment::DESITEM_KW, ossimNitfDataExtensionSegment::DESOFLW_KW, ossimNitfDataExtensionSegment::DESVER_KW, m_dataExtensionSegments, m_fileHeader, m_imageHeader, ossimNitfDataExtensionSegmentV2_1::setProperty(), ossimNitfDataExtensionSegmentV2_1::setTagList(), ossimNitfImageHeaderV2_1::takeOverflowTags(), and ossimNitfFileHeaderV2_1::takeOverflowTags().

Referenced by writeBlockBandSeparate().

 {
    ossimString itemIndex;
    std::vector<ossimNitfTagInformation> overflowTags;
    const ossim_uint32 potentialDesIndex = m_dataExtensionSegments.size() + 1;
 
    if (useFileHeader)
    {
       m_fileHeader->takeOverflowTags(overflowTags, potentialDesIndex, userDefinedTags);
       itemIndex = "0";
    }
    else
    {
       m_imageHeader->takeOverflowTags(overflowTags, potentialDesIndex, userDefinedTags);
       itemIndex = "1";
    }
 
    if (overflowTags.empty() == false)
    {
       ossimNitfDataExtensionSegmentV2_1 des;
       ossimRefPtr<ossimProperty> pDe =
          new ossimStringProperty(ossimNitfDataExtensionSegmentV2_1::DE_KW, "DE");
       des.setProperty(pDe);
 
       ossimRefPtr<ossimProperty> pId =
          new ossimStringProperty(ossimNitfDataExtensionSegmentV2_1::DESID_KW, "TRE_OVERFLOW");
       des.setProperty(pId);
 
       ossimRefPtr<ossimProperty> pVersion =
          new ossimStringProperty(ossimNitfDataExtensionSegmentV2_1::DESVER_KW, "1");
       des.setProperty(pVersion);
 
       ossimRefPtr<ossimProperty> pOverflow =
          new ossimStringProperty(ossimNitfDataExtensionSegmentV2_1::DESOFLW_KW, overflowTags[0].getTagType());
       des.setProperty(pOverflow);
 
       ossimRefPtr<ossimProperty> pItem =
          new ossimStringProperty(ossimNitfDataExtensionSegmentV2_1::DESITEM_KW, itemIndex);
       des.setProperty(pItem);
 
       des.setTagList(overflowTags);
       addDataExtensionSegment(des, true);
    }
 }

◆ writeBlockBandSeparate()

bool ossimNitfWriter::writeBlockBandSeparate ( )

protectedvirtual

write out block band separate

Returns: true on success and false on error

Definition at line 304 of file ossimNitfWriter.cpp.

 {
    ossimScalarType scalarType  = theInputConnection->getOutputScalarType();
    ossim_uint64    byteSize    = ossim::scalarSizeInBytes(scalarType);
    ossimIrect      rect        = theInputConnection->getBoundingRect();
    ossim_uint64    bands       = theInputConnection->getNumberOfOutputBands();
    ossim_uint64    idx         = 0;
    ossim_uint64    headerStart = (ossim_uint64)m_str->tellp();
 
    // Set the sequencer block size to be the same as output.
    theInputConnection->setTileSize(m_blockSize);
    
    ossim_uint64 blocksHorizontal = theInputConnection->getNumberOfTilesHorizontal();
    ossim_uint64 blocksVertical   = theInputConnection->getNumberOfTilesVertical();
    ossim_uint64 numberOfTiles    = theInputConnection->getNumberOfTiles();
 
    ossimNitfImageInfoRecordV2_1 imageInfoRecord;
    imageInfoRecord.setSubheaderLength(439); // ok if no tags
    imageInfoRecord.setImageLength(bands*byteSize*blocksVertical*m_blockSize.y*blocksHorizontal*m_blockSize.x);
 
    m_fileHeader->setDate();
    m_fileHeader->addImageInfoRecord(imageInfoRecord);
 
    if ( m_textHeader.valid() )
    {
       // Add any text headers
       ossimNitfTextFileInfoRecordV2_1 textInfoRecord;
       textInfoRecord.setSubheaderLength(285); //default
       // Set length of text to be that of input text
       textInfoRecord.setTextLength(m_textEntry.length()); 
       m_fileHeader->addTextInfoRecord(textInfoRecord);
    }  
 
    // Get the overflow tags from the file header and the image subheader
    takeOverflowTags(true, true);
    takeOverflowTags(true, false);
    takeOverflowTags(false, true);
    takeOverflowTags(false, false);
 
    for (vector<ossimNitfDataExtensionSegmentV2_1>::iterator iter = m_dataExtensionSegments.begin();
       iter != m_dataExtensionSegments.end(); iter++)
    {
       ossimNitfDataExtSegInfoRecordV2_1 desInfoRecord;
       iter->setSecurityMarkings(*m_fileHeader);
       std::ostringstream headerOut;
       headerOut << std::setw(4)
                 << std::setfill('0')
                 << std::setiosflags(ios::right)
                 << iter->getHeaderLength();
       strcpy(desInfoRecord.theDataExtSegSubheaderLength, headerOut.str().c_str());
 
       std::ostringstream dataOut;
       dataOut << std::setw(9)
                 << std::setfill('0')
                 << std::setiosflags(ios::right)
                 << iter->getDataLength();
       strcpy(desInfoRecord.theDataExtSegLength, dataOut.str().c_str());
 
       m_fileHeader->addDataExtSegInfoRecord(desInfoRecord);
    }
 
    //---
    // This makes space for the file header; it is written again at the end of
    // this method with updated values
    // need a better way to get the length.  This should be queried on the
    // header before writing
    //---
    m_fileHeader->writeStream( *m_str ); 
    ossim_uint64 headerLength = ((ossim_uint64)m_str->tellp() - headerStart) /* + 1 */;
    
    ossimString representation;
    m_imageHeader->setActualBitsPerPixel(ossim::getActualBitsPerPixel(scalarType));
    m_imageHeader->setBitsPerPixel(ossim::getBitsPerPixel(scalarType));
    m_imageHeader->setPixelType(ossimNitfCommon::getNitfPixelType(scalarType));
    m_imageHeader->setNumberOfBands(bands);
    m_imageHeader->setImageMode('B');// blocked
 
    bool masked = (m_imageHeader->getCompressionCode() == "NM");
    ossimNitfImageDataMaskV2_1 datamask;
    datamask.setBlockCount(blocksVertical * blocksHorizontal);
    ossim_uint64 blockLength = bands * byteSize * m_blockSize.x * m_blockSize.y;
    datamask.setBlockLengthInBytes(blockLength);
    std::vector<char> blockZeros;
 
 
    if((bands == 3)&&
       (scalarType == OSSIM_UCHAR))
    {
       m_imageHeader->setRepresentation("RGB");
       m_imageHeader->setCategory("VIS");
    }
    else if(bands == 1)
    {
       m_imageHeader->setRepresentation("MONO");
       m_imageHeader->setCategory("VIS");
    }
    else
    {
       m_imageHeader->setRepresentation("MULTI");
       m_imageHeader->setCategory("MS");
    }
    
    m_imageHeader->setBlocksPerRow(blocksHorizontal);
    m_imageHeader->setBlocksPerCol(blocksVertical);
    m_imageHeader->setNumberOfPixelsPerBlockRow(m_blockSize.x);
    m_imageHeader->setNumberOfPixelsPerBlockCol(m_blockSize.y);
    m_imageHeader->setNumberOfRows(rect.height());
    m_imageHeader->setNumberOfCols(rect.width());
 
    ossimNitfImageBandV2_1 bandInfo;
    for(idx = 0; idx < bands; ++idx)
    {
       std::ostringstream out;
       
       out << std::setfill('0')
           << std::setw(2)
           << idx;
       
       bandInfo.setBandRepresentation(out.str().c_str());
       m_imageHeader->setBandInfo(idx, bandInfo);
    }
 
    ossim_uint64 imageHeaderStart = m_str->tellp();
    m_imageHeader->writeStream( *m_str );
    ossim_uint64 imageHeaderEnd = m_str->tellp();
    ossim_uint64 imageHeaderSize = imageHeaderEnd - imageHeaderStart;
 
    // Start the sequence through tiles:
    theInputConnection->setToStartOfSequence();
    
    ossimRefPtr<ossimImageData> data = theInputConnection->getNextTile();
    ossim_uint64 tileNumber = 1;
    ossimEndian endian;
    
    // write out mask if needed
    if(masked)
    {
       blockZeros.resize(blockLength);
       memset(&blockZeros.front(), '\0', blockLength);
       datamask.writeStream( *m_str );
    }
    while( data.valid() && !needsAborting())
    {
       bool write = true;
       if(endian.getSystemEndianType() == OSSIM_LITTLE_ENDIAN)
       {
          switch(data->getScalarType())
          {
             case OSSIM_USHORT16:
             case OSSIM_USHORT11:
             case OSSIM_USHORT12:
             case OSSIM_USHORT13:
             case OSSIM_USHORT14:
             case OSSIM_USHORT15:
             {
                endian.swap((ossim_uint16*)data->getBuf(),
                            data->getWidth()*data->getHeight()*data->getNumberOfBands());
                break;
             }
             case OSSIM_SSHORT16:
             {
                endian.swap((ossim_sint16*)data->getBuf(),
                            data->getWidth()*data->getHeight()*data->getNumberOfBands());
                break;
             }
             case OSSIM_FLOAT:
             case OSSIM_NORMALIZED_FLOAT:
             {
                endian.swap((ossim_float32*)data->getBuf(),
                            data->getWidth()*data->getHeight()*data->getNumberOfBands());
                break;
             }
             case OSSIM_DOUBLE:
             case OSSIM_NORMALIZED_DOUBLE:
             {
                endian.swap((ossim_float64*)data->getBuf(),
                            data->getWidth()*data->getHeight()*data->getNumberOfBands());
                break;
             }
             default:
                break;
          }
       }
       
       if (masked)
       {
          if (memcmp(data->getBuf(), &blockZeros.front(), blockLength) == 0)
          {
             write = false;
             datamask.setIncludeBlock(tileNumber-1, false);
          }
       }
       if(write)
       {
          m_str->write((char*)(data->getBuf()), data->getSizeInBytes());         
       }
       
       setPercentComplete(((double)tileNumber / (double)numberOfTiles) * 100);
       
       if(!needsAborting())
       {
          data = theInputConnection->getNextTile();
       }
       ++tileNumber;
    }
 
    // ossim_uint64 imageSegmentEnd = m_str->tellp();
 
    // Let's write our text header
    if ( m_textHeader.valid() )
    {
       m_textHeader->writeStream( *m_str ); 
       //Now write the text
       m_str->write((char*)(m_textEntry.c_str()), m_textEntry.length());
    }   
 
 
    for (vector<ossimNitfDataExtensionSegmentV2_1>::iterator iter = m_dataExtensionSegments.begin();
       iter != m_dataExtensionSegments.end(); iter++)
    {
       iter->writeStream( *m_str );
    }
 
    if (masked)
    {
       m_str->seekp(imageHeaderEnd);
       datamask.writeStream( *m_str );
       //delete [] blockZeros;
    }
 
    std::streamoff pos = m_str->tellp();
 
    setComplexityLevel(pos, m_fileHeader.get());
 
    /*
     * Need to change the way I compute file length and header length later
     * We need to figure out a better way to compute.
     */
    m_fileHeader->setFileLength(static_cast<ossim_uint64>(pos));
    m_fileHeader->setHeaderLength(headerLength);
    m_str->seekp(0, ios::beg);
    imageInfoRecord.setSubheaderLength(imageHeaderSize);
    m_fileHeader->replaceImageInfoRecord(0, imageInfoRecord);
    m_fileHeader->writeStream( *m_str );
    
    return true;
 }

◆ writeBlockBandSequential()

bool ossimNitfWriter::writeBlockBandSequential ( )

protectedvirtual

Outputs in band sequential format.

Band 1 is followed by band 2, ... etc.

Definition at line 552 of file ossimNitfWriter.cpp.

 {
    ossimScalarType scalarType = theInputConnection->getOutputScalarType();
    ossim_uint64    byteSize   = ossim::scalarSizeInBytes(scalarType);
    ossimIrect      rect       = theInputConnection->getBoundingRect();
    ossim_uint64    bands      = theInputConnection->getNumberOfOutputBands();
    ossim_uint64    idx        = 0;
    ossim_uint64    headerStart   = (ossim_uint64)m_str->tellp();
 
    // Set the sequencer block size to be the same as output.
    theInputConnection->setTileSize(m_blockSize);
    
    ossim_uint64 blocksHorizontal = theInputConnection->getNumberOfTilesHorizontal();
    ossim_uint64 blocksVertical   = theInputConnection->getNumberOfTilesVertical();
    ossim_uint64 numberOfTiles    = theInputConnection->getNumberOfTiles();
 
    ossimNitfImageInfoRecordV2_1 imageInfoRecord;
    imageInfoRecord.setSubheaderLength(439);
    imageInfoRecord.setImageLength(bands*byteSize*blocksHorizontal*blocksVertical*m_blockSize.x*m_blockSize.y);
 
    m_fileHeader->setDate();
    m_fileHeader->addImageInfoRecord(imageInfoRecord);
 
    if ( m_textHeader.valid() )
    {
       // Add any text headers
       ossimNitfTextFileInfoRecordV2_1 textInfoRecord;
       textInfoRecord.setSubheaderLength(285); //default
       // Set length of text to be that of input text
       textInfoRecord.setTextLength(m_textEntry.length()); 
       m_fileHeader->addTextInfoRecord(textInfoRecord);
    }
 
    //---
    // This makes space for the file header; it is written again at the end of
    // this method with updated values
    // need a better way to get the length.  This should be queried on the
    // header before writing
    //---  
    m_fileHeader->writeStream( *m_str );
    ossim_uint64 headerLength = ((ossim_uint64)m_str->tellp() - headerStart) /* + 1 */;
    
    ossimString representation;
    m_imageHeader->setActualBitsPerPixel(ossim::getActualBitsPerPixel(scalarType));
    m_imageHeader->setBitsPerPixel(ossim::getBitsPerPixel(scalarType));
    m_imageHeader->setPixelType(ossimNitfCommon::getNitfPixelType(scalarType));
    m_imageHeader->setNumberOfBands(bands);
    m_imageHeader->setImageMode('S');// blocked
    
    if((bands == 3)&&
       (scalarType == OSSIM_UCHAR))
    {
       m_imageHeader->setRepresentation("RGB");
       m_imageHeader->setCategory("VIS");
    }
    else if(bands == 1)
    {
       m_imageHeader->setRepresentation("MONO");
       m_imageHeader->setCategory("VIS");
    }
    else
    {
       m_imageHeader->setRepresentation("MULTI");
       m_imageHeader->setCategory("MS");
    }
    m_imageHeader->setBlocksPerRow(blocksHorizontal);
    m_imageHeader->setBlocksPerCol(blocksVertical);
    m_imageHeader->setNumberOfPixelsPerBlockRow(m_blockSize.x);
    m_imageHeader->setNumberOfPixelsPerBlockCol(m_blockSize.y);
    m_imageHeader->setNumberOfRows(rect.height());
    m_imageHeader->setNumberOfCols(rect.width());
 
    ossimNitfImageBandV2_1 bandInfo;
    for(idx = 0; idx < bands; ++idx)
    {
       std::ostringstream out;
       
       out << std::setfill('0')
           << std::setw(2)
           << idx;
       
       bandInfo.setBandRepresentation(out.str().c_str());
       m_imageHeader->setBandInfo(idx, bandInfo);
    }
 
    ossim_uint64 imageHeaderStart = m_str->tellp();
    m_imageHeader->writeStream( *m_str );
    ossim_uint64 imageHeaderEnd = m_str->tellp();
    ossim_uint64 imageHeaderSize = imageHeaderEnd - imageHeaderStart;
 
    // ossimIpt ul = rect.ul();
 
    // Start the sequence through tiles:
    theInputConnection->setToStartOfSequence();
 
    ossimRefPtr<ossimImageData> data = theInputConnection->getNextTile();
    ossim_uint64 tileNumber = 0;
    ossimEndian endian;
 
    // get the start to the first band of data block
    //
    ossim_uint64 streamOffset = m_str->tellp();
    
    // holds the total pixels to the next band
 
    ossim_uint64 blockSizeInBytes = m_blockSize.x*m_blockSize.y*ossim::scalarSizeInBytes(data->getScalarType());
    ossim_uint64 bandOffsetInBytes = (blockSizeInBytes*blocksHorizontal*blocksVertical);
 
    bool needSwapping = endian.getSystemEndianType() == OSSIM_LITTLE_ENDIAN;
    while(data.valid() && !needsAborting())
    {
       if(needSwapping)
       {
          switch(data->getScalarType())
          {
             case OSSIM_USHORT16:
             case OSSIM_USHORT11:
             case OSSIM_USHORT12:
             case OSSIM_USHORT13:
             case OSSIM_USHORT14:
             case OSSIM_USHORT15:
             {
                endian.swap((ossim_uint16*)data->getBuf(),
                            data->getWidth()*data->getHeight()*data->getNumberOfBands());
                break;
             }
             case OSSIM_SSHORT16:
             {
                endian.swap((ossim_sint16*)data->getBuf(),
                            data->getWidth()*data->getHeight()*data->getNumberOfBands());
                break;
             }
             case OSSIM_FLOAT:
             case OSSIM_NORMALIZED_FLOAT:
             {
                endian.swap((ossim_float32*)data->getBuf(),
                            data->getWidth()*data->getHeight()*data->getNumberOfBands());
                break;
             }
             case OSSIM_DOUBLE:
             case OSSIM_NORMALIZED_DOUBLE:
             {
                endian.swap((ossim_float64*)data->getBuf(),
                            data->getWidth()*data->getHeight()*data->getNumberOfBands());
                break;
             }
             default:
                break;
          }
       }
 
       for(idx = 0; idx < bands; ++idx)
       {
          m_str->seekp(streamOffset+ // start of image stream
                                tileNumber*blockSizeInBytes + // start of block for band separate output
                                bandOffsetInBytes*idx, // which band offset is it
                                ios::beg); 
          
          m_str->write((char*)(data->getBuf(idx)),
                                blockSizeInBytes);
       }
       ++tileNumber;
       
       setPercentComplete(((double)tileNumber / (double)numberOfTiles) * 100);
       
       if(!needsAborting())
       {
          data = theInputConnection->getNextTile();
       }
    }
 
    // Let's write our text header
    if ( m_textHeader.valid() )
    {
       m_textHeader->writeStream( *m_str ); 
       //Now write the text
       m_str->write((char*)(m_textEntry.c_str()), m_textEntry.length());
    }   
 
    ossim_uint64 pos = m_str->tellp();
 
    setComplexityLevel(pos, m_fileHeader.get());
 
    /*
     * Need to change the way I compute file length and header length later
     * We need to figure out a better way to compute.
     */
    m_fileHeader->setFileLength(static_cast<ossim_uint64>(pos));
    m_fileHeader->setHeaderLength(headerLength);
    m_str->seekp(0, ios::beg);
    imageInfoRecord.setSubheaderLength(imageHeaderSize);
    m_fileHeader->replaceImageInfoRecord(0, imageInfoRecord);
    m_fileHeader->writeStream( *m_str );
    
    return true;
 }

◆ writeFile()

bool ossimNitfWriter::writeFile ( )

protectedvirtual

Returns: true on success false on error.

Implements ossimImageFileWriter.

Definition at line 143 of file ossimNitfWriter.cpp.

References ossimImageSourceSequencer::isMaster(), isOpen(), open(), ossimImageSourceSequencer::slaveProcessTiles(), and ossimImageFileWriter::theInputConnection.

 {
    if(!theInputConnection->isMaster())
    {
       theInputConnection->slaveProcessTiles();
 
       return true;
    }
 
    open();
 
    if (!isOpen())
    {
       if (traceDebug())
       {
          ossimNotify(ossimNotifyLevel_DEBUG)
             << "ossimNitfWriter::writeFile ERROR:"
             << " Could not open!  Returning..."
             << std::endl;
       }
 
       return false;
    }
    
    // Write out the geometry info.
    writeGeometry(m_imageHeader.get(), theInputConnection.get());
 
    // addStandardTags();
    
    bool result = false;
    if((theOutputImageType == "nitf_block_band_separate")||
       (theOutputImageType == "image/nitf"))
    {
       result =  writeBlockBandSeparate();
    }
    else if(theOutputImageType == "nitf_block_band_sequential")
    {
       result =  writeBlockBandSequential();
    }
    
    close();
    
    return result;
 }

Member Data Documentation

◆ m_blockSize

ossimIpt ossimNitfWriter::m_blockSize

protected

Definition at line 166 of file ossimNitfWriter.h.

Referenced by getProperty(), getTileSize(), ossimNitfWriter(), writeBlockBandSeparate(), and writeBlockBandSequential().

◆ m_dataExtensionSegments

std::vector<ossimNitfDataExtensionSegmentV2_1> ossimNitfWriter::m_dataExtensionSegments

protected

Definition at line 163 of file ossimNitfWriter.h.

Referenced by addDataExtensionSegment(), takeOverflowTags(), and writeBlockBandSeparate().

◆ m_fileHeader

ossimRefPtr<ossimNitfFileHeaderV2_1> ossimNitfWriter::m_fileHeader

protected

Definition at line 161 of file ossimNitfWriter.h.

Referenced by addRegisteredTag(), getFileHeader(), getProperty(), ossimNitfWriter(), setProperty(), takeOverflowTags(), writeBlockBandSeparate(), writeBlockBandSequential(), and ~ossimNitfWriter().

◆ m_imageHeader

ossimRefPtr<ossimNitfImageHeaderV2_1> ossimNitfWriter::m_imageHeader

protected

Definition at line 162 of file ossimNitfWriter.h.

Referenced by addRegisteredTag(), getImageHeader(), getProperty(), ossimNitfWriter(), setProperty(), takeOverflowTags(), writeBlockBandSeparate(), writeBlockBandSequential(), and ~ossimNitfWriter().

◆ m_str

std::shared_ptr<ossim::ofstream> ossimNitfWriter::m_str

protected

Currently disabled...

Definition at line 160 of file ossimNitfWriter.h.

Referenced by close(), isOpen(), open(), writeBlockBandSeparate(), and writeBlockBandSequential().

◆ m_textEntry

std::string ossimNitfWriter::m_textEntry

protected

Definition at line 165 of file ossimNitfWriter.h.

Referenced by addTextToNitf(), writeBlockBandSeparate(), and writeBlockBandSequential().

◆ m_textHeader

ossimRefPtr<ossimNitfTextHeaderV2_1> ossimNitfWriter::m_textHeader

protected

Definition at line 164 of file ossimNitfWriter.h.

Referenced by addTextToNitf(), writeBlockBandSeparate(), writeBlockBandSequential(), and ~ossimNitfWriter().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ossimNitfWriter()

◆ ~ossimNitfWriter()

Member Function Documentation

◆ addDataExtensionSegment()

◆ addRegisteredTag() [1/2]

◆ addRegisteredTag() [2/2]

◆ addTextToNitf()

◆ close()

◆ getFileHeader()

◆ getImageHeader()

◆ getImageTypeList()

◆ getProperty()

◆ getPropertyNames()

◆ getTileSize()

◆ isOpen()

◆ loadState()

◆ open()

◆ saveState()

◆ setProperty()

◆ setTileSize()

◆ takeOverflowTags()

◆ writeBlockBandSeparate()

◆ writeBlockBandSequential()

◆ writeFile()

Member Data Documentation

◆ m_blockSize

◆ m_dataExtensionSegments

◆ m_fileHeader

◆ m_imageHeader

◆ m_str

◆ m_textEntry

◆ m_textHeader