onstove.OnStove.add_mask_layer

OnStove.add_mask_layer(category: str, name: str, path: str, query: str = None, postgres: bool = False)

Adds a vector layer to self.mask_layer, which will be used to mask all other layers into is boundaries

Parameters:

category: str

Category name of the dataset.

name: str

name of the dataset.

path: str

The relative path to the datafile. This file can be of any type that is accepted by geopandas.read_file.

query: str, optional

A query string to filter the data. For more information refer to pandas.DataFrame.query.

postgres: bool, default False

Whether to use a PostgreSQL database connection to read the layer from. The connection needs be already created and stored in the conn attribute using the set_postgres() method.