magmap.atlas.reg_tasks module¶

Atlas-related (“register”) tasks for MagellanMapper

magmap.atlas.reg_tasks.build_labels_diff_images(paths=None)[source]¶

Build labels difference images or regional heat maps for given metrics.

Replaces each label in an atlas labels image with the metric value.

magmap.settings.config.PlotLabels.X_COL in magmap.settings.config.plot_labels can be used to change the metric column, which otherwise defaults to “vals.effect”.

Parameters:: paths (Optional[Sequence[str]], default: None) – Paths to volume stat files output from the R pipeline or output from the --register vol_stats pipeline (magmap.atlas.register.volumes_by_id()).