nilearn.maskers: Extracting Signals from Brain Images

The nilearn.maskers contains masker objects.

User guide: See the NiftiMasker: applying a mask to load time-series section for further details.

Classes

BaseMasker()

Base class for NiftiMaskers.

NiftiMasker([mask_img, runs, ...])

Applying a mask to extract time-series from Niimg-like objects.

MultiNiftiMasker([mask_img, runs, ...])

Applying a mask to extract time-series from multiple Niimg-like objects.

NiftiLabelsMasker([labels_img, labels, lut, ...])

Class for extracting data from Niimg-like objects using labels of non-overlapping brain regions.

MultiNiftiLabelsMasker([labels_img, labels, ...])

Class for extracting data from multiple Niimg-like objects using labels of non-overlapping brain regions.

NiftiMapsMasker([maps_img, mask_img, ...])

Class for extracting data from Niimg-like objects using maps of potentially overlapping brain regions.

MultiNiftiMapsMasker([maps_img, mask_img, ...])

Class for extracting data from multiple Niimg-like objects using maps of potentially overlapping brain regions.

NiftiSpheresMasker([seeds, radius, ...])

Class for masking of Niimg-like objects using seeds.

SurfaceMasker([mask_img, smoothing_fwhm, ...])

Extract data from a SurfaceImage.

MultiSurfaceMasker([mask_img, ...])

Extract time-series from multiple SurfaceImage objects.

SurfaceLabelsMasker([labels_img, labels, ...])

Extract data from a SurfaceImage, averaging over atlas regions.

MultiSurfaceLabelsMasker([labels_img, ...])

Extract time-series from multiple SurfaceImage objects.

SurfaceMapsMasker([maps_img, mask_img, ...])

Extract data from a SurfaceImage, using maps of potentially overlapping brain regions.

MultiSurfaceMapsMasker([maps_img, mask_img, ...])

Extract time-series from multiple SurfaceImage objects.

 
        classDiagram
  BaseEstimator <|-- BaseMasker
  BaseEstimator <|-- _BaseSurfaceMasker
  BaseMasker <|-- NiftiLabelsMasker
  BaseMasker <|-- NiftiMapsMasker
  BaseMasker <|-- NiftiMasker
  BaseMasker <|-- NiftiSpheresMasker
  CacheMixin <|-- BaseMasker
  CacheMixin <|-- _BaseSurfaceMasker
  ClassNamePrefixFeaturesOutMixin <|-- NiftiMapsMasker
  ClassNamePrefixFeaturesOutMixin <|-- NiftiMasker
  ClassNamePrefixFeaturesOutMixin <|-- NiftiSpheresMasker
  ClassNamePrefixFeaturesOutMixin <|-- SurfaceMapsMasker
  ClassNamePrefixFeaturesOutMixin <|-- SurfaceMasker
  NiftiLabelsMasker <|-- MultiNiftiLabelsMasker
  NiftiMapsMasker <|-- MultiNiftiMapsMasker
  NiftiMasker <|-- MultiNiftiMasker
  ReprHTMLMixin <|-- BaseEstimator
  SurfaceLabelsMasker <|-- MultiSurfaceLabelsMasker
  SurfaceMapsMasker <|-- MultiSurfaceMapsMasker
  SurfaceMasker <|-- MultiSurfaceMasker
  TransformerMixin <|-- BaseMasker
  TransformerMixin <|-- _BaseSurfaceMasker
  _BaseSurfaceMasker <|-- SurfaceLabelsMasker
  _BaseSurfaceMasker <|-- SurfaceMapsMasker
  _BaseSurfaceMasker <|-- SurfaceMasker
  _HTMLDocumentationLinkMixin <|-- BaseEstimator
  _LabelMaskerMixin <|-- NiftiLabelsMasker
  _LabelMaskerMixin <|-- SurfaceLabelsMasker
  _MetadataRequester <|-- BaseEstimator
  _MultiMixin <|-- MultiNiftiLabelsMasker
  _MultiMixin <|-- MultiNiftiMapsMasker
  _MultiMixin <|-- MultiNiftiMasker
  _MultiMixin <|-- MultiSurfaceLabelsMasker
  _MultiMixin <|-- MultiSurfaceMapsMasker
  _MultiMixin <|-- MultiSurfaceMasker
  _SetOutputMixin <|-- TransformerMixin