[u/mrichter/AliRoot.git] / FMD / AliFMDDisplay.h

#ifndef AliFMDDISPLAY_H
#define AliFMDDISPLAY_H
/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights
 * reserved. 
 *
 * See cxx source for full Copyright notice                               
 */
/** @file    AliFMDDisplay.h
    @author  Christian Holm Christensen <cholm@nbi.dk>
    @date    Mon Mar 27 12:39:09 2006
    @brief   FMD Event display 
*/
//___________________________________________________________________
//
// The classes defined here, are utility classes for reading in data
// for the FMD.  They are  put in a seperate library to not polute the
// normal libraries.  The classes are intended to be used as base
// classes for customized class that do some sort of analysis on the
// various types of data produced by the FMD. 
//
#include "AliFMDInput.h"
#include <TObjArray.h>
#include <TTimer.h>
class TCanvas;
class TPad;
class TButton;
class TSlider;
class TH1;

//___________________________________________________________________
/** @class AliFMDDisplay 
    @brief Utility class to visualize FMD data in geometry. 
    @ingroup FMD_util
 */
class AliFMDDisplay : public AliFMDInput
{
public:
  /** Constructor
      @param onlyFMD Only show the FMD
      @param gAliceFile galice file*/
  AliFMDDisplay(Bool_t onlyFMD=kTRUE, const char* gAliceFile="galice.root");
  /** DTOR */
  virtual ~AliFMDDisplay();
  /** Singleton access function
      @return Singleton object. */
  static AliFMDDisplay* Instance();

  /** Continue to next event */
  void  Continue() { fWait = kFALSE; }
  /** Run throug events as fast as possible */ 
  void Start() { fContinous = kTRUE; fWait = kFALSE; }
  /** Pause the processing */ 
  void Pause() { fContinous = kFALSE; fWait = kTRUE; }
  /** Zoom mode */
  void  Zoom() { fZoomMode = kTRUE; }
  /** Pick mode */
  void  Pick() { fZoomMode = kFALSE; }
  /** Redisplay the event */ 
  virtual void Redisplay(); // *MENU*
  /** Break */
  virtual void Break();
  /** Render in 3D */
  virtual void Render();
  
  /** Change cut */
  virtual void ChangeCut();
  /** Change cut */
  virtual void ChangeFactor();
  /** Called when a mouse or similar event happens in the display. 
      @param event Event type
      @param px    where the event happened in pixels along X
      @param py    where the event happened in pixels along Y */
  virtual void  ExecuteEvent(Int_t event, Int_t px, Int_t py);
  /** Paint into canvas 
      @param option Not used */
  virtual void  Paint(Option_t* option="") { (void)option; }

  /** Initialize
      @return  @c false on error */
  virtual Bool_t Init();
  /** Called at beginning of an event 
      @param event Event number
      @return @c false on error  */
  virtual Bool_t Begin(Int_t event);
  /** Called at end of an event 
      @return @c false on error  */
  virtual Bool_t End();
  /** Visualize a hit
      @param hit Hit
      @param p   Track
      @return @c false on error  */
  virtual Bool_t ProcessHit(AliFMDHit* hit, TParticle* p);
  /** Visualize a digit
      @param digit Digit to draw
      @return @c false on error  */
  virtual Bool_t ProcessDigit(AliFMDDigit* digit);
  /** Visualize a summable digit
      @param sdigit Summable digit to draw
      @return @c false on error  */
  virtual Bool_t ProcessSDigit(AliFMDSDigit* sdigit);
  /** Visualize a raw digit
      @param digit Raw digit.
      @return @c false on error  */
  virtual Bool_t ProcessRawDigit(AliFMDDigit* digit);
  /** Visualize a raw digit
      @param digit Raw digit.
      @return @c false on error  */
  virtual Bool_t ProcessRawCalibDigit(AliFMDDigit* digit);
  /** Visualize a reconstructed point.
      @param recpoint Reconstructed point
      @return @c false on error  */
  virtual Bool_t ProcessRecPoint(AliFMDRecPoint* recpoint);
  /** Process ESD data for the FMD.  Users should overload this to
      deal with ESD data. 
      @param d    Detector number (1-3)
      @param r    Ring identifier ('I' or 'O')
      @param s    Sector number (0-19, or 0-39)
      @param t    Strip number (0-511, or 0-255)
      @param eta  Psuedo-rapidity 
      @param mult Psuedo-multiplicity 
      @return  @c false on error  */
  virtual Bool_t ProcessESD(UShort_t d, Char_t r, UShort_t s, UShort_t t, 
			    Float_t eta, Float_t mult);
  /** Look up a color index, based on the value @a x and the maximum
      value of @a x
      @param x   Value 
      @param max Maximum (for example 1023 for digits)
      @return @c false on error  */
  virtual Int_t  LookupColor(Float_t x, Float_t min, Float_t max)  const;

  /** Set range of displayed values */
  virtual void SetCut(Float_t l=0., Float_t h=1.); //*MENU*
  virtual void SetFactor(Float_t f=1);
protected:
  /** Copy constructor 
      @param o Object to copy from  */
  AliFMDDisplay(const AliFMDDisplay& o) 
    : AliFMDInput(o),
      fWait(kFALSE),
      fMarkers(0),
      fHits(0),
      fCanvas(0),
      fPad(0),
      fButtons(0),
      fSlider(0),
      fFactor(0),
      fZoomMode(0),
      fX0(0),
      fY0(0),
      fX1(0),
      fY1(0),
      fXPixel(0),
      fYPixel(0),
      fOldXPixel(0),
      fOldYPixel(0),
      fLineDrawn(0), 
      fOnlyFMD(kTRUE),
      fSpec(0), 
      fSpecCut(0),
      fAux(0),
      fReturn(kFALSE),
      fContinous(kFALSE), 
      fTimeout(), 
      fInitialMin(0), 
      fInitialMax(1), 
      fInitialFactor(3./10)
  { } 
  /** Assignment operator 
      @return Reference to this object */
  AliFMDDisplay& operator=(const AliFMDDisplay&) { return *this; } 
  /** Add a marker to the display
      @param x   X position
      @param y   Y position
      @param z   Z position
      @param o   Object to refer to
      @param s   Signal 
      @param max Maximum of signal */
  virtual void AddMarker(Float_t x, Float_t y, Float_t z, 
			 TObject* o, Float_t s, Float_t min, Float_t max);
  /** Add a marker to the display
      @param det Detector
      @param rng Ring
      @param sec Sector 
      @param str Strip
      @param o   Object to refer to
      @param s   Signal 
      @param max Maximum of signal */
  virtual void AddMarker(UShort_t det, Char_t rng, UShort_t sec, UShort_t str, 
			 TObject* o, Float_t s, Float_t min, Float_t max);
  
  /** Show only the FMD detectors. */
  void ShowOnlyFMD();
  /** Make base canvas */ 
  virtual void MakeCanvas(const char** which);
  virtual void MakeAux();
  virtual void DrawAux();
  virtual void Idle();
  virtual void AtEnd();
  virtual Bool_t InsideCut(Float_t v, const Float_t& min, 
			 const Float_t& max) const;
  virtual Double_t GetADCThreshold(UShort_t d, Char_t r, 
				   UShort_t s, UShort_t t) const;
  
  static AliFMDDisplay* fgInstance; // Static instance 
  Bool_t                fWait;      // Wait until user presses `Continue'
  TObjArray*            fMarkers;   // Cache of markers
  TObjArray*            fHits;      // Cache of `hits'
  TCanvas*              fCanvas;    // Canvas to draw in 
  TPad*                 fPad;       // View pad. 
  TObjArray             fButtons;   // Continue button
  TSlider*              fSlider;    // Cut slider
  TSlider*              fFactor;    // Factor slider
  Bool_t                fZoomMode;  // Whether we're in Zoom mode
  Float_t               fX0;        // X at lower left corner or range 
  Float_t               fY0;        // Y at lower left corner or range 
  Float_t               fX1;        // X at upper right corner or range 
  Float_t               fY1;        // Y at upper right corner or range 
  Int_t                 fXPixel;    // X pixel of mark
  Int_t                 fYPixel;    // Y pixel of mark
  Int_t                 fOldXPixel; // Old x pixel of mark
  Int_t                 fOldYPixel; // Old y pixel of mark
  Bool_t                fLineDrawn; // Whether we're drawing a box
  Bool_t                fOnlyFMD;   // Whether to only do FMD
  TH1*                  fSpec;      // Spectra
  TH1*                  fSpecCut;   // Cut spectra
  TCanvas*              fAux;       // Aux canvas.
  Bool_t                fReturn;    // Stop 
  Bool_t                fContinous;
  TTimer                fTimeout;
  Float_t               fInitialMin;
  Float_t               fInitialMax;
  Float_t               fInitialFactor;

  struct Range_t { 
    UInt_t  fNbins;
    Float_t fLow;
    Float_t fHigh;
  };
  static const Range_t fgkEdepRange;
  static const Range_t fgkAdcRange;
  static const Range_t fgkMultRange;

  ClassDef(AliFMDDisplay,0)  // FMD specialised event display
};

#endif
//____________________________________________________________________
//
// Local Variables:
//   mode: C++
// End:
//
// EOF
//
Commit	Line	Data
	1	#ifndef AliFMDDISPLAY_H
	2	#define AliFMDDISPLAY_H
	3	/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights
	4	* reserved.
	5	*
	6	* See cxx source for full Copyright notice
	7	*/
	8	/** @file AliFMDDisplay.h
	9	@author Christian Holm Christensen <cholm@nbi.dk>
	10	@date Mon Mar 27 12:39:09 2006
	11	@brief FMD Event display
	12	*/
	13	//___________________________________________________________________
	14	//
	15	// The classes defined here, are utility classes for reading in data
	16	// for the FMD. They are put in a seperate library to not polute the
	17	// normal libraries. The classes are intended to be used as base
	18	// classes for customized class that do some sort of analysis on the
	19	// various types of data produced by the FMD.
	20	//
	21	#include "AliFMDInput.h"
	22	#include <TObjArray.h>
	23	#include <TTimer.h>
	24	class TCanvas;
	25	class TPad;
	26	class TButton;
	27	class TSlider;
	28	class TH1;
	29
	30	//___________________________________________________________________
	31	/** @class AliFMDDisplay
	32	@brief Utility class to visualize FMD data in geometry.
	33	@ingroup FMD_util
	34	*/
	35	class AliFMDDisplay : public AliFMDInput
	36	{
	37	public:
	38	/** Constructor
	39	@param onlyFMD Only show the FMD
	40	@param gAliceFile galice file*/
	41	AliFMDDisplay(Bool_t onlyFMD=kTRUE, const char* gAliceFile="galice.root");
	42	/** DTOR */
	43	virtual ~AliFMDDisplay();
	44	/** Singleton access function
	45	@return Singleton object. */
	46	static AliFMDDisplay* Instance();
	47
	48	/** Continue to next event */
	49	void Continue() { fWait = kFALSE; }
	50	/** Run throug events as fast as possible */
	51	void Start() { fContinous = kTRUE; fWait = kFALSE; }
	52	/** Pause the processing */
	53	void Pause() { fContinous = kFALSE; fWait = kTRUE; }
	54	/** Zoom mode */
	55	void Zoom() { fZoomMode = kTRUE; }
	56	/** Pick mode */
	57	void Pick() { fZoomMode = kFALSE; }
	58	/** Redisplay the event */
	59	virtual void Redisplay(); // MENU
	60	/** Break */
	61	virtual void Break();
	62	/** Render in 3D */
	63	virtual void Render();
	64
	65	/** Change cut */
	66	virtual void ChangeCut();
	67	/** Change cut */
	68	virtual void ChangeFactor();
	69	/** Called when a mouse or similar event happens in the display.
	70	@param event Event type
	71	@param px where the event happened in pixels along X
	72	@param py where the event happened in pixels along Y */
	73	virtual void ExecuteEvent(Int_t event, Int_t px, Int_t py);
	74	/** Paint into canvas
	75	@param option Not used */
	76	virtual void Paint(Option_t* option="") { (void)option; }
	77
	78	/** Initialize
	79	@return @c false on error */
	80	virtual Bool_t Init();
	81	/** Called at beginning of an event
	82	@param event Event number
	83	@return @c false on error */
	84	virtual Bool_t Begin(Int_t event);
	85	/** Called at end of an event
	86	@return @c false on error */
	87	virtual Bool_t End();
	88	/** Visualize a hit
	89	@param hit Hit
	90	@param p Track
	91	@return @c false on error */
	92	virtual Bool_t ProcessHit(AliFMDHit* hit, TParticle* p);
	93	/** Visualize a digit
	94	@param digit Digit to draw
	95	@return @c false on error */
	96	virtual Bool_t ProcessDigit(AliFMDDigit* digit);
	97	/** Visualize a summable digit
	98	@param sdigit Summable digit to draw
	99	@return @c false on error */
	100	virtual Bool_t ProcessSDigit(AliFMDSDigit* sdigit);
	101	/** Visualize a raw digit
	102	@param digit Raw digit.
	103	@return @c false on error */
	104	virtual Bool_t ProcessRawDigit(AliFMDDigit* digit);
	105	/** Visualize a raw digit
	106	@param digit Raw digit.
	107	@return @c false on error */
	108	virtual Bool_t ProcessRawCalibDigit(AliFMDDigit* digit);
	109	/** Visualize a reconstructed point.
	110	@param recpoint Reconstructed point
	111	@return @c false on error */
	112	virtual Bool_t ProcessRecPoint(AliFMDRecPoint* recpoint);
	113	/** Process ESD data for the FMD. Users should overload this to
	114	deal with ESD data.
	115	@param d Detector number (1-3)
	116	@param r Ring identifier ('I' or 'O')
	117	@param s Sector number (0-19, or 0-39)
	118	@param t Strip number (0-511, or 0-255)
	119	@param eta Psuedo-rapidity
	120	@param mult Psuedo-multiplicity
	121	@return @c false on error */
	122	virtual Bool_t ProcessESD(UShort_t d, Char_t r, UShort_t s, UShort_t t,
	123	Float_t eta, Float_t mult);
	124	/** Look up a color index, based on the value @a x and the maximum
	125	value of @a x
	126	@param x Value
	127	@param max Maximum (for example 1023 for digits)
	128	@return @c false on error */
	129	virtual Int_t LookupColor(Float_t x, Float_t min, Float_t max) const;
	130
	131	/** Set range of displayed values */
	132	virtual void SetCut(Float_t l=0., Float_t h=1.); //MENU
	133	virtual void SetFactor(Float_t f=1);
	134	protected:
	135	/** Copy constructor
	136	@param o Object to copy from */
	137	AliFMDDisplay(const AliFMDDisplay& o)
	138	: AliFMDInput(o),
	139	fWait(kFALSE),
	140	fMarkers(0),
	141	fHits(0),
	142	fCanvas(0),
	143	fPad(0),
	144	fButtons(0),
	145	fSlider(0),
	146	fFactor(0),
	147	fZoomMode(0),
	148	fX0(0),
	149	fY0(0),
	150	fX1(0),
	151	fY1(0),
	152	fXPixel(0),
	153	fYPixel(0),
	154	fOldXPixel(0),
	155	fOldYPixel(0),
	156	fLineDrawn(0),
	157	fOnlyFMD(kTRUE),
	158	fSpec(0),
	159	fSpecCut(0),
	160	fAux(0),
	161	fReturn(kFALSE),
	162	fContinous(kFALSE),
	163	fTimeout(),
	164	fInitialMin(0),
	165	fInitialMax(1),
	166	fInitialFactor(3./10)
	167	{ }
	168	/** Assignment operator
	169	@return Reference to this object */
	170	AliFMDDisplay& operator=(const AliFMDDisplay&) { return *this; }
	171	/** Add a marker to the display
	172	@param x X position
	173	@param y Y position
	174	@param z Z position
	175	@param o Object to refer to
	176	@param s Signal
	177	@param max Maximum of signal */
	178	virtual void AddMarker(Float_t x, Float_t y, Float_t z,
	179	TObject* o, Float_t s, Float_t min, Float_t max);
	180	/** Add a marker to the display
	181	@param det Detector
	182	@param rng Ring
	183	@param sec Sector
	184	@param str Strip
	185	@param o Object to refer to
	186	@param s Signal
	187	@param max Maximum of signal */
	188	virtual void AddMarker(UShort_t det, Char_t rng, UShort_t sec, UShort_t str,
	189	TObject* o, Float_t s, Float_t min, Float_t max);
	190
	191	/** Show only the FMD detectors. */
	192	void ShowOnlyFMD();
	193	/** Make base canvas */
	194	virtual void MakeCanvas(const char** which);
	195	virtual void MakeAux();
	196	virtual void DrawAux();
	197	virtual void Idle();
	198	virtual void AtEnd();
	199	virtual Bool_t InsideCut(Float_t v, const Float_t& min,
	200	const Float_t& max) const;
	201	virtual Double_t GetADCThreshold(UShort_t d, Char_t r,
	202	UShort_t s, UShort_t t) const;
	203
	204	static AliFMDDisplay* fgInstance; // Static instance
	205	Bool_t fWait; // Wait until user presses `Continue'
	206	TObjArray* fMarkers; // Cache of markers
	207	TObjArray* fHits; // Cache of `hits'
	208	TCanvas* fCanvas; // Canvas to draw in
	209	TPad* fPad; // View pad.
	210	TObjArray fButtons; // Continue button
	211	TSlider* fSlider; // Cut slider
	212	TSlider* fFactor; // Factor slider
	213	Bool_t fZoomMode; // Whether we're in Zoom mode
	214	Float_t fX0; // X at lower left corner or range
	215	Float_t fY0; // Y at lower left corner or range
	216	Float_t fX1; // X at upper right corner or range
	217	Float_t fY1; // Y at upper right corner or range
	218	Int_t fXPixel; // X pixel of mark
	219	Int_t fYPixel; // Y pixel of mark
	220	Int_t fOldXPixel; // Old x pixel of mark
	221	Int_t fOldYPixel; // Old y pixel of mark
	222	Bool_t fLineDrawn; // Whether we're drawing a box
	223	Bool_t fOnlyFMD; // Whether to only do FMD
	224	TH1* fSpec; // Spectra
	225	TH1* fSpecCut; // Cut spectra
	226	TCanvas* fAux; // Aux canvas.
	227	Bool_t fReturn; // Stop
	228	Bool_t fContinous;
	229	TTimer fTimeout;
	230	Float_t fInitialMin;
	231	Float_t fInitialMax;
	232	Float_t fInitialFactor;
	233
	234	struct Range_t {
	235	UInt_t fNbins;
	236	Float_t fLow;
	237	Float_t fHigh;
	238	};
	239	static const Range_t fgkEdepRange;
	240	static const Range_t fgkAdcRange;
	241	static const Range_t fgkMultRange;
	242
	243	ClassDef(AliFMDDisplay,0) // FMD specialised event display
	244	};
	245
	246	#endif
	247	//____________________________________________________________________
	248	//
	249	// Local Variables:
	250	// mode: C++
	251	// End:
	252	//
	253	// EOF
	254	//