Forecast

A class that represents a PQPF

Quick Index

DESCRIPTION

AUTHOR

Class Summary

class Forecast

{

public:

Forecast(const string& ft, const GridType& gt, const vector< vector<Area> >& a);

Forecast(const Forecast& g);

~Forecast();

Forecast& operator=(const Forecast& rhs);

void show(const ShowStyle& s );

int getNumAreas() const ;

int getNumSubAreas(const int& i) const ;

int getNumPointsAreas(const int& i) const;

int getNumPointsSubAreas(const int& i,const int& j) const;

float getX25Hat(const int& i) ;

float getX50Hat(const int& i) ;

float getX75Hat(const int& i) ;

float getPiBar(const int& i) ;

float getGamma1(const int& i, const int& j) ;

float getGamma2(const int& i, const int& j) ;

float getGamma3(const int& i, const int& j) ;

float getGamma4(const int& i, const int& j) ;

float getZ1Avg( const int& i ) ;

float getZ2Avg( const int& i ) ;

float getZ3Avg( const int& i ) ;

Date getDate() const ;

string getName( const int& i ) ;

string getSubName( const int& i,const int&j ) ;

protected:

private:

string _formatType;

GridType _gridType;

vector<float> _x25Hat;

vector<float> _x50Hat;

vector<float> _x75Hat;

vector<float> _z1Avg;

vector<float> _z2Avg;

vector<float> _z3Avg;

vector< vector<float> > _gamma1;

vector< vector<float> > _gamma2;

vector< vector<float> > _gamma3;

vector< vector<float> > _gamma4;

vector<float> _MBar;

vector<float> _alphaHat;

vector<float> _betaHat;

vector<float> _piBar;

vector<float> _xsiBar;

vector<string> _names;

vector< vector<string> > _subNames;

Date _date;

int _numAreas;

vector<int> _numSubAreas;

vector<int> _numPointsArea;

vector< vector<int> > _numPointsSubArea;

void _createForecasts( const vector< vector<Area> >& v);

void _distributionFactors( const vector< vector<Area> >& v, const int& i );

}; // Forecast

DESCRIPTION

A class that represents a Probabilistic Quantitative Precipitation Forecast.

AUTHOR

Mike Smoot

Forecast(const string& ft, const GridType& gt, const vector< vector<Area> >& a);

Constructor

		Forecast(const string& ft, 
				 const GridType& gt,
				 const vector< vector<Area> >& a);

Forecast(const Forecast& g);

Copy constructor

		Forecast(const Forecast& g);

~Forecast();

Destructor

		~Forecast();

Forecast& operator=(const Forecast& rhs);

Operator =

		Forecast& operator=(const Forecast& rhs);

void show(const ShowStyle& s );

Dumps all the forecast data. Used for debugging purposes.

		void show(const ShowStyle& s = HUMAN);

int getNumAreas() const ;

Returns the number of areas in the forecast.

		int getNumAreas() const                      ;

Function is currently defined inline.

int getNumSubAreas(const int& i) const ;

Returns the number of sub areas for a particular area indicated by the index.

		int getNumSubAreas(const int& i) const                            ;

Function is currently defined inline.

int getNumPointsAreas(const int& i) const;

Returns the number of points in a particular area indicated by the index.

		int getNumPointsAreas(const int& i) const;

int getNumPointsSubAreas(const int& i,const int& j) const;

Returns the number of points in a sub area. The area then the sub area indexes are the arguments.

		int getNumPointsSubAreas(const int& i,const int& j) const;

float getX25Hat(const int& i) ;

Returns estimated X25 for an area indicated by the index.

		float getX25Hat(const int& i)                       ;

Function is currently defined inline.

float getX50Hat(const int& i) ;

Returns estimated X50 for an area indicated by the index.

		float getX50Hat(const int& i)                       ;

Function is currently defined inline.

float getX75Hat(const int& i) ;

Returns estimated X75 for an area indicated by the index.

		float getX75Hat(const int& i)                       ;

Function is currently defined inline.

float getPiBar(const int& i) ;

Returns average of pi for an area indicated by the index.

		float getPiBar(const int& i)                      ;

Function is currently defined inline.

float getGamma1(const int& i, const int& j) ;

Returns gamma for the first sub period for an area and sub area indicated respectively by the indices.

		float getGamma1(const int& i, const int& j) 
			                         ;

Function is currently defined inline.

float getGamma2(const int& i, const int& j) ;

Returns gamma for the second sub period for an area and sub area indicated respectively by the indices.

		float getGamma2(const int& i, const int& j)
			                         ;

Function is currently defined inline.

float getGamma3(const int& i, const int& j) ;

Returns gamma for the third sub period for an area and sub area indicated respectively by the indices.

		float getGamma3(const int& i, const int& j)
			                         ;

Function is currently defined inline.

float getGamma4(const int& i, const int& j) ;

Returns gamma for the forth sub period for an area and sub area indicated respectively by the indices.

		float getGamma4(const int& i, const int& j)
			                         ;

Function is currently defined inline.

float getZ1Avg( const int& i ) ;

Returns Z1 average for an area indicated by the index.

		float getZ1Avg( const int& i )                      ;

Function is currently defined inline.

float getZ2Avg( const int& i ) ;

Returns Z2 average for an area indicated by the index.

		float getZ2Avg( const int& i )                      ;

Function is currently defined inline.

float getZ3Avg( const int& i ) ;

Returns Z3 average for an area indicated by the index.

		float getZ3Avg( const int& i )                      ;

Function is currently defined inline.

Date getDate() const ;

Returns the Date of the forecast.

		Date getDate() const                  ;

Function is currently defined inline.

string getName( const int& i ) ;

Returns the name of an area indicated by the index.

		string getName( const int& i )                     ;

Function is currently defined inline.

string getSubName( const int& i,const int&j ) ;

Returns the name of a sub area indicated by the indices, respectively.

		string getSubName( const int& i,const int&j )                          ;

Function is currently defined inline.

string _formatType;

Forecast format type.

		string _formatType;

GridType _gridType;

Forecast grid type.

		GridType _gridType;

vector<float> _x25Hat;

Estimated x25

		vector<float> _x25Hat;

vector<float> _x50Hat;

Estimated x50

		vector<float> _x50Hat;

vector<float> _x75Hat;

Estimated x75

		vector<float> _x75Hat;

vector<float> _z1Avg;

Average expected fraction for subperiod 1

		vector<float> _z1Avg;

vector<float> _z2Avg;

Average expected fraction for subperiod 2

		vector<float> _z2Avg;

vector<float> _z3Avg;

Average expected fraction for subperiod 3

		vector<float> _z3Avg;

vector< vector<float> > _gamma1;

Vector of subperiod1 disaggregation factors.

		vector< vector<float> > _gamma1;

vector< vector<float> > _gamma2;

Vector of subperiod2 disaggregation factors.

		vector< vector<float> > _gamma2;

vector< vector<float> > _gamma3;

Vector of subperiod3 disaggregation factors.

		vector< vector<float> > _gamma3;

vector< vector<float> > _gamma4;

Vector of subperiod4 disaggregation factors.

		vector< vector<float> > _gamma4;

vector<float> _MBar;

Mean expected total amount for all of the Areas combined.

		vector<float> _MBar;

vector<float> _alphaHat;

_MBar*_betaHat / _piBar * exp(gamma(1/_betaHat))

		vector<float> _alphaHat;

vector<float> _betaHat;

constantC/ln(epsilionBar)

		vector<float> _betaHat;

vector<float> _piBar;

Mean of positive pop values.

		vector<float> _piBar;

vector<float> _xsiBar;

vector of xsiBar

		vector<float> _xsiBar;

vector<string> _names;

Vector of Area names.

		vector<string> _names;

vector< vector<string> > _subNames;

Vector of sub Area names.

		vector< vector<string> > _subNames;

Date _date;

Forecast date.

		Date _date;

int _numAreas;

The number of areas in the Forecast.

		int _numAreas;

vector<int> _numSubAreas;

A vector of the number of sub areas in each area.

		vector<int> _numSubAreas;

vector<int> _numPointsArea;

A vector of the number of points in each area.

		vector<int> _numPointsArea;

vector< vector<int> > _numPointsSubArea;

A vector of vectors of the number of points in each area.

		vector< vector<int> > _numPointsSubArea;

void _createForecasts( const vector< vector<Area> >& v);

Method that calculates the forecast factors

		void _createForecasts( const vector< vector<Area> >& v);

void _distributionFactors( const vector< vector<Area> >& v, const int& i );

Method that calculates the distribution factors if needed.

		void _distributionFactors( const vector< vector<Area> >& v,
								   const int& i );

All Members

public:: Forecast& operator=(const Forecast& rhs);; void show(const ShowStyle& s );; int getNumAreas() const ;; int getNumSubAreas(const int& i) const ;; int getNumPointsAreas(const int& i) const;; int getNumPointsSubAreas(const int& i,const int& j) const;; float getX25Hat(const int& i) ;; float getX50Hat(const int& i) ;; float getX75Hat(const int& i) ;; float getPiBar(const int& i) ;; float getGamma1(const int& i, const int& j) ;; float getGamma2(const int& i, const int& j) ;; float getGamma3(const int& i, const int& j) ;; float getGamma4(const int& i, const int& j) ;; float getZ1Avg( const int& i ) ;; float getZ2Avg( const int& i ) ;; float getZ3Avg( const int& i ) ;; Date getDate() const ;; string getName( const int& i ) ;; string getSubName( const int& i,const int&j ) ;
protected:

Ancestors

Class does not inherit from any other class.

Descendants

Class is not inherited by any others.

Generated from source by the Cocoon utilities on Wed Aug 30 12:53:32 2000 .

Report problems to jkotula@stratasys.com