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

# The `Histogrammer` Instrument

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

## Identification

- Site: Tools
- Author: Peter Willendrup (peter.willendrup@risoe.dk)
- Origin: Risoe
- Date: 2007-03-19
- Version: 1.4

## Description

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

    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" Type="text"
      - 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 |
MODE | int | Input file mode/format - 0 for help on usage 1=McStas,2=Vitess,3=MCNP,4=Tripoli4 | 0
Options | string | Specifies the histogramming rules used by Monitor_nD. It MUST contain the 'previous' word - see mcdoc page | "sphere theta phi outgoing previous"
Type | string | Virtual_input event files, 'type' parameter(text/float/double) - see mcdoc page | "text"
BufSize | int | Vitess_input 'buffersize' parameter - see mcdoc page | 10000

## Links

- Source code for `Histogrammer.instr`.
- Virtual_input component (McStas event file)
- Vitess_input component (Vitess event file)
- Virtual_mcnp_input component (MCNP PTRAC event file)
- Virtual_tripoli4_input component (Tripoli4 BATCH event file)
- Monitor_nD component (detector/histogrammer)

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