McStas logo McStas - A neutron ray-trace simulation package ILL; PSI; ESS Niels Bohr Institute DTU Physics NEXMAP


About McStas
 Conditions of use
 Project funding

 Other Downloads (share)

Mailing list

Search web/mailinglist

 Wiki (GitHub)
 McStas manual


Report bugs (GitHub)

Code-repository (GitHub)

McStas: Histogrammer Instrument at Tools

[ Identification | Description | Input parameters | Output parameters | Links ]

The Histogrammer Instrument

Takes eventfile input (Virtual_input/Vitess/MCNP/Tripoli4/MCPL formats) and applies Monitor_nD to generate histograms. Histograms can be chosen freely using the options string, see mcdoc Monitor_nD.comp


  • Site: Tools
  • Author: Peter Willendrup (
  • Origin: Risoe
  • Date: 2007-03-19
  • Version:(Unknown)


Takes any possible  McStas eventfile inputs (Virtual_input/Vitess/MCNP/Tripoli4 formats) and applies
Monitor_nD to generate user-selectable neutron histograms.

The 'options' parameter allows to customize the type of histogram to generate.
We suggest:
  "sphere theta phi outgoing previous" (this is the default)
  "previous, multiple, auto, x, y, z, vx, vy, vz, hdiv, vdiv, tof, lambda"
  "previous, auto, x, y"
  "previous, auto, tof, lambda"

Example: mcrun Histogrammer.instr MODE=0
  - Gives information on the input parameters

Example: mcrun Histogrammer.instr filename="events.dat" MODE=1 options="sphere theta phi outgoing previous"
  - Reads a Virtual_output generated event file and applies a spherical PSD

Input parameters

Parameters in boldface are required; the others are optional.
Name Unit Description Default
filename string Specifies input event file 0
MODE int Input file mode/format - 0 for help on usage 1=McStas,2=Vitess,3=MCNP,4=Tripoli4,5=MCPL 0
options string Specifies the histogramming rules used by Monitor_nD. It MUST contain the 'previous' word - see mcdoc Monitor_nD "sphere theta phi outgoing previous"
bufsize int Vitess_input 'buffersize' parameter - see mcdoc Vitess_input 10000
xwidth m Horizontal width of detector, or diameter for banana,cylinder and shpere geometry 0.1
yheight m Vertical height of detector, for plate, cylinder, banana shape 0.1


[ Identification | Description | Input parameters | Output parameters | Links ]

Generated automatically by McDoc, Peter Willendrup <> / Wed Jan 12 15:13:21 2022

Last Modified: Wednesday, 12-Jan-2022 16:13:21 CET
Search website mailinglist archive GitHub repos