prospect.feature

class prospect.feature.Feature(name: str, layer_name: str, shape: Union[shapely.geometry.point.Point, shapely.geometry.linestring.LineString, shapely.geometry.polygon.Polygon], time_penalty: Union[float, scipy.stats._distn_infrastructure.rv_frozen] = 0.0, ideal_obs_rate: Union[float, scipy.stats._distn_infrastructure.rv_frozen] = 1.0)[source]

Bases: object

Represents an observable thing like an artifact or landscape feature.

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

Parameters

  • name (str) – Unique name for the feature

  • layer_name (str) – Name of the parent layer

  • shape (Union[Point, LineString, Polygon]) – Geographic specification

  • time_penalty (Union[float, rv_frozen], optional) – Minimum amount of time it takes to record a feature (the default is 0.0, which indicates no time cost for feature recording)

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

    Ideal observation rate: the frequency with which an artifact or feature will be recorded, assuming the following ideal conditions:

    • It lies inside or intersects the Coverage

    • Surface visibility is 100%

    • The surveyor is highly skilled

    The default is 1.0, which indicates that when visibility and surveyor skill allow, the feature will always be recorded.

name

Unique name for the feature

Type

str

layer_name

Name of parent layer

Type

str

shape

Geographic specification

Type

Union[Point, LineString, Polygon]

time_penalty

Minimum amount of time it takes to record a feature

Type

Union[float, rv_frozen]

ideal_obs_rate

Ideal observation rate: the frequency with which an artifact or feature will be recorded, assuming the following ideal conditions:

  • It lies inside or intersects the Coverage

  • Surface visibility is 100%

  • The surveyor is highly skilled

Type

Union[float, rv_frozen]

to_dict() → Dict[source]

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

Returns

Dictionary containing pairs of class attributes and their values

Return type

dict

prospect.assemblage prospect.layer