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...")
 
(removed link to deleted function page bloch_sph_plot.m (removed per IK instruction 2026-08-30))
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
Volumetric plot function for scalar fields. Syntax:
+
{{DISPLAYTITLE:volplot.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].
+
==Parameters==
 +
 
 +
    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]], [[hfc_display.m]], [[cst_display.m]], [[apodisation.m]], [[axis_1d.m]], [[bwr_cmap.m]], [[contspacing.m]], [[crop_2d.m]], [[cylgrid.m]], [[fid2ascii.m]], [[ft_axis.m]], [[heterodyne.m]], [[int_2d.m]], [[plot_uf.m]], [[s2json.m]], [[scale_figure.m]], [[slice_2d.m]], [[stack_2d.m]], [[sweep2ticks.m]], [[write_movie.m]], [[xyz2pd.m]], [[zoom_3d.m]], [[Hyperfine_shift_module]], [[Import,_export,_and_visualisation]], [[Kernel_utilities]]
 +
 
 +
''Version 2.3, authors: [[Ilya Kuprov]]''

Latest revision as of 10:10, 30 August 2026

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)

Parameters

   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, hfc_display.m, cst_display.m, apodisation.m, axis_1d.m, bwr_cmap.m, contspacing.m, crop_2d.m, cylgrid.m, fid2ascii.m, ft_axis.m, heterodyne.m, int_2d.m, plot_uf.m, s2json.m, scale_figure.m, slice_2d.m, stack_2d.m, sweep2ticks.m, write_movie.m, xyz2pd.m, zoom_3d.m, Hyperfine_shift_module, Import,_export,_and_visualisation, Kernel_utilities

Version 2.3, authors: Ilya Kuprov