onstove.MCA.mask_layers#

MCA.mask_layers(datasets: dict[str, list[str]] = 'all', crop: bool = True, save_layers: bool = False)#

Uses the mask layer in self.mask_layer to mask layers to its boundaries.

Parameters:

datasets: dictionary of ``category``-``list of layer names`` pairs, default ‘all’

Specifies which dataset(s) to clip.

Example#

datasets={'category_1': ['layer_1', 'layer_2'],
          'category_2': [...]}

crop: boolean, default True

Determines whether to crop the masked layers extent to the mask layers extent.

save_layers: boolean, default False

Determines whether to save the reprojected layer to disc or not.