ROME XML Definition Schema Documentation

Complex Type: HistogramDesc

[Table of contents]

Super-types: None
Sub-types: None
Name HistogramDesc
Used by (from the same schema document) Complex Type TaskDesc
Abstract no
Documentation Description of histograms.
XML Instance Representation
<...>
<HistName> string </HistName> [1]

'The name of the histogram. (required)'

Start Choice [0..*]
<HistTitle> string </HistTitle> [0..1]

'The title of the histogram. Displayed in the ROOT browser. This value can be overwritten in the configuration file. (optional)'

<HistFolderName> string </HistFolderName> [0..1]

'The ROOT folder, where the histogram is stored in (this folder has nothing to do with a data folder of ROME). The histograms are stored under //root/[Shortcut]/[TaskName]/[HistFolderName]. Default is the value of HistName.'

<HistFolderTitle> string </HistFolderTitle> [0..1]

'The title of the ROOT folder in which the histogram is stored. This value can be overwritten in the configuration file. (optional)'

End Choice
<HistType> HistTypeDesc </HistType> [1]

'The type of the histogram. Can be any ROOT histogram type. (required)'

Start Choice [0..*]
<HistArraySize> string </HistArraySize> [0..1]

'The array size of the histogram. If the value is 1 the histogram is a single histogram. If the histogram is an array they are named HistName_001 and so on. With HistArrayStartIndex you can specifie with which number the enumeration starts. This value can be overwritten in the configuration file. Default is 1.'

<HistArrayStartIndex> string </HistArrayStartIndex> [0..1]

'Start index of histogram array name enumeration. This value can be overwritten in the configuration file. Default is 0.'

<HistXLabel> string </HistXLabel> [0..1]

'The label text of the x axis. Text has to be placed in quotes. This value can be overwritten in the configuration file. (optional)'

<HistYLabel> string </HistYLabel> [0..1]

'The label text of the y axis. Text has to be placed in quotes. This value can be overwritten in the configuration file. (optional)'

<HistZLabel> string </HistZLabel> [0..1]

'The label text of the z axis. Text has to be placed in quotes. This value can be overwritten in the configuration file. (optional)'

<HistXNbins> string </HistXNbins> [0..1]

'The number of bins in x. This value can be overwritten in the configuration file. Default is 1.'

<HistXmin> string </HistXmin> [0..1]

'The minimum value in x. This value can be overwritten in the configuration file. Default is 0.'

<HistXmax> string </HistXmax> [0..1]

'The maximum value in x. This value can be overwritten in the configuration file. Default is 1.'

<HistYNbins> string </HistYNbins> [0..1]

'The number of bins in y. This value can be overwritten in the configuration file. Default is 1.'

<HistYmin> string </HistYmin> [0..1]

'The minimum value in y. This value can be overwritten in the configuration file. Default is 0.'

<HistYmax> string </HistYmax> [0..1]

'The maximum value in y. This value can be overwritten in the configuration file. Default is 1.'

<HistZNbins> string </HistZNbins> [0..1]

'The number of bins in z. This value can be overwritten in the configuration file. Default is 1.'

<HistZmin> string </HistZmin> [0..1]

'The minimum value in z. This value can be overwritten in the configuration file. Default is 0.'

<HistZmax> string </HistZmax> [0..1]

'The maximum value in z. This value can be overwritten in the configuration file. Default is 1.'

<Argus> HistGraphArgusDesc </Argus> [0..1]

'Argus display configuration for the histogram/graph.'

End Choice
</...>
Diagram
h491787058 h-70776962
Schema Component Representation
<complexType name="HistogramDesc">
<sequence>
<element name="HistName" type=" string "/>
<choice minOccurs="0" maxOccurs="unbounded">
<element name="HistTitle" type=" string " minOccurs="0"/>
<element name="HistFolderName" type=" string " minOccurs="0"/>
<element name="HistFolderTitle" type=" string " minOccurs="0"/>
</choice>
<element name="HistType" type=" HistTypeDesc "/>
<choice minOccurs="0" maxOccurs="unbounded">
<element name="HistArraySize" type=" string " default="1" minOccurs="0"/>
<element name="HistArrayStartIndex" type=" string " default="0" minOccurs="0"/>
<element name="HistXLabel" type=" string " minOccurs="0"/>
<element name="HistYLabel" type=" string " minOccurs="0"/>
<element name="HistZLabel" type=" string " minOccurs="0"/>
<element name="HistXNbins" type=" string " default="1" minOccurs="0"/>
<element name="HistXmin" type=" string " default="0" minOccurs="0"/>
<element name="HistXmax" type=" string " default="1" minOccurs="0"/>
<element name="HistYNbins" type=" string " default="1" minOccurs="0"/>
<element name="HistYmin" type=" string " default="0" minOccurs="0"/>
<element name="HistYmax" type=" string " default="1" minOccurs="0"/>
<element name="HistZNbins" type=" string " default="1" minOccurs="0"/>
<element name="HistZmin" type=" string " default="0" minOccurs="0"/>
<element name="HistZmax" type=" string " default="1" minOccurs="0"/>
<element name="Argus" type=" HistGraphArgusDesc " minOccurs="0"/>
</choice>
</sequence>
</complexType>