vapor.annotations module

vapor.annotations module#

class vapor.annotations.AxisAnnotation(p: ParamsBase)#

Bases: ParamsWrapper

Wraps VAPoR::AxisAnnotation class that indicates location and direction of view

GetAxisAnnotationEnabled#: bool VAPoR::AxisAnnotation::GetAxisAnnotationEnabled()

GetAxisBackgroundColor#

vector<double> VAPoR::AxisAnnotation::GetAxisBackgroundColor()

void VAPoR::AxisAnnotation::GetAxisBackgroundColor(float bgColor[])

GetAxisColor#: vector<double> VAPoR::AxisAnnotation::GetAxisColor()

GetAxisDigits#: long VAPoR::AxisAnnotation::GetAxisDigits()

GetAxisFontSize#: int VAPoR::AxisAnnotation::GetAxisFontSize()

GetAxisOrigin#: vector<double> VAPoR::AxisAnnotation::GetAxisOrigin()

GetAxisTextHeight#: long VAPoR::AxisAnnotation::GetAxisTextHeight()

GetLatLonAxesEnabled#: bool VAPoR::AxisAnnotation::GetLatLonAxesEnabled()

GetMaxTics#: vector<double> VAPoR::AxisAnnotation::GetMaxTics()

GetMinTics#: vector<double> VAPoR::AxisAnnotation::GetMinTics()

GetNumTics#: vector<double> VAPoR::AxisAnnotation::GetNumTics()

GetShowAxisArrows#: bool VAPoR::AxisAnnotation::GetShowAxisArrows()

GetTicDirs#: vector<double> VAPoR::AxisAnnotation::GetTicDirs()

GetTicSize#: vector<double> VAPoR::AxisAnnotation::GetTicSize()

GetTicWidth#: double VAPoR::AxisAnnotation::GetTicWidth()

GetXTicDir#: int VAPoR::AxisAnnotation::GetXTicDir()

GetYTicDir#: int VAPoR::AxisAnnotation::GetYTicDir()

GetZTicDir#: int VAPoR::AxisAnnotation::GetZTicDir()

SetAxisAnnotationEnabled#: void VAPoR::AxisAnnotation::SetAxisAnnotationEnabled(bool val)

SetAxisBackgroundColor#: void VAPoR::AxisAnnotation::SetAxisBackgroundColor(vector< double > color)

SetAxisColor#: void VAPoR::AxisAnnotation::SetAxisColor(vector< double > color)

SetAxisDigits#: void VAPoR::AxisAnnotation::SetAxisDigits(long val)

SetAxisFontSize#: void VAPoR::AxisAnnotation::SetAxisFontSize(int size)

SetAxisOrigin#: void VAPoR::AxisAnnotation::SetAxisOrigin(vector< double > orig)

SetAxisTextHeight#: void VAPoR::AxisAnnotation::SetAxisTextHeight(long val)

SetLatLonAxesEnabled#: void VAPoR::AxisAnnotation::SetLatLonAxesEnabled(bool val)

SetMaxTics#: void VAPoR::AxisAnnotation::SetMaxTics(vector< double > ticmaxs)

SetMinTics#: void VAPoR::AxisAnnotation::SetMinTics(vector< double > ticmins)

SetNumTics#: void VAPoR::AxisAnnotation::SetNumTics(vector< double > ticnums)

SetShowAxisArrows#: void VAPoR::AxisAnnotation::SetShowAxisArrows(bool val)

SetTicDirs#: void VAPoR::AxisAnnotation::SetTicDirs(vector< double > ticdirs)

SetTicSize#: void VAPoR::AxisAnnotation::SetTicSize(vector< double > ticsizes)

SetTicWidth#: void VAPoR::AxisAnnotation::SetTicWidth(double val)

SetXTicDir#: void VAPoR::AxisAnnotation::SetXTicDir(double dir)

SetYTicDir#: void VAPoR::AxisAnnotation::SetYTicDir(double dir)

SetZTicDir#: void VAPoR::AxisAnnotation::SetZTicDir(double dir)

class vapor.annotations.ColorbarAnnotation(p: ParamsBase)#

Bases: ParamsWrapper

Wraps VAPoR::ColorbarPbase Settings for color bar displayed in scene Intended to be used in any Params class. The ColorbarPbase class is a ParamsBase class that manages the settings associated with a color bar. There is a corresponding ColorbarFrame class in the GUI that manages display of these settings.

GetBackgroundColor#

vector<double> VAPoR::ColorbarPbase::GetBackgroundColor(): Get the background color as an rgb triple
Returns: rgb color

GetCornerPosition#

vector<double> VAPoR::ColorbarPbase::GetCornerPosition(): Get the X,Y corner (upper left) coordinates Relative to [0,1]
Returns: pair of x,y coordinates

GetFontSize#: long VAPoR::ColorbarPbase::GetFontSize() Determine colorbar text size

GetNumDigits#: long VAPoR::ColorbarPbase::GetNumDigits() Determine colorbar num digits to display

GetNumTicks#: long VAPoR::ColorbarPbase::GetNumTicks() Determine colorbar num tics

GetSize#

vector<double> VAPoR::ColorbarPbase::GetSize(): Get the X,Y size Relative to [0,1]
Returns: pair of x,y sizes

GetTitle#

string VAPoR::ColorbarPbase::GetTitle(): Get the title text (displayed after variable name)
Returns: title

GetUseScientificNotation() → bool#

IsEnabled#: bool VAPoR::ColorbarPbase::IsEnabled() Determine if colorbar is enabled

SetBackgroundColor#

void VAPoR::ColorbarPbase::SetBackgroundColor(vector< double > color): Set the background color as an rgb triple
Parameters: color = (r,g,b)

SetCornerPosition#

void VAPoR::ColorbarPbase::SetCornerPosition(vector< double > posn): Set the X,Y corner (upper left) coordinates Relative to [0,1]
Parameters: posn = x,y coordinates

SetEnabled#

void VAPoR::ColorbarPbase::SetEnabled(bool val): Enable or disable colorbar
Parameters: bool true if enabled

SetFontSize#

void VAPoR::ColorbarPbase::SetFontSize(long val): Set colorbar text size
Parameters: val text point size

SetNumDigits#

void VAPoR::ColorbarPbase::SetNumDigits(long val): Set colorbar number of digits
Parameters: val number of digits

SetNumTicks#

void VAPoR::ColorbarPbase::SetNumTicks(long val): Set colorbar number of tic marks
Parameters: val number of tics

SetSize#

void VAPoR::ColorbarPbase::SetSize(vector< double > sz): Set the X,Y sizes Relative to [0,1]
Parameters: posn = x,y sizes

SetTitle#

void VAPoR::ColorbarPbase::SetTitle(string text): Set the title text
Parameters: text to display

SetUseScientificNotation(value: bool)#

class vapor.annotations.SceneAnnotation(p: ParamsBase)#

Bases: ParamsWrapper

Wraps VAPoR::AnnotationParams A class for describing visual features displayed in the visualizer. The AnnotationParams class controls various features displayed in the visualizers There is a global AnnotationParams , that is shared by all windows whose vizfeature is set to “global”. There is also a local AnnotationParams for each window, that users can select whenever there are multiple windows. When local settings are used, they only affect one currently active visualizer. The AnnotationParams class also has several methods that are useful in setting up data requests from the DataMgr .

GetAxisArrowEnabled#: bool VAPoR::AnnotationParams::GetAxisArrowEnabled()

GetAxisArrowSize#: double VAPoR::AnnotationParams::GetAxisArrowSize()

GetAxisArrowXPos#: double VAPoR::AnnotationParams::GetAxisArrowXPos()

GetAxisArrowYPos#: double VAPoR::AnnotationParams::GetAxisArrowYPos()

GetAxisFontSize#: int VAPoR::AnnotationParams::GetAxisFontSize()

GetBackgroundColor#

void VAPoR::AnnotationParams::GetBackgroundColor(double color[3])

void VAPoR::AnnotationParams::GetBackgroundColor(std::vector< double > &color)

GetCurrentAxisDataMgrName#: string VAPoR::AnnotationParams::GetCurrentAxisDataMgrName()

GetDomainColor#

void VAPoR::AnnotationParams::GetDomainColor(double color[3])

void VAPoR::AnnotationParams::GetDomainColor(std::vector< double > &color)

GetRegionColor#

void VAPoR::AnnotationParams::GetRegionColor(double color[3])

void VAPoR::AnnotationParams::GetRegionColor(std::vector< double > &color)

GetTimeLLX#: double VAPoR::AnnotationParams::GetTimeLLX()

GetTimeLLY#: double VAPoR::AnnotationParams::GetTimeLLY()

GetTimeSize#: int VAPoR::AnnotationParams::GetTimeSize()

GetTimeType#: int VAPoR::AnnotationParams::GetTimeType()

GetUseDomainFrame#: bool VAPoR::AnnotationParams::GetUseDomainFrame()

GetUseRegionFrame#: bool VAPoR::AnnotationParams::GetUseRegionFrame()

SetAxisArrowEnabled#: void VAPoR::AnnotationParams::SetAxisArrowEnabled(bool enabled)

SetAxisArrowSize#: void VAPoR::AnnotationParams::SetAxisArrowSize(double pos)

SetAxisArrowXPos#: void VAPoR::AnnotationParams::SetAxisArrowXPos(double pos)

SetAxisArrowYPos#: void VAPoR::AnnotationParams::SetAxisArrowYPos(double pos)

SetAxisFontSize#: void VAPoR::AnnotationParams::SetAxisFontSize(int size)

SetBackgroundColor#: void VAPoR::AnnotationParams::SetBackgroundColor(std::vector< double > color)

SetCurrentAxisDataMgrName#: void VAPoR::AnnotationParams::SetCurrentAxisDataMgrName(string dataMgr=”default”)

SetDomainColor#: void VAPoR::AnnotationParams::SetDomainColor(vector< double > color)

SetTimeColor#: void VAPoR::AnnotationParams::SetTimeColor(std::vector< double > color)

SetTimeLLX#: void VAPoR::AnnotationParams::SetTimeLLX(double llx)

SetTimeLLY#: void VAPoR::AnnotationParams::SetTimeLLY(double lly)

SetTimeSize#: void VAPoR::AnnotationParams::SetTimeSize(int size)

SetTimeType#: void VAPoR::AnnotationParams::SetTimeType(int type)

SetUseDomainFrame#: void VAPoR::AnnotationParams::SetUseDomainFrame(bool onOff)

SetUseRegionFrame#: void VAPoR::AnnotationParams::SetUseRegionFrame(bool onOff)

class TimeAnnotationType#

Bases: object

Formatted = 3#

NoAnnotation = 0#

Timestep = 1#

User = 2#

f#: std::vector<double> VAPoR::AnnotationParams::GetTimeColor()

3.8.0 documentation

vapor.annotations module

Contents

vapor.annotations module#