ossimKakaduNitfOverviewBuilder Class to build overviews from the Kakadu library. More...

#include <ossimKakaduNitfOverviewBuilder.h>

Inheritance diagram for ossimKakaduNitfOverviewBuilder:

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

virtual	~ossimKakaduNitfOverviewBuilder ()
	virtual destructor More...

virtual bool	execute ()
	Builds the overviews. More...

virtual void	setOutputFile (const ossimFilename &file)
	Sets the output filename. More...

virtual ossimFilename	getOutputFile () const
	Returns the output. More...

virtual bool	setOverviewType (const ossimString &type)
	Sets the overview output type. More...

virtual ossimString	getOverviewType () const
	Gets the overview type. More...

virtual void	getTypeNameList (std::vector< ossimString > &typeList) const
	Method to populate class supported types. More...

virtual ossimObject *	getObject ()

virtual const ossimObject *	getObject () const

virtual bool	canConnectMyInputTo (ossim_int32 index, const ossimConnectableObject *obj) const

virtual void	setProperty (ossimRefPtr< ossimProperty > property)
	Method to set properties. More...

virtual void	getPropertyNames (std::vector< ossimString > &propertyNames) const
	Method to populate the list of property names. More...

virtual std::ostream &	print (std::ostream &out) const
	print method. More...

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

virtual bool	setOutputWriter (ossimImageFileWriter *outputWriter)
	Sets an optional file writer to the builder. More...

virtual bool	setInputSource (ossimImageHandler *imageSource)
	Sets the input to the builder. More...

virtual bool	hasOverviewType (const ossimString &type) const
	Method to check if builder can handle type. More...

virtual ossim_uint32	getOverviewStopDimension () const
	Get the overview stop dimension. More...

virtual void	setOverviewStopDimension (ossim_uint32 dim)
	Sets the overview stop dimension. More...

ossimHistogramMode	getHistogramMode () const
	Gets the histogram accumulation mode. More...

void	setHistogramMode (ossimHistogramMode mode)
	Sets the histogram accumulation mode. More...

virtual void	finalize ()
	Finalize method. More...

void	setBitMaskSpec (const ossimKeywordlist &bit_mask_spec)
	Specifies parameters (in KWL) for generation of an alpha (bit) mask such that any full or partial null pixels will be masked out. More...

void	setScanForMinMax (bool flag)
	Turn on/off scan for min max flag. More...

bool	getScanForMinMax () const

void	setScanForMinMaxNull (bool flag)
	Turn on/off scan for min, max, null flag. More...

bool	getScanForMinMaxNull () const

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 void	initialize ()

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

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

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

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	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 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 void	setPercentComplete (double percentComplete)

virtual ossimListenerManager *	getManager ()

void	enableEvents ()

void	disableEvents ()

void	setCurrentMessage (const ossimString &message)

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	disconnectInputEvent (ossimConnectionEvent &)

virtual void	disconnectOutputEvent (ossimConnectionEvent &)

virtual void	connectInputEvent (ossimConnectionEvent &)

virtual void	connectOutputEvent (ossimConnectionEvent &)

virtual void	propertyEvent (ossimPropertyEvent &)

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

Private Member Functions
void	setImagField (ossimNitfImageHeaderV2_1 *hdr, ossim_uint32 startingResLevel) const
	Set the Image Magnification (IMAG) field in the form of "/2 ". More...

Private Attributes
ossimFilename	m_outputFile

ossimFilename	m_outputFileTmp

ossimKakaduCompressor *	m_compressor

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 Member Functions inherited from ossimOverviewBuilderBase
virtual	~ossimOverviewBuilderBase ()
	virtual destructor More...

ossim_uint32	getRequiredResLevels (const ossimImageHandler *ih) const
	Gets the required number of res levels. More...

void	initializePreferenceSettings ()
	Initializes preference settings. More...

void	initializeScanOptions ()
	Checks scalar type and turns on scanning for min, max, nulls if needed. 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 inherited from ossimOverviewBuilderBase
ossim_uint32	m_overviewStopDimension

ossimHistogramMode	m_histoMode

ossimKeywordlist	m_bitMaskSpec

ossimRefPtr< ossimImageHandler >	m_imageHandler

std::vector< ossim_uint32 >	m_originalBandList

ossimRefPtr< ossimBitMaskWriter >	m_maskWriter

ossimRefPtr< ossimMaskFilter >	m_maskFilter

ossimFilename	m_outputFile

bool	m_scanForMinMax

bool	m_scanForMinMaxNull

bool	m_scanFloatData

Protected Attributes inherited from ossimSource
bool	theEnableFlag

bool	theInitializedFlag

Protected Attributes inherited from ossimConnectableObject
ossimId	theId

ossimString	theDescription

ossimObject *	theOwner

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

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

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

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

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

bool	theEnabledFlag

std::list< ossimListener * >	theDelayedAdd

std::list< ossimListener * >	theDelayedRemove

bool	theFireEventFlag

Protected Attributes inherited from ossimErrorStatusInterface
ossimErrorCode	theErrorStatus

Protected Attributes inherited from ossimProcessInterface
double	thePercentComplete

ossimProcessStatus	theProcessStatus

ossimString	theMessage

bool	theEventFlag

Protected Attributes inherited from ossimListener
bool	theListenerEnableFlag

Detailed Description

ossimKakaduNitfOverviewBuilder Class to build overviews from the Kakadu library.

Definition at line 32 of file ossimKakaduNitfOverviewBuilder.h.

Constructor & Destructor Documentation

◆ ossimKakaduNitfOverviewBuilder()

ossimKakaduNitfOverviewBuilder::ossimKakaduNitfOverviewBuilder ( )

default constructor

Definition at line 66 of file ossimKakaduNitfOverviewBuilder.cpp.

    :
    ossimOverviewBuilderBase(),
    m_outputFile(ossimFilename::NIL),
    m_outputFileTmp(ossimFilename::NIL),
    m_compressor(new ossimKakaduCompressor())
 {
    if (traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "ossimKakaduNitfOverviewBuilder::ossimKakaduNitfOverviewBuilder"
          << " DEBUG:\n";
 #ifdef OSSIM_ID_ENABLED
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "OSSIM_ID:  "
          << OSSIM_ID
          << "\n";
 #endif
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "overview stop dimension: " << m_overviewStopDimension
          << std::endl;
    }
 }

◆ ~ossimKakaduNitfOverviewBuilder()

ossimKakaduNitfOverviewBuilder::~ossimKakaduNitfOverviewBuilder ( )

virtual

virtual destructor

Definition at line 90 of file ossimKakaduNitfOverviewBuilder.cpp.

References m_compressor, and ossimOverviewBuilderBase::m_imageHandler.

 {
    m_imageHandler = 0;
 
    if (m_compressor)
    {
       delete m_compressor;
       m_compressor = 0;
    }
 }

Member Function Documentation

◆ canConnectMyInputTo()

bool ossimKakaduNitfOverviewBuilder::canConnectMyInputTo	(	ossim_int32	index,
		const ossimConnectableObject *	obj
	)		const

virtual

Returns: true if input is an image handler. Satisfies pure virtual.

Implements ossimConnectableObject.

Definition at line 748 of file ossimKakaduNitfOverviewBuilder.cpp.

References PTR_CAST.

 {
    if ( (index == 0) &&
         PTR_CAST(ossimImageHandler, obj) )
    {
       return true;
    }
 
    return false;
 }

◆ execute()

bool ossimKakaduNitfOverviewBuilder::execute ( )

virtual

Builds the overviews.

Returns: true on success, false on error.

Note: If setOutputFile was not called the output name will be derived from the image name. If image was "foo.tif" the overview file will be "foo.rrd" or "foo.ovr".

Implements ossimOverviewBuilderBase.

Definition at line 149 of file ossimKakaduNitfOverviewBuilder.cpp.

 {
    static const char MODULE[] = "ossimKakaduNitfOverviewBuilder::execute";
 
    if (traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG) << MODULE << " entered...\n";
    }
    
    bool result = false;
 
    if ( m_imageHandler.valid() ) // Make sure there is a source.
    {
       // Get the output filename.
       ossimFilename outputFile = getOutputFile();
 
       if (outputFile != m_imageHandler->getFilename())
       {
          //---
          // Add .tmp in case process gets aborted to avoid leaving bad .ovr
          // file.
          //---
          ossimFilename outputFileTemp = outputFile + ".tmp";
          
          // Required number of levels needed including r0.
          ossim_uint32 requiedResLevels =
             getRequiredResLevels(m_imageHandler.get());
          
          // Zero based starting resLevel.
          ossim_uint32 startingResLevel =
             m_imageHandler->getNumberOfDecimationLevels();
          
          if (traceDebug())
          {
             ossimNotify(ossimNotifyLevel_DEBUG)
                << MODULE
                << "\nCurrent number of reduced res sets: "
                << m_imageHandler->getNumberOfDecimationLevels()
                << "\nNumber of required reduced res sets:  "
                << requiedResLevels
                << "\nStarting reduced res set:    " << startingResLevel
                << "\nHistogram mode: " << getHistogramMode()
                << std::endl;
          }
 
          if ( startingResLevel < requiedResLevels )
          {
             //---
             // If image handler is band selector, start with all bands.
             // Some sources, e.g. ossimEnviTileSource can pick up default
             // bands and filter out all other bands.
             //---
             m_imageHandler->setOutputToInputBandList();  
             
             // If alpha bit mask generation was requested, then need to instantiate the mask writer
             // object.  This is simply a "transparent" tile source placed after to the right of the
             // image handler that scans the pixels being pulled and accumulates alpha bit mask for
             // writing at the end:
             if (m_bitMaskSpec.getSize() > 0)
             {
                m_maskWriter = new ossimBitMaskWriter();
                m_maskWriter->loadState(m_bitMaskSpec);
                m_maskWriter->setStartingResLevel(1);
                ossimRefPtr<ossimBitMaskTileSource> bmts = new ossimBitMaskTileSource;
                bmts->setAssociatedMaskWriter(m_maskWriter.get());
                m_maskFilter->connectMyInputTo(m_imageHandler.get());
                m_maskFilter->setMaskSource((ossimImageSource*)bmts.get());
             }
 
             //---
             // Set up the sequencer.  This will be one of three depending
             // on if we're running mpi and if we are a master process or
             // a slave process.
             //---
             ossimRefPtr<ossimOverviewSequencer> sequencer;
             
             if(ossimMpi::instance()->getNumberOfProcessors() > 1)
             {
                if ( ossimMpi::instance()->getRank() == 0 )
                {
                   sequencer = new ossimMpiMasterOverviewSequencer();
                }
                else
                {
                   sequencer = new ossimMpiSlaveOverviewSequencer();
                }
             }
             else
             {
                sequencer = new ossimOverviewSequencer();
             }
 
             if( ossimMpi::instance()->getNumberOfProcessors() == 1)
             {
                //---
                // Pass the histogram mode to the sequencer.
                // Can't do with mpi/multi-process.
                //---
                sequencer->setHistogramMode( getHistogramMode() );
 
                if ( getScanForMinMaxNull() == true )
                {
                   sequencer->setScanForMinMaxNull(true);
                }
                else if ( getScanForMinMax() == true )
                {
                   sequencer->setScanForMinMax(true);
                }
             }
             
             sequencer->setImageHandler( m_imageHandler.get() );
             
             ossim_uint32 sourceResLevel = 0;
             if ( startingResLevel > 1)
             {
                sourceResLevel = startingResLevel - 1;
             }
          
             if (traceDebug())
             {
                ossimNotify(ossimNotifyLevel_DEBUG)
                   << MODULE
                   << "\nSource starting reduced res set: " << sourceResLevel
                   << std::endl;
             }
             
             sequencer->setSourceLevel(sourceResLevel);
 
             // Tmp hard coded to BOX:
             sequencer->setResampleType(
                   ossimFilterResampler::ossimFilterResampler_BOX);
 
             sequencer->setTileSize( DEFAULT_TILE_SIZE );
 
             sequencer->initialize();
             
             //---
             // If we are a slave process start the resampling of tiles.
             //---
             if (ossimMpi::instance()->getRank() != 0 )
             {
                sequencer->slaveProcessTiles();
                return true; // End of slave process.
             }
 
             ossim_uint32 outputTilesWide =
                sequencer->getNumberOfTilesHorizontal();
             ossim_uint32 outputTilesHigh =
                sequencer->getNumberOfTilesVertical();
             ossim_uint32 numberOfTiles =
                sequencer->getNumberOfTiles();
             ossim_uint32 tileNumber = 0;
             ossimIrect imageRect;
             sequencer->getOutputImageRectangle(imageRect);
             
             //---
             // From here on out master process only.
             //---
             ossimNitfFileHeaderV2_1* fHdr = 0;
             ossimNitfImageHeaderV2_1* iHdr = 0;
             ossimStdOutProgress* progressListener = 0;
             std::ofstream* os = 0;
             std::streampos endOfFileHdrPos;
             std::streampos endOfImgHdrPos;
             std::streampos endOfFilePos;
             ossimNitfImageInfoRecordV2_1 imageInfoRecord;
             
             // Open the output file.
             os = new std::ofstream;
             os->open(outputFileTemp.chars(), std::ios_base::out|std::ios_base::binary);
             if ( os->good() )
             {
                result = true; // Assuming we are good from this point.
                
                // Get an info dump to a keyword list.
                ossimKeywordlist kwl;
                std::shared_ptr<ossimInfoBase> info =
                   ossimInfoFactoryRegistry::instance()->
                   create(m_imageHandler->getFilename());
                if ( info )
                {
                   info->getKeywordlist(kwl);
                   info.reset();
                }
                
                fHdr = new ossimNitfFileHeaderV2_1();
                
                fHdr->addImageInfoRecord(imageInfoRecord);
                
                fHdr->setDate(ossimDate());
                fHdr->setTitle(ossimString("ossim_nitf_j2k_overview"));
                
                const char* lookup = kwl.find("nitf.FSCLAS");
                if (lookup)
                {
                   fHdr->setSecurityClassificationSys(ossimString(lookup));
                }
                fHdr->writeStream(*os);
                endOfFileHdrPos = os->tellp();
                
                iHdr = new ossimNitfImageHeaderV2_1();
 
                // Set the compression type:
                iHdr->setCompression(ossimString("C8"));
 
                // Set the Image Magnification (IMAG) field.
                setImagField(iHdr, startingResLevel);
 
                ossimScalarType scalarType = m_imageHandler->getOutputScalarType();
 
                // Set the pixel type (PVTYPE field).
                iHdr->setPixelType(
                   ossimNitfCommon::getNitfPixelType(scalarType));
 
                // Set the actual bits per pixel (ABPP field).
                iHdr->setActualBitsPerPixel(
                   ossim::getActualBitsPerPixel(scalarType));
                iHdr->setBitsPerPixel(ossim::getBitsPerPixel(scalarType));
                
                const ossim_uint64 BANDS =
                   m_imageHandler->getNumberOfOutputBands();
 
                iHdr->setNumberOfBands(BANDS);
                iHdr->setImageMode('B');// blocked
                
                if((BANDS == 3)&&
                   (scalarType == OSSIM_UCHAR))
                {
                   iHdr->setRepresentation("RGB");
                   iHdr->setCategory("VIS");
                }
                else if(BANDS == 1)
                {
                   iHdr->setRepresentation("MONO");
                   iHdr->setCategory("MS");
                }
                else
                {
                   iHdr->setRepresentation("MULTI");
                   iHdr->setCategory("MS");
                }
                
                iHdr->setBlocksPerRow(outputTilesWide);
                iHdr->setBlocksPerCol(outputTilesHigh);
                iHdr->setNumberOfPixelsPerBlockRow(DEFAULT_TILE_SIZE.y);
                iHdr->setNumberOfPixelsPerBlockCol(DEFAULT_TILE_SIZE.x);
                iHdr->setNumberOfRows(imageRect.height());
                iHdr->setNumberOfCols(imageRect.width());
                
                ossimNitfImageBandV2_1 bandInfo;
                for(ossim_uint32 band = 0; band < BANDS; ++band)
                {
                   std::ostringstream out;
                   
                   out << std::setfill('0')
                       << std::setw(2)
                       << band;
                   
                   bandInfo.setBandRepresentation(out.str().c_str());
                   iHdr->setBandInfo(band, bandInfo);
                }
                
                iHdr->writeStream(*os);
                endOfImgHdrPos = os->tellp();
                
                //---
                // Check for a listeners.  If the list is empty, add a
                // standard out listener so that command line apps like
                // img2rr will get some progress.
                //---
                ossimStdOutProgress* progressListener = 0;
                if (theListenerList.empty())
                {
                   progressListener = new ossimStdOutProgress(0, true);
                   addListener(progressListener);
                }
                setProcessStatus(
                   ossimProcessInterface::PROCESS_STATUS_EXECUTING);
                setPercentComplete(0.0);
                
                if (traceDebug())
                {
                   ossimNotify(ossimNotifyLevel_DEBUG)
                      << MODULE << " DEBUG:"
                      << "\noutputTilesWide:  " << outputTilesWide
                      << "\noutputTilesHigh:  " << outputTilesHigh
                      << "\nnumberOfTiles:    " << numberOfTiles
                      << "\nimageRect: " << imageRect
                      << std::endl;
                }
 
                if (m_compressor->getAlphaChannelFlag())
                {
                   //--- 
                   // Someone can set this through the generic setProperty
                   // interface. Unset, currently only supported in jp2 writer.
                   // Could be used here but I think we would have to update the
                   // nitf tags.
                   //---
                   m_compressor->setAlphaChannelFlag(false);
                }
 
                if ( ossim::getActualBitsPerPixel(scalarType) > 31 )
                {
                   m_compressor->setQualityType(ossimKakaduCompressor::OKP_VISUALLY_LOSSLESS);
                }
 
                try
                {
                   // Make a compressor
                   m_compressor->create(os,
                                        scalarType,
                                        BANDS,
                                        imageRect,
                                        DEFAULT_TILE_SIZE,
                                        numberOfTiles,
                                        false);
                   
                   ossimNotify(ossimNotifyLevel_INFO)
                      << "Generating " << (m_compressor->getLevels()+1)
                      << " levels..." << endl;
                }
                catch (const ossimException& e)
                {
                   setErrorStatus();
                   ossimNotify(ossimNotifyLevel_WARN) << e.what() << std::endl;
                   result = false;
                }
 
                if ( result )
                {
                   // Tile loop in the line direction.
                   for(ossim_uint32 y = 0; y < outputTilesHigh; ++y)
                   {
                      // Tile loop in the sample (width) direction.
                      for(ossim_uint32 x = 0; x < outputTilesWide; ++x)
                      {
                         // Grab the resampled tile.
                         ossimRefPtr<ossimImageData> t = sequencer->getNextTile();
 
                         // Check for errors reading tile:
                         if ( sequencer->hasError() )
                         {
                            setErrorStatus();
                            ossimNotify(ossimNotifyLevel_WARN)
                               << MODULE << " ERROR: reading tile:  "
                               << tileNumber << std::endl;
                            result = false;
                         }
 
                         if ( result && t.valid() )
                         {
                            //---
                            // If masking was enabled, pass the tile onto that object for
                            // processing:
                            //---
                            if ( m_maskWriter.valid())
                            {
                               m_maskWriter->generateMask(t, 0);
                            }
                            
                            if ( t->getDataObjectStatus() != OSSIM_NULL )
                            {
                               if ( ! m_compressor->writeTile( *(t.get()) ) )
                               {
                                  setErrorStatus();
                                  ossimNotify(ossimNotifyLevel_WARN)
                                     << MODULE << " ERROR:\nWriting tile:  "
                                     << tileNumber << std::endl;
                                  result = false;
                               }
                            }
                            else
                            {
                               setErrorStatus();
                               ossimNotify(ossimNotifyLevel_WARN)
                                  << MODULE << " ERROR:\nNull tile returned:  " << tileNumber
                                  << std::endl;
                               result = false;
                            }
                         }
                         
                         if ( !result )
                         {
                            // Bust out of sample loop.
                            break;
                         }
                         
                         // Increment tile number for percent complete.
                         ++tileNumber;
                         
                      } // End of tile loop in the sample (width) direction.
 
                      if ( !result )
                      {
                         // Bust out of line loop.
                         break;
                      }
                      
                      if ( needsAborting() )
                      {
                         setPercentComplete(100.0);
                         break;
                      }
                      else
                      {
                         double tile = tileNumber;
                         double numTiles = numberOfTiles;
                         setPercentComplete(tile / numTiles * 100.0);
                      }
                      
                   } // End of tile loop in the line (height) direction.
 
                   if ( result )
                   {
                      m_compressor->finish();
                      
                      // Get the file length.
                      endOfFilePos = os->tellp();
                      
                      //---
                      // Seek back to set some things that were not know until now and
                      // rewrite the nitf file and image header.
                      //---
                      os->seekp(0, std::ios_base::beg);
                      
                      // Set the file length.
                      std::streamoff length = endOfFilePos;
                      fHdr->setFileLength(static_cast<ossim_uint64>(length));
                      
                      // Set the file header length.
                      length = endOfFileHdrPos;
                      fHdr->setHeaderLength(static_cast<ossim_uint64>(length));            
                      // Set the image sub header length.
                      length = endOfImgHdrPos - endOfFileHdrPos;
                      
                      imageInfoRecord.setSubheaderLength(
                         static_cast<ossim_uint64>(length));
                      
                      // Set the image length.
                      length = endOfFilePos - endOfImgHdrPos;
                      imageInfoRecord.setImageLength(
                         static_cast<ossim_uint64>(length));
                      
                      fHdr->replaceImageInfoRecord(0, imageInfoRecord);
                      
                      // Rewrite the header.
                      fHdr->writeStream(*os);
                      
                      // Set the compression rate now that the image size is known.
                      ossimString comrat = ossimNitfCommon::getCompressionRate(
                         imageRect,
                         BANDS,
                         scalarType,
                         static_cast<ossim_uint64>(length));
                      iHdr->setCompressionRateCode(comrat);
                      
                      // Rewrite the image header.
                      iHdr->writeStream(*os);
                      
                      if (progressListener)
                      {
                         removeListener(progressListener);
                         delete progressListener;
                         progressListener = 0;
                      }
                      
                      if ( ossimMpi::instance()->getNumberOfProcessors() == 1 )
                      {
                         if ( getHistogramMode() != OSSIM_HISTO_MODE_UNKNOWN )
                         {
                            // Write the histogram.
                            ossimFilename histoFilename = getOutputFile();
                            histoFilename.setExtension("his");
                            sequencer->writeHistogram(histoFilename);
                         }
                         
                         if ( ( getScanForMinMaxNull() == true ) || ( getScanForMinMax() == true ) )
                         {
                            // Write the omd file:
                            ossimFilename file = m_outputFile;
                            file = file.setExtension("omd");
                            sequencer->writeOmdFile(file);
                         }
                      }
                      
                      // If masking was enabled, then only R0 was processed, need to process
                      // remaining levels:
                      if (m_maskWriter.valid())
                      {
                         ossim_uint32 num_rlevels = m_compressor->getLevels() + 1;
                         m_maskWriter->buildOverviews(num_rlevels);
                         m_maskFilter->disconnectMyInput(0);
                         m_maskWriter->disconnectAllInputs();
                         ossimNotify(ossimNotifyLevel_INFO)
                            << MODULE << "Writing alpha bit mask file..." << std::endl;
                         m_maskWriter->close();
                      }
                      
                   } // if ( result ) *** after end of tile loop ***
 
                } // End: if ( result ) from m_compressor->create
 
             } // End: if (os->good())
             
             if (fHdr)
             {
                delete fHdr;
                fHdr = 0;
             }
             
             if (iHdr)
             {
                delete iHdr;
                iHdr = 0;
             }
 
             if (progressListener)
             {
                delete progressListener;
                progressListener = 0;
             }
             
             if (os->is_open())
             {
                os->close();
                if ( result )
                {
                   outputFileTemp.rename(outputFile);
                }
                else
                {
                   ossimFilename::remove( outputFileTemp );
                }
             }
             delete os;
             os = 0;
 
          }
          else
          {
             ossimNotify(ossimNotifyLevel_INFO)<< MODULE << " NOTICE:"
                <<"  Image has required reduced resolution data sets.\n"<< std::endl;
          }
       }
       else
       {
          ossimNotify(ossimNotifyLevel_WARN)
             << "Source image file and overview file cannot be the same!"
             << std::endl;
       }
       
    } // matches: if (m_imageHandler)
 
    if (traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << MODULE << " exit status = " << (result?"true":"false\n")
          << std::endl;
    }
 
    finalize();  // Reset band list if a band selector.
 
    return result;
 
 } // End: ossimKakaduNitfOverviewBuilder::execute()

◆ getObject() [1/2]

ossimObject * ossimKakaduNitfOverviewBuilder::getObject ( )

virtual

Returns: ossimObject* to this object. Satisfies pure virtual.

Implements ossimProcessInterface.

Definition at line 738 of file ossimKakaduNitfOverviewBuilder.cpp.

 {
    return this;
 }

◆ getObject() [2/2]

const ossimObject * ossimKakaduNitfOverviewBuilder::getObject ( ) const

virtual

Returns: const ossimObject* to this object. Satisfies pure virtual.

Implements ossimProcessInterface.

Definition at line 743 of file ossimKakaduNitfOverviewBuilder.cpp.

 {
    return this;
 }

◆ getOutputFile()

ossimFilename ossimKakaduNitfOverviewBuilder::getOutputFile ( ) const

virtual

Returns the output.

This will be derived from the input file if not explicitly set.

Returns: The output filename.

Implements ossimOverviewBuilderBase.

Definition at line 106 of file ossimKakaduNitfOverviewBuilder.cpp.

References ossimImageHandler::getNumberOfEntries(), ossimOverviewBuilderBase::m_imageHandler, m_outputFile, ossimFilename::NIL, and ossimRefPtr< T >::valid().

 {
    ossimFilename result = m_outputFile;
    if (m_outputFile == ossimFilename::NIL)
    {
       if ( m_imageHandler.valid() )
       {
          bool usePrefix = (m_imageHandler->getNumberOfEntries()>1?true:false);
          result = m_imageHandler->
             getFilenameWithThisExtension(ossimString("ovr"), usePrefix);
       }
    }
    return result;
 }

◆ getOverviewType()

ossimString ossimKakaduNitfOverviewBuilder::getOverviewType ( ) const

virtual

Gets the overview type.

Satisfies pure virtual from ossimOverviewBuilderInterface.

Returns: The overview output type as a string.

Implements ossimOverviewBuilderBase.

Definition at line 137 of file ossimKakaduNitfOverviewBuilder.cpp.

 {
    return OVERVIEW_TYPE;   
 }

◆ getPropertyNames()

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

virtual

Method to populate the list of property names.

Parameters

propertyNames List to populate. This does not clear the list just adds to it.

Reimplemented from ossimSource.

Definition at line 725 of file ossimKakaduNitfOverviewBuilder.cpp.

References ossimKakaduCompressor::getPropertyNames(), and m_compressor.

 {
    m_compressor->getPropertyNames(propertyNames);
 }

◆ getTypeNameList()

void ossimKakaduNitfOverviewBuilder::getTypeNameList ( std::vector< ossimString > & typeList ) const

virtual

Method to populate class supported types.

Satisfies pure virtual from ossimOverviewBuilderInterface.

Parameters

typeList List of ossimStrings to add to.

Implements ossimOverviewBuilderBase.

Definition at line 142 of file ossimKakaduNitfOverviewBuilder.cpp.

 {
    typeList.push_back(OVERVIEW_TYPE);
    typeList.push_back(OVERVIEW_TYPE_ALIAS);   
 }

◆ print()

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

virtual

print method.

Returns: std::ostream&

Reimplemented from ossimProcessInterface.

Definition at line 731 of file ossimKakaduNitfOverviewBuilder.cpp.

 {
    out << "ossimKakaduNitfOverviewBuilder::print"
        << std::endl;
    return out;
 }

◆ setImagField()

void ossimKakaduNitfOverviewBuilder::setImagField	(	ossimNitfImageHeaderV2_1 *	hdr,
		ossim_uint32	startingResLevel
	)		const

private

Set the Image Magnification (IMAG) field in the form of "/2 ".

Parameters

hdr	The nitf image header.
starting	resolution level.

Definition at line 761 of file ossimKakaduNitfOverviewBuilder.cpp.

References ossimNitfImageHeaderV2_1::setImageMagnification(), ossimString::size(), and ossimString::toString().

 {
    //---
    // This assumes res level 0 is 1.0 magnification.
    //---
    if (hdr)
    {
       ossimString imagString;
       
       if (startingResLevel == 0)
       {
          imagString = "1.0  ";
       }
       else
       {
          //---
          // Assumes power of 2 decimation.
          //---
          ossim_uint32 decimation = 1<<startingResLevel;
                      
          //---
          // Using slash '/' format.  "/2" = 1/2, /  
          imagString = "/";
          imagString += ossimString::toString(decimation);
          if (imagString.size() <= 4)
          {
             if (imagString.size() == 2)
             {
                imagString += "  "; // two spaces
             }
             else if (imagString.size() == 3)
             {
                imagString += " "; // one space
             }
          }
       }
       if (imagString.size())
       {
          hdr->setImageMagnification(imagString);
       }
    }
 }

◆ setOutputFile()

void ossimKakaduNitfOverviewBuilder::setOutputFile ( const ossimFilename & file )

virtual

Sets the output filename.

Satisfies pure virtual from ossimOverviewBuilderInterface.

Parameters

file	The output file name.

Implements ossimOverviewBuilderBase.

Definition at line 101 of file ossimKakaduNitfOverviewBuilder.cpp.

References m_outputFile.

 {
    m_outputFile = file;
 }

◆ setOverviewType()

bool ossimKakaduNitfOverviewBuilder::setOverviewType ( const ossimString & type )

virtual

Sets the overview output type.

Satisfies pure virtual from ossimOverviewBuilderInterface.

Currently handled types are: "ossim_tiff_nearest" and "ossim_tiff_box"

Parameters

type	This should be the string representing the type. This method will do nothing if type is not handled and return false.

Returns: true if type is handled, false if not.

Implements ossimOverviewBuilderBase.

Definition at line 121 of file ossimKakaduNitfOverviewBuilder.cpp.

 {
    bool result = false;
 
    //---
    // Only have one type right now.  These are the same:
    // "ossim_kakadu_nitf_j2k" or "j2k"
    //---
    if ( (type == OVERVIEW_TYPE) || (type == OVERVIEW_TYPE_ALIAS) )
    {
       result = true;
    }
 
    return result;
 }

◆ setProperty()

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

virtual

Method to set properties.

Parameters

property Property to set.

Note: Currently supported property:

Reimplemented from ossimSource.

Definition at line 716 of file ossimKakaduNitfOverviewBuilder.cpp.

References m_compressor, ossimKakaduCompressor::setProperty(), and ossimRefPtr< T >::valid().

 {
    if ( property.valid() )
    {
       m_compressor->setProperty(property);
    }
 }

Member Data Documentation

◆ m_compressor

ossimKakaduCompressor* ossimKakaduNitfOverviewBuilder::m_compressor

private

Definition at line 150 of file ossimKakaduNitfOverviewBuilder.h.

Referenced by getPropertyNames(), setProperty(), and ~ossimKakaduNitfOverviewBuilder().

◆ m_outputFile

ossimFilename ossimKakaduNitfOverviewBuilder::m_outputFile

private

Definition at line 148 of file ossimKakaduNitfOverviewBuilder.h.

Referenced by getOutputFile(), and setOutputFile().

◆ m_outputFileTmp

ossimFilename ossimKakaduNitfOverviewBuilder::m_outputFileTmp

private

Definition at line 149 of file ossimKakaduNitfOverviewBuilder.h.

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ossimKakaduNitfOverviewBuilder()

◆ ~ossimKakaduNitfOverviewBuilder()

Member Function Documentation

◆ canConnectMyInputTo()

◆ execute()

◆ getObject() [1/2]

◆ getObject() [2/2]

◆ getOutputFile()

◆ getOverviewType()

◆ getPropertyNames()

◆ getTypeNameList()

◆ print()

◆ setImagField()

◆ setOutputFile()

◆ setOverviewType()

◆ setProperty()

Member Data Documentation

◆ m_compressor

◆ m_outputFile

◆ m_outputFileTmp