[u/mrichter/AliRoot.git] / HLT / comp / AliHLTCOMPHuffmanAltroCalibComponent.h

//-*- Mode: C++ -*-
// $Id$
#ifndef ALIHLTCOMPHUFFMANALTROCALIBCOMPONENT_H
#define ALIHLTCOMPHUFFMANALTROCALIBCOMPONENT_H

//* This file is property of and copyright by the ALICE HLT Project        * 
//* ALICE Experiment at CERN, All rights reserved.                         *
//* See cxx source for full Copyright notice                               *

/** @file   AliHLTCOMPHuffmanAltroCalibComponent.h
    @author Jochen Thaeder
    @author extended by Jenny Wagner
    @date   20-11-2007
    @brief  A calibration component for the Huffman code creator 
*/

#include "AliHLTCalibrationProcessor.h"

class AliHLTCOMPHuffmanAltro;
class AliHLTCOMPHuffmanData;

/**
 * @class AliHLTCOMPHuffmanAltroCalibComponent
 * This class is the calibration component for the AliTPCCalibHuffmanAltro class 
 * used for calibration of the Huffman code table (which is created here). 
 *
 * <h2>General properties:</h2>
 *
 * Component ID: \b HuffmanAltroCalibComponent                          <br>
 * Library: \b libAliHLTComp.so                                         <br>
 * Input Data Types: ::kAliHLTDataTypeDDLRaw                            <br>
 * Output Data Types: AliHLTCompDefinitions::fgkHuffmanAltroCalDataType <br>
 *
 * <h2>Mandatory arguments:</h2>
 * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
 * \li -origin <i> detector </i> <br>
 *  set origin of data for code creation to specify output table (parameter transient)
 * \li -runnumber <i> decimal number </i> <br>
 *  set runnumber to specify output table (parameter transient)
 * \li -dataspec <i> 0xYYXXaabb </i> <br>
 *  set usual HLT dataspec (last slice, first slice, last patch, first patch)_Hexadezimal to specify output table
 * \li -trailerwords <i> decimal number </i> <br>
 *  set number of trailerwords of incoming data (ranging from 1 to 3)
 *
 * <h2>Optional arguments:</h2>
 * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
 * \li -tablepath <i> path to Huffman code table </i> <br>
 *  set path to out put Huffman code table as root file, if no path is given,
 *  output path is set to current path (parameter transient)
 *
 * It inherits from the @ref AliHLTCalibrationProcessor and uses the high-level 
 * interface. The output is the class AliHLTCOMPHuffmanData as a TObject which
 * is written to the data base
 *
 * @ingroup alihlt_comp_components
 */
class AliHLTCOMPHuffmanAltroCalibComponent : public AliHLTCalibrationProcessor
    {
    public:
      /** constructor */
      AliHLTCOMPHuffmanAltroCalibComponent();
      
      /** destructor */
      virtual ~AliHLTCOMPHuffmanAltroCalibComponent();
      
      // Public functions to implement AliHLTComponent's interface.
      // These functions are required for the registration process

      const char* GetComponentID();
      void GetInputDataTypes( vector<AliHLTComponentDataType>& list);
      AliHLTComponentDataType GetOutputDataType();
      virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier );
      AliHLTComponent* Spawn();

    protected:
      
      // Protected functions to implement AliHLTComponent's interface.
      // These functions provide initialization as well as the actual processing
      // capabilities of the component. 
      
      /** Initialize the calibration component. */
      Int_t InitCalibration();

      /** Scan commandline arguments of the calibration component. */
      Int_t ScanArgument( Int_t argc, const char** argv );

      /** DeInitialize the calibration component. */
      Int_t DeinitCalibration();

      /** Process the data in the calibration component. */
      Int_t ProcessCalibration( const AliHLTComponentEventData& evtData, AliHLTComponentTriggerData& trigData );

      /** Ship the data to the FXS at end of run or eventmodulo. */
      Int_t ShipDataToFXS( const AliHLTComponentEventData& evtData, AliHLTComponentTriggerData& trigData );

    private:

      /** copy constructor prohibited */
      AliHLTCOMPHuffmanAltroCalibComponent(const AliHLTCOMPHuffmanAltroCalibComponent&);

      /** assignment operator prohibited */
      AliHLTCOMPHuffmanAltroCalibComponent& operator=(const AliHLTCOMPHuffmanAltroCalibComponent&);

      /** Huffman compressor class */
      AliHLTCOMPHuffmanAltro * fHuffmanCompressor; //! instance of Huffman Compressor in this component
      
      /** pointer to output Huffman code table and occurrence table (togehter in this class) */
      AliHLTCOMPHuffmanData * fHuffmanData;            //! instance of output (Huffman Data, containing code table)

      /** The Specification for this component */
      /** explicit specification of the origin of the data (transient) */
      TString fOrigin;                      // input line argument to determine origin for Huffman table
                                           // -> no input --> default taken from incoming data
      /** explicit specification of the run number */
      AliHLTUInt64_t fRunNumber;           // input line argument to determine run number for Huffman table

      /** specifications of the data */
      AliHLTUInt64_t fSpecification;      // see above

      /** explicit path to Huffman code table which will be put out */
      TString fTablePath;                 // input line argument to determine path for Huffman table
                                          // -> no input --> default set to current path name
      //AliHLTUInt8_t fSlice;             // slice 
      //AliHLTUInt8_t fPatch;            // patch   

      /** number of NRCU trailer words of input data */
      Int_t fNRCUTrailerWords;          // see above

      ClassDef(AliHLTCOMPHuffmanAltroCalibComponent, 0)

    };
#endif
Commit	Line	Data
	1	//-- Mode: C++ --
	2	// $Id$
	3	#ifndef ALIHLTCOMPHUFFMANALTROCALIBCOMPONENT_H
	4	#define ALIHLTCOMPHUFFMANALTROCALIBCOMPONENT_H
	5
	6	//* This file is property of and copyright by the ALICE HLT Project *
	7	//* ALICE Experiment at CERN, All rights reserved. *
	8	//* See cxx source for full Copyright notice *
	9
	10	/** @file AliHLTCOMPHuffmanAltroCalibComponent.h
	11	@author Jochen Thaeder
	12	@author extended by Jenny Wagner
	13	@date 20-11-2007
	14	@brief A calibration component for the Huffman code creator
	15	*/
	16
	17	#include "AliHLTCalibrationProcessor.h"
	18
	19	class AliHLTCOMPHuffmanAltro;
	20	class AliHLTCOMPHuffmanData;
	21
	22	/**
	23	* @class AliHLTCOMPHuffmanAltroCalibComponent
	24	* This class is the calibration component for the AliTPCCalibHuffmanAltro class
	25	* used for calibration of the Huffman code table (which is created here).
	26	*
	27	* <h2>General properties:</h2>
	28	*
	29	* Component ID: \b HuffmanAltroCalibComponent <br>
	30	* Library: \b libAliHLTComp.so <br>
	31	* Input Data Types: ::kAliHLTDataTypeDDLRaw <br>
	32	* Output Data Types: AliHLTCompDefinitions::fgkHuffmanAltroCalDataType <br>
	33	*
	34	* <h2>Mandatory arguments:</h2>
	35	* <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
	36	* \li -origin <i> detector </i> <br>
	37	* set origin of data for code creation to specify output table (parameter transient)
	38	* \li -runnumber <i> decimal number </i> <br>
	39	* set runnumber to specify output table (parameter transient)
	40	* \li -dataspec <i> 0xYYXXaabb </i> <br>
	41	* set usual HLT dataspec (last slice, first slice, last patch, first patch)_Hexadezimal to specify output table
	42	* \li -trailerwords <i> decimal number </i> <br>
	43	* set number of trailerwords of incoming data (ranging from 1 to 3)
	44	*
	45	* <h2>Optional arguments:</h2>
	46	* <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
	47	* \li -tablepath <i> path to Huffman code table </i> <br>
	48	* set path to out put Huffman code table as root file, if no path is given,
	49	* output path is set to current path (parameter transient)
	50	*
	51	* It inherits from the @ref AliHLTCalibrationProcessor and uses the high-level
	52	* interface. The output is the class AliHLTCOMPHuffmanData as a TObject which
	53	* is written to the data base
	54	*
	55	* @ingroup alihlt_comp_components
	56	*/
	57	class AliHLTCOMPHuffmanAltroCalibComponent : public AliHLTCalibrationProcessor
	58	{
	59	public:
	60	/** constructor */
	61	AliHLTCOMPHuffmanAltroCalibComponent();
	62
	63	/** destructor */
	64	virtual ~AliHLTCOMPHuffmanAltroCalibComponent();
	65
	66	// Public functions to implement AliHLTComponent's interface.
	67	// These functions are required for the registration process
	68
	69	const char* GetComponentID();
	70	void GetInputDataTypes( vector<AliHLTComponentDataType>& list);
	71	AliHLTComponentDataType GetOutputDataType();
	72	virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier );
	73	AliHLTComponent* Spawn();
	74
	75	protected:
	76
	77	// Protected functions to implement AliHLTComponent's interface.
	78	// These functions provide initialization as well as the actual processing
	79	// capabilities of the component.
	80
	81	/** Initialize the calibration component. */
	82	Int_t InitCalibration();
	83
	84	/** Scan commandline arguments of the calibration component. */
	85	Int_t ScanArgument( Int_t argc, const char** argv );
	86
	87	/** DeInitialize the calibration component. */
	88	Int_t DeinitCalibration();
	89
	90	/** Process the data in the calibration component. */
	91	Int_t ProcessCalibration( const AliHLTComponentEventData& evtData, AliHLTComponentTriggerData& trigData );
	92
	93	/** Ship the data to the FXS at end of run or eventmodulo. */
	94	Int_t ShipDataToFXS( const AliHLTComponentEventData& evtData, AliHLTComponentTriggerData& trigData );
	95
	96	private:
	97
	98	/** copy constructor prohibited */
	99	AliHLTCOMPHuffmanAltroCalibComponent(const AliHLTCOMPHuffmanAltroCalibComponent&);
	100
	101	/** assignment operator prohibited */
	102	AliHLTCOMPHuffmanAltroCalibComponent& operator=(const AliHLTCOMPHuffmanAltroCalibComponent&);
	103
	104	/** Huffman compressor class */
	105	AliHLTCOMPHuffmanAltro * fHuffmanCompressor; //! instance of Huffman Compressor in this component
	106
	107	/** pointer to output Huffman code table and occurrence table (togehter in this class) */
	108	AliHLTCOMPHuffmanData * fHuffmanData; //! instance of output (Huffman Data, containing code table)
	109
	110	/** The Specification for this component */
	111	/** explicit specification of the origin of the data (transient) */
	112	TString fOrigin; // input line argument to determine origin for Huffman table
	113	// -> no input --> default taken from incoming data
	114	/** explicit specification of the run number */
	115	AliHLTUInt64_t fRunNumber; // input line argument to determine run number for Huffman table
	116
	117	/** specifications of the data */
	118	AliHLTUInt64_t fSpecification; // see above
	119
	120	/** explicit path to Huffman code table which will be put out */
	121	TString fTablePath; // input line argument to determine path for Huffman table
	122	// -> no input --> default set to current path name
	123	//AliHLTUInt8_t fSlice; // slice
	124	//AliHLTUInt8_t fPatch; // patch
	125
	126	/** number of NRCU trailer words of input data */
	127	Int_t fNRCUTrailerWords; // see above
	128
	129	ClassDef(AliHLTCOMPHuffmanAltroCalibComponent, 0)
	130
	131	};
	132	#endif