#include <ossimAdjustableParameterInfo.h>

Public Member Functions
	ossimAdjustableParameterInfo ()

	ossimAdjustableParameterInfo (const ossimAdjustableParameterInfo &rhs)

double	getParameter () const

void	setParameter (double parameter)

double	getSigma () const

void	setSigma (double sigma)

const ossimString &	getDescription () const

void	setDescription (const ossimString &description)

ossimUnitType	getUnit () const

void	setUnit (ossimUnitType unit)

ossimString	getUnitAsString () const

void	setCenter (double center)

double	getCenter () const

void	setOffset (ossim_float64 value)

double	computeOffset () const

void	setLockFlag (bool flag)

bool	getLockFlag () const

bool	loadState (const ossimKeywordlist &kwl, const ossimString &prefix=ossimString(""))

bool	saveState (ossimKeywordlist &kwl, const ossimString &prefix=ossimString("")) const

Protected Attributes
double	theParameter

double	theSigma

double	theCenter

ossimUnitType	theUnit

ossimString	theDescription

bool	theLockFlag

Friends
OSSIM_DLL friend std::ostream &	operator<< (std::ostream &out, const ossimAdjustableParameterInfo &data)

Detailed Description

Definition at line 16 of file ossimAdjustableParameterInfo.h.

Constructor & Destructor Documentation

◆ ossimAdjustableParameterInfo() [1/2]

ossimAdjustableParameterInfo::ossimAdjustableParameterInfo ( )

inline

Definition at line 21 of file ossimAdjustableParameterInfo.h.

       : theParameter(0.0),
         theSigma(0.0),
     theCenter(0.0),
         theUnit(OSSIM_UNIT_UNKNOWN),
       theDescription(""),
       theLockFlag(false)
       {
       }

◆ ossimAdjustableParameterInfo() [2/2]

ossimAdjustableParameterInfo::ossimAdjustableParameterInfo ( const ossimAdjustableParameterInfo & rhs )

inline

Definition at line 30 of file ossimAdjustableParameterInfo.h.

       :theParameter(rhs.theParameter),
       theSigma(rhs.theSigma),
       theCenter(rhs.theCenter),
       theUnit(rhs.theUnit),
       theDescription(rhs.theDescription),
       theLockFlag(rhs.theLockFlag)
       {
       }

Member Function Documentation

◆ computeOffset()

double ossimAdjustableParameterInfo::computeOffset ( ) const

will return theCenter + theSigma*theParameter

Definition at line 55 of file ossimAdjustableParameterInfo.cpp.

References theCenter, theParameter, and theSigma.

 {
   return theCenter + theSigma*theParameter;
 }

◆ getCenter()

double ossimAdjustableParameterInfo::getCenter ( ) const

Definition at line 50 of file ossimAdjustableParameterInfo.cpp.

References theCenter.

 {
   return theCenter;
 }

◆ getDescription()

const ossimString& ossimAdjustableParameterInfo::getDescription ( ) const

inline

Definition at line 61 of file ossimAdjustableParameterInfo.h.

References theDescription.

       {
          return theDescription;
       }

◆ getLockFlag()

bool ossimAdjustableParameterInfo::getLockFlag ( ) const

inline

Definition at line 98 of file ossimAdjustableParameterInfo.h.

    {
       return theLockFlag;
    }

◆ getParameter()

double ossimAdjustableParameterInfo::getParameter ( ) const

inline

Definition at line 39 of file ossimAdjustableParameterInfo.h.

       {
          return theParameter;
       }

◆ getSigma()

double ossimAdjustableParameterInfo::getSigma ( ) const

inline

Definition at line 50 of file ossimAdjustableParameterInfo.h.

       {
          return theSigma;
       }

◆ getUnit()

ossimUnitType ossimAdjustableParameterInfo::getUnit ( ) const

inline

Definition at line 74 of file ossimAdjustableParameterInfo.h.

       {
          return theUnit;
       }

◆ getUnitAsString()

ossimString ossimAdjustableParameterInfo::getUnitAsString ( ) const

Definition at line 37 of file ossimAdjustableParameterInfo.cpp.

References ossimLookUpTable::getEntryString(), ossimUnitTypeLut::instance(), and theUnit.

 {
    return ossimUnitTypeLut::instance()->getEntryString((int)theUnit);
 }

◆ loadState()

bool ossimAdjustableParameterInfo::loadState	(	const ossimKeywordlist &	kwl,
		const ossimString &	prefix = `ossimString("")`
	)

Definition at line 87 of file ossimAdjustableParameterInfo.cpp.

References ossimKeywordlist::find().

 {
    const char* param       = kwl.find(prefix, PARAM_KW);
    const char* sigma       = kwl.find(prefix, PARAM_SIGMA_KW);
    const char* center      = kwl.find(prefix, PARAM_CENTER_KW);
    const char* unit        = kwl.find(prefix, ossimKeywordNames::UNITS_KW);
    const char* locked      = kwl.find(prefix, PARAM_LOCK_FLAG_KW);
    
    theDescription          = kwl.find(prefix, ossimKeywordNames::DESCRIPTION_KW);
    
    if(param)
    {
       theParameter = ossimString(param).toDouble();
    }
    else
    {
       theParameter = 0.0;
    }
    if(unit)
    {
       theUnit = (ossimUnitType)(ossimUnitTypeLut::instance()->getEntryNumber(unit));
    }
    else
    {
       theUnit      = OSSIM_UNIT_UNKNOWN;
    }
    if(sigma)
    {
       theSigma  = ossimString(sigma).toDouble();
    }
    else
    {
       theSigma     = 0.0;
    }
    if(center)
    {
      theCenter = ossimString(center).toDouble();
    }
    else
    {
      theCenter = 0.0;
    }
    if(locked)
    {
       theLockFlag = ossimString(locked).toBool();
    }
    
    return true;
 }

◆ saveState()

bool ossimAdjustableParameterInfo::saveState	(	ossimKeywordlist &	kwl,
		const ossimString &	prefix = `ossimString("")`
	)		const

Definition at line 138 of file ossimAdjustableParameterInfo.cpp.

References ossimKeywordlist::add(), ossimKeywordNames::DESCRIPTION_KW, ossimUnitTypeLut::instance(), theDescription, theUnit, and ossimKeywordNames::UNITS_KW.

 {
    kwl.add(prefix,
            ossimKeywordNames::DESCRIPTION_KW,
            theDescription,
            true);
    kwl.add(prefix, ossimKeywordNames::UNITS_KW,
            ossimUnitTypeLut::instance()->getEntryString(theUnit), true);
    kwl.add(prefix, PARAM_KW, theParameter, true);
    kwl.add(prefix, PARAM_SIGMA_KW, theSigma, true);
    kwl.add(prefix, PARAM_CENTER_KW, theCenter, true);
    kwl.add(prefix, PARAM_LOCK_FLAG_KW, theLockFlag, true);
    
    return true;
 }

◆ setCenter()

void ossimAdjustableParameterInfo::setCenter ( double center )

Definition at line 42 of file ossimAdjustableParameterInfo.cpp.

References theCenter, and theLockFlag.

 {
    if(!theLockFlag)
    {
       theCenter = center;
    }
 }

◆ setDescription()

void ossimAdjustableParameterInfo::setDescription ( const ossimString & description )

inline

Definition at line 66 of file ossimAdjustableParameterInfo.h.

References theDescription.

       {
          if(!theLockFlag)
          {
             theDescription = description;
          }
       }

◆ setLockFlag()

void ossimAdjustableParameterInfo::setLockFlag ( bool flag )

inline

Definition at line 94 of file ossimAdjustableParameterInfo.h.

    {
       theLockFlag = flag;
    }

◆ setOffset()

void ossimAdjustableParameterInfo::setOffset ( ossim_float64 value )

Definition at line 60 of file ossimAdjustableParameterInfo.cpp.

References abs, DBL_EPSILON, theCenter, theLockFlag, theParameter, theSigma, and x.

 {
    if(!theLockFlag)
    {
       double minValue = theCenter - theSigma;
       double maxValue = theCenter + theSigma;
       double x = 0.0;
       
       if(std::abs(theSigma) > DBL_EPSILON)
       {
          x = (value - theCenter)/theSigma;
          
          value = theCenter + x*theSigma;
          
          if(value < minValue)
          {
             x = -1;
          }
          else if(value > maxValue)
          {
             x = 1.0;
          }
          theParameter = x;
       }
    }
 }

◆ setParameter()

void ossimAdjustableParameterInfo::setParameter ( double parameter )

inline

Definition at line 43 of file ossimAdjustableParameterInfo.h.

       {
          if(!theLockFlag)
          {
             theParameter = parameter;
          }
       }

◆ setSigma()

void ossimAdjustableParameterInfo::setSigma ( double sigma )

inline

Definition at line 54 of file ossimAdjustableParameterInfo.h.

       {
          if(!theLockFlag)
          {
             theSigma = sigma;
          }
       }

◆ setUnit()

void ossimAdjustableParameterInfo::setUnit ( ossimUnitType unit )

inline

Definition at line 78 of file ossimAdjustableParameterInfo.h.

       {
          theUnit = unit;
       }

Friends And Related Function Documentation

◆ operator<<

OSSIM_DLL friend std::ostream& operator<<	(	std::ostream &	out,
		const ossimAdjustableParameterInfo &	data
	)

friend

Definition at line 23 of file ossimAdjustableParameterInfo.cpp.

 {
    out << "description: " << data.theDescription << std::endl
        << "center:      " << data.theCenter <<  std::endl
        << "parameter:   " << data.theParameter << std::endl
        << "sigma:       " << data.theSigma << std::endl
        << "units:       " << (ossimUnitTypeLut::instance()->getEntryString(data.theUnit))
        << std::endl
        << "locked:       " << (data.theLockFlag?"true":"false") << std::endl;
    
    return out;
 }