prospect.area

class prospect.area.Area(name: str, shape: shapely.geometry.polygon.Polygon, vis: Union[float, scipy.stats._distn_infrastructure.rv_frozen] = 1.0)[source]

Bases: object

Spatial extent of the survey

Parameters

  • name (str) – Unique name for the area

  • shape (Polygon) – Geographic specification

  • vis (Union[float, rv_frozen], optional) – Surface visibility (the default is 1.0, which means perfect surface visibility)

name

Name of the area

Type

str

shape

Geographic specification

Type

Polygon

vis

Surface visibility

Type

Union[float, rv_frozen]

df

GeoDataFrame with one row that summarizes the area’s attributes

Type

geopandas GeoDataFrame

classmethod from_area_value(name: str, value: float, origin: Tuple[float, float] = (0.0, 0.0), vis: Union[float, scipy.stats._distn_infrastructure.rv_frozen] = 1.0) → prospect.area.Area[source]

Create a square Area object by specifying its area

Parameters

  • name (str) – Unique name for the area

  • value (float) – Area of the output shape

  • origin (Tuple[float, float]) – Location of the bottom left corner of square

  • vis (Union[float, rv_frozen]) – Surface visibility

Returns

Return type

Area

classmethod from_shapefile(name: str, path: str, vis: Union[float, scipy.stats._distn_infrastructure.rv_frozen] = 1.0, **kwargs) → prospect.area.Area[source]

Create an Area object from a shapefile

Parameters

  • name (str) – Unique name for the area

  • path (str) – File path to the shapefile

  • vis (Union[float, rv_frozen]) – Surface visibility

Returns

Return type

Area

Survey prospect.assemblage