Inheritance diagram for nipy.labs.viz_tools.slicers:
The Slicer classes.
The main purpose of these classes is to have auto adjust of axes size to the data with different layout of cuts.
Bases: object
The main purpose of these class is to have auto adjust of axes size to the data with different layout of cuts.
Methods
annotate([left_right, positions, size]) | Add annotations to the plot. |
contour_map(map, affine, **kwargs) | Contour a 3D map in all the views. |
edge_map(map, affine[, color]) | Plot the edges of a 3D map in all the views. |
find_cut_coords([data, affine, threshold, ...]) | |
init_with_figure([data, affine, threshold, ...]) | |
plot_map(map, affine[, threshold]) | Plot a 3D map in all the views. |
title(text[, x, y, size, color, bgcolor, alpha]) | Write a title to the view. |
Create 3 linked axes for plotting orthogonal cuts.
Parameters : | cut_coords: 3 tuple of ints :
axes: matplotlib axes object, optional :
black_bg: boolean, optional :
|
---|
Add annotations to the plot.
Parameters : | left_right: boolean, optional :
positions: boolean, optional :
size: integer, optional :
kwargs: :
|
---|
Contour a 3D map in all the views.
Parameters : | map: 3D ndarray :
affine: 4x4 ndarray :
kwargs: :
|
---|
Plot the edges of a 3D map in all the views.
Parameters : | map: 3D ndarray :
affine: 4x4 ndarray :
color: matplotlib color: string or (r, g, b) value :
|
---|
Plot a 3D map in all the views.
Parameters : | map: 3D ndarray :
affine: 4x4 ndarray :
threshold : a number, None, or ‘auto’
kwargs: :
|
---|
Write a title to the view.
Parameters : | text: string :
x: float, optional :
y: float, optional :
size: integer, optional :
color: matplotlib color specifier, optional :
bgcolor: matplotlib color specifier, optional :
alpha: float, optional :
kwargs: :
|
---|
Bases: nipy.labs.viz_tools.slicers.BaseSlicer
A class to create linked axes for plotting stacked cuts of 3D maps.
Notes
The extent of the different axes are adjusted to fit the data best in the viewing area.
Attributes
axes: dictionnary of axes | The axes used to plot each view. |
frame_axes: axes | The axes framing the whole set of views. |
Methods
annotate([left_right, positions, size]) | Add annotations to the plot. |
contour_map(map, affine, **kwargs) | Contour a 3D map in all the views. |
draw_cross([cut_coords]) | Draw a crossbar on the plot to show where the cut is performed. |
edge_map(map, affine[, color]) | Plot the edges of a 3D map in all the views. |
find_cut_coords([data, affine, threshold, ...]) | |
init_with_figure([data, affine, threshold, ...]) | |
plot_map(map, affine[, threshold]) | Plot a 3D map in all the views. |
title(text[, x, y, size, color, bgcolor, alpha]) | Write a title to the view. |
Create 3 linked axes for plotting orthogonal cuts.
Parameters : | cut_coords: 3 tuple of ints :
axes: matplotlib axes object, optional :
black_bg: boolean, optional :
|
---|
Add annotations to the plot.
Parameters : | left_right: boolean, optional :
positions: boolean, optional :
size: integer, optional :
kwargs: :
|
---|
Contour a 3D map in all the views.
Parameters : | map: 3D ndarray :
affine: 4x4 ndarray :
kwargs: :
|
---|
Draw a crossbar on the plot to show where the cut is performed.
Parameters : | cut_coords: 3-tuple of floats, optional :
kwargs: :
|
---|
Plot the edges of a 3D map in all the views.
Parameters : | map: 3D ndarray :
affine: 4x4 ndarray :
color: matplotlib color: string or (r, g, b) value :
|
---|
Plot a 3D map in all the views.
Parameters : | map: 3D ndarray :
affine: 4x4 ndarray :
threshold : a number, None, or ‘auto’
kwargs: :
|
---|
Write a title to the view.
Parameters : | text: string :
x: float, optional :
y: float, optional :
size: integer, optional :
color: matplotlib color specifier, optional :
bgcolor: matplotlib color specifier, optional :
alpha: float, optional :
kwargs: :
|
---|
Bases: object
An MPL axis-like object that displays a cut of 3D volumes
Methods
do_cut(map, affine) | Cut the 3D volume into a 2D slice |
draw_cut(cut, data_bounds, bounding_box[, type]) | |
draw_left_right(size, bg_color, **kwargs) | |
draw_position(size, bg_color, **kwargs) | |
get_object_bounds() | Return the bounds of the objects on this axes. |
An MPL axis-like object that displays a cut of 3D volumes
Parameters : | ax: a MPL axes instance :
direction: {‘x’, ‘y’, ‘z’} :
coord: float :
|
---|
Cut the 3D volume into a 2D slice
Parameters : | map: 3D ndarray :
affine: 4x4 ndarray :
|
---|
Return the bounds of the objects on this axes.
Bases: nipy.labs.viz_tools.slicers.BaseSlicer
A class to create 3 linked axes for plotting orthogonal cuts of 3D maps.
Notes
The extent of the different axes are adjusted to fit the data best in the viewing area.
Attributes
axes: dictionnary of axes | The 3 axes used to plot each view. |
frame_axes: axes | The axes framing the whole set of views. |
Methods
annotate([left_right, positions, size]) | Add annotations to the plot. |
contour_map(map, affine, **kwargs) | Contour a 3D map in all the views. |
draw_cross([cut_coords]) | Draw a crossbar on the plot to show where the cut is performed. |
edge_map(map, affine[, color]) | Plot the edges of a 3D map in all the views. |
find_cut_coords([data, affine, threshold, ...]) | |
init_with_figure([data, affine, threshold, ...]) | |
plot_map(map, affine[, threshold]) | Plot a 3D map in all the views. |
title(text[, x, y, size, color, bgcolor, alpha]) | Write a title to the view. |
Create 3 linked axes for plotting orthogonal cuts.
Parameters : | cut_coords: 3 tuple of ints :
axes: matplotlib axes object, optional :
black_bg: boolean, optional :
|
---|
Add annotations to the plot.
Parameters : | left_right: boolean, optional :
positions: boolean, optional :
size: integer, optional :
kwargs: :
|
---|
Contour a 3D map in all the views.
Parameters : | map: 3D ndarray :
affine: 4x4 ndarray :
kwargs: :
|
---|
Draw a crossbar on the plot to show where the cut is performed.
Parameters : | cut_coords: 3-tuple of floats, optional :
kwargs: :
|
---|
Plot the edges of a 3D map in all the views.
Parameters : | map: 3D ndarray :
affine: 4x4 ndarray :
color: matplotlib color: string or (r, g, b) value :
|
---|
Plot a 3D map in all the views.
Parameters : | map: 3D ndarray :
affine: 4x4 ndarray :
threshold : a number, None, or ‘auto’
kwargs: :
|
---|
Write a title to the view.
Parameters : | text: string :
x: float, optional :
y: float, optional :
size: integer, optional :
color: matplotlib color specifier, optional :
bgcolor: matplotlib color specifier, optional :
alpha: float, optional :
kwargs: :
|
---|
Bases: nipy.labs.viz_tools.slicers.BaseStackedSlicer
Methods
annotate([left_right, positions, size]) | Add annotations to the plot. |
contour_map(map, affine, **kwargs) | Contour a 3D map in all the views. |
draw_cross([cut_coords]) | Draw a crossbar on the plot to show where the cut is performed. |
edge_map(map, affine[, color]) | Plot the edges of a 3D map in all the views. |
find_cut_coords([data, affine, threshold, ...]) | |
init_with_figure([data, affine, threshold, ...]) | |
plot_map(map, affine[, threshold]) | Plot a 3D map in all the views. |
title(text[, x, y, size, color, bgcolor, alpha]) | Write a title to the view. |
Create 3 linked axes for plotting orthogonal cuts.
Parameters : | cut_coords: 3 tuple of ints :
axes: matplotlib axes object, optional :
black_bg: boolean, optional :
|
---|
Add annotations to the plot.
Parameters : | left_right: boolean, optional :
positions: boolean, optional :
size: integer, optional :
kwargs: :
|
---|
Contour a 3D map in all the views.
Parameters : | map: 3D ndarray :
affine: 4x4 ndarray :
kwargs: :
|
---|
Draw a crossbar on the plot to show where the cut is performed.
Parameters : | cut_coords: 3-tuple of floats, optional :
kwargs: :
|
---|
Plot the edges of a 3D map in all the views.
Parameters : | map: 3D ndarray :
affine: 4x4 ndarray :
color: matplotlib color: string or (r, g, b) value :
|
---|
Plot a 3D map in all the views.
Parameters : | map: 3D ndarray :
affine: 4x4 ndarray :
threshold : a number, None, or ‘auto’
kwargs: :
|
---|
Write a title to the view.
Parameters : | text: string :
x: float, optional :
y: float, optional :
size: integer, optional :
color: matplotlib color specifier, optional :
bgcolor: matplotlib color specifier, optional :
alpha: float, optional :
kwargs: :
|
---|
Bases: nipy.labs.viz_tools.slicers.BaseStackedSlicer
Methods
annotate([left_right, positions, size]) | Add annotations to the plot. |
contour_map(map, affine, **kwargs) | Contour a 3D map in all the views. |
draw_cross([cut_coords]) | Draw a crossbar on the plot to show where the cut is performed. |
edge_map(map, affine[, color]) | Plot the edges of a 3D map in all the views. |
find_cut_coords([data, affine, threshold, ...]) | |
init_with_figure([data, affine, threshold, ...]) | |
plot_map(map, affine[, threshold]) | Plot a 3D map in all the views. |
title(text[, x, y, size, color, bgcolor, alpha]) | Write a title to the view. |
Create 3 linked axes for plotting orthogonal cuts.
Parameters : | cut_coords: 3 tuple of ints :
axes: matplotlib axes object, optional :
black_bg: boolean, optional :
|
---|
Add annotations to the plot.
Parameters : | left_right: boolean, optional :
positions: boolean, optional :
size: integer, optional :
kwargs: :
|
---|
Contour a 3D map in all the views.
Parameters : | map: 3D ndarray :
affine: 4x4 ndarray :
kwargs: :
|
---|
Draw a crossbar on the plot to show where the cut is performed.
Parameters : | cut_coords: 3-tuple of floats, optional :
kwargs: :
|
---|
Plot the edges of a 3D map in all the views.
Parameters : | map: 3D ndarray :
affine: 4x4 ndarray :
color: matplotlib color: string or (r, g, b) value :
|
---|
Plot a 3D map in all the views.
Parameters : | map: 3D ndarray :
affine: 4x4 ndarray :
threshold : a number, None, or ‘auto’
kwargs: :
|
---|
Write a title to the view.
Parameters : | text: string :
x: float, optional :
y: float, optional :
size: integer, optional :
color: matplotlib color specifier, optional :
bgcolor: matplotlib color specifier, optional :
alpha: float, optional :
kwargs: :
|
---|
Bases: nipy.labs.viz_tools.slicers.BaseStackedSlicer
Methods
annotate([left_right, positions, size]) | Add annotations to the plot. |
contour_map(map, affine, **kwargs) | Contour a 3D map in all the views. |
draw_cross([cut_coords]) | Draw a crossbar on the plot to show where the cut is performed. |
edge_map(map, affine[, color]) | Plot the edges of a 3D map in all the views. |
find_cut_coords([data, affine, threshold, ...]) | |
init_with_figure([data, affine, threshold, ...]) | |
plot_map(map, affine[, threshold]) | Plot a 3D map in all the views. |
title(text[, x, y, size, color, bgcolor, alpha]) | Write a title to the view. |
Create 3 linked axes for plotting orthogonal cuts.
Parameters : | cut_coords: 3 tuple of ints :
axes: matplotlib axes object, optional :
black_bg: boolean, optional :
|
---|
Add annotations to the plot.
Parameters : | left_right: boolean, optional :
positions: boolean, optional :
size: integer, optional :
kwargs: :
|
---|
Contour a 3D map in all the views.
Parameters : | map: 3D ndarray :
affine: 4x4 ndarray :
kwargs: :
|
---|
Draw a crossbar on the plot to show where the cut is performed.
Parameters : | cut_coords: 3-tuple of floats, optional :
kwargs: :
|
---|
Plot the edges of a 3D map in all the views.
Parameters : | map: 3D ndarray :
affine: 4x4 ndarray :
color: matplotlib color: string or (r, g, b) value :
|
---|
Plot a 3D map in all the views.
Parameters : | map: 3D ndarray :
affine: 4x4 ndarray :
threshold : a number, None, or ‘auto’
kwargs: :
|
---|
Write a title to the view.
Parameters : | text: string :
x: float, optional :
y: float, optional :
size: integer, optional :
color: matplotlib color specifier, optional :
bgcolor: matplotlib color specifier, optional :
alpha: float, optional :
kwargs: :
|
---|