next up previous
Next: MODRF Up: Element Dictionary Previous: MBUMPER

MHISTOGRAM

Request for multiple dimensions (1, 2, 4 or 6) histogram output of particle coordinates.
Parallel capable? : no
Parameter Name Units Type Default Description
FILE1D   STRING NULL filename for 1d histogram output, possibly incomplete (see below)
FILE2DH   STRING NULL filename for 2d x-x' histogram output, possibly incomplete (see below)
FILE2DV   STRING NULL filename for 2d y-y' histogram output, possibly incomplete (see below)
FILE2DL   STRING NULL filename for 2d dt-deltaP histogram output, possibly incomplete (see below)
FILE4D   STRING NULL filename for 4d x-x'-y-y' histogram output, possibly incomplete (see below)
FILE6D   STRING NULL filename for 6d x-x'-y-y'-dt-deltaP histogram output, possibly incomplete (see below)
INPUT_BINS   STRING NULL Name of SDDS file contains input bin number.
INTERVAL   long 1 interval in passes between output.
START_PASS   long 0 starting pass for output
NORMALIZE   long 1 normalize histogram with number of particles?
DISABLE   long 0 If nonzero, no output will be generated.
LUMPED   long 0 If nonzero, then results at elements with same name will be output to a single multipage SDDS file.
GROUP   string NULL Optionally used to assign an element to a group, with a user-defined name. Group names will appear in the parameter output file in the column ElementGroup





This element is used to generate multiple dimension (1, 2, 4, or 6) histogram output of particle coordinates.

The calculation is set up through output filename: FILE1D, FILE2DH, FILE2DV, FILE2DL, FILE4D, FILE6D. They may be an incomplete filename (see HISTOGRAM for detail). If LUMPED set to non zero, then results are directed to a multi page SDDS file with each page contains data of same elements MHISTOGRAM but at difference occurrence instead of multiple SDDS files. In this case the ``%ld'' in filename is ignored.

The bin number used to do histogram analysis is given through a SDDS file from INPUT_BINS. It contains 4 columns: Bins_1D, Bins_2D, Bins_4D, Bins_6D; and 6 rows (x, x', y, y', dt, delta). A non-zero value in Bins_1D is a switch for doing histogram analysis in corresponding dimension, and the maximum value in Bins_1D is used as bin number to do the analysis.

The normalization is different from HISTOGRAM as we alwayse treat bin-size = 1.



The output file uses the general format designed for a n-dimensional histogram data. It must contains a column named ``Frequency'' (Type: ``double''), and following parameters:

The data is arranged as it has a ``ND'' index counter $[i_{ND-1} \vert
... \vert i_1]$, where $i_{ND-1}$ takes value from ``0'' to ``Variable[%02d ND-1]Dimension''.


next up previous
Next: MODRF Up: Element Dictionary Previous: MBUMPER
Robert Soliday 2014-03-21