#include <ossimMpiSlaveOverviewSequencer.h>

Inheritance diagram for ossimMpiSlaveOverviewSequencer:

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

virtual bool	isMaster () const

virtual void	initialize ()
	This must be called. More...

virtual void	setToStartOfSequence ()
	Will set the internal pointers to the upperleft tile number. More...

virtual void	slaveProcessTiles ()
	This is a trigger to start resampling tiles. More...

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

ossim_uint32	getNumberOfTiles () const

ossim_uint32	getNumberOfTilesHorizontal () const

ossim_uint32	getNumberOfTilesVertical () const

virtual void	getOutputImageRectangle (ossimIrect &rect) const
	Gets the zero-based image rectangle for the output reduced resolution data set (rrds). More...

void	setImageHandler (ossimImageHandler *input)
	Sets the input source or connection. More...

void	setBitMaskObjects (ossimBitMaskWriter mask_writer, ossimMaskFilter mask_filter)
	Enabled the generation of an alpha (bit) mask such that any full or partial null pixels will be masked out. More...

void	setSourceLevel (ossim_uint32 level)
	Sets the input source resolution to decimate from. More...

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

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

void	writeHistogram ()
	Write histogram method. More...

void	writeHistogram (const ossimFilename &file)
	Write histogram method that takes a file name. More...

virtual ossimRefPtr< ossimImageData >	getNextTile ()
	Will allow you to get the next tile in the sequence. More...

ossimIpt	getTileSize () const

void	setTileSize (const ossimIpt &pt)
	updated the tile size. More...

void	setResampleType (ossimFilterResampler::ossimFilterResamplerType resampleType)
	Sets the resampling type. 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

bool	writeOmdFile (const std::string &file)
	Writes an ossim metadata(omd) file with min, max, null values. More...

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

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

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

Protected Member Functions inherited from ossimOverviewSequencer
virtual	~ossimOverviewSequencer ()
	virtual destructor More...

void	getInputTileRectangle (ossimIrect &inputRect) const
	Gets the image rectangle for the input tile for theCurrentTileNumber. More...

void	getOutputTileRectangle (ossimIrect &outputRect) const
	Gets the image rectangle for the output tile for theCurrentTileNumber. More...

void	updateTileDimensions ()
	Updates theNumberOfTilesHorizontal and theNumberOfTilesVertical. More...

void	resampleTile (const ossimImageData *inputTile)
	Resamples a patch of data. More...

template<class T >
void	resampleTile (const ossimImageData *inputTile, T dummy)

void	clearMinMaxNullArrays ()
	Clears out the arrays from a scan for min, max, nulls. More...

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
int	m_rank

int	m_numberOfProcessors

Protected Attributes inherited from ossimOverviewSequencer
ossimRefPtr< ossimImageHandler >	m_imageHandler

ossimRefPtr< ossimBitMaskWriter >	m_maskWriter

ossimRefPtr< ossimMaskFilter >	m_maskFilter

ossimRefPtr< ossimImageData >	m_tile

ossimIrect	m_areaOfInterest

ossimIpt	m_tileSize

ossim_uint32	m_numberOfTilesHorizontal

ossim_uint32	m_numberOfTilesVertical

ossim_uint32	m_currentTileNumber

ossim_uint32	m_sourceResLevel
	This is the resolution level to build overviews from. More...

bool	m_dirtyFlag
	Dirty flag - if true, this object is not initialized. More...

ossim_int32	m_decimationFactor
	TODO make this handle any decimation. More...

ossimFilterResampler::ossimFilterResamplerType	m_resampleType
	Currently only handles NEAREST_NEIGHBOR and BOX (default = BOX) More...

ossimRefPtr< ossimMultiBandHistogram >	m_histogram

ossimHistogramMode	m_histoMode

ossim_uint32	m_histoTileIndex
	Used to determine which tiles to accumulate a histogram from. More...

bool	m_scanForMinMax
	Control flags for min, max, null scanning. More...

bool	m_scanForMinMaxNull

std::vector< ossim_float64 >	m_minValues
	Arrays o hold the min value for each band for scan min/max methods. More...

std::vector< ossim_float64 >	m_maxValues

std::vector< ossim_float64 >	m_nulValues

Protected Attributes inherited from ossimErrorStatusInterface
ossimErrorCode	theErrorStatus

Detailed Description

Definition at line 21 of file ossimMpiSlaveOverviewSequencer.h.

Constructor & Destructor Documentation

◆ ossimMpiSlaveOverviewSequencer()

ossimMpiSlaveOverviewSequencer::ossimMpiSlaveOverviewSequencer ( )

default constructor

Definition at line 26 of file ossimMpiSlaveOverviewSequencer.cpp.

References ossimOverviewSequencer::m_currentTileNumber, m_numberOfProcessors, and m_rank.

    :
    ossimOverviewSequencer(),
    m_rank(0),
    m_numberOfProcessors(1)
 {
 #if OSSIM_HAS_MPI   
    MPI_Comm_rank(MPI_COMM_WORLD, &m_rank);
    MPI_Comm_size(MPI_COMM_WORLD, &m_numberOfProcessors);
 #endif
    
    if( m_rank != 0 )
    {
       //---
       // Master process (rank 0) does not resample tiles so our process rank
       // is 1 then we'll start at tile 0, rank 2 starts at 1, rank 3 starts
       // at 2 and so on...
       //---
       m_currentTileNumber = m_rank -1;
    }
    else
    {
       m_currentTileNumber = 0;
    }   
 }

◆ ~ossimMpiSlaveOverviewSequencer()

ossimMpiSlaveOverviewSequencer::~ossimMpiSlaveOverviewSequencer ( )

protectedvirtual

virtual destructor

Definition at line 52 of file ossimMpiSlaveOverviewSequencer.cpp.

53 {

54 }

Member Function Documentation

◆ initialize()

void ossimMpiSlaveOverviewSequencer::initialize ( )

virtual

This must be called.

We can only initialize this object completely if we know all connections are valid. Some other object drives this and so the connection's initialize will be called after. The job of this connection is to set up the sequence. It will default to the bounding rect. The area of interest can be set to some other rectagle (use setAreaOfInterest).

Reimplemented from ossimOverviewSequencer.

Definition at line 61 of file ossimMpiSlaveOverviewSequencer.cpp.

References ossimOverviewSequencer::initialize(), ossimOverviewSequencer::m_currentTileNumber, and m_rank.

 {
    ossimOverviewSequencer::initialize();
 
    m_currentTileNumber = m_rank-1;
 }

◆ isMaster()

bool ossimMpiSlaveOverviewSequencer::isMaster ( ) const

virtual

Returns: Always false for this implementation.

Reimplemented from ossimOverviewSequencer.

Definition at line 56 of file ossimMpiSlaveOverviewSequencer.cpp.

 {
    return false;
 }

◆ setToStartOfSequence()

void ossimMpiSlaveOverviewSequencer::setToStartOfSequence ( )

virtual

Will set the internal pointers to the upperleft tile number.

To go to the next tile in the sequence just call getNextTile.

Reimplemented from ossimOverviewSequencer.

Definition at line 68 of file ossimMpiSlaveOverviewSequencer.cpp.

References ossimOverviewSequencer::m_currentTileNumber, and m_rank.

 {
    if(m_rank != 0)
    {
       //---
       // Subtract one since the masters job is just writing and not issue
       // getTiles.
       //---
       m_currentTileNumber = m_rank-1;
    }
    else
    {
       // the master will start at 0
       m_currentTileNumber = 0;
    }
 }

◆ slaveProcessTiles()

void ossimMpiSlaveOverviewSequencer::slaveProcessTiles ( )

virtual

This is a trigger to start resampling tiles.

Reimplemented from ossimOverviewSequencer.

Definition at line 85 of file ossimMpiSlaveOverviewSequencer.cpp.

References ossim::byteOrder(), ossimImageData::getBuf(), ossimOverviewSequencer::getNextTile(), ossimOverviewSequencer::getNumberOfTiles(), ossimImageSource::getOutputScalarType(), ossimRectilinearDataObject::getScalarType(), ossimImageData::getSize(), ossimImageData::getSizeInBytes(), ossimOverviewSequencer::m_currentTileNumber, ossimOverviewSequencer::m_imageHandler, m_numberOfProcessors, ossimOverviewSequencer::m_tile, OSSIM_BIG_ENDIAN, OSSIM_UINT8, ossimEndian::swap(), and ossimRefPtr< T >::valid().

 {
 #if OSSIM_HAS_MPI 
 
    //---
    // Bytes must be swapped to big endian (network byte order) if the scalar
    // type is not 8 bit and the system byte order is little endian.  We will
    // use the endian pointer itself as a flag to swap.
    //---
    ossimEndian* endian = 0;
    if (m_imageHandler.valid())
    {
       if (m_imageHandler->getOutputScalarType() != OSSIM_UINT8)
       {
          if (ossim::byteOrder() != OSSIM_BIG_ENDIAN)
          {
             endian = new ossimEndian();
          }
       }
    }
 
    // Total number of tiles for all processes.
    ossim_uint32 numberOfTiles = getNumberOfTiles();
 
    int         errorValue; // Needed for MPI_Isend and MPI_Wait.
    MPI_Request request;    // Needed for MPI_Isend and MPI_Wait.
 
    while(m_currentTileNumber < numberOfTiles)
    {
       ossimRefPtr<ossimImageData> data = ossimOverviewSequencer::getNextTile();
 
       void* buf = data->getBuf();
 
       // Data always sent in big endian byte order.
       if (endian)
       {
          endian->swap(m_tile->getScalarType(), buf, m_tile->getSize());
       }
 
       // Send the buffer to the master process.
       request = MPI_REQUEST_NULL;
       errorValue = MPI_Isend(buf,
                              data->getSizeInBytes(),
                              MPI_UNSIGNED_CHAR,
                              0,
                              0,
                              MPI_COMM_WORLD,
                              &request);
 
       //---
       // Wait for send to complete before we overwrite the buffer with the
       // next tile.
       //---
       errorValue = MPI_Wait(&request, MPI_STATUS_IGNORE);
 
       //---
       // If we have eight processes only seven are used for resampling tiles,
       // so we would process every seventh tile.
       // 
       // The call to getNextTile has already incremented m_currentTileNumber
       // by one so adjust accordingly.
       //---
       if (m_numberOfProcessors>2)
       {
          m_currentTileNumber += (m_numberOfProcessors-2);
       }
       
    } // End of while loop through number of tiles.
 
    // cleanup...
    if (endian)
    {
       delete endian;
       endian = 0;
    }
    
 #endif /* End of #if OSSIM_HAS_MPI */
    
 }