Home > Scripts > Treatment > Instruments > mccode_display.m

iFit/mccode_display

PURPOSE ^

mccode_display: runs the model in --trace mode and capture the output

SYNOPSIS ^

function [comps, fig, model]=mccode_display(model, p, options)

DESCRIPTION ^

 mccode_display: runs the model in --trace mode and capture the output
 grab all MCDISPLAY lines, and render the TRACE information into a figure.

  mccode_display
     alone displays the default mccode model view (diffractometer)
  mccode_display(path_to_mccode_instr)
     compiles the given mccode instrument and displays it
  mccode_display(model)
     displays the given McCode model with its defaults/current parameters.
  mccode_display(model, parameters)
     same as above, but uses the given parameters (vector, structure, cell)
  [comps, fig] = mccode_display(...)
     returns the list of components, figure used for display and updated model.
     
 Example:
   model = mccode('instrument_file')
   mccode_display(model)
     a figure is generated, which shows the instrument geometry.

 input:
   model: instrument simulation as obtained with 'mccode' (iFunc)
          or path to an instrumnt definition to compile.
   parameters: parameters to use, as a vector, cell, structure...
   options: rendering options. Can contain 'html','x3d','png'
   
 output:
   comps: a list of component specifications (structure array)
   fig:   figure handle
   model: model, updated or created (iFunc)

 See also: mccode, iFunc, iFunc/feval, http://www.mcstas.org

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Tue 22-Aug-2017 11:03:30 by m2html © 2005. iFit (c) E.Farhi/ILL EUPL 1.1