Note

This page is a reference documentation. It only explains the class signature, and not how to use it. Please refer to the user guide for the big picture.

nilearn.utils.InputTags

class nilearn.utils.InputTags(one_d_array=False, two_d_array=True, three_d_array=False, sparse=False, categorical=False, string=False, dict=False, positive_only=False, allow_nan=False, pairwise=False, niimg_like=True, surf_img=False)

Tags for the input data.

Nilearn version of sklearn.utils.InputTags with two extra tags for neuroimaging inputs. All other parameters are those of sklearn.utils.InputTags.

Added in Nilearn 0.15.0.

Parameters:

niimg_likebool, default=True

Whether the estimator accepts Niimg-like inputs.

surf_imgbool, default=False

Whether the estimator accepts SurfaceImage inputs.

__init__(one_d_array=False, two_d_array=True, three_d_array=False, sparse=False, categorical=False, string=False, dict=False, positive_only=False, allow_nan=False, pairwise=False, niimg_like=True, surf_img=False)

allow_nan

categorical

dict

niimg_like = True

one_d_array

pairwise

positive_only

sparse

string

surf_img = False

three_d_array

two_d_array