Skip to content

mne.Dipole attributes not documented in API docs #13150

@sappelhoff

Description

@sappelhoff

An mne.Dipole object has several attributes like the goodness of fit (gof), see:

mne-python/mne/dipole.py

Lines 134 to 144 in be27cf8

self.pos = np.array(pos)
self.amplitude = np.array(amplitude)
self.ori = np.array(ori)
self.gof = np.array(gof)
self.name = name
self.conf = dict()
if conf is not None:
for key, value in conf.items():
self.conf[key] = np.array(value)
self.khi2 = np.array(khi2) if khi2 is not None else None
self.nfree = np.array(nfree) if nfree is not None else None

However in the API docs, only "times" is documented:


Image


Should sphinx not pick these up automatically?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions