nilearn
tit.plotting.nilearn ¶
TI-Toolbox Nilearn plotting helpers.
This package contains "basic" neuroimaging plotting utilities (non-blender), including: - Slice PDF exports - Glass brain exports - Interactive HTML views
NilearnVisualizer ¶
NilearnVisualizer(subject_id: str | None = None)
Main visualization class for electric field distributions.
Provides methods for creating both static PDF visualizations and interactive HTML plots. Uses PathManager for consistent path handling and supports multiple atlas overlays.
Initialize the visualizer.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
subject_id
|
str | None
|
Subject ID (optional, will use PathManager detection if not provided) |
None
|
Source code in tit/plotting/nilearn/visualizer.py
create_pdf_visualization ¶
create_pdf_visualization(subject_id: str, simulation_name: str, min_cutoff: float = 0.3, max_cutoff: float = None, atlas_name: str = 'harvard_oxford_sub', selected_regions: list[int] | None = None) -> str | None
Create PDF visualization with multiple surface views and atlas contours.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
subject_id
|
str
|
Subject ID |
required |
simulation_name
|
str
|
Name of the simulation |
required |
min_cutoff
|
float
|
Minimum cutoff for visualization (V/m) |
0.3
|
max_cutoff
|
float
|
Maximum cutoff for visualization (V/m), if None uses 99.9th percentile |
None
|
atlas_name
|
str
|
Name of atlas to overlay |
'harvard_oxford_sub'
|
selected_regions
|
list[int] | None
|
List of region indices to include (0-indexed), if None includes all |
None
|
Returns:
| Type | Description |
|---|---|
str | None
|
Path to saved PDF file or None if failed |
Source code in tit/plotting/nilearn/visualizer.py
create_html_visualization ¶
create_html_visualization(subject_id: str, simulation_name: str, min_cutoff: float = 0.3) -> str | None
Create interactive HTML visualization.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
subject_id
|
str
|
Subject ID |
required |
simulation_name
|
str
|
Name of the simulation |
required |
min_cutoff
|
float
|
Minimum cutoff for visualization (V/m) |
0.3
|
Returns:
| Type | Description |
|---|---|
str | None
|
Path to saved HTML file or None if failed |
Source code in tit/plotting/nilearn/visualizer.py
create_pdf_visualization_group ¶
create_pdf_visualization_group(averaged_img, base_filename: str, output_dir: str, min_cutoff: float = 0.3, max_cutoff: float = None, atlas_name: str = 'harvard_oxford_sub', selected_regions: list[int] | None = None) -> str | None
Create PDF visualization with pre-averaged nifti data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
averaged_img
|
Pre-averaged nibabel Nifti1Image |
required | |
base_filename
|
str
|
Base filename for output (without extension) |
required |
output_dir
|
str
|
Output directory path |
required |
min_cutoff
|
float
|
Minimum cutoff for visualization (V/m) |
0.3
|
max_cutoff
|
float
|
Maximum cutoff for visualization (V/m), if None uses 99.9th percentile |
None
|
atlas_name
|
str
|
Name of atlas to overlay |
'harvard_oxford_sub'
|
selected_regions
|
list[int] | None
|
List of region indices to include (0-indexed), if None includes all |
None
|
Returns:
| Type | Description |
|---|---|
str | None
|
Path to saved PDF file or None if failed |
Source code in tit/plotting/nilearn/visualizer.py
create_glass_brain_visualization ¶
create_glass_brain_visualization(subject_id: str, simulation_name: str, min_cutoff: float = 0.3, max_cutoff: float = None, cmap: str = 'hot') -> str | None
Create glass brain visualization using nilearn's plot_glass_brain.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
subject_id
|
str
|
Subject ID |
required |
simulation_name
|
str
|
Name of the simulation |
required |
min_cutoff
|
float
|
Minimum cutoff for visualization (V/m) |
0.3
|
max_cutoff
|
float
|
Maximum cutoff for visualization (V/m), if None uses 99.9th percentile |
None
|
cmap
|
str
|
Colormap name for visualization |
'hot'
|
Returns:
| Type | Description |
|---|---|
str | None
|
Path to saved PNG file or None if failed |
Source code in tit/plotting/nilearn/visualizer.py
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 | |
create_pdf_entry_point ¶
create_pdf_entry_point(subject_id: str, simulation_name: str, min_cutoff: float = 0.3, max_cutoff: float = None, atlas_name: str = 'harvard_oxford_sub', selected_regions: list = None, output_callback=None)
Entry point for PDF visualization creation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
subject_id
|
str
|
Subject ID |
required |
simulation_name
|
str
|
Simulation name |
required |
min_cutoff
|
float
|
Minimum cutoff for visualization (V/m) |
0.3
|
max_cutoff
|
float
|
Maximum cutoff for visualization (V/m), if None uses 99.9th percentile |
None
|
atlas_name
|
str
|
Atlas name for contours |
'harvard_oxford_sub'
|
selected_regions
|
list
|
List of region indices to include (0-indexed), if None includes all |
None
|
output_callback
|
Optional callback function for output (for GUI integration) |
None
|
Source code in tit/plotting/nilearn/img_slices.py
create_pdf_entry_point_group ¶
create_pdf_entry_point_group(averaged_img, base_filename: str, output_dir: str, min_cutoff: float = 0.3, max_cutoff: float = None, atlas_name: str = 'harvard_oxford_sub', selected_regions: list = None, output_callback=None)
Entry point for PDF visualization creation with pre-averaged nifti data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
averaged_img
|
Pre-averaged nibabel Nifti1Image |
required | |
base_filename
|
str
|
Base filename for output (without extension) |
required |
output_dir
|
str
|
Output directory path |
required |
min_cutoff
|
float
|
Minimum cutoff for visualization (V/m) |
0.3
|
max_cutoff
|
float
|
Maximum cutoff for visualization (V/m), if None uses 99.9th percentile |
None
|
atlas_name
|
str
|
Atlas name for contours |
'harvard_oxford_sub'
|
selected_regions
|
list
|
List of region indices to include (0-indexed), if None includes all |
None
|
output_callback
|
Optional callback function for output (for GUI integration) |
None
|
Source code in tit/plotting/nilearn/img_slices.py
create_glass_brain_entry_point ¶
create_glass_brain_entry_point(subject_id: str, simulation_name: str, min_cutoff: float = 0.3, max_cutoff: float = None, cmap: str = 'hot', output_callback=None)
Entry point for glass brain visualization creation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
subject_id
|
str
|
Subject ID |
required |
simulation_name
|
str
|
Simulation name |
required |
min_cutoff
|
float
|
Minimum cutoff for visualization (V/m) |
0.3
|
max_cutoff
|
float
|
Maximum cutoff for visualization (V/m), if None uses 99.9th percentile |
None
|
cmap
|
str
|
Colormap name for visualization |
'hot'
|
output_callback
|
Optional callback function for output (for GUI integration) |
None
|
Source code in tit/plotting/nilearn/img_glass.py
create_glass_brain_entry_point_group ¶
create_glass_brain_entry_point_group(averaged_img, base_filename: str, output_dir: str, min_cutoff: float = 0.3, max_cutoff: float = None, cmap: str = 'hot', output_callback=None)
Entry point for glass brain visualization creation with pre-averaged nifti data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
averaged_img
|
Pre-averaged nibabel Nifti1Image |
required | |
base_filename
|
str
|
Base filename for output (without extension) |
required |
output_dir
|
str
|
Output directory path |
required |
min_cutoff
|
float
|
Minimum cutoff for visualization (V/m) |
0.3
|
max_cutoff
|
float
|
Maximum cutoff for visualization (V/m), if None uses 99.9th percentile |
None
|
cmap
|
str
|
Colormap name for visualization |
'hot'
|
output_callback
|
Optional callback function for output (for GUI integration) |
None
|
Source code in tit/plotting/nilearn/img_glass.py
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 | |
create_html_entry_point ¶
Entry point for HTML visualization creation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
subject_id
|
str
|
Subject ID |
required |
simulation_name
|
str
|
Simulation name |
required |
min_cutoff
|
float
|
Minimum cutoff for visualization (V/m) |
0.3
|