4.1.3. GridPoint¶

class pyprom.lib.locations.gridpoint.GridPoint(x, y, elevation)[source]¶

A GridPoint Object. This is a Child of pyprom.lib.locations.base_gridpoint.BaseGridPoint In essence, this is an x,y coordinate which also includes elevation.

__eq__(other)[source]¶

Parameters: other (GridPoint) – object which we compare against.
Returns: equality
Return type: bool
Raises: TypeError if other not of GridPoint

__hash__()[source]¶

Returns: hash representation of this object.
Return type: str

__init__(x, y, elevation)[source]¶

Parameters

x (int) – x coordinate
y (int) – y coordinate
elevation (float, int) – elevation in meters

__lt__(other)[source]¶

Parameters: other (GridPoint) – object which we compare against.
Returns: bool of if self is of lower elevation than other.
Return type: bool
Raises: TypeError if other not of GridPoint

__ne__(other)[source]¶

Parameters: other (GridPoint) – object which we compare against.
Returns: inequality
Return type: bool
Raises: TypeError if other not of GridPoint

__repr__()[source]¶

Returns: String representation of this object

__str__()¶

Returns: String representation of this object

__unicode__()¶

Returns: String representation of this object

classmethod from_dict(gridPointDict)[source]¶

Create this object from dictionary representation

Parameters: gridPointDict (dict) – dict() representation of this object.
Returns: GridPoint from dict()
Return type: GridPoint

classmethod from_tuple(tup)[source]¶: Create this object from tuple representation :param tup: :return: GridPoint from tuple() :rtype: GridPoint

toSpotElevation(datamap)[source]¶

Converts this GridPoint into a SpotElevation using a datamap.

Parameters: datamap (pyprom.lib.datamap.DataMap) – Datamap object
Returns: GridPoint as a SpotElevation object.
Return type: pyprom.lib.locations.spot_elevation.SpotElevation

to_dict()[source]¶

Returns: dict() representation of GridPoint

to_tuple()[source]¶

Returns: tuple() representation of GridPoint