mne.io.get_channel_type_constants

mne.io.get_channel_type_constants(include_defaults=False)

Return all known channel types, and associated FIFF constants.

Parameters:

include_defaultsbool

Whether to include default values for “unit” and “coil_type” for all entries (see Notes). Defaults are generally based on values normally present for a VectorView MEG system. Defaults to False.

Returns:

channel_typesdict

The keys are channel type strings, and the values are dictionaries of FIFF constants for “kind”, and possibly “unit” and “coil_type”.

Notes

Values which might vary within a channel type across real data recordings are excluded unless include_defaults=True. For example, “ref_meg” channels may have coil type FIFFV_COIL_MAGNES_OFFDIAG_REF_GRAD, FIFFV_COIL_VV_MAG_T3, etc (depending on the recording system), so no “coil_type” entry is given for “ref_meg” unless include_defaults is requested.