code::WindFieldLLGVolume Class Reference

Inheritance diagram for code::WindFieldLLGVolume:

code::LatLonHeightGrid code::Data3D< T2, T3, T4, X > code::Volume code::DataType List of all members.

Public Types

 LatLonHeightGrid
typedef T2 Dim1Type
typedef T3 Dim2Type
typedef T4 Dim3Type
typedef X ValueType
typedef std::map< std::string,
SmartPtr< DataColumn > > 
AttrMap
 key-value pairs that describe the data.
 RadialSet
 LatLonGrid
 CartesianGrid2D
 Grid2D
 DataTable
 WindField
 WindFieldLLGVolume
 ElevationVolume
 ContourData
 Other
enum  Type {
  RadialSet, LatLonGrid, LatLonHeightGrid, CartesianGrid2D,
  Grid2D, DataTable, WindField, WindFieldLLGVolume,
  ElevationVolume, ContourData, Other
}

Public Member Functions

virtual ~WindFieldLLGVolume ()
 Clean up after descendants.
virtual short getType () const
 Get enum type of this class.
virtual bool constructVolume (std::vector< code::SmartPtr< code::DataType > > &dataslices)
 Construct volume object from a datatype set.
virtual double getRawValue (const Location &, bool=false) const
 Gets raw value from data set.
virtual double interpolatedValue (const code::Location &loc) const
 Return the value corresponding to a linearly weighted average of the six grid points nearest in lat-lon-hgt space.
void addLatLonGrid (const code::LatLonGrid &)
 Add a LatLonGrid to a non-uniformly vertically spaced LatLonHeightGrid.
code::LatLonGrid getLatLonGrid (size_t i) const
 Get the LatLonGrid at the ith index (shallow copy).
virtual void invoke (Algorithm &alg)
 Use this to invoke any algorithm.
const LocationgetOrigin () const
 Return the Location of the extreme north-west-bottom grid point.
const TimegetTime () const
 Return time corresponding to this grid.
int getTotalNumOfLevels () const
 Return total number of levels of this grid.
const DimType & getGridSpacing () const
 Return the spacing of grid points.
const std::vector< Length > & getHeightSpacing () const
 Return the spacing along the height dimension.
Length getHeight (size_t i) const
 get the height of the ith level (i=0,1,2.
const std::map< Length, size_t > & getHeightIndexMap () const
 Return the height spacing index map.
const Coord & size () const
 Return the number of grid points along each direction.
virtual SpaceTimeRef reference (size_t i, size_t j, size_t k) const
 Obtain the reference corresponding to the grid point offset (i,j,k).
virtual LatLonHeightGrid::DimType coord_value (size_t i, size_t j, size_t k) const
 Return the parametric displacement of grid point offset (i,j,k) from the origin (0,0,0).
float getNearestValue (const Location &) const
 Return the value corresponding to the grid point nearest a particular Location.
void setHeightScale (float)
 Set factor by which heights are multiplied.
float getHeightScale () const
 Return factor by which heights are multiplied.
virtual double rawFunction (const code::Location &loc) const
 Get closest raw value this given location.
virtual double rawFunction (const code::LocationCPoint &loc) const
 Get closest raw value this given location.
virtual double interpolatedValue (const code::LocationCPoint &loc) const
 Get interpolated value for given location.
Data3D clone () const
 Creates a completely separate copy of the data.
const Data2D< T3, T4, X > & operator[] (size_t i) const
Data2D< T3, T4, X > & operator[] (size_t i)
X & cell_ref (size_t i, size_t j, size_t k)
 Deprecated alternative to data3d[i][j][k].
const X & cell_ref (size_t i, size_t j, size_t k) const
 Deprecated alternative to data3d[i][j][k].
void set_val (size_t i, size_t j, size_t k, const X &value)
 Deprecated alternative to data3d[i][j][k].
void get_1d_bounds (size_t i, size_t j, const X *setme_begin, const X *setme_end) const
void replace_1d (size_t i, size_t j, const X *begin, const X *end)
 Overwrite a 1d of elements.
void replace_1d (size_t i, size_t j, const std::vector< X > &v)
 Overwrite a 1d of elements.
void replace (const X &old_value, const X &new_value)
 Replace any instance of old_value with new_value.
void fill (const X &val)
void fill (const X &val, size_t i_begin, size_t i_end, size_t j_begin, size_t j_end, size_t k_begin, size_t k_end)
 Set the values in the table.
get_val (size_t i, size_t j, size_t k) const
 Return a copy of the specified element.
const std::vector< Data2D<
T3, T4, X > > & 
data () const
 Returns the internal vector of Data2D.
std::vector< Data2D< T3, T4,
X > > & 
data ()
 Returns the internal vector of Data2D.
Datum< X > data (size_t i, size_t j, size_t k) const
 Obtain the datum corresponding to the ith element.
size_t size_d () const
 Returns the number of 2Ds in this Data3D.
size_t size_d (size_t i) const
 Returns the number of 1Ds in the 2D in [i].
size_t size_d (size_t i, size_t j) const
 Returns the number of elements in the 1D in [i][j].
virtual SpaceTimeRef getSpaceTimeRef () const
 Returns the reference of the first element.
std::string getTypeClassName () const
 returns a string such as RadialSet, LatLonGrid, etc.
void copyDataType (const DataType &dt)
 A convenience function provided for subclasses that implement clone() -- will copy into this data type all the attributes in the type dt.
const std::string & getTypeName () const
 Return the TypeName of this DataType.
void setTypeName (const std::string &)
 Set the TypeName of this DataType.
SmartPtr< DataCellgetAttributeValue (const std::string &key) const
 Return a single value associated with an attribute key corresponding to the function's argument.
bool getAttributeValue (const std::string &key, std::string &setme) const
 Assign `setme' with the attribute corresponding to `key'.
bool getAttributeValue (const std::string &key, double &setme) const
 Assign `setme' with the attribute corresponding to `key'.
void setAttributeValue (const std::string &key, const std::string &value, const std::string &unit="dimensionless")
 Set a single-valued attribute that describes this DataType.
void setAttributeValue (const std::string &key, double value, const std::string &unit="dimensionless", const std::string &format="%g")
 Set a single-valued attribute that describes this DataType.
void setAttribute (const std::string &key, SmartPtr< DataColumn > value)
 Set a multiple-valued attribute that describes this DataType.
SmartPtr< DataColumngetAttribute (const std::string &key) const
 Get the attribute value for a particular key.
const AttrMapgetAttributes () const
 Get the entire map of attributes available for this data type.
virtual TimeInterval getExpiryInterval () const
 Return 15 minutes as the length of time for which this DataType is valid.
bool hasQuality () const
const DataTypegetQuality () const
void setQuality (SmartPtr< DataType > dt)
void clearAttributes ()
virtual double testValue (const code::Location &loc) const
 Get volume test value for given location.
virtual double testValue (const code::LocationCPoint &loc) const
 Get volume test value for given location.

Public Attributes

InitSmartPtr< std::vector<
Data2D< T3, T4, X > > > 
vals
 The array of 2D types that is held.

Static Public Attributes

static const std::string IsTableData
static const std::string Unit
static const std::string ColorMap
static const std::string ExpiryInterval

Protected Member Functions

virtual void deep_copy (const DataType &source)

Protected Attributes

code::SmartPtr< code::LatLonHeightGridmyV
 The V grid.

Member Typedef Documentation

typedef std::map< std::string, SmartPtr<DataColumn> > code::DataType::AttrMap [inherited]

key-value pairs that describe the data.

template<class T2, class T3, class T4, class X>
typedef T2 code::Data3D< T2, T3, T4, X >::Dim1Type [inherited]

template<class T2, class T3, class T4, class X>
typedef T3 code::Data3D< T2, T3, T4, X >::Dim2Type [inherited]

template<class T2, class T3, class T4, class X>
typedef T4 code::Data3D< T2, T3, T4, X >::Dim3Type [inherited]

template<class T2, class T3, class T4, class X>
typedef X code::Data3D< T2, T3, T4, X >::ValueType [inherited]


Member Enumeration Documentation

enum code::DataType::Type [inherited]

Enumerator:
RadialSet 
LatLonGrid 
LatLonHeightGrid 
CartesianGrid2D 
Grid2D 
DataTable 
WindField 
WindFieldLLGVolume 
ElevationVolume 
ContourData 
Other 


Constructor & Destructor Documentation

virtual code::WindFieldLLGVolume::~WindFieldLLGVolume (  )  [virtual]

Clean up after descendants.


Member Function Documentation

void code::LatLonHeightGrid::addLatLonGrid ( const code::LatLonGrid  )  [inherited]

Add a LatLonGrid to a non-uniformly vertically spaced LatLonHeightGrid.

template<class T2, class T3, class T4, class X>
const X& code::Data3D< T2, T3, T4, X >::cell_ref ( size_t  i,
size_t  j,
size_t  k 
) const [inline, inherited]

Deprecated alternative to data3d[i][j][k].

template<class T2, class T3, class T4, class X>
X& code::Data3D< T2, T3, T4, X >::cell_ref ( size_t  i,
size_t  j,
size_t  k 
) [inline, inherited]

Deprecated alternative to data3d[i][j][k].

void code::DataType::clearAttributes (  )  [inline, inherited]

template<class T2, class T3, class T4, class X>
Data3D code::Data3D< T2, T3, T4, X >::clone (  )  const [inline, inherited]

Creates a completely separate copy of the data.

virtual bool code::WindFieldLLGVolume::constructVolume ( std::vector< code::SmartPtr< code::DataType > > &  dataslices  )  [virtual]

Construct volume object from a datatype set.

A volume is a a group of data type

Reimplemented from code::LatLonHeightGrid.

virtual LatLonHeightGrid::DimType code::LatLonHeightGrid::coord_value ( size_t  i,
size_t  j,
size_t  k 
) const [virtual, inherited]

Return the parametric displacement of grid point offset (i,j,k) from the origin (0,0,0).

Implementation of virtual function in Data3D.

Reimplemented from code::Data3D< T2, T3, T4, X >.

void code::DataType::copyDataType ( const DataType dt  )  [inherited]

A convenience function provided for subclasses that implement clone() -- will copy into this data type all the attributes in the type dt.

Attributes with the same name will be over-written, other attributes will remain unchanged.

template<class T2, class T3, class T4, class X>
Datum<X> code::Data3D< T2, T3, T4, X >::data ( size_t  i,
size_t  j,
size_t  k 
) const [inline, inherited]

Obtain the datum corresponding to the ith element.

template<class T2, class T3, class T4, class X>
std::vector< Data2D<T3,T4,X> >& code::Data3D< T2, T3, T4, X >::data (  )  [inline, inherited]

Returns the internal vector of Data2D.

Avoid using this if possible.

template<class T2, class T3, class T4, class X>
const std::vector< Data2D<T3,T4,X> >& code::Data3D< T2, T3, T4, X >::data (  )  const [inline, inherited]

Returns the internal vector of Data2D.

Avoid using this if possible.

virtual void code::DataType::deep_copy ( const DataType source  )  [inline, protected, virtual, inherited]

template<class T2, class T3, class T4, class X>
void code::Data3D< T2, T3, T4, X >::fill ( const X &  val,
size_t  i_begin,
size_t  i_end,
size_t  j_begin,
size_t  j_end,
size_t  k_begin,
size_t  k_end 
) [inline, inherited]

Set the values in the table.

template<class T2, class T3, class T4, class X>
void code::Data3D< T2, T3, T4, X >::fill ( const X &  val  )  [inline, inherited]

template<class T2, class T3, class T4, class X>
void code::Data3D< T2, T3, T4, X >::get_1d_bounds ( size_t  i,
size_t  j,
const X *  setme_begin,
const X *  setme_end 
) const [inline, inherited]

template<class T2, class T3, class T4, class X>
X code::Data3D< T2, T3, T4, X >::get_val ( size_t  i,
size_t  j,
size_t  k 
) const [inline, inherited]

Return a copy of the specified element.

SmartPtr< DataColumn > code::DataType::getAttribute ( const std::string &  key  )  const [inherited]

Get the attribute value for a particular key.

Parameters:
key attribute key
Returns:
value attribute value in unit-safe manner, or an invalid SmartPtr on error.
See also:
getAttributeValue()

getAttributes() if you don't know the attribute key.

const AttrMap& code::DataType::getAttributes (  )  const [inline, inherited]

Get the entire map of attributes available for this data type.

See also:
getAttribute for a more selective get.

getAttributeValue for a convenient get.

bool code::DataType::getAttributeValue ( const std::string &  key,
double &  setme 
) const [inherited]

Assign `setme' with the attribute corresponding to `key'.

Returns:
true on success; false if no such attribute exists

bool code::DataType::getAttributeValue ( const std::string &  key,
std::string &  setme 
) const [inherited]

Assign `setme' with the attribute corresponding to `key'.

Returns:
true on success; false if no such attribute exists

SmartPtr< DataCell > code::DataType::getAttributeValue ( const std::string &  key  )  const [inherited]

Return a single value associated with an attribute key corresponding to the function's argument.

If no such attribute key exists, then return the NULL SmartPtr. In case multiple values are associated with the key, only the first item is returned.

See also:
getAttribute() to get all values.

virtual TimeInterval code::DataType::getExpiryInterval (  )  const [virtual, inherited]

Return 15 minutes as the length of time for which this DataType is valid.

Override this function in the descendant of DataType as appropriate.

Reimplemented in code::DEM.

const DimType& code::LatLonHeightGrid::getGridSpacing (  )  const [inherited]

Return the spacing of grid points.

If the height spacing is nonuniform, then the first component of the return value will be zero.

Length code::LatLonHeightGrid::getHeight ( size_t  i  )  const [inherited]

get the height of the ith level (i=0,1,2.

..) results are undefined if the ith level doesnt exist.

const std::map< Length, size_t >& code::LatLonHeightGrid::getHeightIndexMap (  )  const [inherited]

Return the height spacing index map.

float code::LatLonHeightGrid::getHeightScale (  )  const [inline, inherited]

Return factor by which heights are multiplied.

const std::vector< Length >& code::LatLonHeightGrid::getHeightSpacing (  )  const [inherited]

Return the spacing along the height dimension.

If the height spacing is uniform, then the return value will be an empty vector.

code::LatLonGrid code::LatLonHeightGrid::getLatLonGrid ( size_t  i  )  const [inherited]

Get the LatLonGrid at the ith index (shallow copy).

float code::LatLonHeightGrid::getNearestValue ( const Location  )  const [inherited]

Return the value corresponding to the grid point nearest a particular Location.

const Location& code::LatLonHeightGrid::getOrigin (  )  const [inherited]

Return the Location of the extreme north-west-bottom grid point.

const DataType& code::DataType::getQuality (  )  const [inline, inherited]

virtual double code::WindFieldLLGVolume::getRawValue ( const Location ,
bool  = false 
) const [virtual]

Gets raw value from data set.

Overridden from Volume

Reimplemented from code::LatLonHeightGrid.

template<class T2, class T3, class T4, class X>
virtual SpaceTimeRef code::Data3D< T2, T3, T4, X >::getSpaceTimeRef (  )  const [inline, virtual, inherited]

Returns the reference of the first element.

Implements code::DataType.

Reimplemented in code::CartesianGrid3D.

const Time& code::LatLonHeightGrid::getTime (  )  const [inherited]

Return time corresponding to this grid.

int code::LatLonHeightGrid::getTotalNumOfLevels (  )  const [inherited]

Return total number of levels of this grid.

virtual short code::WindFieldLLGVolume::getType (  )  const [inline, virtual]

Get enum type of this class.

Reimplemented from code::LatLonHeightGrid.

std::string code::DataType::getTypeClassName (  )  const [inherited]

returns a string such as RadialSet, LatLonGrid, etc.

See the enum Type for all the possible options. Subclasses need only to over-ride getType()

const std::string& code::DataType::getTypeName (  )  const [inherited]

Return the TypeName of this DataType.

bool code::DataType::hasQuality (  )  const [inline, inherited]

virtual double code::Volume::interpolatedValue ( const code::LocationCPoint loc  )  const [inline, virtual, inherited]

Get interpolated value for given location.

Reimplemented in code::ElevationVolume.

virtual double code::WindFieldLLGVolume::interpolatedValue ( const code::Location loc  )  const [virtual]

Return the value corresponding to a linearly weighted average of the six grid points nearest in lat-lon-hgt space.

Reimplemented from code::LatLonHeightGrid.

virtual void code::LatLonHeightGrid::invoke ( Algorithm alg  )  [inline, virtual, inherited]

Use this to invoke any algorithm.

Reimplemented from code::DataType.

template<class T2, class T3, class T4, class X>
Data2D<T3,T4,X>& code::Data3D< T2, T3, T4, X >::operator[] ( size_t  i  )  [inline, inherited]

template<class T2, class T3, class T4, class X>
const Data2D<T3,T4,X>& code::Data3D< T2, T3, T4, X >::operator[] ( size_t  i  )  const [inline, inherited]

virtual double code::Volume::rawFunction ( const code::LocationCPoint loc  )  const [inline, virtual, inherited]

Get closest raw value this given location.

Reimplemented in code::ElevationVolume.

virtual double code::LatLonHeightGrid::rawFunction ( const code::Location loc  )  const [virtual, inherited]

Get closest raw value this given location.

Reimplemented from code::Volume.

virtual SpaceTimeRef code::LatLonHeightGrid::reference ( size_t  i,
size_t  j,
size_t  k 
) const [virtual, inherited]

Obtain the reference corresponding to the grid point offset (i,j,k).

Implementation of virtual function in Data3D.

Reimplemented from code::Data3D< T2, T3, T4, X >.

template<class T2, class T3, class T4, class X>
void code::Data3D< T2, T3, T4, X >::replace ( const X &  old_value,
const X &  new_value 
) [inline, inherited]

Replace any instance of old_value with new_value.

template<class T2, class T3, class T4, class X>
void code::Data3D< T2, T3, T4, X >::replace_1d ( size_t  i,
size_t  j,
const std::vector< X > &  v 
) [inline, inherited]

Overwrite a 1d of elements.

The number of old and new elements must match.

template<class T2, class T3, class T4, class X>
void code::Data3D< T2, T3, T4, X >::replace_1d ( size_t  i,
size_t  j,
const X *  begin,
const X *  end 
) [inline, inherited]

Overwrite a 1d of elements.

The number of old and new elements must match.

template<class T2, class T3, class T4, class X>
void code::Data3D< T2, T3, T4, X >::set_val ( size_t  i,
size_t  j,
size_t  k,
const X &  value 
) [inline, inherited]

Deprecated alternative to data3d[i][j][k].

void code::DataType::setAttribute ( const std::string &  key,
SmartPtr< DataColumn value 
) [inherited]

Set a multiple-valued attribute that describes this DataType.

If value is 0 (i.e. invalid), this attribute will be removed from the map.

void code::DataType::setAttributeValue ( const std::string &  key,
double  value,
const std::string &  unit = "dimensionless",
const std::string &  format = "%g" 
) [inherited]

Set a single-valued attribute that describes this DataType.

This is a convenience function that allows you to set a dimensionless number as the value of an attribute.

If the attribute key does not already exist, then it will be constructed.

See also:
setAttribute() to set multiple values for an attribute.

void code::DataType::setAttributeValue ( const std::string &  key,
const std::string &  value,
const std::string &  unit = "dimensionless" 
) [inherited]

Set a single-valued attribute that describes this DataType.

This is a convenience function that allows you to set a text string as the value of an attribute.

If the attribute key does not already exist, then it will be constructed. The empty string may NOT be used as a value for the attribute; this function will return immediately if the value is the empty string.

See also:
setAttribute() to set multiple values for an attribute.

void code::LatLonHeightGrid::setHeightScale ( float   )  [inherited]

Set factor by which heights are multiplied.

void code::DataType::setQuality ( SmartPtr< DataType dt  )  [inline, inherited]

void code::DataType::setTypeName ( const std::string &   )  [inherited]

Set the TypeName of this DataType.

const Coord& code::LatLonHeightGrid::size (  )  const [inherited]

Return the number of grid points along each direction.

Reimplemented from code::Data3D< T2, T3, T4, X >.

template<class T2, class T3, class T4, class X>
size_t code::Data3D< T2, T3, T4, X >::size_d ( size_t  i,
size_t  j 
) const [inline, inherited]

Returns the number of elements in the 1D in [i][j].

template<class T2, class T3, class T4, class X>
size_t code::Data3D< T2, T3, T4, X >::size_d ( size_t  i  )  const [inline, inherited]

Returns the number of 1Ds in the 2D in [i].

template<class T2, class T3, class T4, class X>
size_t code::Data3D< T2, T3, T4, X >::size_d (  )  const [inline, inherited]

Returns the number of 2Ds in this Data3D.

virtual double code::Volume::testValue ( const code::LocationCPoint loc  )  const [inline, virtual, inherited]

Get volume test value for given location.

Reimplemented in code::ElevationVolume.

virtual double code::Volume::testValue ( const code::Location loc  )  const [inline, virtual, inherited]

Get volume test value for given location.

Reimplemented in code::ElevationVolume.


Member Data Documentation

const std::string code::DataType::ColorMap [static, inherited]

const std::string code::DataType::ExpiryInterval [static, inherited]

const std::string code::DataType::IsTableData [static, inherited]

code::SmartPtr<code::LatLonHeightGrid> code::WindFieldLLGVolume::myV [protected]

The V grid.

const std::string code::DataType::Unit [static, inherited]

template<class T2, class T3, class T4, class X>
InitSmartPtr< std::vector< Data2D<T3,T4,X> > > code::Data3D< T2, T3, T4, X >::vals [inherited]

The array of 2D types that is held.

Use [] to dereference ...


Generated on Fri May 4 13:40:11 2012 for WDSS-IIw2 by  doxygen 1.4.7