nimare.meta.kernel
.Peaks2MapsKernel
- class Peaks2MapsKernel(model_dir='auto')[source]
Bases:
KernelTransformer
Generate peaks2maps modeled activation images from coordinates.
Deprecated since version 0.0.11:
Peaks2MapsKernel
will be removed in NiMARE 0.0.13.- Parameters
model_dir (
str
, optional) – Path to model directory. Default is “auto”.
Warning
Peaks2MapsKernel is not intended for serious research. We strongly recommend against using it for any meaningful analyses.
Methods
get_params
([deep])Get parameters for this estimator.
load
(filename[, compressed])Load a pickled class instance from file.
save
(filename[, compress])Pickle the class instance to the provided file.
set_params
(**params)Set the parameters of this estimator.
transform
(dataset[, masker, return_type])Generate modeled activation images for each Contrast in dataset.
- classmethod load(filename, compressed=True)[source]
Load a pickled class instance from file.
- Parameters
- Returns
obj – Loaded class object.
- Return type
class object
- set_params(**params)[source]
Set the parameters of this estimator.
The method works on simple estimators as well as on nested objects (such as pipelines). The latter have parameters of the form
<component>__<parameter>
so that it’s possible to update each component of a nested object.- Return type
self
- transform(dataset, masker=None, return_type='image')[source]
Generate modeled activation images for each Contrast in dataset.
- Parameters
dataset (
Dataset
orpandas.DataFrame
) – Dataset for which to make images. Can be a DataFrame if necessary.masker (img_like or None, optional) – Mask to apply to MA maps. Required if
dataset
is a DataFrame. If None (anddataset
is a Dataset), the Dataset’s masker attribute will be used. Default is None.return_type ({'sparse', 'array', 'image', 'dataset'}, optional) – Whether to return a numpy array (‘array’), a list of niimgs (‘image’), or a Dataset with MA images saved as files (‘dataset’). Default is ‘image’.
- Returns
imgs – If return_type is ‘sparse’, a 4D sparse array (E x S), where E is the number of unique experiments, and the remaining 3 dimensions are equal to shape of the images. If return_type is ‘array’, a 2D numpy array (C x V), where C is contrast and V is voxel. If return_type is ‘image’, a list of modeled activation images (one for each of the Contrasts in the input dataset). If return_type is ‘dataset’, a new Dataset object with modeled activation images saved to files and referenced in the Dataset.images attribute.
- Return type
(C x V)
numpy.ndarray
orlist
ofnibabel.Nifti1Image
orDataset
- Variables