Difference between revisions of "Volplot.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(Created page with "Volumetric plot function for scalar fields. Syntax: volplot(data_cube,axis_ranges) where data_cube is a 3D cube of real data and axis ranges is a six-element vec...")
 
Line 1: Line 1:
−
Volumetric plot function for scalar fields. Syntax:
+
{{DISPLAYTITLE:function.m}} __NOTOC__
 +
Volumetric 3D plot function for scalar fields. Sign is mapped into colour and amplitude into opacity. Separate scaling for positive and negative values -- displaying the colour bar is recommended.
  
−
            volplot(data_cube,axis_ranges)
+
==Syntax==
  
−
where data_cube is a 3D cube of real data and axis
+
    volplot(data_cube,axis_ranges,clip_ranges)
−
ranges is a six-element vector giving axis extents
+
 
−
as [xmin xmax ymin ymax zmin zmax].
+
==Arguments==
 +
 
 +
    data_cube  - data cube with dimensions ordered
 +
                  as [X Y Z]
 +
 +
    axis_ranges - six-element vector giving axis extents
 +
                  as [xmin xmax ymin ymax zmin zmax]
 +
 +
    clip_ranges - (optional) the values, as a fraction
 +
                  of the maximum in positive and nega-
 +
                  tive directions, at which the values
 +
                  should be clipped (this is useful for
 +
                  steep functions).
 +
 
 +
==Outputs==
 +
 
 +
    this function produces a figure
 +
 
 +
==See also==
 +
[[plot_1d.m]], [[plot_2d.m]], [[plot_3d.m]], [[molplot.m]], [[mri_2d_plot.m]]
 +
 
 +
 
 +
''Version 2.3, authors: [[Ilya Kuprov]]''

Revision as of 20:32, 28 December 2018

Volumetric 3D plot function for scalar fields. Sign is mapped into colour and amplitude into opacity. Separate scaling for positive and negative values -- displaying the colour bar is recommended.

Syntax

    volplot(data_cube,axis_ranges,clip_ranges)

Arguments

   data_cube   - data cube with dimensions ordered
                 as [X Y Z]

   axis_ranges - six-element vector giving axis extents
                 as [xmin xmax ymin ymax zmin zmax]

   clip_ranges - (optional) the values, as a fraction 
                  of the maximum in positive and nega-
                  tive directions, at which the values
                  should be clipped (this is useful for
                  steep functions).

Outputs

    this function produces a figure

See also

plot_1d.m, plot_2d.m, plot_3d.m, molplot.m, mri_2d_plot.m


Version 2.3, authors: Ilya Kuprov