OPeNDAP Hyrax Back End Server (BES)
Updated for version 3.8.3
|
Encapsulate the logic needed to handle geographical constraints when they are applied to DAP Grid (and some Array) variables. More...
#include <GeoConstraint.h>
Public Types | |
enum | LatitudeSense { unknown_sense, normal, inverted } |
Most of the time, latitude starts at the top of an array with positive values and ends up at the bottom with negative ones. More... | |
enum | Notation { unknown_notation, pos, neg_pos } |
The longitude extents of the constraint bounding box can be expressed two ways: using a 0/359 notation and using a -180/179 notation. More... | |
Public Member Functions | |
virtual void | apply_constraint_to_data ()=0 |
Once the bounding box is set use this method to apply the constraint. More... | |
void | set_bounding_box (double top, double left, double bottom, double right) |
Set the bounding box for this constraint. More... | |
virtual | ~GeoConstraint () |
Constructors | |
GeoConstraint () | |
Initialize GeoConstraint. More... | |
Accessors/Mutators | |
char * | get_array_data () const |
int | get_array_data_size () const |
double * | get_lat () const |
double * | get_lon () const |
void | set_lat (double *lat) |
void | set_lon (double *lon) |
int | get_lat_length () const |
int | get_lon_length () const |
void | set_lat_length (int len) |
void | set_lon_length (int len) |
Array::Dim_iter | get_lon_dim () const |
Array::Dim_iter | get_lat_dim () const |
void | set_lon_dim (Array::Dim_iter lon) |
void | set_lat_dim (Array::Dim_iter lat) |
int | get_latitude_index_top () const |
int | get_latitude_index_bottom () const |
void | set_latitude_index_top (int top) |
void | set_latitude_index_bottom (int bottom) |
int | get_longitude_index_left () const |
int | get_longitude_index_right () const |
void | set_longitude_index_left (int left) |
void | set_longitude_index_right (int right) |
bool | is_bounding_box_set () const |
bool | is_longitude_rightmost () const |
void | set_longitude_rightmost (bool state) |
Notation | get_longitude_notation () const |
LatitudeSense | get_latitude_sense () const |
void | set_longitude_notation (Notation n) |
void | set_latitude_sense (LatitudeSense l) |
set< string > | get_coards_lat_units () const |
set< string > | get_coards_lon_units () const |
set< string > | get_lat_names () const |
set< string > | get_lon_names () const |
Protected Member Functions | |
virtual bool | build_lat_lon_maps ()=0 |
A protected method that searches for latitude and longitude map vectors and sets six key internal fields. More... | |
virtual LatitudeSense | categorize_latitude () const |
Take a look at the latitude vector values and record whether the world is normal or upside down. More... | |
Notation | categorize_notation (const double left, const double right) const |
A private method that determines if the longitude part of the bounding box uses 0/359 or -180/179 notation. More... | |
void | find_latitude_indeces (double top, double bottom, LatitudeSense sense, int &latitude_index_top, int &latitude_index_bottom) const |
Scan from the top to the bottom, and the bottom to the top, looking for the top and bottom bounding box edges, respectively. More... | |
void | find_longitude_indeces (double left, double right, int &longitude_index_left, int &longitude_index_right) const |
Scan from the left to the right, and the right to the left, looking for the left and right bounding box edges, respectively. More... | |
virtual void | flip_latitude_within_array (Array &a, int lat_length, int lon_length) |
virtual bool | is_bounding_box_valid (const double left, const double top, const double right, const double bottom) const |
virtual bool | lat_lon_dimensions_ok ()=0 |
Are the latitude and longitude dimensions ordered so that this class can properly constrain the data? This method throws Error if lat and lon are not to two 'fastest-varying' (or 'rightmost) dimensions. More... | |
virtual void | reorder_data_longitude_axis (Array &a, Array::Dim_iter lon_dim) |
Reorder the data values relative to the longitude axis so that the reordered longitude map (see GeoConstraint::reorder_longitude_map()) and the data values match. More... | |
virtual void | reorder_longitude_map (int longitude_index_left) |
Reorder the elements in the longitude map so that the longitude constraint no longer crosses the edge of the map's storage. More... | |
void | transform_constraint_to_pos_notation (double &left, double &right) const |
virtual void | transform_longitude_to_neg_pos_notation () |
Given that the Grid has a longitude map that uses the 'pos' notation, transform it to the 'neg_pos' notation. More... | |
virtual void | transform_longitude_to_pos_notation () |
Given that the Grid has a longitude map that uses the 'neg_pos' notation, transform it to the 'pos' notation. More... | |
virtual void | transpose_vector (double *src, const int length) |
Given a vector of doubles, transpose the elements. More... | |
Friends | |
class | GridGeoConstraintTest |
Encapsulate the logic needed to handle geographical constraints when they are applied to DAP Grid (and some Array) variables.
This class will apply a longitude/latitude bounding box to a Grid that is a 'geo-referenced' Grid. That is, it follows the COARDS/CF conventions. This may be relaxed...
If the longitude range of the constraint crosses the boundary of the data array so that the constraint creates two separate rectangles, this class will arrange to return the result as a single Grid. It will do this by rearranging the data before control is passed onto the constraint evaluator and serialization logic. Here's a diagram of how it works:
Suppose a constraint for the longitude BB starts at the left edge of L and goes to the right edge of R:
0.0 180.0 360.0 (longitude, in degrees) +----------------------+ |xxxxxyyyyyyyyyyyyzzzzz| -----+ +----- | | | | | R | | L | | | | | -----+ +----- | | +----------------------+
For example, suppose the client provides a bounding box that starts at 200 degrees and ends at 80. This class will first copy the Left part to new storage and then copy the right part, thus 'stitching together' the two halves of the constraint. The result looks like:
80.0 360.0/0.0 180.0 ~200.0 (longitude, in degrees) +----------------------+ |zzzzzxxxxxxyyyyyyyyyyy| -----++----- | | || | | | L || R | | | || | | -----++----- | | | +----------------------+
The changes are made in the Grid variable itself, so once this is done the Grid should not be re-read by the CE or serialization code.
Definition at line 95 of file GeoConstraint.h.
Most of the time, latitude starts at the top of an array with positive values and ends up at the bottom with negative ones.
But sometimes... the world is upside down.
Enumerator | |
---|---|
unknown_sense | |
normal | |
inverted |
Definition at line 110 of file GeoConstraint.h.
The longitude extents of the constraint bounding box can be expressed two ways: using a 0/359 notation and using a -180/179 notation.
I call the 0/359 notation 'pos' and the -180/179 notation 'neg_pos'.
Enumerator | |
---|---|
unknown_notation | |
pos | |
neg_pos |
Definition at line 101 of file GeoConstraint.h.
libdap::GeoConstraint::GeoConstraint | ( | ) |
Initialize GeoConstraint.
Definition at line 549 of file GeoConstraint.cc.
|
inlinevirtual |
Definition at line 204 of file GeoConstraint.h.
|
pure virtual |
Once the bounding box is set use this method to apply the constraint.
Implemented in libdap::GridGeoConstraint.
|
protectedpure virtual |
A protected method that searches for latitude and longitude map vectors and sets six key internal fields.
This method returns false if either map cannot be found.
The d_lon, d_lon_length and d_lon_dim (and matching lat) fields must be set by this method.
|
protectedvirtual |
Take a look at the latitude vector values and record whether the world is normal or upside down.
Definition at line 331 of file GeoConstraint.cc.
Referenced by set_bounding_box().
|
protected |
A private method that determines if the longitude part of the bounding box uses 0/359 or -180/179 notation.
This class only supports latitude constraints which use 90/-90 notation, so there's no need to figure out what sort of notation they use.
left | The left side of the bounding box, in degrees |
right | The right side of the bounding box |
Definition at line 105 of file GeoConstraint.cc.
Referenced by set_bounding_box().
|
protected |
Scan from the top to the bottom, and the bottom to the top, looking for the top and bottom bounding box edges, respectively.
top | The top edge of the bounding box |
bottom | The bottom edge |
sense | Does the array/grid store data with larger latitudes at the starting indices or are the latitude 'upside down?' |
latitude_index_top | Value-result parameter that holds the index in the grid's latitude map of the top bounding box edge. Uses a closed interval for the test. |
latitude_index_bottom | Value-result parameter for the bottom edge index. |
Definition at line 280 of file GeoConstraint.cc.
Referenced by set_bounding_box().
|
protected |
Scan from the left to the right, and the right to the left, looking for the left and right bounding box edges, respectively.
left | The left edge of the bounding box |
right | The right edge |
longitude_index_left | Value-result parameter that holds the index in the grid's longitude map of the left bounding box edge. Uses a closed interval for the test. |
longitude_index_right | Value-result parameter for the right edge index. |
Definition at line 202 of file GeoConstraint.cc.
Referenced by set_bounding_box().
|
protectedvirtual |
Definition at line 390 of file GeoConstraint.cc.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data().
|
inline |
Definition at line 214 of file GeoConstraint.h.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data().
|
inline |
Definition at line 218 of file GeoConstraint.h.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data().
|
inline |
Definition at line 339 of file GeoConstraint.h.
|
inline |
Definition at line 343 of file GeoConstraint.h.
|
inline |
Definition at line 223 of file GeoConstraint.h.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data().
|
inline |
Definition at line 261 of file GeoConstraint.h.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data().
|
inline |
Definition at line 240 of file GeoConstraint.h.
|
inline |
Definition at line 348 of file GeoConstraint.h.
|
inline |
Definition at line 279 of file GeoConstraint.h.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data().
|
inline |
Definition at line 275 of file GeoConstraint.h.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data().
|
inline |
Definition at line 326 of file GeoConstraint.h.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data().
|
inline |
Definition at line 227 of file GeoConstraint.h.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data().
|
inline |
Definition at line 257 of file GeoConstraint.h.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data().
|
inline |
Definition at line 244 of file GeoConstraint.h.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data().
|
inline |
Definition at line 352 of file GeoConstraint.h.
|
inline |
Definition at line 292 of file GeoConstraint.h.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data().
|
inline |
Definition at line 296 of file GeoConstraint.h.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data().
|
inline |
Definition at line 322 of file GeoConstraint.h.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data().
|
inline |
Definition at line 309 of file GeoConstraint.h.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data().
|
protectedvirtual |
Definition at line 170 of file GeoConstraint.cc.
Referenced by set_bounding_box().
|
inline |
Definition at line 313 of file GeoConstraint.h.
|
protectedpure virtual |
Are the latitude and longitude dimensions ordered so that this class can properly constrain the data? This method throws Error if lat and lon are not to two 'fastest-varying' (or 'rightmost) dimensions.
It sets the internal property longitude_rightmost if that's true.
|
protectedvirtual |
Reorder the data values relative to the longitude axis so that the reordered longitude map (see GeoConstraint::reorder_longitude_map()) and the data values match.
Definition at line 473 of file GeoConstraint.cc.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data().
|
protectedvirtual |
Reorder the elements in the longitude map so that the longitude constraint no longer crosses the edge of the map's storage.
The d_lon field is modified.
longitude_index_left | The left edge of the bounding box. |
Definition at line 434 of file GeoConstraint.cc.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data().
void libdap::GeoConstraint::set_bounding_box | ( | double | top, |
double | left, | ||
double | bottom, | ||
double | right | ||
) |
Set the bounding box for this constraint.
After calling this method the object has values for the indexes for the latitude and longitude extent as well as the sense of the latitude (south pole at the top or bottom of the Array or Grid). These are used by the apply_constraint_to_data() method to actually constrain the data.
left | The left side of the bounding box. |
right | The right side |
top | The top |
bottom | The bottom |
Definition at line 589 of file GeoConstraint.cc.
References categorize_latitude(), categorize_notation(), find_latitude_indeces(), find_longitude_indeces(), inverted, is_bounding_box_valid(), neg_pos, transform_constraint_to_pos_notation(), and transform_longitude_to_pos_notation().
Referenced by libdap::function_geogrid().
|
inline |
Definition at line 231 of file GeoConstraint.h.
|
inline |
Definition at line 269 of file GeoConstraint.h.
|
inline |
Definition at line 248 of file GeoConstraint.h.
|
inline |
Definition at line 287 of file GeoConstraint.h.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data().
|
inline |
Definition at line 283 of file GeoConstraint.h.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data().
|
inline |
Definition at line 334 of file GeoConstraint.h.
|
inline |
Definition at line 235 of file GeoConstraint.h.
|
inline |
Definition at line 265 of file GeoConstraint.h.
|
inline |
Definition at line 252 of file GeoConstraint.h.
|
inline |
Definition at line 300 of file GeoConstraint.h.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data().
|
inline |
Definition at line 304 of file GeoConstraint.h.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data().
|
inline |
Definition at line 330 of file GeoConstraint.h.
|
inline |
Definition at line 317 of file GeoConstraint.h.
|
protected |
Definition at line 126 of file GeoConstraint.cc.
Referenced by set_bounding_box().
|
protectedvirtual |
Given that the Grid has a longitude map that uses the 'pos' notation, transform it to the 'neg_pos' notation.
This method modifies the d_lon array.
Definition at line 163 of file GeoConstraint.cc.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data().
|
protectedvirtual |
Given that the Grid has a longitude map that uses the 'neg_pos' notation, transform it to the 'pos' notation.
This method modifies the d_lon array.
Definition at line 144 of file GeoConstraint.cc.
Referenced by set_bounding_box().
|
protectedvirtual |
Given a vector of doubles, transpose the elements.
Use this to flip the latitude vector for a Grid that stores the southern latitudes at the top instead of the bottom.
src | A pointer to the vector |
length | The number of elements in the vector |
Definition at line 364 of file GeoConstraint.cc.
Referenced by libdap::GridGeoConstraint::apply_constraint_to_data().
|
friend |
Definition at line 196 of file GeoConstraint.h.