MatricesBase.aggregate#

MatricesBase.aggregate(segmentation_, output_name='{name}-aggregated', progress_bar=True)[source]#

Aggregate matrices to target segmentation.

Outputs aggregated to a new matrices class.

Parameters:

  • segmentation (segmentation.Segmentation) – Segmentation to aggregate to, must be a subset of current segmentation.

  • output_name (str) – Name for the output matrices, default “{name}-aggregated”, where name is self.name.

  • progress_bar (bool) – If True display progress bar for aggregation.

  • segmentation_ (Segmentation)

Returns:

Aggregated matrices class.

Return type:

Self

Raises:

ValueError – If segmentation_ isn’t a subset of self.segmentation.