nimare.results
.MetaResult
- class MetaResult(estimator, mask, maps=None)[source]
Bases:
object
Base class for meta-analytic results.
- Parameters
- Variables
~MetaResult.estimator (
Estimator
) – The Estimator used to generate the maps in the MetaResult.~MetaResult.masker (
NiftiMasker
or similar) – Masker object.~MetaResult.maps (
dict
) – Keys are map names and values are arrays.
Methods
copy
()Return copy of result object.
get_map
(name[, return_type])Get stored map as image or array.
save_maps
([output_dir, prefix, prefix_sep, ...])Save results to files.
- get_map(name, return_type='image')[source]
Get stored map as image or array.
- Parameters
name (
str
) – Name of the map. Used to index self.maps.return_type ({'image', 'array'}, optional) – Whether to return a niimg (‘image’) or a numpy array. Default is ‘image’.
- save_maps(output_dir='.', prefix='', prefix_sep='_', names=None)[source]
Save results to files.
- Parameters
output_dir (
str
, optional) – Output directory in which to save results. If the directory doesn’t exist, it will be created. Default is current directory.prefix (
str
, optional) – Prefix to prepend to output file names. Default is None.prefix_sep (
str
, optional) – Separator to add between prefix and default file names. Default is _.names (None or
list
ofstr
, optional) – Names of specific maps to write out. If None, save all maps. Default is None.