This class contours a grid. More...

#include "../include/ContPlot.h"

Public Types
enum	ContType { NONE , VALUE , LINE , FILL , BOTH }

Public Member Functions
	ContPlot ()

	ContPlot (const char *params)

int	init ()

int	setParam (const char *str)

int	setType (int rtype)

int	setType (const char *str)

int	getType ()

bool	isTypeFill ()

int	setInterval (float val)

float	getInterval ()

int	setBase (float val)

int	setBase (const char *str)

float	getBase ()

float	getMax ()

float	getMin ()

int	setLabelParam (int skip, int rad)

int	setLabelSpace (int x, int y)

int	setFillStyle (int type)

int	setLineWidth (float width)

int	setTextFormat (const char *fm)

int	setColorTable (const char *str)

int	setColorFill (const char *str)

int	setColorLine (const char *str)

int	setColorLabel (const char *str)

int	setScaleFactor (float sc)

int	draw (Plot &plot, Grid &grid)

int	drawLabels (Plot &plot, Grid &grid)

int	drawFill (Plot &plot, Grid &grid)

int	drawBoxFill (Plot &plot)

int	drawLine (Plot &plot, Grid &grid)

int	drawBoxLine (Plot &plot)

int	drawValues (Plot &plot, Grid &grid)

int	drawLineLabels (Plot &plot, Grid &grid)

int	drawMaxMin (Plot &plot, Grid &grid)

float	getLevel (int ind)

PlotAttr	getColorFill (int ind)

Static Public Member Functions
static int	decodeType (const char *str)

Detailed Description

This class contours a grid.

Author: Dan Vietor

Member Enumeration Documentation

◆ ContType

enum WXP::ContPlot::ContType

Contour types

Enumerator
NONE	No contour output
VALUE	Plot grid values
LINE	Plot line contours
FILL	Plot fill contours
BOTH	Plot both line and fill contours

Constructor & Destructor Documentation

◆ ContPlot()

ContPlot::ContPlot ( )

Constructor

References init().

Member Function Documentation

◆ decodeType()

int ContPlot::decodeType ( const char * str )

static

Decodes the contour type from a string

Parameters

str	The plot type

Returns: Plot type (NONE, VALUE, FILL, LINE, BOTH)

References BOTH, WXP::StrLib::equal(), FILL, LINE, NONE, and VALUE.

Referenced by WXP::MosPlot::draw(), WXP::RawPlot::draw(), WXP::SfcPlot::draw(), WXP::UpaPlot::draw(), WXP::UpaXSectPlot::draw(), and setType().

◆ draw()

int ContPlot::draw	(	Plot &	plot,
		Grid &	grid
	)

Contours the grid

Parameters

plot	Plot object
grid	Grid to contour

References BOTH, drawFill(), drawLine(), drawValues(), LINE, and VALUE.

Referenced by WXP::UpaXSectCont::draw(), and WXP::UpaXSectPlot::draw().

◆ drawBoxFill()

int ContPlot::drawBoxFill ( Plot & plot )

Draw fill contours for a grid box

Parameters

plot	The plot object

References WXP::Points::add1(), WXP::Points::clear(), and WXP::Plot::drawFill().

Referenced by drawFill().

◆ drawBoxLine()

int ContPlot::drawBoxLine ( Plot & plot )

Plots contour lines within a grid box

Parameters

plot	The plot object

References WXP::Plot::drawLine().

Referenced by drawLine().

◆ drawFill()

int ContPlot::drawFill	(	Plot &	plot,
		Grid &	grid
	)

Draw color fill contours

Parameters

plot	The plot object
grid	The grid to contour

References WXP::Points::add1(), WXP::Grid::allocLocate(), WXP::Tools::calcInterval(), WXP::Points::clear(), drawBoxFill(), WXP::Plot::drawFill(), WXP::Plot::drawLine(), drawLineLabels(), drawMaxMin(), WXP::String::get(), WXP::Plot::getColorMap(), getLevel(), WXP::Grid::getNx(), WXP::Grid::getNy(), WXP::Grid::getRange(), WXP::GridMath::isDomainEqual(), WXP::Const::MISS, WXP::Wxp::outWarning(), WXP::ColorFile::read(), WXP::GridPoint::set(), WXP::GridBox::set(), WXP::Plot::setColorMap(), WXP::Plot::setFill(), WXP::Plot::setFillColor(), WXP::Plot::setFillStyle(), WXP::Plot::setLine(), WXP::Plot::setLineColor(), WXP::Grid::setLocate(), WXP::Plot::setText(), WXP::Domain::tran(), WXP::Grid::tran(), and WXP::String::valid().

Referenced by draw().

◆ drawLabels()

int ContPlot::drawLabels	(	Plot &	plot,
		Grid &	grid
	)

Draw the labels on the plot

Parameters

plot	Plot object
grid	Grid to extract labels

References WXP::Plot::addLabel(), WXP::String::get(), WXP::Grid::getDatim(), WXP::Grid::getForeHours(), WXP::Grid::getInfo(), WXP::Grid::getRange(), and WXP::Const::MISS.

◆ drawLine()

int ContPlot::drawLine	(	Plot &	plot,
		Grid &	grid
	)

Draws line contours

Parameters

plot	The plot object
grid	The grid to contour

References WXP::Tools::calcInterval(), drawBoxLine(), drawLineLabels(), drawMaxMin(), WXP::String::equal(), FILL, WXP::String::get(), WXP::Plot::getColorMap(), getLevel(), WXP::Grid::getNx(), WXP::Grid::getNy(), WXP::Grid::getRange(), WXP::Const::MISS, WXP::Wxp::outWarning(), WXP::ColorFile::read(), WXP::GridBox::set(), WXP::Plot::setColorMap(), WXP::Plot::setLine(), WXP::Plot::setLineStyle(), WXP::Plot::setLineWidth(), and WXP::String::valid().

Referenced by draw().

◆ drawLineLabels()

int ContPlot::drawLineLabels	(	Plot &	plot,
		Grid &	grid
	)

Sets the input file type

Parameters

str	The file type

References WXP::Plot::drawText(), WXP::String::equal(), FILL, WXP::String::get(), getLevel(), WXP::Grid::getNx(), WXP::Grid::getNy(), WXP::Point::interp(), WXP::Const::MISS, WXP::GridBox::set(), WXP::Plot::setText(), and WXP::String::valid().

Referenced by drawFill(), and drawLine().

◆ drawMaxMin()

int ContPlot::drawMaxMin	(	Plot &	plot,
		Grid &	grid
	)

Draws the local max and min values on the plot

Parameters

plot	The plot object
grid	The grid

References WXP::Plot::drawText(), WXP::String::equal(), FILL, WXP::String::get(), WXP::Grid::getNx(), WXP::Grid::getNy(), WXP::Grid::getValue(), WXP::Const::MISS, WXP::GridPoint::set(), WXP::Plot::setText(), WXP::Grid::tran(), WXP::String::valid(), and WXP::Point::y.

Referenced by drawFill(), and drawLine().

◆ drawValues()

int ContPlot::drawValues	(	Plot &	plot,
		Grid &	grid
	)

Plots gridpoint values

Parameters

plot	The plot object
grid	The grid

References WXP::Tools::calcInterval(), WXP::Plot::drawFormText(), WXP::Plot::drawText(), WXP::String::get(), WXP::Plot::getColorMap(), WXP::Grid::getDomain(), WXP::Grid::getNx(), WXP::Grid::getNy(), WXP::Grid::getRange(), WXP::Grid::getValue(), WXP::Const::MISS, WXP::Wxp::outWarning(), WXP::ColorFile::read(), WXP::GridPoint::set(), WXP::Plot::setColorMap(), WXP::Plot::setText(), WXP::Grid::tran(), WXP::Domain::translate(), WXP::String::valid(), WXP::StrLib::valid(), and WXP::Point::x.

Referenced by draw().

◆ getBase()

float WXP::ContPlot::getBase ( )

inline

Returns the contour base value

◆ getColorFill()

PlotAttr WXP::ContPlot::getColorFill ( int ind )

inline

Returns the plot attributes for a specific color fill

◆ getInterval()

float WXP::ContPlot::getInterval ( )

inline

Returns the contour interval

◆ getLevel()

float ContPlot::getLevel ( int ind )

Gets the contour level

Parameters

ind	The level number, either first value in color fill or lowest contour level

Returns: Contour level

Referenced by drawFill(), drawLine(), and drawLineLabels().

◆ getMax()

float WXP::ContPlot::getMax ( )

inline

Returns the maximum value in the grid

◆ getMin()

float WXP::ContPlot::getMin ( )

inline

Returns the minimum value in the grid

◆ getType()

int WXP::ContPlot::getType ( )

inline

Returns the contour type

◆ init()

int ContPlot::init ( )

Initializes the object

References WXP::ColorFill::init(), WXP::String::init(), LINE, WXP::Const::MISS, setBase(), setColorFill(), setColorLabel(), setColorLine(), setColorTable(), setInterval(), setParam(), setTextFormat(), and setType().

Referenced by ContPlot(), and WXP::GridCont::init().

◆ isTypeFill()

bool WXP::ContPlot::isTypeFill ( )

inline

Returns whether the plot is a color fill

References BOTH, and FILL.

◆ setBase()

int ContPlot::setBase ( float val )

Sets the contour base value used in color fill and other parameters

Parameters

val	Base value

Referenced by WXP::UpaXSectCont::draw(), init(), and setParam().

◆ setColorFill()

int ContPlot::setColorFill ( const char * str )

Sets the color fill parameters

Parameters

str	Color fill string

References WXP::String::set().

Referenced by init(), WXP::GridCont::setColorFill(), and setParam().

◆ setColorLabel()

int ContPlot::setColorLabel ( const char * str )

Sets the color for contour labels

Parameters

str	Color string

References WXP::String::set().

Referenced by init(), and setParam().

◆ setColorLine()

int ContPlot::setColorLine ( const char * str )

Sets the color for line contours

Parameters

str	Color string

References WXP::String::set().

Referenced by init(), and setParam().

◆ setColorTable()

int ContPlot::setColorTable ( const char * str )

Sets the color table parameters

Parameters

str	Color table parameter

References WXP::String::set().

Referenced by init(), WXP::GridCont::setColorTable(), and setParam().

◆ setFillStyle()

int ContPlot::setFillStyle ( int type )

Sets the fill contour style

Parameters

type	Fill pattern type

Referenced by setParam().

◆ setInterval()

int ContPlot::setInterval ( float val )

Sets the contour interval

Parameters

val	Contour interval

Referenced by WXP::UpaXSectCont::draw(), init(), and setParam().

◆ setLabelParam()

int ContPlot::setLabelParam	(	int	skip,
		int	rad
	)

Sets the label parameters

Parameters

skip	Contour value skip factor
rad	Search radius for max/min labels

Referenced by setParam().

◆ setLabelSpace()

int ContPlot::setLabelSpace	(	int	x,
		int	y
	)

Sets the spacing factors for contour line labels

Parameters

x	X skip factor
y	Y skip factor

Referenced by setParam().

◆ setLineWidth()

int ContPlot::setLineWidth ( float width )

Sets the line width

Parameters

type	Fill pattern type

Referenced by setParam().

◆ setParam()

int ContPlot::setParam ( const char * str )

Sets the contouring parameters

Parameters

str Parameter string
cf - Contour type is color fill
lcf - Contour type is lines and color fill
ln - Contour type is lines
dln - Contour type is dashed lines
ndln - Contour type is negative dashed lines
gvalue - Contour type is plotted values
value - Contour type is plotted values
ty=type - Contour type
pl=type - Contour type
int=intrvl - Contour interval
ci=intrvl - Contour interval
base=val - Contour base
cb=val - Contour base
sc=scale - Scale factor of text values
fm=format - Format of text values (C printf)
wi=width - Width of contour lines
fill=type - Contour fill type
ct=file - Color table file
coco=color - Line contour color
coln=color - Line contour color
co=color - Line contour color
cof=color - Fill contour colors
lab=s:r:x:y - Label parameters: skip, rad, x, y

References WXP::Strings::equal(), WXP::Strings::getNum(), WXP::Strings::getString(), WXP::Strings::getStringAfter(), WXP::Strings::iequal(), WXP::Strings::scanf(), setBase(), setColorFill(), setColorLabel(), setColorLine(), setColorTable(), setFillStyle(), setInterval(), setLabelParam(), setLabelSpace(), setLineWidth(), setScaleFactor(), setTextFormat(), and setType().

Referenced by WXP::UpaXSectCont::draw(), init(), and WXP::GridCont::setParam().

◆ setScaleFactor()

int ContPlot::setScaleFactor ( float sc )

Sets the scale factor

Parameters

str	Color string

Referenced by setParam().

◆ setTextFormat()

int ContPlot::setTextFormat ( const char * fm )

Sets the format for text values

Parameters

fm	The text format (see printf)

References WXP::StrLib::copy().

Referenced by init(), and setParam().

◆ setType() [1/2]

int ContPlot::setType ( const char * str )

Sets the contour type

Parameters

str	Type of contours (cf, ln, dln, ndln, value, gvalue)

References decodeType(), and WXP::StrLib::equal().

◆ setType() [2/2]

int ContPlot::setType ( int rtype )

Sets the contour type

Parameters

rtype Type of contours (from enum)

Referenced by WXP::UpaXSectCont::draw(), init(), and setParam().

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

ContPlot.h
ContPlot.cc

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ ContType

Constructor & Destructor Documentation

◆ ContPlot()

Member Function Documentation

◆ decodeType()

◆ draw()

◆ drawBoxFill()

◆ drawBoxLine()

◆ drawFill()

◆ drawLabels()

◆ drawLine()

◆ drawLineLabels()

◆ drawMaxMin()

◆ drawValues()

◆ getBase()

◆ getColorFill()

◆ getInterval()

◆ getLevel()

◆ getMax()

◆ getMin()

◆ getType()

◆ init()

◆ isTypeFill()

◆ setBase()

◆ setColorFill()

◆ setColorLabel()

◆ setColorLine()

◆ setColorTable()

◆ setFillStyle()

◆ setInterval()

◆ setLabelParam()

◆ setLabelSpace()

◆ setLineWidth()

◆ setParam()

◆ setScaleFactor()

◆ setTextFormat()

◆ setType() [1/2]

◆ setType() [2/2]