Difference between revisions of "Plot 1d.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(Created page with "1D plotting utility. Uses the same parameters structure as 1D pulse sequences. Input syntax: plot_1d(spin_system,spectrum,parameters) Input parameters: pa...")
 
Line 1: Line 1:
1D plotting utility. Uses the same parameters structure as 1D pulse
+
{{DISPLAYTITLE:plot_1d.m}} __NOTOC__
sequences. Input syntax:
+
1D plotting utility.
  
              plot_1d(spin_system,spectrum,parameters)
+
==Syntax==
  
Input parameters:
+
    plot_1d(spin_system,spectrum,parameters,varargin)
  
 +
==Arguments==
 +
 +
    spectrum                      a column vector containing the
 +
                                  spectrum
 +
 
     parameters.sweep              sweep width, Hz
 
     parameters.sweep              sweep width, Hz
 
+
 
     parameters.spins              spin species, e.g. {'1H'}
 
     parameters.spins              spin species, e.g. {'1H'}
 
+
 
     parameters.offset            transmitter offset, Hz
 
     parameters.offset            transmitter offset, Hz
 
+
 
     parameters.axis_units        axis units ('ppm','Gauss',
 
     parameters.axis_units        axis units ('ppm','Gauss',
 
                                   'mT','T','Hz','kHz','MHz')
 
                                   'mT','T','Hz','kHz','MHz')
 
+
 
     parameters.derivative        if set to 1, the spectrum is
 
     parameters.derivative        if set to 1, the spectrum is
 
                                   differentiated before plotting
 
                                   differentiated before plotting
 
+
 
     parameters.invert_axis        if set to 1, the frequency axis  
 
     parameters.invert_axis        if set to 1, the frequency axis  
 
                                   is inverted before plotting
 
                                   is inverted before plotting
 +
 +
    varargin                      any number of any other para-
 +
                                  meters; these will be passed
 +
                                  to Matlab's plot() function
 +
 +
==Outputs==
 +
 +
    this function produces a figure
 +
 +
==See also==
 +
[[plot_2d.m]], [[slice_2d.m]], [[plot_3d.m]], [[mri_2d_plot.m]], [[volplot.m]], [[molplot.m]]
 +
  
Any extra arguments given to this function will be passed to the built-in
+
''Version 2.3, authors: [[Ilya Kuprov]], [[Luke Edwards]]''
Matlab function plot().
 

Revision as of 20:10, 28 December 2018

1D plotting utility.

Syntax

    plot_1d(spin_system,spectrum,parameters,varargin)

Arguments

   spectrum                      a column vector containing the
                                 spectrum

   parameters.sweep              sweep width, Hz

   parameters.spins              spin species, e.g. {'1H'}

   parameters.offset             transmitter offset, Hz

   parameters.axis_units         axis units ('ppm','Gauss',
                                 'mT','T','Hz','kHz','MHz')

   parameters.derivative         if set to 1, the spectrum is
                                 differentiated before plotting

   parameters.invert_axis        if set to 1, the frequency axis 
                                 is inverted before plotting

   varargin                      any number of any other para-
                                 meters; these will be passed
                                 to Matlab's plot() function

Outputs

    this function produces a figure

See also

plot_2d.m, slice_2d.m, plot_3d.m, mri_2d_plot.m, volplot.m, molplot.m


Version 2.3, authors: Ilya Kuprov, Luke Edwards