VAPOR3 3.9.4
Public Types | Public Member Functions | Static Public Member Functions | List of all members
VAPoR::OpacityMap Class Reference

#include <OpacityMap.h>

Inheritance diagram for VAPoR::OpacityMap:
VAPoR::ParamsBase Wasp::MyBase

Public Types

enum  Type { CONTROL_POINT , GAUSSIAN , INVERTED_GAUSSIAN , SINE }
 
- Public Types inherited from Wasp::MyBase
typedef void(* ErrMsgCB_T) (const char *msg, int err_code)
 
typedef void(* DiagMsgCB_T) (const char *msg)
 

Public Member Functions

 OpacityMap (ParamsBase::StateSave *ssave)
 Create a OpacityMap object from scratch.
 
 OpacityMap (ParamsBase::StateSave *ssave, XmlNode *node)
 Create a OpacityMap object from an existing XmlNode tree.
 
virtual ~OpacityMap ()
 
void clear ()
 
float opacityDataAtNorm (float nv) const
 
float opacityData (float value) const
 
bool inDataBounds (float value) const
 
void SetType (OpacityMap::Type type)
 
OpacityMap::Type GetType () const
 
void SetDataBounds (const vector< double > &bounds)
 
vector< double > GetDataBounds () const
 
double minValue () const
 
double maxValue () const
 
void setMinValue (double val)
 
void setMaxValue (double val)
 
bool IsEnabled ()
 
void SetEnabled (bool enabled)
 
double GetMean () const
 
void SetMean (double mean)
 
double GetSSQ () const
 
void SetSSQ (double ssq)
 
double GetFreq () const
 
void SetFreq (double freq)
 
double GetPhase () const
 
void SetPhase (double phase)
 
int numControlPoints () const
 
void addNormControlPoint (float normv, float opacity)
 
void addControlPoint (float value, float opacity)
 
void deleteControlPoint (int index)
 
void moveControlPoint (int index, float dx, float dy)
 
float controlPointOpacity (int index) const
 
void controlPointOpacity (int index, float opacity)
 
float controlPointValueNormalized (int index) const
 
float controlPointValue (int index) const
 
void controlPointValueNormalized (int index, float nv)
 
void controlPointValue (int index, float value)
 
void setOpaque ()
 
bool isOpaque () const
 
void SetInterpType (TFInterpolator::type t)
 
TFInterpolator::type GetInterpType () const
 
vector< double > GetControlPoints () const
 
void SetControlPoints (const vector< double > &opacityControlPoints)
 
- Public Member Functions inherited from VAPoR::ParamsBase
 ParamsBase (StateSave *ssave, const string &classname)
 
 ParamsBase (StateSave *ssave, XmlNode *node)
 
 ParamsBase (const ParamsBase &rhs)
 Copy constructor.
 
ParamsBaseoperator= (const ParamsBase &rhs)
 
 ParamsBase (ParamsBase &&)=delete
 
ParamsBaseoperator= (ParamsBase &)=delete
 
bool operator== (const ParamsBase &rhs) const
 Equivalence operator.
 
bool operator!= (const ParamsBase &rhs) const
 
virtual ~ParamsBase ()
 
void SetParent (ParamsBase *parent)
 
XmlNodeGetNode () const
 
void BeginGroup (const string &description)
 
void EndGroup ()
 
void IntermediateChange ()
 
virtual vector< long > GetValueLongVec (const string tag) const
 
virtual vector< long > GetValueLongVec (const string tag, const vector< long > &defaultVal) const
 
virtual long GetValueLong (const string tag, long defaultVal) const
 
virtual vector< double > GetValueDoubleVec (const string tag) const
 
virtual vector< double > GetValueDoubleVec (const string tag, const vector< double > &defaultVal) const
 
virtual double GetValueDouble (const string tag, double defaultVal) const
 
virtual vector< string > GetValueStringVec (const string tag) const
 
virtual vector< string > GetValueStringVec (const string tag, const vector< string > &defaultVal) const
 
virtual string GetValueString (const string tag, string defaultVal) const
 
virtual void SetValueLongVec (const string &tag, string description, const vector< long > &values)
 
virtual void SetValueLong (const string &tag, string description, long value)
 
virtual void SetValueDoubleVec (const string &tag, string description, const vector< double > &values)
 
virtual void SetValueDouble (const string &tag, string description, double value)
 
virtual void SetValueStringVec (const string &tag, string description, const vector< string > &values)
 
virtual void SetValueString (const string &tag, string description, const string &value)
 
string GetName () const
 
- Public Member Functions inherited from Wasp::MyBase
 MyBase ()
 
const string & getClassName () const
 

Static Public Member Functions

static string GetClassType ()
 
- Static Public Member Functions inherited from Wasp::MyBase
static void SetErrMsg (const char *format,...)
 Record a formatted error message.
 
static void SetErrMsg (int errcode, const char *format,...)
 Record a formatted error message and an error code.
 
static const char * GetErrMsg ()
 
static void SetErrCode (int err_code)
 Record an error code.
 
static int GetErrCode ()
 Retrieve the current error code.
 
static void SetErrMsgCB (ErrMsgCB_T cb)
 
static ErrMsgCB_T GetErrMsgCB ()
 
static void SetErrMsgFilePtr (FILE *fp)
 
static const FILE * SetErrMsgFilePtr ()
 
static void SetDiagMsg (const char *format,...)
 Record a formatted diagnostic message.
 
static const char * GetDiagMsg ()
 
static void SetDiagMsgCB (DiagMsgCB_T cb)
 
static DiagMsgCB_T GetDiagMsgCB ()
 
static void SetDiagMsgFilePtr (FILE *fp)
 
static bool EnableErrMsg (bool enable)
 
static bool GetEnableErrMsg ()
 

Additional Inherited Members

- Static Public Attributes inherited from Wasp::MyBase
static char * ErrMsg
 
static int ErrCode
 
static int ErrMsgSize
 
static FILE * ErrMsgFilePtr
 
static ErrMsgCB_T ErrMsgCB
 
static char * DiagMsg
 
static int DiagMsgSize
 
static FILE * DiagMsgFilePtr
 
static DiagMsgCB_T DiagMsgCB
 
static bool Enabled
 
- Protected Member Functions inherited from VAPoR::ParamsBase
 ParamsBase (StateSave *ssave)
 
void Remove (const string &name)
 
const map< string, string > & GetAttributes ()
 
void Clear ()
 
- Protected Member Functions inherited from Wasp::MyBase
void SetClassName (const string &name)
 
- Protected Attributes inherited from VAPoR::ParamsBase
StateSave_ssave
 
XmlNode_node
 

Detailed Description

Definition at line 22 of file OpacityMap.h.

Member Enumeration Documentation

◆ Type

Enumerator
CONTROL_POINT 
GAUSSIAN 
INVERTED_GAUSSIAN 
SINE 

Definition at line 24 of file OpacityMap.h.

Constructor & Destructor Documentation

◆ OpacityMap() [1/2]

VAPoR::OpacityMap::OpacityMap ( ParamsBase::StateSave ssave)

Create a OpacityMap object from scratch.

◆ OpacityMap() [2/2]

VAPoR::OpacityMap::OpacityMap ( ParamsBase::StateSave ssave,
XmlNode node 
)

Create a OpacityMap object from an existing XmlNode tree.

◆ ~OpacityMap()

virtual VAPoR::OpacityMap::~OpacityMap ( )
virtual

Member Function Documentation

◆ addControlPoint()

void VAPoR::OpacityMap::addControlPoint ( float  value,
float  opacity 
)

◆ addNormControlPoint()

void VAPoR::OpacityMap::addNormControlPoint ( float  normv,
float  opacity 
)

◆ clear()

void VAPoR::OpacityMap::clear ( )

◆ controlPointOpacity() [1/2]

float VAPoR::OpacityMap::controlPointOpacity ( int  index) const

◆ controlPointOpacity() [2/2]

void VAPoR::OpacityMap::controlPointOpacity ( int  index,
float  opacity 
)

◆ controlPointValue() [1/2]

float VAPoR::OpacityMap::controlPointValue ( int  index) const

◆ controlPointValue() [2/2]

void VAPoR::OpacityMap::controlPointValue ( int  index,
float  value 
)

◆ controlPointValueNormalized() [1/2]

float VAPoR::OpacityMap::controlPointValueNormalized ( int  index) const

◆ controlPointValueNormalized() [2/2]

void VAPoR::OpacityMap::controlPointValueNormalized ( int  index,
float  nv 
)

◆ deleteControlPoint()

void VAPoR::OpacityMap::deleteControlPoint ( int  index)

◆ GetClassType()

static string VAPoR::OpacityMap::GetClassType ( )
inlinestatic

Definition at line 92 of file OpacityMap.h.

◆ GetControlPoints()

vector< double > VAPoR::OpacityMap::GetControlPoints ( ) const

◆ GetDataBounds()

vector< double > VAPoR::OpacityMap::GetDataBounds ( ) const

◆ GetFreq()

double VAPoR::OpacityMap::GetFreq ( ) const
inline

Definition at line 60 of file OpacityMap.h.

◆ GetInterpType()

TFInterpolator::type VAPoR::OpacityMap::GetInterpType ( ) const
inline

Definition at line 85 of file OpacityMap.h.

◆ GetMean()

double VAPoR::OpacityMap::GetMean ( ) const
inline

Definition at line 56 of file OpacityMap.h.

◆ GetPhase()

double VAPoR::OpacityMap::GetPhase ( ) const
inline

Definition at line 62 of file OpacityMap.h.

References M_PI.

◆ GetSSQ()

double VAPoR::OpacityMap::GetSSQ ( ) const
inline

Definition at line 58 of file OpacityMap.h.

◆ GetType()

OpacityMap::Type VAPoR::OpacityMap::GetType ( ) const
inline

Definition at line 43 of file OpacityMap.h.

◆ inDataBounds()

bool VAPoR::OpacityMap::inDataBounds ( float  value) const

◆ IsEnabled()

bool VAPoR::OpacityMap::IsEnabled ( )
inline

Definition at line 54 of file OpacityMap.h.

◆ isOpaque()

bool VAPoR::OpacityMap::isOpaque ( ) const

◆ maxValue()

double VAPoR::OpacityMap::maxValue ( ) const

◆ minValue()

double VAPoR::OpacityMap::minValue ( ) const

◆ moveControlPoint()

void VAPoR::OpacityMap::moveControlPoint ( int  index,
float  dx,
float  dy 
)

◆ numControlPoints()

int VAPoR::OpacityMap::numControlPoints ( ) const
inline

Definition at line 65 of file OpacityMap.h.

◆ opacityData()

float VAPoR::OpacityMap::opacityData ( float  value) const

◆ opacityDataAtNorm()

float VAPoR::OpacityMap::opacityDataAtNorm ( float  nv) const

◆ SetControlPoints()

void VAPoR::OpacityMap::SetControlPoints ( const vector< double > &  opacityControlPoints)

◆ SetDataBounds()

void VAPoR::OpacityMap::SetDataBounds ( const vector< double > &  bounds)

◆ SetEnabled()

void VAPoR::OpacityMap::SetEnabled ( bool  enabled)

◆ SetFreq()

void VAPoR::OpacityMap::SetFreq ( double  freq)

◆ SetInterpType()

void VAPoR::OpacityMap::SetInterpType ( TFInterpolator::type  t)

◆ setMaxValue()

void VAPoR::OpacityMap::setMaxValue ( double  val)

◆ SetMean()

void VAPoR::OpacityMap::SetMean ( double  mean)

◆ setMinValue()

void VAPoR::OpacityMap::setMinValue ( double  val)

◆ setOpaque()

void VAPoR::OpacityMap::setOpaque ( )

◆ SetPhase()

void VAPoR::OpacityMap::SetPhase ( double  phase)

◆ SetSSQ()

void VAPoR::OpacityMap::SetSSQ ( double  ssq)

◆ SetType()

void VAPoR::OpacityMap::SetType ( OpacityMap::Type  type)

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