Inheritance diagram for nipy.labs.viz_tools.ortho_slicer:
The OrthoSlicer class.
The main purpose of this class is to have auto adjust of axes size to the data.
Bases: object
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. |
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: :
|
---|
A small demo of the OrthoSlicer functionality.