ossimMultiResLevelHistogram Class Reference

#include <ossimMultiResLevelHistogram.h>

Inheritance diagram for ossimMultiResLevelHistogram:

Classes
class	ossimProprietaryHeaderInformation

Public Member Functions
	ossimMultiResLevelHistogram ()
	ossimMultiResLevelHistogram (ossim_uint32 numberOfResLevels)
	ossimMultiResLevelHistogram (const ossimMultiResLevelHistogram &rhs)
virtual	~ossimMultiResLevelHistogram ()
ossimRefPtr< ossimHistogram >	getHistogram (ossim_uint32 band, ossim_uint32 resLevel=0)
const ossimRefPtr< ossimHistogram >	getHistogram (ossim_uint32 band, ossim_uint32 resLevel=0) const
ossim_uint32	getNumberOfResLevels () const
ossim_uint32	getNumberOfBands (ossim_uint32 resLevel=0) const
void	create (ossim_uint32 numberOfResLevels)
ossimRefPtr< ossimMultiBandHistogram >	getMultiBandHistogram (ossim_uint32 resLevel) const
ossimRefPtr< ossimMultiResLevelHistogram >	createAccumulationLessThanEqual () const
ossimRefPtr< ossimMultiResLevelHistogram >	createAccumulationGreaterThanEqual () const
void	setBinCount (double binNumber, double count)
virtual void	addHistogram (ossimMultiBandHistogram *histo)
virtual ossimRefPtr< ossimMultiBandHistogram >	addHistogram ()
virtual bool	setHistogram (ossimRefPtr< ossimMultiBandHistogram > histo, ossim_uint32 resLevel)
virtual ossimFilename	getHistogramFile () const
virtual bool	importHistogram (const ossimFilename &inputFile)
virtual bool	importHistogram (std::istream &in)
virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)
virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) 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

Protected Member Functions
void	deleteHistograms ()
bool	parseProprietaryHistogram (std::istream &in)
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
std::vector< ossimRefPtr< ossimMultiBandHistogram > >	theHistogramList
ossimFilename	theHistogramFile

Detailed Description

Definition at line 21 of file ossimMultiResLevelHistogram.h.

Constructor & Destructor Documentation

ossimMultiResLevelHistogram() [1/3]

ossimMultiResLevelHistogram::ossimMultiResLevelHistogram

(

)

Definition at line 23 of file ossimMultiResLevelHistogram.cpp.

Referenced by createAccumulationGreaterThanEqual(), and createAccumulationLessThanEqual().

   :
      theHistogramList(),
      theHistogramFile()
{  
}

ossimMultiResLevelHistogram() [2/3]

ossimMultiResLevelHistogram::ossimMultiResLevelHistogram

(

ossim_uint32

numberOfResLevels

)

Definition at line 30 of file ossimMultiResLevelHistogram.cpp.

References create().

   :
      theHistogramList(),
      theHistogramFile()
{
   create(numberOfResLevels);
}

ossimMultiResLevelHistogram() [3/3]

ossimMultiResLevelHistogram::ossimMultiResLevelHistogram

(

const ossimMultiResLevelHistogram &

rhs

)

Definition at line 38 of file ossimMultiResLevelHistogram.cpp.

References create(), getNumberOfResLevels(), and theHistogramList.

   :
      theHistogramList(),
      theHistogramFile()
{
   
   create(rhs.getNumberOfResLevels());
   for(ossim_uint32 i = 0; i < theHistogramList.size(); ++i)
   {
      theHistogramList[i] = rhs.theHistogramList[i].valid()?
                            new ossimMultiBandHistogram(*rhs.theHistogramList[i]):
                            (ossimMultiBandHistogram*)NULL;
   }
}

~ossimMultiResLevelHistogram()

ossimMultiResLevelHistogram::~ossimMultiResLevelHistogram ( )

virtual

Definition at line 53 of file ossimMultiResLevelHistogram.cpp.

References deleteHistograms().

{
   deleteHistograms();
}

Member Function Documentation

addHistogram() [1/2]

void ossimMultiResLevelHistogram::addHistogram ( ossimMultiBandHistogram *  histo )

virtual

Will append to the list the passed in histogram.

Definition at line 141 of file ossimMultiResLevelHistogram.cpp.

References theHistogramList.

Referenced by ossimHistogramRemapper::computeHistogram(), and ossimOverviewSequencer::writeHistogram().

{
   theHistogramList.push_back(histo);
}

addHistogram() [2/2]

ossimRefPtr< ossimMultiBandHistogram > ossimMultiResLevelHistogram::addHistogram ( )

virtual

This will create and append a histogram to the list and return a pointer to the new histogram.

Definition at line 146 of file ossimMultiResLevelHistogram.cpp.

References theHistogramList.

{
   ossimRefPtr<ossimMultiBandHistogram> result = new ossimMultiBandHistogram;
   theHistogramList.push_back(result);
   return result;
}

create()

void ossimMultiResLevelHistogram::create

(

ossim_uint32

numberOfResLevels

)

Definition at line 58 of file ossimMultiResLevelHistogram.cpp.

References deleteHistograms(), and theHistogramList.

Referenced by ossimImageHistogramSource::computeFastModeHistogram(), ossimImageHistogramSource::computeNormalModeHistogram(), ossimImageSourceSequencer::getTile(), and ossimMultiResLevelHistogram().

{
   deleteHistograms();

   for(ossim_uint32 idx = 0; idx < numberOfResLevels; ++idx)
   {
      theHistogramList.push_back(new ossimMultiBandHistogram);      
   }
}

createAccumulationGreaterThanEqual()

ossimRefPtr< ossimMultiResLevelHistogram > ossimMultiResLevelHistogram::createAccumulationGreaterThanEqual

(

)

const

Definition at line 111 of file ossimMultiResLevelHistogram.cpp.

References ossimMultiResLevelHistogram(), and theHistogramList.

{
   ossimRefPtr<ossimMultiResLevelHistogram> result = NULL;

   if(theHistogramList.size() > 0)
   {
      result = new ossimMultiResLevelHistogram((ossim_uint32)theHistogramList.size());

      for(ossim_uint32 idx=0; idx < (ossim_uint32) theHistogramList.size(); ++ idx)
      {
         if(theHistogramList[idx].valid())
         {
            ossimRefPtr<ossimMultiBandHistogram> multiBandAccumulator = theHistogramList[idx]->createAccumulationGreaterThanEqual();
            result->theHistogramList[idx]=multiBandAccumulator;
         }
         else
         {
            // we will push on a null since someone could
            // turn off a band.  A null accumulation will
            // indicate no histogram data.
            //
            result->theHistogramList[idx] = 0;
         }
      }
      result = 0;
   }
   
   return result;
}

createAccumulationLessThanEqual()

ossimRefPtr< ossimMultiResLevelHistogram > ossimMultiResLevelHistogram::createAccumulationLessThanEqual

(

)

const

Definition at line 68 of file ossimMultiResLevelHistogram.cpp.

References ossimMultiResLevelHistogram(), and theHistogramList.

Referenced by ossimHistogramEqualization::computeAccumulationHistogram(), and ossimHistogramEqualization::ossimHistogramEqualization().

{
   ossimRefPtr<ossimMultiResLevelHistogram> result = 0;

   if(theHistogramList.size() > 0)
   {
      result = new ossimMultiResLevelHistogram((ossim_uint32)theHistogramList.size());

      for(ossim_uint32 idx=0; idx < (ossim_uint32) theHistogramList.size(); ++ idx)
      {
         if(theHistogramList[idx].valid())
         {
            ossimRefPtr<ossimMultiBandHistogram> multiBandAccumulator = theHistogramList[idx]->createAccumulationLessThanEqual();
            result->theHistogramList[idx] = multiBandAccumulator;
         }
         else
         {
            // we will push on a null since someone could
            // turn off a band.  A null accumulation will
            // indicate no histogram data.
            //
            result->theHistogramList[idx] = 0;
         }
      }
   }
   
   return result;
}

deleteHistograms()

void ossimMultiResLevelHistogram::deleteHistograms ( )

protected

Definition at line 164 of file ossimMultiResLevelHistogram.cpp.

References theHistogramList.

Referenced by create(), importHistogram(), loadState(), and ~ossimMultiResLevelHistogram().

{
   for(ossim_uint32 idx = 0; idx < (ossim_uint32)theHistogramList.size(); ++idx)
   {
      if(theHistogramList[idx].valid())
      {
         theHistogramList[idx] = NULL;
      }
   }
   
   theHistogramList.clear();
}

getHistogram() [1/2]

ossimRefPtr< ossimHistogram > ossimMultiResLevelHistogram::getHistogram	(	ossim_uint32	band,
		ossim_uint32	resLevel = 0
	)

Definition at line 177 of file ossimMultiResLevelHistogram.cpp.

References ossimMultiBandHistogram::getHistogram(), getMultiBandHistogram(), and ossimRefPtr< T >::valid().

Referenced by ossimShorelineTool::autoComputeThreshold(), ossimHistogramRemapper::getHistogram(), and ossimHistogramRemapper::setNullCount().

{
   ossimRefPtr<ossimMultiBandHistogram> temp = getMultiBandHistogram(resLevel);

   if(temp.valid())
   {
      return temp->getHistogram(band);
   }
   
   return (ossimHistogram*)0;
}

getHistogram() [2/2]

const ossimRefPtr< ossimHistogram > ossimMultiResLevelHistogram::getHistogram	(	ossim_uint32	band,
		ossim_uint32	resLevel = 0
	)		const

Definition at line 189 of file ossimMultiResLevelHistogram.cpp.

References ossimMultiBandHistogram::getHistogram(), getMultiBandHistogram(), and ossimRefPtr< T >::valid().

{
   const ossimRefPtr<ossimMultiBandHistogram> temp = getMultiBandHistogram(resLevel);

   if(temp.valid())
   {
      return temp->getHistogram(band);
   }
   
   return (ossimHistogram*)0;
}

getHistogramFile()

ossimFilename ossimMultiResLevelHistogram::getHistogramFile ( ) const

virtual

Definition at line 508 of file ossimMultiResLevelHistogram.cpp.

References theHistogramFile.

Referenced by ossimHistogramRemapper::getHistogramFile().

{
   return theHistogramFile;
}

getMultiBandHistogram()

ossimRefPtr< ossimMultiBandHistogram > ossimMultiResLevelHistogram::getMultiBandHistogram

(

ossim_uint32

resLevel

)

const

Definition at line 218 of file ossimMultiResLevelHistogram.cpp.

References theHistogramList.

Referenced by ossimImageHistogramSource::computeFastModeHistogram(), ossimImageHistogramSource::computeNormalModeHistogram(), getHistogram(), getNumberOfBands(), ossimImageSourceSequencer::getTile(), ossimKMeansFilter::initialize(), ossimHistogramEqualization::initializeLuts(), ossimHistogramEqualization::runEqualizationAlgorithm(), ossimMultiBandHistogramTileSource::runLinearStretchAlgorithm(), and ossimHistogramThreshholdFilter::runThreshholdStretchAlgorithm().

{
   if(resLevel < (ossim_uint32)theHistogramList.size())
   {
      return theHistogramList[resLevel];
   }

   return NULL;
}

getNumberOfBands()

ossim_uint32 ossimMultiResLevelHistogram::getNumberOfBands

(

ossim_uint32

resLevel = 0

)

const

Definition at line 207 of file ossimMultiResLevelHistogram.cpp.

References getMultiBandHistogram(), ossimMultiBandHistogram::getNumberOfBands(), and ossimRefPtr< T >::valid().

Referenced by ossimHistogramRemapper::setNullCount().

{
   const ossimRefPtr<ossimMultiBandHistogram> h = getMultiBandHistogram(resLevel);
   if (h.valid())
   {
      return h->getNumberOfBands();
   }

   return 0;
}  

getNumberOfResLevels()

ossim_uint32 ossimMultiResLevelHistogram::getNumberOfResLevels

(

)

const

Definition at line 202 of file ossimMultiResLevelHistogram.cpp.

References theHistogramList.

Referenced by ossimMultiResLevelHistogram(), and setHistogram().

{
   return (ossim_uint32)theHistogramList.size();
}

importHistogram() [1/2]

bool ossimMultiResLevelHistogram::importHistogram ( const ossimFilename &  inputFile )

virtual

Definition at line 335 of file ossimMultiResLevelHistogram.cpp.

References ossim::StreamFactoryRegistry::instance(), and theHistogramFile.

Referenced by ossimImageHandler::getImageHistogram(), ossimHistogramSource::loadState(), ossimHistogramRemapper::openHistogram(), and ossimImageSourceHistogramFilter::setHistogram().

{
   //---
   // File size check removed for s3
   // if( file.fileSize() > 0 )
   // {
   //    theHistogramFile = file;
   
   bool result = false;
   std::shared_ptr<ossim::istream> in = ossim::StreamFactoryRegistry::instance()->
      createIstream( file, std::ios_base::in );
   if ( in )
   {
      result = importHistogram( *in );
      if ( result )
      {
         theHistogramFile = file;
      }
   }
   return result;
}

importHistogram() [2/2]

bool ossimMultiResLevelHistogram::importHistogram ( std::istream &  in )

virtual

Definition at line 228 of file ossimMultiResLevelHistogram.cpp.

References ossimString::c_str(), deleteHistograms(), ossimString::find(), getline(), ossimMultiResLevelHistogram::ossimProprietaryHeaderInformation::getNumberOfResLevels(), ossimMultiBandHistogram::importHistogram(), loadState(), ossimMultiResLevelHistogram::ossimProprietaryHeaderInformation::parseStream(), ossimKeywordlist::parseStream(), ossimString::substr(), theHistogramList, and ossimString::toUInt32().

{
   if (!in) // Check stream state.
   {
      return false;
   }
   
   ossimString buffer;
   getline(in, buffer);

   if ( in.eof() ) // Zero byte files will hit here.
   {
      return false;
   }

   // check to see if it is a proprietary histogram file
   // 
   if((buffer =="") || (buffer.c_str()[0] != 'F' ||
      buffer.c_str()[1] != 'i'))
   {
      in.seekg(0, ios::beg);
      ossimKeywordlist kwl;
      if (kwl.parseStream(in) == true)
      {
         return loadState(kwl);
      }
      else
      {
         return false;
      }
   }
   
   ossimProprietaryHeaderInformation header;
   in.seekg(0, ios::beg);
   deleteHistograms();
   if(header.parseStream(in))
   {
      ossim_uint32 numberOfResLevels = header.getNumberOfResLevels();
      
      if(numberOfResLevels)
      {
         theHistogramList.resize(numberOfResLevels);

         for(ossim_uint32 counter = 0; counter < (ossim_uint32)theHistogramList.size(); ++counter)
         {
            theHistogramList[counter] = NULL;
         }
         ossimString reslevelBuffer;
         ossimString buffer;
         
         for(ossim_uint32 idx = 0; idx < numberOfResLevels; ++idx)
         {
            getline(in, buffer);
            if(buffer.find("RR Level") != string::npos)
            {
               std::string::size_type offset = buffer.find(":");
               if(offset != string::npos)
               {
                  reslevelBuffer = buffer.substr(offset+1);
               }
               else
               {
                  deleteHistograms();
                  return false;
               }
            }
            else
            {
               deleteHistograms();
               return false;
            }
            ossim_uint32 resLevelIdx = reslevelBuffer.toUInt32();

            if(resLevelIdx < (ossim_uint32)theHistogramList.size())
            {
               if(!theHistogramList[resLevelIdx])
               {
                  ossimRefPtr<ossimMultiBandHistogram> histogram = new ossimMultiBandHistogram;
                  if(histogram->importHistogram(in))
                  {
                     theHistogramList[resLevelIdx] = histogram;
                  }
                  else
                  {
                     deleteHistograms();
                     return false;
                  }
               }
            }
            else
            {
               deleteHistograms();
               return false;
            }
            ossimString skipDot;
            getline(in, skipDot);
         }
      }
      else
      {
         return false;
      }
   }  

   return true;
}

loadState()

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

virtual

Definition at line 476 of file ossimMultiResLevelHistogram.cpp.

References deleteHistograms(), and ossimKeywordlist::find().

Referenced by importHistogram(), and ossimHistogramSource::loadState().

{
   deleteHistograms();
   const char* number_of_res_levels = kwl.find(prefix, NUMBER_OF_RES_LEVELS.key());

   if(number_of_res_levels)
   {
      ossim_uint32 numberOfResLevels = ossimString(number_of_res_levels).toUInt32();

      if(numberOfResLevels)
      {
         ossimString newPrefix;
         for(ossim_uint32 idx = 0; idx < numberOfResLevels; ++idx)
         {
            ossimRefPtr<ossimMultiBandHistogram> histo = new ossimMultiBandHistogram;

            if (prefix) newPrefix = prefix;
            
            newPrefix += "rr_level";
            newPrefix += ossimString::toString(idx);
            newPrefix += ".";
            
            histo->loadState(kwl, newPrefix.c_str());
            
            theHistogramList.push_back(histo);
         }
      }
   }
   return true;
}

parseProprietaryHistogram()

bool ossimMultiResLevelHistogram::parseProprietaryHistogram ( std::istream &  in )

protected

saveState()

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

virtual

Definition at line 441 of file ossimMultiResLevelHistogram.cpp.

References ossimKeywordlist::add(), theHistogramList, and ossimKeywordNames::TYPE_KW.

Referenced by ossimHistogramEqualization::initializeLuts(), ossimHistogramSource::saveState(), ossimHistogramWriter::writeHistogram(), and ossimOverviewSequencer::writeHistogram().

{
   bool result = true;
   if(theHistogramList.size() > 0)
   {
      ossimString s1 = prefix;
      kwl.add(prefix,
              ossimKeywordNames::TYPE_KW,
              "ossimMultiResLevelHistogram",
              true);
      kwl.add(prefix,
              NUMBER_OF_RES_LEVELS.key(),
              static_cast<ossim_uint32>(theHistogramList.size()),
              true);

      for(ossim_uint32 idx = 0; idx < theHistogramList.size(); ++idx)
      {
         ossimString rr_level = ossimString(prefix) + "rr_level";
         rr_level += ossimString::toString(idx)   + ".";
         if(theHistogramList[idx].valid())
         {
            result = theHistogramList[idx]->saveState(kwl, rr_level.c_str());
            
            if(!result)
            {
               return result;
            }
         }
      }    
   }

   return result;
}

setBinCount()

void ossimMultiResLevelHistogram::setBinCount	(	double	binNumber,
		double	count
	)

Definition at line 97 of file ossimMultiResLevelHistogram.cpp.

References theHistogramList.

Referenced by ossimImageSourceHistogramFilter::setHistogram().

{
   if(theHistogramList.size() > 0)
   {
      for(ossim_uint32 idx=0; idx < (ossim_uint32) theHistogramList.size(); ++ idx)
      {
         if(theHistogramList[idx].valid())
         {
            theHistogramList[idx]->setBinCount(binNumber, count);
         }
      }
   }   
}

setHistogram()

bool ossimMultiResLevelHistogram::setHistogram ( ossimRefPtr< ossimMultiBandHistogram >  histo, ossim_uint32  resLevel  )

virtual

Will set the histogram to the passed in res level. It will delete the histogram at the res level before setting the pointer to the passed in histogram. if the resLevel is out of range it will return false meaning it was unable to assign the pointer.

Definition at line 153 of file ossimMultiResLevelHistogram.cpp.

References getNumberOfResLevels(), and theHistogramList.

{
   if(resLevel < getNumberOfResLevels())
   {
      theHistogramList[resLevel] = histo;
      return true;
   }
   return false;
}

Member Data Documentation

theHistogramFile

ossimFilename ossimMultiResLevelHistogram::theHistogramFile

protected

Definition at line 97 of file ossimMultiResLevelHistogram.h.

Referenced by getHistogramFile(), and importHistogram().

theHistogramList

std::vector<ossimRefPtr<ossimMultiBandHistogram> > ossimMultiResLevelHistogram::theHistogramList

protected

Definition at line 96 of file ossimMultiResLevelHistogram.h.

Referenced by addHistogram(), create(), createAccumulationGreaterThanEqual(), createAccumulationLessThanEqual(), deleteHistograms(), getMultiBandHistogram(), getNumberOfResLevels(), importHistogram(), ossimMultiResLevelHistogram(), saveState(), setBinCount(), and setHistogram().

---

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

• ossimMultiResLevelHistogram.h
• ossimMultiResLevelHistogram.cpp