ossimRgbLutDataObject Class Reference

#include <ossimRgbLutDataObject.h>

Inheritance diagram for ossimRgbLutDataObject:

Public Member Functions
	ossimRgbLutDataObject (unsigned long numberOfEntries=0)
	ossimRgbLutDataObject (const ossimRgbLutDataObject &lut)
virtual ossimObject *	dup () const
const ossimRgbVector &	operator[] (unsigned int index) const
ossimRgbVector &	operator[] (unsigned int index)
const ossimRgbVector &	operator[] (int index) const
ossimRgbVector &	operator[] (int index)
const ossimRgbVector &	operator[] (double normalizedIndex) const
ossimRgbVector &	operator[] (double normalizedIndex)
long	getNumberOfEntries () const
int	findIndex (const ossimRgbVector &rgb)
int	findIndex (ossim_uint8 r, ossim_uint8 g, ossim_uint8 b)
ossimRgbLutDataObject &	rotate (long numberOfElements=1)
ossimRgbLutDataObject	rotate (long numberOfElements=1) const
const ossimRgbLutDataObject &	operator= (const ossimRgbLutDataObject &lut)
bool	operator== (const ossimRgbLutDataObject &lut) 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 ossimObject
	ossimObject ()
virtual	~ossimObject ()
virtual ossimString	getShortName () const
virtual ossimString	getLongName () const
virtual ossimString	getDescription () 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 std::ostream &	print (std::ostream &out) const
	Generic print method. More...
virtual bool	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const
virtual void	accept (ossimVisitor &visitor)
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	~ossimRgbLutDataObject ()
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
ossimRgbVector *	theLut
ossim_uint32	theNumberOfEntries

Friends
std::ostream &	operator<< (std::ostream &out, const ossimRgbLutDataObject &lut)

Detailed Description

Definition at line 18 of file ossimRgbLutDataObject.h.

Constructor & Destructor Documentation

ossimRgbLutDataObject() [1/2]

ossimRgbLutDataObject::ossimRgbLutDataObject

(

unsigned long

numberOfEntries = 0

)

Will allocate 256 values for the color table

Definition at line 34 of file ossimRgbLutDataObject.cpp.

References theLut, and theNumberOfEntries.

   :
      theLut(NULL),
      theNumberOfEntries(numberOfEntries)
{
   if(theNumberOfEntries > 0)
   {
      // allocate 256 entries for the data object;
      theLut = new ossimRgbVector[theNumberOfEntries];
   }
      
}

ossimRgbLutDataObject() [2/2]

ossimRgbLutDataObject::ossimRgbLutDataObject

(

const ossimRgbLutDataObject &

lut

)

Definition at line 47 of file ossimRgbLutDataObject.cpp.

References theLut, and theNumberOfEntries.

   :
      theLut(NULL),
      theNumberOfEntries(0)
{
   theNumberOfEntries = lut.theNumberOfEntries;
   if(theNumberOfEntries > 0)
   {
      theLut = new ossimRgbVector[theNumberOfEntries];
      for(ossim_uint32 index = 0; index < theNumberOfEntries; ++index)
      {
         theLut[index] = lut.theLut[index];
      }
   }
}

~ossimRgbLutDataObject()

ossimRgbLutDataObject::~ossimRgbLutDataObject ( )

protectedvirtual

Definition at line 63 of file ossimRgbLutDataObject.cpp.

References theLut, and theNumberOfEntries.

{
   if(theLut)
   {
      delete [] theLut;
      theLut = NULL;
   }
   theNumberOfEntries = 0;
}

Member Function Documentation

dup()

virtual ossimObject* ossimRgbLutDataObject::dup ( ) const

inlinevirtual

Reimplemented from ossimObject.

Definition at line 28 of file ossimRgbLutDataObject.h.

Referenced by ossimRgbToIndexFilter::setLut().

   {
      return new ossimRgbLutDataObject(*this);
   }

findIndex() [1/2]

int ossimRgbLutDataObject::findIndex ( const ossimRgbVector &  rgb )

inline

Definition at line 67 of file ossimRgbLutDataObject.h.

References ossimRgbVector::getB(), ossimRgbVector::getG(), and ossimRgbVector::getR().

Referenced by ossimRgbToIndexFilter::convertInputTile().

      {
         return findIndex(rgb.getR(),
                          rgb.getG(),
                          rgb.getB());
      }

findIndex() [2/2]

int ossimRgbLutDataObject::findIndex	(	ossim_uint8	r,
		ossim_uint8	g,
		ossim_uint8	b
	)

Definition at line 73 of file ossimRgbLutDataObject.cpp.

References distance(), ossimRgbVector::getB(), ossimRgbVector::getG(), ossimRgbVector::getR(), theLut, and theNumberOfEntries.

{
   ossim_uint32 distance = 0x7FFFFFFF; // max 4 byte signed
   ossim_int32 result   = 0;

   if(theNumberOfEntries > 0)
   {
      for(ossim_uint32 i = 0; i < theNumberOfEntries; ++i)
      {
         ossim_uint32 rDelta = r - theLut[i].getR();
         ossim_uint32 gDelta = g - theLut[i].getG();
         ossim_uint32 bDelta = b - theLut[i].getB();

         ossim_uint32 deltaSumSquare = (rDelta*rDelta +
                                        gDelta*gDelta +
                                        bDelta*bDelta);
         if(deltaSumSquare == 0)
         {
            return static_cast<int>(i);
         }
         else if( deltaSumSquare < distance)
         {
            result = static_cast<int>(i);
            distance = deltaSumSquare;
         }
      }
   }

   return result;
}

getNumberOfEntries()

long ossimRgbLutDataObject::getNumberOfEntries ( ) const

inline

Definition at line 66 of file ossimRgbLutDataObject.h.

{return theNumberOfEntries;}

loadState()

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

virtual

Method to the load (recreate) the state of the object from a keyword list. Return true if ok or false on error.

Reimplemented from ossimObject.

Definition at line 199 of file ossimRgbLutDataObject.cpp.

References ossimKeywordlist::addFile(), ossimString::c_str(), ossimFilename::exists(), ossimKeywordlist::find(), ossimRgbVector::setB(), ossimRgbVector::setG(), ossimRgbVector::setR(), theLut, theNumberOfEntries, ossimString::toInt32(), ossimString::toString(), and ossimString::toULong().

Referenced by ossimRgbToIndexFilter::loadState().

{
   const char* lutFile = kwl.find(prefix, "lut_file");
   ossimKeywordlist fileLut;
   ossimKeywordlist* tempKwl = (const_cast<ossimKeywordlist*>(&kwl));
   ossimString tempPrefix = prefix;

   // this should have been used instead of lut_file.  We will still look
   // for lut_file for backward compatibility.
   //
   if(!lutFile)
   {
      lutFile = kwl.find(prefix, "filename");
   }
   // check to see if we should open an external file
   // if so point the fileLut to the one that we use
   if(lutFile)
   {
      ossimFilename filename(lutFile);
      if(filename.exists())
      {
         fileLut.addFile(filename.c_str());
         tempKwl = &fileLut;
         tempPrefix = "";
      }
   }
 
   const char* numberOfEntries = tempKwl->find(tempPrefix, "number_of_entries");
   if(!numberOfEntries)
   {
      numberOfEntries = tempKwl->find(tempPrefix, "number_entries");
   }
   if(!numberOfEntries) return false;
   theNumberOfEntries = ossimString(numberOfEntries).toULong();

   delete [] theLut;
   theLut = new ossimRgbVector[theNumberOfEntries];

   if(tempKwl->find(tempPrefix, "entry0"))
   {
      for(ossim_uint32 index = 0; index < theNumberOfEntries; ++index)
      {
         ossimString newPrefix = "entry";
         newPrefix += ossimString::toString(index);
         ossimString v = tempKwl->find(tempPrefix, newPrefix.c_str());
         istringstream istr(v);

         ossimString r, g, b;
         istr >> r >> g >> b;
         theLut[index].setR((unsigned char)r.toInt32());
         theLut[index].setG((unsigned char)g.toInt32());
         theLut[index].setB((unsigned char)b.toInt32());
      }
   }
   else
   {
      for(ossim_uint32 index = 0; index < theNumberOfEntries; ++index)
      {
         ossimString newPrefix = "entry";
         newPrefix += ossimString::toString(index);
         
         const char* r = tempKwl->find(tempPrefix, (newPrefix+".r").c_str());
         const char* g = tempKwl->find(tempPrefix, (newPrefix+".g").c_str());
         const char* b = tempKwl->find(tempPrefix, (newPrefix+".b").c_str());
         
         if(r)
         {
            theLut[index].setR((unsigned char)ossimString(r).toLong());
         }
         if(g)
         {
            theLut[index].setG((unsigned char)ossimString(g).toLong());
         }
         if(b)
         {
            theLut[index].setB((unsigned char)ossimString(b).toLong());
         }
      }
   }
   return true;
}

operator=()

const ossimRgbLutDataObject & ossimRgbLutDataObject::operator=

(

const ossimRgbLutDataObject &

lut

)

Definition at line 135 of file ossimRgbLutDataObject.cpp.

References theLut, and theNumberOfEntries.

{
   if(theNumberOfEntries != lut.theNumberOfEntries)
   {
      delete [] theLut;
      theLut = NULL;
   }

   theNumberOfEntries = lut.theNumberOfEntries;
   if(!theLut&&(theNumberOfEntries > 0))
   {
      theLut = new ossimRgbVector[theNumberOfEntries];
   }
   for(unsigned long index = 0; index < theNumberOfEntries; ++index)
   {
      theLut[index] = lut.theLut[index];
   }

   return *this;
}

operator==()

bool ossimRgbLutDataObject::operator==

(

const ossimRgbLutDataObject &

lut

)

const

Definition at line 156 of file ossimRgbLutDataObject.cpp.

References theLut, and theNumberOfEntries.

{
   if(theNumberOfEntries != lut.theNumberOfEntries)
   {
      return false;
   }
   for(unsigned long index = 0; index < theNumberOfEntries; ++index)
   {
      if(theLut[index] != lut.theLut[index])
      {
         return false;
      }
   }
   return true;
}

operator[]() [1/6]

const ossimRgbVector& ossimRgbLutDataObject::operator[] ( unsigned int  index ) const

inline

Definition at line 32 of file ossimRgbLutDataObject.h.

      {
         return index<theNumberOfEntries?theLut[index]:theLut[theNumberOfEntries-1];
      }

operator[]() [2/6]

ossimRgbVector& ossimRgbLutDataObject::operator[] ( unsigned int  index )

inline

Definition at line 36 of file ossimRgbLutDataObject.h.

      {
         return index<theNumberOfEntries?theLut[index]:theLut[theNumberOfEntries-1];
      }

operator[]() [3/6]

const ossimRgbVector& ossimRgbLutDataObject::operator[] ( int  index ) const

inline

Definition at line 40 of file ossimRgbLutDataObject.h.

      {
         return index<(long)theNumberOfEntries?theLut[index]:theLut[theNumberOfEntries-1];
      }

operator[]() [4/6]

ossimRgbVector& ossimRgbLutDataObject::operator[] ( int  index )

inline

Definition at line 44 of file ossimRgbLutDataObject.h.

      {
         return index<(long)theNumberOfEntries?theLut[index]:theLut[theNumberOfEntries-1];
      }

operator[]() [5/6]

const ossimRgbVector& ossimRgbLutDataObject::operator[] ( double  normalizedIndex ) const

inline

Definition at line 48 of file ossimRgbLutDataObject.h.

      {
         int index = int(normalizedIndex*theNumberOfEntries+.5);
         if (index < 0)
         {
            index = 0;
         }
         return (*this)[index];
      }

operator[]() [6/6]

ossimRgbVector& ossimRgbLutDataObject::operator[] ( double  normalizedIndex )

inline

Definition at line 57 of file ossimRgbLutDataObject.h.

      {
         int index = int(normalizedIndex*theNumberOfEntries+.5);
         if (index < 0)
         {
            index = 0;
         }
         return (*this)[index];
      }

rotate() [1/2]

ossimRgbLutDataObject & ossimRgbLutDataObject::rotate

(

long

numberOfElements = 1

)

Definition at line 121 of file ossimRgbLutDataObject.cpp.

References ossimNotify(), ossimNotifyLevel_FATAL, and rotate().

Referenced by rotate().

{
   if(numberOfElements < 0)
   {
      ossimNotify(ossimNotifyLevel_FATAL) << "FATAL: Negative rotation is not supported yet in ossimRgbLutDataObject::rotate" << endl;
      return *this;
   }
   const ossimRgbLutDataObject* temp = this;

   *this = temp->rotate(numberOfElements);

   return *this;
}

rotate() [2/2]

ossimRgbLutDataObject ossimRgbLutDataObject::rotate

(

long

numberOfElements = 1

)

const

Definition at line 104 of file ossimRgbLutDataObject.cpp.

References ossimNotify(), ossimNotifyLevel_FATAL, theLut, and theNumberOfEntries.

{
   if(numberOfElements < 0)
   {
      ossimNotify(ossimNotifyLevel_FATAL) << "FATAL: Negative rotation is not supported yet in ossimRgbLutDataObject::rotate" << endl;
      return *this;
   }
   ossimRgbLutDataObject lut;
   for(ossim_uint32 index = 0; index < theNumberOfEntries; ++index)
   {
      int adjustedDestinationIndex = (index+numberOfElements)%theNumberOfEntries;
      lut[adjustedDestinationIndex] = theLut[index] ;
   }

   return lut;
}

saveState()

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

virtual

Method to save the state of the object to a keyword list. Return true if ok or false on error.

Reimplemented from ossimObject.

Definition at line 172 of file ossimRgbLutDataObject.cpp.

References ossimKeywordlist::add(), ossimString::c_str(), ossimRgbVector::getB(), ossimObject::getClassName(), ossimRgbVector::getG(), theLut, theNumberOfEntries, and ossimString::toString().

Referenced by ossimRgbToIndexFilter::saveState().

{
   kwl.add(prefix,
           "type",
           getClassName(),
           true);
   kwl.add(prefix,
           "number_of_entries",
           ossimString::toString(theNumberOfEntries).c_str(),
           true);
   for(ossim_uint32 index = 0; index < theNumberOfEntries; ++index)
   {
      ossimString newPrefix = "entry";
      newPrefix += ossimString::toString(index);
      ostringstream ostr;
      ostr << (int)(theLut[index].getR())
           << " " << (int)(theLut[index].getG())
           << " " << (int)(theLut[index].getB());
      kwl.add(prefix,
              newPrefix,
              ostr.str().c_str(),
              true);
   }

   return true;
}

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  out, const ossimRgbLutDataObject &  lut  )

friend

Member Data Documentation

theLut

ossimRgbVector* ossimRgbLutDataObject::theLut

protected

Definition at line 85 of file ossimRgbLutDataObject.h.

Referenced by findIndex(), loadState(), operator=(), operator==(), ossimRgbLutDataObject(), rotate(), saveState(), and ~ossimRgbLutDataObject().

theNumberOfEntries

ossim_uint32 ossimRgbLutDataObject::theNumberOfEntries

protected

Definition at line 86 of file ossimRgbLutDataObject.h.

Referenced by findIndex(), loadState(), operator<<(), operator=(), operator==(), ossimRgbLutDataObject(), rotate(), saveState(), and ~ossimRgbLutDataObject().

---

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

• ossimRgbLutDataObject.h
• ossimRgbLutDataObject.cpp