prospect.surveyunit

class prospect.surveyunit.SurveyUnit(name: str, coverage_name: str, shape: shapely.geometry.polygon.Polygon, surveyunit_type: str, length: Optional[float] = None, radius: Optional[float] = None, min_time_per_unit: Union[float, scipy.stats._distn_infrastructure.rv_frozen] = 0.0)[source]

Bases: object

Represents a spatial unit of survey like a transect or radial unit.

This class is not normally used directly. It is usually more efficient to use the constructor methods of the Coverage class to create many SurveyUnit objects at once.

Parameters
  • name (str) – Unique name for the survey unit

  • coverage_name (str) – Name of the parent coverage

  • shape (Polygon) – Geographic specification

  • surveyunit_type ({'transect', 'radial'}) – Type of the unit

  • length (float, optional) – Length of transect units (the default is None)

  • radius (float, optional) – Radius of radial units (the default is None)

  • min_time_per_unit (Union[float, rv_frozen], optional) –

    Minimum amount of time required to complete one “unit” of survey, given no surveyor speed penalty and no time penalty for recording features. The default is 0.0.

    Because transects can differ in length, transect coverages should specify this term as time per one unit of distance (e.g., seconds per meter).

    For radial survey units, this term should be specified more simply as time per one survey unit.

name

Unique name for the survey unit

Type

str

coverage_name

Name of the parent coverage

Type

str

shape

Geographic specification

Type

Polygon

surveyunit_type

Type of the unit

Type

{‘transect’, ‘radial’}

surveyunit_area

Area value calculated from the shape

Type

float

length

Length of transect units

Type

float

radius

Radius of radial units

Type

float

min_time_per_unit

Minimum amount of time required to complete one “unit” of survey, given no surveyor speed penalty and no time penalty for recording features.

Because transects can differ in length, transect coverages should specify this term as time per one unit of distance (e.g., seconds per meter).

For radial survey units, this term should be specified more simply as time per one survey unit.

Type

Union[float, rv_frozen]

to_dict()Dict[source]

Create dictionary from attributes to allow easy DataFrame creation by Coverage.

Returns

Dictionary containing pairs of class attributes and their values

Return type

dict