ossimMultiBandHistogram Class Reference

#include <ossimMultiBandHistogram.h>

Inheritance diagram for ossimMultiBandHistogram:

Classes
class	ossimProprietaryHeaderInformation

Public Member Functions
	ossimMultiBandHistogram ()
	ossimMultiBandHistogram (const ossimMultiBandHistogram &rhs)
	ossimMultiBandHistogram (ossim_int32 numberOfBands, ossim_int32 numberOfBuckets, float minValue, float maxValue)
void	create (const ossimImageSource *input)
void	create (ossim_int32 numberOfBands, ossim_int32 numberOfBuckets, float minValue, float maxValue)
ossim_uint32	getNumberOfBands () const
void	create (ossim_int32 numberOfBands)
void	setBinCount (double binNumber, double count)
ossimRefPtr< ossimHistogram >	getHistogram (ossim_int32 band)
const ossimRefPtr< ossimHistogram >	getHistogram (ossim_int32 band) const
ossimRefPtr< ossimMultiBandHistogram >	createAccumulationLessThanEqual () const
ossimRefPtr< ossimMultiBandHistogram >	createAccumulationGreaterThanEqual () 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
virtual bool	saveState (ossimRefPtr< ossimXmlNode > xmlNode) const
virtual bool	loadState (const ossimRefPtr< ossimXmlNode > xmlNode)
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
virtual	~ossimMultiBandHistogram ()
void	deleteHistograms ()
bool	parseProprietaryHistogram (std::istream &in)
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
std::vector< ossimRefPtr< ossimHistogram > >	theHistogramList

Detailed Description

Definition at line 23 of file ossimMultiBandHistogram.h.

Constructor & Destructor Documentation

ossimMultiBandHistogram() [1/3]

ossimMultiBandHistogram::ossimMultiBandHistogram

(

)

Definition at line 18 of file ossimMultiBandHistogram.cpp.

Referenced by createAccumulationGreaterThanEqual(), and createAccumulationLessThanEqual().

{  
}

ossimMultiBandHistogram() [2/3]

ossimMultiBandHistogram::ossimMultiBandHistogram

(

const ossimMultiBandHistogram &

rhs

)

Definition at line 27 of file ossimMultiBandHistogram.cpp.

References theHistogramList.

{
   theHistogramList.resize(rhs.theHistogramList.size());

   for(ossim_uint32 i = 0; i < theHistogramList.size(); ++i)
   {
      theHistogramList[i] =  rhs.theHistogramList[i].valid()?
         new ossimHistogram(*rhs.theHistogramList[i].get()):(ossimHistogram*)0;
   }
}

ossimMultiBandHistogram() [3/3]

ossimMultiBandHistogram::ossimMultiBandHistogram	(	ossim_int32	numberOfBands,
		ossim_int32	numberOfBuckets,
		float	minValue,
		float	maxValue
	)

Definition at line 38 of file ossimMultiBandHistogram.cpp.

References create().

{
   if(numberOfBands > 0)
   {
      create(numberOfBands, numberOfBuckets, minValue, maxValue);
   }
}

~ossimMultiBandHistogram()

ossimMultiBandHistogram::~ossimMultiBandHistogram ( )

protectedvirtual

Definition at line 22 of file ossimMultiBandHistogram.cpp.

References deleteHistograms().

{
   deleteHistograms();
}

Member Function Documentation

create() [1/3]

void ossimMultiBandHistogram::create

(

const ossimImageSource *

input

)

Definition at line 49 of file ossimMultiBandHistogram.cpp.

References ossimImageSource::getNumberOfOutputBands(), ossimImageSource::getOutputScalarType(), OSSIM_DEFAULT_MAX_PIX_SINT16, OSSIM_DEFAULT_MAX_PIX_UCHAR, OSSIM_DEFAULT_MAX_PIX_UINT11, OSSIM_DEFAULT_MAX_PIX_UINT12, OSSIM_DEFAULT_MAX_PIX_UINT13, OSSIM_DEFAULT_MAX_PIX_UINT14, OSSIM_DEFAULT_MAX_PIX_UINT15, OSSIM_DEFAULT_MAX_PIX_UINT16, OSSIM_DEFAULT_MIN_PIX_SINT16, OSSIM_FLOAT32, OSSIM_FLOAT64, OSSIM_NORMALIZED_DOUBLE, OSSIM_NORMALIZED_FLOAT, OSSIM_SINT16, OSSIM_SINT32, OSSIM_UINT16, OSSIM_UINT32, OSSIM_UINT8, OSSIM_USHORT11, OSSIM_USHORT12, OSSIM_USHORT13, OSSIM_USHORT14, OSSIM_USHORT15, ossimNotify(), and ossimNotifyLevel_WARN.

Referenced by ossimImageHistogramSource::computeFastModeHistogram(), ossimHistogramRemapper::computeHistogram(), ossimImageHistogramSource::computeNormalModeHistogram(), ossimImageSourceSequencer::getTile(), ossimOverviewSequencer::initialize(), and ossimMultiBandHistogram().

{
   if (input)
   {
      ossim_uint32 bands = input->getNumberOfOutputBands();;
      ossim_uint32 numberOfBins = 0;
      ossim_float64 minValue = 0.0;
      ossim_float64 maxValue = 0.0;
      
      switch(input->getOutputScalarType())
      {
         case OSSIM_UINT8:
         {
            minValue     = 0;
            maxValue     = OSSIM_DEFAULT_MAX_PIX_UCHAR;
            numberOfBins = 256;
            break;
         }
         case OSSIM_USHORT11:
         {
            minValue     = 0;
            maxValue     = OSSIM_DEFAULT_MAX_PIX_UINT11;
            numberOfBins = OSSIM_DEFAULT_MAX_PIX_UINT11 + 1;
            break;
         }
         case OSSIM_USHORT12:
         {
            minValue     = 0;
            maxValue     = OSSIM_DEFAULT_MAX_PIX_UINT12;
            numberOfBins = OSSIM_DEFAULT_MAX_PIX_UINT12 + 1;
            break;
         }
         case OSSIM_USHORT13:
         {
            minValue     = 0;
            maxValue     = OSSIM_DEFAULT_MAX_PIX_UINT13;
            numberOfBins = OSSIM_DEFAULT_MAX_PIX_UINT13 + 1;
            break;
         }
         case OSSIM_USHORT14:
         {
            minValue     = 0;
            maxValue     = OSSIM_DEFAULT_MAX_PIX_UINT14;
            numberOfBins = OSSIM_DEFAULT_MAX_PIX_UINT14 + 1;
            break;
         }
         case OSSIM_USHORT15:
         {
            minValue     = 0;
            maxValue     = OSSIM_DEFAULT_MAX_PIX_UINT15;
            numberOfBins = OSSIM_DEFAULT_MAX_PIX_UINT15 + 1;
            break;
         }
         case OSSIM_UINT16:
         case OSSIM_UINT32:
         {
            minValue     = 0;
            maxValue     = OSSIM_DEFAULT_MAX_PIX_UINT16;
            numberOfBins = OSSIM_DEFAULT_MAX_PIX_UINT16 + 1;
            break;
         }
         case OSSIM_SINT16:
         case OSSIM_SINT32:
         case OSSIM_FLOAT32:
         case OSSIM_FLOAT64:
         {
            //---
            // Special case to handle DTED which has a null of -32767 and SRTM
            // which has null of -32768.  Set the min to -32766 which is OK for
            // both types.  Basically we don't want to count the null values as
            // a valid pixel. drb - 04 Feb. 2016
            //
            // NOTE: OSSIM_DEFAULT_MIN_PIX_SINT16 = -32767
            //---
            minValue     = OSSIM_DEFAULT_MIN_PIX_SINT16+1;
            maxValue     = OSSIM_DEFAULT_MAX_PIX_SINT16;
            numberOfBins = (OSSIM_DEFAULT_MAX_PIX_SINT16-OSSIM_DEFAULT_MIN_PIX_SINT16);
            break;
         }
         case OSSIM_NORMALIZED_FLOAT:
         case OSSIM_NORMALIZED_DOUBLE:
         {
            minValue     = 0;
            maxValue     = 1.0;
            numberOfBins = OSSIM_DEFAULT_MAX_PIX_UINT16+1;
            break;
         }
         default:
         {
            ossimNotify(ossimNotifyLevel_WARN)
               << "Unsupported scalar type in ossimMultiBandHistogram::create()"
               << std::endl;
            return;
         }
         
      }  // switch(input->getOutputScalarType())

      create(bands, numberOfBins, minValue, maxValue);
      
   } // if (input)
}

create() [2/3]

void ossimMultiBandHistogram::create	(	ossim_int32	numberOfBands,
		ossim_int32	numberOfBuckets,
		float	minValue,
		float	maxValue
	)

Definition at line 151 of file ossimMultiBandHistogram.cpp.

References deleteHistograms(), and theHistogramList.

{
   // Make sure we clear our internal lists before we start.
   deleteHistograms();

   if(numberOfBands > 0)
   {
      numberOfBuckets = numberOfBuckets>0?numberOfBuckets:1;

      for(ossim_int32 bands = 0; bands < numberOfBands; ++bands)
      {
         theHistogramList.push_back(new ossimHistogram(numberOfBuckets,
                                                       minValue,
                                                       maxValue));
      }
   }
}

create() [3/3]

void ossimMultiBandHistogram::create

(

ossim_int32

numberOfBands

)

Definition at line 172 of file ossimMultiBandHistogram.cpp.

References deleteHistograms(), and theHistogramList.

{
   deleteHistograms();
   for(ossim_int32 bands = 0; bands < numberOfBands; ++bands)
   {
      theHistogramList.push_back(new ossimHistogram);
   }
}

createAccumulationGreaterThanEqual()

ossimRefPtr< ossimMultiBandHistogram > ossimMultiBandHistogram::createAccumulationGreaterThanEqual

(

)

const

Definition at line 245 of file ossimMultiBandHistogram.cpp.

References ossimMultiBandHistogram(), and theHistogramList.

{
   ossimRefPtr<ossimMultiBandHistogram> result = NULL;

   if(theHistogramList.size() > 0)
   {
      result = new ossimMultiBandHistogram;
      
      for(ossim_uint32 idx = 0; idx < theHistogramList.size(); ++idx)
      {
         if(theHistogramList[idx].valid())
         {
            result->theHistogramList[idx] = theHistogramList[idx]->CumulativeGreaterThanEqual();
         }
         else
         {
            result->theHistogramList[idx] = 0;
         }     
      }
   }

   return result;
}

createAccumulationLessThanEqual()

ossimRefPtr< ossimMultiBandHistogram > ossimMultiBandHistogram::createAccumulationLessThanEqual

(

)

const

Definition at line 220 of file ossimMultiBandHistogram.cpp.

References ossimMultiBandHistogram(), and theHistogramList.

{
   ossimRefPtr<ossimMultiBandHistogram> result = NULL;

   if(theHistogramList.size() > 0)
   {
      result = new ossimMultiBandHistogram;
      result->theHistogramList.resize(theHistogramList.size());
      
      for(ossim_uint32 idx = 0; idx < theHistogramList.size(); ++idx)
      {
         if(theHistogramList[idx].valid())
         {
            result->theHistogramList[idx] = theHistogramList[idx]->CumulativeLessThanEqual();
         }
         else
         {
            result->theHistogramList[idx] = 0;
         }     
      }
   }

   return result;
}

deleteHistograms()

void ossimMultiBandHistogram::deleteHistograms ( )

protected

Definition at line 269 of file ossimMultiBandHistogram.cpp.

References theHistogramList.

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

{
   theHistogramList.clear();
}

getHistogram() [1/2]

ossimRefPtr< ossimHistogram > ossimMultiBandHistogram::getHistogram

(

ossim_int32

band

)

Definition at line 186 of file ossimMultiBandHistogram.cpp.

References theHistogramList.

Referenced by ossimKMeansFilter::computeKMeans(), ossimMultiResLevelHistogram::getHistogram(), ossimKMeansFilter::getTile(), ossimKMeansFilter::initialize(), ossimHistogramEqualization::initializeLuts(), ossimImageData::populateHistogram(), ossimHistogramEqualization::runEqualizationAlgorithm(), ossimMultiBandHistogramTileSource::runLinearStretchAlgorithm(), and ossimHistogramThreshholdFilter::runThreshholdStretchAlgorithm().

{
   if((band >=0) && (band < (ossim_int32)theHistogramList.size()))
   {
      return theHistogramList[band];
   }

   return NULL;
}

getHistogram() [2/2]

const ossimRefPtr< ossimHistogram > ossimMultiBandHistogram::getHistogram

(

ossim_int32

band

)

const

Definition at line 196 of file ossimMultiBandHistogram.cpp.

References theHistogramList.

{
   if((band >=0) && (band < (ossim_int32)theHistogramList.size()))
   {
      return theHistogramList[band];
   }

   return 0;
}

getNumberOfBands()

ossim_uint32 ossimMultiBandHistogram::getNumberOfBands

(

)

const

Definition at line 181 of file ossimMultiBandHistogram.cpp.

References theHistogramList.

Referenced by ossimMultiResLevelHistogram::getNumberOfBands(), ossimHistogramEqualization::initializeLuts(), ossimHistogramEqualization::runEqualizationAlgorithm(), ossimMultiBandHistogramTileSource::runLinearStretchAlgorithm(), and ossimHistogramThreshholdFilter::runThreshholdStretchAlgorithm().

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

importHistogram() [1/2]

bool ossimMultiBandHistogram::importHistogram ( const ossimFilename &  inputFile )

virtual

Imports a text file that has histogram data

Definition at line 349 of file ossimMultiBandHistogram.cpp.

References ossimString::c_str(), and ossimFilename::exists().

Referenced by ossimMultiResLevelHistogram::importHistogram().

{
   if(file.exists())
   {
      std::ifstream input(file.c_str());

      return importHistogram(input);
   }

   return false;
}

importHistogram() [2/2]

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

virtual

Definition at line 275 of file ossimMultiBandHistogram.cpp.

References deleteHistograms(), ossimString::find(), getline(), ossimMultiBandHistogram::ossimProprietaryHeaderInformation::getNumberOfBands(), ossimHistogram::importHistogram(), ossimMultiBandHistogram::ossimProprietaryHeaderInformation::parseStream(), ossimString::substr(), theHistogramList, and ossimString::toUInt32().

{
   ossimProprietaryHeaderInformation header;
   deleteHistograms();
   
   if(header.parseStream(in))
   {
      ossim_int32 numberOfBands = header.getNumberOfBands();
      
      if(numberOfBands)
      {
         theHistogramList.resize(numberOfBands);

         for(ossim_int32 counter = 0; counter < (ossim_int32)theHistogramList.size(); ++counter)
         {
            theHistogramList[counter] = 0;
         }
         ossimString bandBuffer;
         ossimString buffer;
         
         for(ossim_int32 idx = 0; idx < numberOfBands; ++idx)
         {
            getline(in, buffer);
            if(buffer.find("Band") != string::npos)
            {
                string::size_type offset = buffer.find(":");
               if(offset != string::npos)
               {
                  bandBuffer = buffer.substr(offset+1);
               }
               else
               {
                  deleteHistograms();
                  return false;
               }
            }
            else
            {
               deleteHistograms();
               return false;
            }
            ossim_uint32 bandIdx = bandBuffer.toUInt32();

            if(bandIdx < theHistogramList.size())
            {
               if(!theHistogramList[bandIdx].valid())
               {
                  ossimRefPtr<ossimHistogram> histogram = new ossimHistogram;
                  if(histogram->importHistogram(in))
                  {
                     theHistogramList[bandIdx] = histogram;
                  }
                  else
                  {
                     deleteHistograms();
                     return false;
                  }
               }
            }
            else
            {
               deleteHistograms();
               return false;
            }
         }
      }
      else
      {
         return false;
      }
   }  
   return true;
}

loadState() [1/2]

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

virtual

Definition at line 465 of file ossimMultiBandHistogram.cpp.

References ossimString::c_str(), deleteHistograms(), ossimKeywordlist::find(), ossimHistogram::loadState(), theHistogramList, ossimString::toString(), and ossimString::toUInt32().

{
   deleteHistograms();
   const char* number_of_bands = kwl.find(prefix, "number_of_bands");
   if(number_of_bands)
   {
      ossim_uint32 numberOfBands = ossimString(number_of_bands).toUInt32();

      if(numberOfBands>0)
      {
         ossimString newPrefix;
         for(ossim_uint32 idx = 0; idx < numberOfBands; ++idx)
         {
            ossimHistogram* histo = new ossimHistogram;

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

loadState() [2/2]

bool ossimMultiBandHistogram::loadState ( const ossimRefPtr< ossimXmlNode >  xmlNode )

virtual

Definition at line 521 of file ossimMultiBandHistogram.cpp.

References ossimXmlNode::getChildNodes(), ossimHistogram::loadState(), size, and theHistogramList.

{
   theHistogramList.clear();
   const vector<ossimRefPtr<ossimXmlNode> >& childNodes = xmlNode->getChildNodes();

   ossim_uint32 idx = 0;
   ossim_uint32 maxCount = (ossim_uint32)childNodes.size();
   for(idx = 0; idx < maxCount; ++idx)
   {
      if(childNodes[idx]->getTag() == "Band")
      {
         if(childNodes[idx]->getChildNodes().size())
         {
            ossimRefPtr<ossimHistogram> histo = new ossimHistogram;
            histo->loadState(childNodes[idx]->getChildNodes()[0]);
            theHistogramList.push_back(histo);
         }
      }
   }

   return true;
}

parseProprietaryHistogram()

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

protected

saveState() [1/2]

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

virtual

Definition at line 438 of file ossimMultiBandHistogram.cpp.

References ossimKeywordlist::add(), ossimString::c_str(), theHistogramList, and ossimString::toString().

{
   kwl.add(prefix,
           "type",
           "ossimMultiBandHistogram",
           true);
   kwl.add(prefix,
           "number_of_bands",
           static_cast<ossim_uint32>(theHistogramList.size()),
           true);
   
   for(ossim_uint32 idx = 0; idx < theHistogramList.size(); ++idx)
   {
      ossimString band = ossimString(prefix) + "band";
      band += (ossimString::toString(idx) + ".");
      if(theHistogramList[idx].valid())
      {
         ossimString newPrefix = (ossimString(prefix) + ossimString::toString(idx) + ".");
         
         theHistogramList[idx]->saveState(kwl, band.c_str());
      }
   }
   
   return true;
}

saveState() [2/2]

bool ossimMultiBandHistogram::saveState ( ossimRefPtr< ossimXmlNode >  xmlNode ) const

virtual

Definition at line 496 of file ossimMultiBandHistogram.cpp.

References ossimXmlNode::addAttribute(), ossimXmlNode::addChildNode(), ossimRefPtr< T >::get(), ossimXmlNode::setTag(), theHistogramList, and ossimString::toString().

{
   xmlNode->setTag("ossimMutliBandHistogram");
   for(ossim_uint32 idx = 0; idx < theHistogramList.size(); ++idx)
   {
      ossimRefPtr<ossimXmlNode> band = new ossimXmlNode;
      ossimRefPtr<ossimXmlNode> newNode = new ossimXmlNode;

      band->setTag("Band");
      band->addAttribute("idx", ossimString::toString(idx));
      band->addChildNode(newNode.get());
      if(theHistogramList[idx].valid())
      {         
         theHistogramList[idx]->saveState(newNode);
      }
      else
      {
         newNode->setTag("ossimHistogram");
      }
      xmlNode->addChildNode(band.get());
   }

   return true;
}

setBinCount()

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

Definition at line 206 of file ossimMultiBandHistogram.cpp.

References theHistogramList.

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

Member Data Documentation

theHistogramList

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

protected

Holds the histograms for each band

Definition at line 82 of file ossimMultiBandHistogram.h.

Referenced by create(), createAccumulationGreaterThanEqual(), createAccumulationLessThanEqual(), deleteHistograms(), getHistogram(), getNumberOfBands(), importHistogram(), loadState(), ossimMultiBandHistogram(), saveState(), and setBinCount().

---

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

• ossimMultiBandHistogram.h
• ossimMultiBandHistogram.cpp