class_docstr: Dipole class for sequential dipole fits.
  
  .. note::
      This class should usually not be instantiated directly via
      ``mne.Dipole(...)``. Instead, use one of the functions
      listed in the See Also section below.
  
  Used to store positions, orientations, amplitudes, times, goodness of fit
  of dipoles, typically obtained with Neuromag/xfit, mne_dipole_fit
  or certain inverse solvers. Note that dipole position vectors are given in
  the head coordinate frame.
  
  Parameters
  ----------
  times : array, shape (n_dipoles,)
      The time instants at which each dipole was fitted (s).
  pos : array, shape (n_dipoles, 3)
      The dipoles positions (m) in head coordinates.
  amplitude : array, shape (n_dipoles,)
      The amplitude of the dipoles (Am).
  ori : array, shape (n_dipoles, 3)
      The dipole orientations (normalized to unit length).
  gof : array, shape (n_dipoles,)
      The goodness of fit.
  name : str | None
      Name of the dipole.
  conf : dict
      Confidence limits in dipole orientation for "vol" in m^3 (volume),
      "depth" in m (along the depth axis), "long" in m (longitudinal axis),
      "trans" in m (transverse axis), "qlong" in Am, and "qtrans" in Am
      (currents). The current confidence limit in the depth direction is
      assumed to be zero (although it can be non-zero when a BEM is used).
  
      .. versionadded:: 0.15
  khi2 : array, shape (n_dipoles,)
      The χ^2 values for the fits.
  
      .. versionadded:: 0.15
  nfree : array, shape (n_dipoles,)
      The number of free parameters for each fit.
  
      .. versionadded:: 0.15
  %(verbose)s
  
  See Also
  --------
  fit_dipole
  DipoleFixed
  read_dipole
  
  Notes
  -----
  This class is for sequential dipole fits, where the position
  changes as a function of time. For fixed dipole fits, where the
  position is fixed as a function of time, use :class:`mne.DipoleFixed`.
class_docstr_tok: ["Dipole","class","for","sequential","dipole","fits",".","..","note",":",":","This","class","should","usually","not","be","instantiated","directly","via","``","mne.Dipole","(","...",")","``",".","Instead",",","use","one","of","the","functions","listed","in","the","See","Also","section","below",".","Used","to","store","positions",",","orientations",",","amplitudes",",","times",",","goodness","of","fit","of","dipoles",",","typically","obtained","with","Neuromag\/xfit",",","mne_dipole_fit","or","certain","inverse","solvers",".","Note","that","dipole","position","vectors","are","given","in","the","head","coordinate","frame",".","Parameters","--","--","--","--","--","times",":","array",",","shape","(","n_dipoles",",",")","The","time","instants","at","which","each","dipole","was","fitted","(","s",")",".","pos",":","array",",","shape","(","n_dipoles",",","3",")","The","dipoles","positions","(","m",")","in","head","coordinates",".","amplitude",":","array",",","shape","(","n_dipoles",",",")","The","amplitude","of","the","dipoles","(","Am",")",".","ori",":","array",",","shape","(","n_dipoles",",","3",")","The","dipole","orientations","(","normalized","to","unit","length",")",".","gof",":","array",",","shape","(","n_dipoles",",",")","The","goodness","of","fit",".","name",":","str","|","None","Name","of","the","dipole",".","conf",":","dict","Confidence","limits","in","dipole","orientation","for","``","vol","''","in","m^3","(","volume",")",",","``","depth","''","in","m","(","along","the","depth","axis",")",",","``","long","''","in","m","(","longitudinal","axis",")",",","``","trans","''","in","m","(","transverse","axis",")",",","``","qlong","''","in","Am",",","and","``","qtrans","''","in","Am","(","currents",")",".","The","current","confidence","limit","in","the","depth","direction","is","assumed","to","be","zero","(","although","it","can","be","non-zero","when","a","BEM","is","used",")",".","..","versionadded",":",":","0.15","khi2",":","array",",","shape","(","n_dipoles",",",")","The","\u03c7^2","values","for","the","fits",".","..","versionadded",":",":","0.15","nfree",":","array",",","shape","(","n_dipoles",",",")","The","number","of","free","parameters","for","each","fit",".","..","versionadded",":",":","0.15","%","(","verbose",")","s","See","Also","--","--","--","--","fit_dipole","DipoleFixed","read_dipole","Notes","--","--","-","This","class","is","for","sequential","dipole","fits",",","where","the","position","changes","as","a","function","of","time",".","For","fixed","dipole","fits",",","where","the","position","is","fixed","as","a","function","of","time",",","use",":","class",":","`","mne.DipoleFixed","`","."]
code: def __init__(
      self,
      times,
      pos,
      amplitude,
      ori,
      gof,
      name=None,
      conf=None,
      khi2=None,
      nfree=None,
      *,
      verbose=None,
  ):
      self._set_times(np.array(times))
      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
  
imports: import functools
  import re
  from copy import deepcopy
  from functools import partial
  import numpy
  from scipy.linalg import eigh
  from scipy.optimize import fmin_cobyla
  from ._fiff.constants import FIFF
  from ._fiff.pick import pick_types
  from ._fiff.proj import _needs_eeg_average_ref_proj, make_projector
  from ._freesurfer import _get_aseg, head_to_mni, head_to_mri, read_freesurfer_lut
  from .bem import _bem_find_surface, _bem_surf_name, _fit_sphere
  from .cov import _ensure_cov, compute_whitener
  from .evoked import _aspect_rev, _read_evoked, _write_evokeds
  from .fixes import _safe_svd, pinvh
  from .forward._compute_forward import _compute_forwards_meeg, _prep_field_computation
  from .forward._make_forward import _get_trans, _prep_eeg_channels, _prep_meg_channels, _setup_bem
  from .parallel import parallel_func
  from .source_space._source_space import SourceSpaces, _make_volume_source_space
  from .surface import _compute_nearest, _points_outside_surface, transform_surface_to
  from .transforms import _coord_frame_name, _print_coord_trans, apply_trans
  from .utils import ExtendedTimeMixin, TimeMixin, _check_fname, _check_option, _get_blas_funcs, _pl, _repeated_svd, _svd_lwork, _time_mask, _validate_type, _verbose_safe_false, check_fname, copy_function_doc_to_method_doc, fill_doc, logger, verbose, warn
  from .viz import plot_dipole_amplitudes, plot_dipole_locations
  from .viz.evoked import _plot_evoked
label_desc: Use image node_id 1 to create a new Dipole object from inherited base classes: TimeMixin with example: obj = Dipole(times, pos, amplitude, ori, gof, name, conf, khi2, nfree)