Home > Applications > Horace > @sqw > plot_titles.m

iFit/plot_titles

PURPOSE ^

Get titling and caption information for an sqw object

SYNOPSIS ^

This is a script file.

DESCRIPTION ^

 Get titling and caption information for an sqw object

 Syntax:
   >> [title_main, title_pax, title_iax, display_pax, display_iax, energy_axis] = plot_titles (w)
 
 Input:
 ------
   data            Structure for which titles are to be created from the data in its fields.
                   Type >> help check_sqw_data for a full description of the fields

 Output:
 -------
   title_main      Main title (cell array of character strings)
   title_pax       Cell array containing axes annotations for each of the plot axes
   title_iax       Cell array containing annotations for each of the integration axes
   display_pax     Cell array containing axes annotations for each of the plot axes suitable 
                  for printing to the screen
   display_iax     Cell array containing axes annotations for each of the integration axes suitable 
                  for printing to the screen
   energy_axis     The index of the column in the 4x4 matrix din.u that corresponds
                  to the energy axis
%   Overloaded methods:
      sqw/plot_titles
      sqw/plot_titles

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Tue 27-Nov-2018 10:56:24 by m2html © 2005. iFit (c) E.Farhi/ILL EUPL 1.1