reVX.least_cost_xmission.costs.wet_cost_creator.WetCostCreator

class WetCostCreator(io_handler: LayeredTransmissionH5, mask=None, output_tiff_dir='.', dtype: dtype[Any] | None | Type[Any] | _SupportsDType[dtype[Any]] | str | Tuple[Any, int] | Tuple[Any, SupportsIndex | Sequence[SupportsIndex]] | List[Any] | _DTypeDict | Tuple[Any, Any] = 'float32')[source]

Bases: LayerCreator

Create offshore costs and save to GeoTIFF.

Parameters:

  • io_handler (LayeredTransmissionH5) – Transmission layer IO handler

  • mask (ndarray, optional) – Array representing mask for layer values. Only optional if subclass implementation handles masks differently (e.g. the FrictionBarrierBuilder class). By default, None

  • output_tiff_dir (path-like, optional) – Directory where cost layers should be saved as GeoTIFF. By default, ".".

  • dtype (np.dtype, optional) – Data type for final dataset. By default, float32.

Methods

build(bathy_tiff, bins[, wet_layer_name])

Build complete offshore costs.

Attributes

shape

Layer shape.
build(bathy_tiff: str, bins: List[RangeConfig], wet_layer_name: str = 'wet_costs')[source]

Build complete offshore costs. This is currently very simple. In the future, costs will also vary with distance to port.

Parameters:

  • bathy_tiff (path-like) – Bathymetric depth GeoTIFF. Values underwater should be negative.

  • bins (list) – List of bins to use for assigning depth based costs.

  • wet_layer_name (str) – Name for wet costs in H5 file

property shape

Layer shape.

Type:

tuple