/*!


\page EventFilter_HcalRawToDigi Package EventFilter/HcalRawToDigi

<center>
<small>


<!-- @PROJ_VERS@ will be substituted at build time, no need to touch -->
<a href=http://cmsdoc.cern.ch/swdev/viewcvs/viewcvs.cgi/CMSSW/EventFilter/HcalRawToDigi/?cvsroot=CMSSW&only_with_tag=@PROJ_VERS@>CVS</a> - 
<a href=http://cmsdoc.cern.ch/swdev/viewcvs/viewcvs.cgi/CMSSW/EventFilter/HcalRawToDigi/.admin/developers?rev=HEAD&cvsroot=CMSSW&content-type=text/vnd.viewcvs-markup>Administrative privileges</a>
</small>
</center>


\section desc Description

Unpacking module and classes for reading HCAL raw data and converting it into
digis.  

For reference, the hardware is documentated at
http://cmsdoc.cern.ch/cms/HCAL/document/.  The information on the
readout chain and electronics may be useful for understanding the
unpacking code and functions.

Both of the unpackers require access to the HcalElectronicsMap which
is accessed from the HcalDbService in the HcalDbRecord.

\subsection interface Public interface

 - HcalDCCHeader : Interpret the raw HCAL data from the HCAL FED (DCC)
 - HcalHTRData : Helper class for interpretation of sub-fragments from a single main FPGA on a HTR board

\subsection modules Modules

 - HcalRawToDigi : Unpacker (RawToDigi) module for data taken in normal mode.  Produces collections of HBHEDataFrame, HODataFrame, HFDataFrame, and HcalTrigPrimDigi.

<pre>
\htmlinclude HcalRawToDigi-tb.cfi
</pre>

 - HcalHistogramRawToDigi : Unpacker (RawToDigi) module for special mode where histograms are read out rather than individual events.  Produces HcalHistogramDigis.

<pre>
\htmlinclude HcalHistogramRawToDigi.cfi
</pre>

<!-- \subsection tests Unit tests and examples
 Describe cppunit tests and example configuration files -->


\section status Status and planned development

- HcalRawToDigi is complete and tested.
- HcalHistogramRawToDigi is complete and tested.
- Additional functions for expert work on the HTR and DCC raw data are expected as needs arrise.

<hr>
Last updated:
@DATE@ J. Mans
*/