from typing import Dict, Union
from scipy.stats._distn_infrastructure import rv_frozen
from shapely.geometry import LineString, Point, Polygon
[docs]class Feature:
"""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.
Attributes
----------
name : str
Unique name for the feature
layer_name : str
Name of parent layer
shape : Union[Point, LineString, Polygon]
Geographic specification
time_penalty : Union[float, rv_frozen]
Minimum amount of time it takes to record a feature
ideal_obs_rate : Union[float, rv_frozen]
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
"""
def __init__(
self,
name: str,
layer_name: str,
shape: Union[Point, LineString, Polygon],
time_penalty: Union[float, rv_frozen] = 0.0,
ideal_obs_rate: Union[float, rv_frozen] = 1.0,
):
"""Create a `Feature` instance."""
self.name = name
self.layer_name = layer_name
self.shape = shape
self.time_penalty = time_penalty
self.ideal_obs_rate = ideal_obs_rate
[docs] def to_dict(self) -> Dict:
"""Create dictionary from attributes to allow easy DataFrame creation
by `Layer`.
Returns
-------
dict
Dictionary containing pairs of class attributes and their values
"""
return {
"feature_name": self.name,
"layer_name": self.layer_name,
"shape": self.shape,
"time_penalty": self.time_penalty,
"ideal_obs_rate": self.ideal_obs_rate,
}
