ossimWavelength Class Reference

#include <ossimWavelength.h>

Public Types
typedef std::map< ossim_float64, ossim_uint32 >	WavelengthMap

Public Member Functions
	ossimWavelength ()
	default constructor More...
	ossimWavelength (const ossimWavelength &obj)
	copy constructor More...
const ossimWavelength &	operator= (const ossimWavelength &rhs)
	assignment operator= More...
	~ossimWavelength ()
	virtual destructor More...
const ossimWavelength::WavelengthMap &	getMap () const
ossimWavelength::WavelengthMap &	getMap ()
bool	initialize (const ossimEnviHeader &hdr)
	Initializes map from ENVI header class. More...
WavelengthMap::const_iterator	findClosestIterator (const ossim_float64 &requestedWavelength, const ossim_float64 &thresholdFromCenter) const
	Finds iterator closest to wavelength. More...
ossim_int32	findClosestIndex (const ossim_float64 &requestedWavelength, const ossim_float64 &thresholdFromCenter) const
	Finds index closest to wavelength. More...
bool	getRgbBands (std::vector< ossim_uint32 > &bands) const
	Gets rgb bands if "wavelength" keyword is present. More...
WavelengthMap::const_iterator	end () const
WavelengthMap::iterator	end ()

Private Attributes
WavelengthMap	m_map

Detailed Description

Definition at line 34 of file ossimWavelength.h.

Member Typedef Documentation

WavelengthMap

typedef std::map< ossim_float64, ossim_uint32 > ossimWavelength::WavelengthMap

Definition at line 38 of file ossimWavelength.h.

Constructor & Destructor Documentation

ossimWavelength() [1/2]

ossimWavelength::ossimWavelength

(

)

default constructor

Definition at line 18 of file ossimWavelength.cpp.

   : m_map()
{}

ossimWavelength() [2/2]

ossimWavelength::ossimWavelength

(

const ossimWavelength &

obj

)

copy constructor

Definition at line 22 of file ossimWavelength.cpp.

   : m_map( obj.m_map )
{}

~ossimWavelength()

ossimWavelength::~ossimWavelength

(

)

virtual destructor

Definition at line 35 of file ossimWavelength.cpp.

{
}

Member Function Documentation

end() [1/2]

ossimWavelength::WavelengthMap::const_iterator ossimWavelength::end

(

)

const

Returns

WavelengthMap::const_iterator of underlying map.

Definition at line 195 of file ossimWavelength.cpp.

{
   return m_map.end();
}

end() [2/2]

ossimWavelength::WavelengthMap::iterator ossimWavelength::end

(

)

Returns

WavelengthMap::iterator of underlying map.

Definition at line 200 of file ossimWavelength.cpp.

{
   return m_map.end();
}

findClosestIndex()

ossim_int32 ossimWavelength::findClosestIndex	(	const ossim_float64 &	requestedWavelength,
		const ossim_float64 &	thresholdFromCenter
	)		const

Finds index closest to wavelength.

Parameters

requestedWavelength	Requested wavelength in nanometers.
thresholdFromCenter	in nanometers.

Returns

Closest zero based index to wavelength or -1 if not found.

Definition at line 139 of file ossimWavelength.cpp.

{
   ossim_int32 result = -1;
   WavelengthMap::const_iterator i =
      findClosestIterator( requestedWavelength, thresholdFromCenter );
   if ( i != m_map.end() )
   {
      result = (*i).second;
   }
   return result;
   
} // End: ossim_int32 ossimWavelength::findClosestIndex(...

findClosestIterator()

ossimWavelength::WavelengthMap::const_iterator ossimWavelength::findClosestIterator	(	const ossim_float64 &	requestedWavelength,
		const ossim_float64 &	thresholdFromCenter
	)		const

Finds iterator closest to wavelength.

Parameters

requestedWavelength	Requested wavelength in nanometers.
thresholdFromCenter	in nanometers.

Returns

WavelengthMap::const_iterator if not found will return.

Definition at line 100 of file ossimWavelength.cpp.

{
   WavelengthMap::const_iterator result = m_map.lower_bound( requestedWavelength );
   if ( result != m_map.end() )
   {
      if ( result != m_map.begin() ) //  && (result->first > requestedWavelength) )
      {
         // Somewhere in the middle.
         WavelengthMap::const_iterator lower = result;
         --lower;

         ossim_float64 t = (requestedWavelength - lower->first) / (result->first -lower->first);
         if ( t < 0.5 )
         {
            result = lower;
         }
      }
   }
   else
   {
      --result;
   }
      
   if ( result != m_map.end() )
   {
      // Within threshold check.
      if ( std::fabs( result->first - requestedWavelength) > thresholdFromCenter )
      {
         result = m_map.end();
      }
      
   } // if ( result != m_map.end() )

   return result;
   
} // End: WavelengthMap::const_iterator ossimWavelength::findClosestIterator

getMap() [1/2]

const ossimWavelength::WavelengthMap & ossimWavelength::getMap

(

)

const

Definition at line 39 of file ossimWavelength.cpp.

References m_map.

{
   return m_map;
}

getMap() [2/2]

ossimWavelength::WavelengthMap & ossimWavelength::getMap

(

)

Definition at line 44 of file ossimWavelength.cpp.

References m_map.

{
   return m_map;
}

getRgbBands()

bool ossimWavelength::getRgbBands

(

std::vector< ossim_uint32 > &

bands

)

const

Gets rgb bands if "wavelength" keyword is present.

Parameters

bands

Initialized by this with zero base rbg band indexes.

Returns

true on success, false if bands not found.

Definition at line 153 of file ossimWavelength.cpp.

{
   bool result = false;

   if ( m_map.size() )
   {
      //---
      // Attempt to find bands with closest rgb wavelengths.
      // red:   620 - 750 nm
      // green: 495 - 570 nm
      // blue:  450 - 495 nm
      //---
      //const ossim_float32 RED_WAVELENGTH              = 439.978577; // 442.0;      
      //const ossim_float32 GREEN_WAVELENGTH            = 546.666504; // 546.0;
      //const ossim_float32 BLUE_WAVELENGTH             = 636.941406; // 637.0;
      const ossim_float32 RED_WAVELENGTH              = 685.0;      
      const ossim_float32 GREEN_WAVELENGTH            = 532.5;
      const ossim_float32 BLUE_WAVELENGTH             = 472.5;
      const ossim_float32 RED_THRESHOLD_FROM_CENTER   =  65.0;      
      const ossim_float32 GREEN_THRESHOLD_FROM_CENTER =  37.5;
      const ossim_float32 BLUE_THRESHOLD_FROM_CENTER  =  22.5;

      WavelengthMap::const_iterator r =
         findClosestIterator( RED_WAVELENGTH, RED_THRESHOLD_FROM_CENTER );
      WavelengthMap::const_iterator g =
         findClosestIterator( GREEN_WAVELENGTH, GREEN_THRESHOLD_FROM_CENTER );
      WavelengthMap::const_iterator b =
         findClosestIterator( BLUE_WAVELENGTH, BLUE_THRESHOLD_FROM_CENTER );

      if ( (r != m_map.end()) && (g != m_map.end()) && (b != m_map.end()) )
      {
         bands.resize(3);
         bands[0] = (*r).second;
         bands[1] = (*g).second;
         bands[2] = (*b).second;
         result = true;
      }
   }
   return result;
   
} // bool ossimWavelength::getRgbBands( std::vector<ossim_uint32>& ) const

initialize()

bool ossimWavelength::initialize

(

const ossimEnviHeader &

hdr

)

Initializes map from ENVI header class.

This will clear any existing map, look for the keywords "wavelength units" and "wavelength".

Parameters

header

to initialize from.

Returns

true on success, false on error.

Definition at line 49 of file ossimWavelength.cpp.

References ossimString::downcase(), ossimEnviHeader::getValue(), m_map, ossimString::size(), ossimString::split(), ossimString::trim(), and true.

{
   //---
   // Example envi wavelength format:
   // wavelength = { 374.323608,  382.530487,  390.737427 }
   //---
   ossimString value;

   // Check the units...
   ossimString key = "wavelength units";
   if ( hdr.getValue( key, value ) )
   {
      if ( value.downcase() == "nanometers" )
      {
         // Check for wavelength key:
         key = "wavelength";
         if ( hdr.getValue( key, value ) )
         {
            if ( value.size() )
            {
               // Split into array.
               value.trim( ossimString("{}") );
               std::vector<ossimString> list;
               value.split( list, ossimString(","), true );

               if ( list.size() )
               {
                  // Initialize the map:
                  
                  std::vector<ossimString>::const_iterator i = list.begin();
                  ossim_uint32 band = 0;
                  ossim_float32 wavelength = 0.0;
            
                  while ( i != list.end() )
                  {
                     wavelength = (*i).toFloat64();
                     m_map.insert( std::make_pair( wavelength, band ) );
                     ++band;
                     ++i;
                  }
               }
            }
         }
      }
   }
   
   return ( m_map.size() ? true : false);
   
} // End: bool ossimWavelength::initialize(const ossimEnviHeader&)

operator=()

const ossimWavelength & ossimWavelength::operator=

(

const ossimWavelength &

rhs

)

assignment operator=

Definition at line 26 of file ossimWavelength.cpp.

References m_map.

{
   if ( this != &rhs )
   {
      m_map = rhs.m_map;
   }
   return *this;   
}

Member Data Documentation

m_map

WavelengthMap ossimWavelength::m_map

private

Definition at line 103 of file ossimWavelength.h.

Referenced by getMap(), initialize(), and operator=().

---

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

• ossimWavelength.h
• ossimWavelength.cpp