code::Grid2D Class Reference

Inheritance diagram for code::Grid2D:

code::Data2D< T3, T4, X > code::DataType code::Dim2D< X > List of all members.

Detailed Description

Store an area of double data on a uniform 2-D grid that is orientated in lat/lon/height space.

The grid spacing of a Grid2D is expressed in terms of displacement pieces, or DLLHs. We can pretend that lat/lon/height is a valid vector space as long as we realize the 'norm' or distance is not. Passing in an origin, the DLLH's of two sides of the grid, and the density factors allows us to create a 'slice' in the 3D lat/lon/height 'space' in any direction. Well except height, which is mapped linearly between corners.

Examples of Grid2Ds:

An origin of lat1, lon1, h1 with an XAxis of lat2,lon2, h1 and a YAxis of lat1, lon1, 0 is a vertical slice with constant height over earth's surface.

An origin of lat1, lon1, h1 with an XAxis of lat2, lon2, h1 and a YAxis of lat1, lon2, h1 yields the same results as a LatLonGrid

Time is constant across the grid.

Author:
REST
See also:
LatLonGrid
Version:
Author
lakshman
$Version$
RCSfile
code_Grid2D.h,v


Public Types

typedef std::map< std::string,
SmartPtr< DataColumn > > 
AttrMap
 key-value pairs that describe the data.
 RadialSet
 LatLonGrid
 LatLonHeightGrid
 CartesianGrid2D
 Grid2D
 DataTable
 WindField
 WindFieldLLGVolume
 ElevationVolume
 ContourData
 Other
enum  Type {
  RadialSet, LatLonGrid, LatLonHeightGrid, CartesianGrid2D,
  Grid2D, DataTable, WindField, WindFieldLLGVolume,
  ElevationVolume, ContourData, Other
}
typedef __normal_iterator< X > iterator
typedef __normal_iterator<
const X > 
const_iterator

Public Member Functions

 Grid2D ()
 For STL use only.
Grid2D clone () const
 A completely separate copy of this grid.
 Grid2D (const SpaceTimeRef &origin, const DLLH &xAxis, const DLLH &yAxis, const size_t &nx, const size_t &ny)
 Build an empty Grid2D.
virtual void invoke (Algorithm &alg)
 Use this to invoke any algorithm.
virtual short getType () const
 Get enum type of this class.
const LocationgetOrigin () const
 Return the Location of the extreme northwest grid point.
const TimegetTime () const
 Return the Time of the grid.
void setTime (const Time &)
const Grid2D::DimType & getGridSpacing () const
 Return the angular spacing of grid points.
virtual SpaceTimeRef reference (size_t i, size_t j) const
 Obtain the reference corresponding to the grid point offset (i,j).
virtual Grid2D::DimType coord_value (size_t i, size_t j) const
 Return the parametric displacement of grid point offset (i,j) from the origin (0,0).
Coord size () const
 Return the number of grid points along each direction.
virtual ~Grid2D ()
 Call descendant destructor.
virtual SpaceTimeRef getSpaceTimeRef () const
 DimensionedData requires that this be implemented in the descendant.
Datum< X > data (size_t i, size_t j) const
 Return the datum of the specified 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 double getRawValue (const Location &, bool=false) const
 Gets raw value from data set.
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 ()
iterator begin ()
const_iterator begin () const
iterator end ()
const_iterator end () const
iterator get_iterator (size_t row, size_t col)
const_iterator get_iterator (size_t row, size_t col) const
X & cell_ref (size_t row, size_t col)
 Deprecated alternative to dim2d[row][col].
const X & cell_ref (size_t row, size_t col) const
 Deprecated alternative to dim2d[row][col].
get_val (size_t row, size_t col) const
 Return a copy of the element in the specified coordinate.
void set_val (size_t row, size_t col, const X &value)
 Slightly more efficient form of dim2d[row][col] = value.
X * operator[] (size_t row)
const X * operator[] (size_t row) const
void get_1d_bounds (size_t row, X *&setme_begin, X *&setme_end)
void get_1d_bounds (size_t row, const X *&setme_begin, const X *&setme_end) const
void push_back (const X *begin, const X *end)
 Add a row of elements.
void push_back (const std::vector< X > &v)
 Add a row of elements.
void replace_1d (size_t row, const X *first, const X *last)
 Overwrite a 'row' of elements.
void replace_1d (int row, const std::vector< X > &v)
 Overwrite a 'row' of elements.
void replace_2d (const Dim2D< X > &d)
 Overwrite the entire 2D.
void set_2d (size_t x, size_t y, const X **values)
 Repopulate the grid as an X x Y grid with a copy of `values'.
void fill (const X &val)
 Set the entire grid to a value.
void fill (const X &val, size_t row_begin, size_t row_end, size_t col_begin, size_t col_end)
 Fill a 2D range with the specified value.
void clear ()
 resets this object to a 0x0 matrix
void reserve (size_t rows, size_t cols)
 ensure enough memory is allocated to populate an ROW x COL matrix.
void resize (size_t rows, size_t cols, const X &value=X())
 resizes to a ROW x COL grid and sets each cell to `value'
void replace (const X &old_value, const X &new_value)
 replace every instance of old_value with new_value
size_t size_d () const
 number of rows.
size_t size_d (size_t row) const
 number of columns.
int dim_x () const
 Number of rows.
int dim_y () const
 Number of cols.

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

void shallow_copy (const Grid2D &source)
void deep_copy (const Grid2D &source)
virtual void shallow_copy (const Data2D &x)
virtual void shallow_copy (const Dim2D< X > &source)
virtual void deep_copy (const Data2D &x)
virtual void deep_copy (const DataType &source)
virtual void deep_copy (const Dim2D< X > &source)

Protected Attributes

InitSmartPtr< Impl > _impl
 The array of 1D types that is held.


Member Typedef Documentation

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

key-value pairs that describe the data.

template<class X>
typedef __normal_iterator<const X> code::Dim2D< X >::const_iterator [inherited]

template<class X>
typedef __normal_iterator<X> code::Dim2D< X >::iterator [inherited]


Member Enumeration Documentation

enum code::DataType::Type [inherited]

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


Constructor & Destructor Documentation

code::Grid2D::Grid2D (  ) 

For STL use only.

code::Grid2D::Grid2D ( const SpaceTimeRef origin,
const DLLH xAxis,
const DLLH yAxis,
const size_t &  nx,
const size_t &  ny 
)

Build an empty Grid2D.

Parameters:
const_SpaceTimeRef& time and origin grid point's Location
xAxis change in lat/lon/height from the origin that is the XAxis
yAxis change in lat/lon/height from the origin that is the yAxis
nx sample density along xAxis
ny sample density along yAxis

virtual code::Grid2D::~Grid2D (  )  [inline, virtual]

Call descendant destructor.


Member Function Documentation

template<class X>
const_iterator code::Dim2D< X >::begin (  )  const [inline, inherited]

template<class X>
iterator code::Dim2D< X >::begin (  )  [inline, inherited]

template<class X>
const X& code::Dim2D< X >::cell_ref ( size_t  row,
size_t  col 
) const [inline, inherited]

Deprecated alternative to dim2d[row][col].

template<class X>
X& code::Dim2D< X >::cell_ref ( size_t  row,
size_t  col 
) [inline, inherited]

Deprecated alternative to dim2d[row][col].

template<class X>
void code::Dim2D< X >::clear (  )  [inline, inherited]

resets this object to a 0x0 matrix

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

Grid2D code::Grid2D::clone (  )  const

A completely separate copy of this grid.

Reimplemented from code::Data2D< T3, T4, X >.

virtual Grid2D::DimType code::Grid2D::coord_value ( size_t  i,
size_t  j 
) const [virtual]

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

Implementation of virtual function in Data2D.

Reimplemented from code::Data2D< 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 T3, class T4, class X>
Datum<X> code::Data2D< T3, T4, X >::data ( size_t  i,
size_t  j 
) const [inline, inherited]

Return the datum of the specified element.

template<class X>
virtual void code::Dim2D< X >::deep_copy ( const Dim2D< X > &  source  )  [inline, protected, virtual, inherited]

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

template<class T3, class T4, class X>
virtual void code::Data2D< T3, T4, X >::deep_copy ( const Data2D< T3, T4, X > &  x  )  [inline, protected, virtual, inherited]

void code::Grid2D::deep_copy ( const Grid2D source  )  [protected]

template<class X>
int code::Dim2D< X >::dim_x (  )  const [inline, inherited]

Number of rows.

Reimplemented in code::Image< T >, code::Image< float >, and code::Image< int >.

template<class X>
int code::Dim2D< X >::dim_y (  )  const [inline, inherited]

Number of cols.

Reimplemented in code::Image< T >, code::Image< float >, and code::Image< int >.

template<class X>
const_iterator code::Dim2D< X >::end (  )  const [inline, inherited]

template<class X>
iterator code::Dim2D< X >::end (  )  [inline, inherited]

template<class X>
void code::Dim2D< X >::fill ( const X &  val,
size_t  row_begin,
size_t  row_end,
size_t  col_begin,
size_t  col_end 
) [inline, inherited]

Fill a 2D range with the specified value.

Equivalent, but more efficient, form of "for (i=ibegin; i<iend; ++i) for (j=jbegin; j<jend; ++j) d[i][j]=val;"

template<class X>
void code::Dim2D< X >::fill ( const X &  val  )  [inline, inherited]

Set the entire grid to a value.

template<class X>
void code::Dim2D< X >::get_1d_bounds ( size_t  row,
const X *&  setme_begin,
const X *&  setme_end 
) const [inline, inherited]

template<class X>
void code::Dim2D< X >::get_1d_bounds ( size_t  row,
X *&  setme_begin,
X *&  setme_end 
) [inline, inherited]

template<class X>
const_iterator code::Dim2D< X >::get_iterator ( size_t  row,
size_t  col 
) const [inline, inherited]

template<class X>
iterator code::Dim2D< X >::get_iterator ( size_t  row,
size_t  col 
) [inline, inherited]

template<class X>
X code::Dim2D< X >::get_val ( size_t  row,
size_t  col 
) const [inline, inherited]

Return a copy of the element in the specified coordinate.

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 Grid2D::DimType& code::Grid2D::getGridSpacing (  )  const

Return the angular spacing of grid points.

const Location& code::Grid2D::getOrigin (  )  const

Return the Location of the extreme northwest grid point.

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

virtual double code::DataType::getRawValue ( const Location ,
bool  = false 
) const [inline, virtual, inherited]

Gets raw value from data set.

Reimplemented in code::CartesianGrid2D, code::CartesianGrid3D, code::ElevationVolume, code::LatLonGrid, code::LatLonHeightGrid, code::RadialSet, code::SparseGrid, and code::WindFieldLLGVolume.

virtual SpaceTimeRef code::Grid2D::getSpaceTimeRef (  )  const [inline, virtual]

DimensionedData requires that this be implemented in the descendant.

Reimplemented from code::Data2D< T3, T4, X >.

const Time& code::Grid2D::getTime (  )  const

Return the Time of the grid.

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

Get enum type of this class.

Reimplemented from code::DataType.

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 void code::Grid2D::invoke ( Algorithm alg  )  [inline, virtual]

Use this to invoke any algorithm.

Reimplemented from code::DataType.

template<class X>
const X* code::Dim2D< X >::operator[] ( size_t  row  )  const [inline, inherited]

template<class X>
X* code::Dim2D< X >::operator[] ( size_t  row  )  [inline, inherited]

template<class X>
void code::Dim2D< X >::push_back ( const std::vector< X > &  v  )  [inline, inherited]

Add a row of elements.

template<class X>
void code::Dim2D< X >::push_back ( const X *  begin,
const X *  end 
) [inline, inherited]

Add a row of elements.

virtual SpaceTimeRef code::Grid2D::reference ( size_t  i,
size_t  j 
) const [virtual]

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

Implementation of virtual function in Data2D.

Reimplemented from code::Data2D< T3, T4, X >.

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

replace every instance of old_value with new_value

template<class X>
void code::Dim2D< X >::replace_1d ( int  row,
const std::vector< X > &  v 
) [inline, inherited]

Overwrite a 'row' of elements.

The number of new and old elements must match.

template<class X>
void code::Dim2D< X >::replace_1d ( size_t  row,
const X *  first,
const X *  last 
) [inline, inherited]

Overwrite a 'row' of elements.

The number of old and new elements must match.

template<class X>
void code::Dim2D< X >::replace_2d ( const Dim2D< X > &  d  )  [inline, inherited]

Overwrite the entire 2D.

This copies the elements from d, rather than sharing them. If you want to share them, use the assignment operator instead.

template<class X>
void code::Dim2D< X >::reserve ( size_t  rows,
size_t  cols 
) [inline, inherited]

ensure enough memory is allocated to populate an ROW x COL matrix.

template<class X>
void code::Dim2D< X >::resize ( size_t  rows,
size_t  cols,
const X &  value = X() 
) [inline, inherited]

resizes to a ROW x COL grid and sets each cell to `value'

template<class X>
void code::Dim2D< X >::set_2d ( size_t  x,
size_t  y,
const X **  values 
) [inline, inherited]

Repopulate the grid as an X x Y grid with a copy of `values'.

template<class X>
void code::Dim2D< X >::set_val ( size_t  row,
size_t  col,
const X &  value 
) [inline, inherited]

Slightly more efficient form of dim2d[row][col] = value.

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::DataType::setQuality ( SmartPtr< DataType dt  )  [inline, inherited]

void code::Grid2D::setTime ( const Time  ) 

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

Set the TypeName of this DataType.

template<class X>
virtual void code::Dim2D< X >::shallow_copy ( const Dim2D< X > &  source  )  [inline, protected, virtual, inherited]

template<class T3, class T4, class X>
virtual void code::Data2D< T3, T4, X >::shallow_copy ( const Data2D< T3, T4, X > &  x  )  [inline, protected, virtual, inherited]

void code::Grid2D::shallow_copy ( const Grid2D source  )  [protected]

Coord code::Grid2D::size (  )  const [inline]

Return the number of grid points along each direction.

Reimplemented from code::Dim2D< X >.

template<class X>
size_t code::Dim2D< X >::size_d ( size_t  row  )  const [inline, inherited]

number of columns.

template<class X>
size_t code::Dim2D< X >::size_d (  )  const [inline, inherited]

number of rows.


Member Data Documentation

template<class X>
InitSmartPtr< Impl > code::Dim2D< X >::_impl [protected, inherited]

The array of 1D types that is held.

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

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

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

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


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