Container for volume source estimates. Parameters ---------- data : array of shape (n_dipoles, 3, n_times) The data in source space. Each dipole contains three vectors that denote the dipole strength in X, Y and Z directions over time. %(vertices_volume)s %(tmin)
| 2715 | |
| 2716 | @fill_doc |
| 2717 | class VolVectorSourceEstimate(_BaseVolSourceEstimate, _BaseVectorSourceEstimate): |
| 2718 | """Container for volume source estimates. |
| 2719 | |
| 2720 | Parameters |
| 2721 | ---------- |
| 2722 | data : array of shape (n_dipoles, 3, n_times) |
| 2723 | The data in source space. Each dipole contains three vectors that |
| 2724 | denote the dipole strength in X, Y and Z directions over time. |
| 2725 | %(vertices_volume)s |
| 2726 | %(tmin)s |
| 2727 | %(tstep)s |
| 2728 | %(subject_optional)s |
| 2729 | %(verbose)s |
| 2730 | |
| 2731 | Attributes |
| 2732 | ---------- |
| 2733 | subject : str | None |
| 2734 | The subject name. |
| 2735 | times : array of shape (n_times,) |
| 2736 | The time vector. |
| 2737 | %(vertices_volume)s |
| 2738 | data : array of shape (n_dipoles, n_times) |
| 2739 | The data in source space. |
| 2740 | shape : tuple |
| 2741 | The shape of the data. A tuple of int (n_dipoles, n_times). |
| 2742 | |
| 2743 | See Also |
| 2744 | -------- |
| 2745 | SourceEstimate : A container for surface source estimates. |
| 2746 | VectorSourceEstimate : A container for vector surface source estimates. |
| 2747 | VolSourceEstimate : A container for volume source estimates. |
| 2748 | MixedSourceEstimate : A container for mixed surface + volume source |
| 2749 | estimates. |
| 2750 | |
| 2751 | Notes |
| 2752 | ----- |
| 2753 | .. versionadded:: 0.9.0 |
| 2754 | """ |
| 2755 | |
| 2756 | _scalar_class = VolSourceEstimate |
| 2757 | |
| 2758 | # defaults differ: hemi='both', views='axial' |
| 2759 | @copy_function_doc_to_method_doc(plot_vector_source_estimates) |
| 2760 | def plot_3d( |
| 2761 | self, |
| 2762 | subject=None, |
| 2763 | hemi="both", |
| 2764 | colormap="hot", |
| 2765 | time_label="auto", |
| 2766 | smoothing_steps=10, |
| 2767 | transparent=True, |
| 2768 | brain_alpha=0.4, |
| 2769 | overlay_alpha=None, |
| 2770 | vector_alpha=1.0, |
| 2771 | scale_factor=None, |
| 2772 | time_viewer="auto", |
| 2773 | *, |
| 2774 | subjects_dir=None, |
no outgoing calls