WXP::ObjectAnal Class Reference

This class performs an objective analysis on point data converting it to a grid.
More...

#include "../include/ObjectAnal.h"

Public Member Functions
	ObjectAnal ()
	ObjectAnal (const char *str)
int	init ()
int	set (const char *param)
int	set (float fil, float rad, int pass, float conv)
int	setParam (const char *param)
int	setFilter (float fil)
int	setRadInf (float rad)
int	setNumPass (int pass)
int	setConverg (float conv)
int	setMinSta (int min)
int	setMissVal (float val)
int	compute (Data &data, Grids &grid)
int	print ()

Detailed Description

This class performs an objective analysis on point data converting it to a grid.

An initial grid such as a model grid can be used as a seed value.

Author

Dan Vietor

Constructor & Destructor Documentation

ObjectAnal() [1/2]

ObjectAnal::ObjectAnal

(

)

Constructor

References init().

ObjectAnal() [2/2]

ObjectAnal::ObjectAnal

(

const char *

param

)

Constructor. Sets up parameters

Parameters

param

Parameter string

References init(), and setParam().

Member Function Documentation

compute()

int ObjectAnal::compute	(	Data &	data,
		Grids &	grids
	)

This function performs an objective analysis to fit randomly spaced data to a grid

Parameters

data	Input data to fit to grid

Return values

grid	Output grid

References WXP::DomainVal::dx, WXP::DomainVal::dy, WXP::String::get(), WXP::Const::MISS, WXP::DomainVal::nx, WXP::DomainVal::ny, WXP::Wxp::outMessage(), WXP::Domain::set(), WXP::Domain::tran(), and WXP::StrLib::valid().

Referenced by WXP::RawGrid::compute(), WXP::MosGrid::compute(), WXP::SfcGrid::compute(), and WXP::UpaGrid::compute().

init()

int ObjectAnal::init

(

)

Initializes the object

References WXP::Const::MISS, and set().

Referenced by ObjectAnal(), and ObjectAnal().

print()

int ObjectAnal::print

(

)

Prints the object parameters

set() [1/2]

int ObjectAnal::set

(

const char *

str

)

Sets objective analysis parameters

Parameters

str	Parameters (fp,ri,np,cv,mn)

References setConverg(), setFilter(), setMinSta(), setNumPass(), setRadInf(), and WXP::StrLib::valid().

Referenced by init().

set() [2/2]

int ObjectAnal::set	(	float	fil,
		float	rad,
		int	pass,
		float	conv
	)

Sets objective analysis parameters

Parameters

fil	Filter parameter
rad	Radius of influence
pass	Number of passes
conv	Convergence parameter

setConverg()

int ObjectAnal::setConverg

(

float

conv

)

Sets the convergence parameter. This is a additional filtering parameter which speeds up reduction of RMS errors.

Parameters

conv	Convergence parameter

Referenced by set(), and setParam().

setFilter()

int ObjectAnal::setFilter

(

float

fil

)

Sets the filter parameter (larger gives more smoothing)

Parameters

fil	Filter parameter

Referenced by set(), and setParam().

setMinSta()

int ObjectAnal::setMinSta

(

int

min

)

Sets the minimum number of stations at each grid point. If the minimum is not within the radius of influence, the gridpoint is set to MISS.

Parameters

min	The number of stations

Referenced by set(), and setParam().

setMissVal()

int ObjectAnal::setMissVal

(

float

val

)

Sets a value to use when data are missing. This assures valid data are available. This is helpful in a case of precipitation where a missing value could be interpreted as 0 in gridding.

Parameters

val	Value to use for missing data

setNumPass()

int ObjectAnal::setNumPass

(

int

pass

)

Sets the number of passes through the data. Each subsequent pass reduces RMS errors at each grid point attempting to set value of gridpoint to value of nearest station.

Parameters

pass	Number of passes

Referenced by set(), and setParam().

setParam()

int ObjectAnal::setParam

(

const char *

param

)

Sets the parameters

Parameters

param

Parameter string filter=## - Filter/smoothing parameter rad_inf=## - Radius of influence pass=## - Number of passes conv=## - Convergence parameter min_sta=## - Minimum number of stations at each gridpoint oa=fp:ri:np:cv:mn - All parameters (see above)

References WXP::Strings::equal(), WXP::Strings::getFloat(), WXP::Strings::getInt(), WXP::Strings::getNum(), WXP::Strings::getString(), setConverg(), setFilter(), setMinSta(), setNumPass(), and setRadInf().

Referenced by ObjectAnal(), and WXP::RawGrid::setParam().

setRadInf()

int ObjectAnal::setRadInf

(

float

rad

)

Sets the radius of influence. This is the number of grid distances to include stations.

Parameters

rad

Radius

Referenced by set(), and setParam().

---

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

• ObjectAnal.h
• ObjectAnal.cc