[u/mrichter/AliRoot.git] / HLT / TPCLib / AliHLTTPCCalibPulserComponent.h

//-*- Mode: C++ -*-
#ifndef ALIHLTTPCCALIBPULSERCOMPONENT_H
#define ALIHLTTPCCALIBPULSERCOMPONENT_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   AliHLTTPCCalibPulserComponent.h
    @author Jochen Thaeder
    @date   
    @brief  A pulser calibration component for the TPC.
*/

// see header file for class documentation
// or
// refer to README to build package
// or
// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt   

#include "AliHLTCalibrationProcessor.h"
#include "AliHLTTPCDefinitions.h"

class AliTPCRawStream;
class AliRawReaderMemory;
class AliTPCCalibPulser;

/**
 * @class AliHLTTPCCalibPulserComponent
 * 
 * This class is the calibration component for the AliTPCCalibPulser class 
 * used for pulser calibration of the TPC. 
 * 
 * It inherits from the AliHLTCalibrationProcessor and uses the high-level 
 * interface. The output is the class AliTPCCalibPulser as a TObject.
 *
 * The component has the following component arguments:
 *   -rcuformat <old/new>  : Wether to use old or new rcuformat ( default is new )
 *   -enableanalysis       : Wether to enable analyis before shipping data to FXS
 *
 * @ingroup alihlt_tpc
 */
class AliHLTTPCCalibPulserComponent : public AliHLTCalibrationProcessor
    {
    public:
      /** constructor */
      AliHLTTPCCalibPulserComponent();
      /** destructor */
      virtual ~AliHLTTPCCalibPulserComponent();
      
      // 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:

      using AliHLTCalibrationProcessor::ProcessCalibration;
      using AliHLTCalibrationProcessor::ShipDataToFXS;
      
      // 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 */
      AliHLTTPCCalibPulserComponent(const AliHLTTPCCalibPulserComponent&);
      /** assignment operator prohibited */
      AliHLTTPCCalibPulserComponent& operator=(const AliHLTTPCCalibPulserComponent&);

      /** The reader object for reading from memory */
      AliRawReaderMemory* fRawReader;                                              //!transient

      /** The reader object for reading TPC raw data */  
      AliTPCRawStream* fRawStream;                                                 //!transient

      /** Pulser Calibration class */
      AliTPCCalibPulser * fCalibPulser;                                        //!transient
      
      /** Wether to use old RCU format */
      Bool_t fRCUFormat;                                                           // see above

      /** Minimum patch specifcation for this component */
      AliHLTUInt8_t fMinPatch;                                                     // see above

      /** Minimum patch specifcation for this component */
      AliHLTUInt8_t fMaxPatch;                                                     // see above

      /** The Specification for this component */
      AliHLTUInt32_t fSpecification;                                               // see above

      /** Analysze calibration data before shipping to FXS */
      Bool_t fEnableAnalysis;                                                      // see above

      ClassDef(AliHLTTPCCalibPulserComponent, 0)

    };

#endif
Commit	Line	Data
9d9ffd37	1	//-- Mode: C++ --
	2	#ifndef ALIHLTTPCCALIBPULSERCOMPONENT_H
	3	#define ALIHLTTPCCALIBPULSERCOMPONENT_H
	4
	5	/* This file is property of and copyright by the ALICE HLT Project *
	6	* ALICE Experiment at CERN, All rights reserved. *
	7	* See cxx source for full Copyright notice */
	8
	9	/** @file AliHLTTPCCalibPulserComponent.h
	10	@author Jochen Thaeder
	11	@date
	12	@brief A pulser calibration component for the TPC.
	13	*/
	14
6a8e0bb4	15	// see header file for class documentation
	16	// or
	17	// refer to README to build package
	18	// or
	19	// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
	20
9d9ffd37	21	#include "AliHLTCalibrationProcessor.h"
	22	#include "AliHLTTPCDefinitions.h"
	23
	24	class AliTPCRawStream;
	25	class AliRawReaderMemory;
	26	class AliTPCCalibPulser;
	27
	28	/**
	29	* @class AliHLTTPCCalibPulserComponent
	30	*
	31	* This class is the calibration component for the AliTPCCalibPulser class
	32	* used for pulser calibration of the TPC.
	33	*
7c4091c1	34	* It inherits from the AliHLTCalibrationProcessor and uses the high-level
7c4091c1	35	* interface. The output is the class AliTPCCalibPulser as a TObject.
9d9ffd37	36	*
	37	* The component has the following component arguments:
	38	* -rcuformat <old/new> : Wether to use old or new rcuformat ( default is new )
	39	* -enableanalysis : Wether to enable analyis before shipping data to FXS
	40	*
	41	* @ingroup alihlt_tpc
	42	*/
	43	class AliHLTTPCCalibPulserComponent : public AliHLTCalibrationProcessor
	44	{
	45	public:
	46	/** constructor */
	47	AliHLTTPCCalibPulserComponent();
9d9ffd37	48	/** destructor */
	49	virtual ~AliHLTTPCCalibPulserComponent();
	50
	51	// Public functions to implement AliHLTComponent's interface.
	52	// These functions are required for the registration process
	53
	54	const char* GetComponentID();
	55	void GetInputDataTypes( vector<AliHLTComponentDataType>& list);
	56	AliHLTComponentDataType GetOutputDataType();
	57	virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier );
	58	AliHLTComponent* Spawn();
	59
	60	protected:
5d2abf3b	61
	62	using AliHLTCalibrationProcessor::ProcessCalibration;
	63	using AliHLTCalibrationProcessor::ShipDataToFXS;
9d9ffd37	64
	65	// Protected functions to implement AliHLTComponent's interface.
	66	// These functions provide initialization as well as the actual processing
	67	// capabilities of the component.
	68
	69	/** Initialize the calibration component. */
	70	Int_t InitCalibration();
	71
	72	/** Scan commandline arguments of the calibration component. */
	73	Int_t ScanArgument( Int_t argc, const char** argv );
	74
	75	/** DeInitialize the calibration component. */
	76	Int_t DeinitCalibration();
	77
	78	/** Process the data in the calibration component. */
	79	Int_t ProcessCalibration( const AliHLTComponentEventData& evtData, AliHLTComponentTriggerData& trigData );
	80
	81	/** Ship the data to the FXS at end of run or eventmodulo. */
	82	Int_t ShipDataToFXS( const AliHLTComponentEventData& evtData, AliHLTComponentTriggerData& trigData );
	83
	84	private:
8f8bf0af	85	/** copy constructor prohibited */
	86	AliHLTTPCCalibPulserComponent(const AliHLTTPCCalibPulserComponent&);
	87	/** assignment operator prohibited */
	88	AliHLTTPCCalibPulserComponent& operator=(const AliHLTTPCCalibPulserComponent&);
9d9ffd37	89
	90	/** The reader object for reading from memory */
	91	AliRawReaderMemory* fRawReader; //!transient
	92
	93	/** The reader object for reading TPC raw data */
	94	AliTPCRawStream* fRawStream; //!transient
	95
	96	/** Pulser Calibration class */
	97	AliTPCCalibPulser * fCalibPulser; //!transient
	98
	99	/** Wether to use old RCU format */
	100	Bool_t fRCUFormat; // see above
	101
	102	/** Minimum patch specifcation for this component */
	103	AliHLTUInt8_t fMinPatch; // see above
	104
	105	/** Minimum patch specifcation for this component */
	106	AliHLTUInt8_t fMaxPatch; // see above
	107
	108	/** The Specification for this component */
	109	AliHLTUInt32_t fSpecification; // see above
	110
	111	/** Analysze calibration data before shipping to FXS */
	112	Bool_t fEnableAnalysis; // see above
	113
	114	ClassDef(AliHLTTPCCalibPulserComponent, 0)
	115
	116	};
	117
	118	#endif