[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>
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; }
  /** 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);
  /** Calculate distance from point @f$ (p_x,p_y)@f$ to this object. 
      @param px Pixel X coordinate 
      @param py Pixel Y coordinate 
      @return distance. */
  virtual Int_t DistancetoPrimitive(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 ProcessRaw(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;
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)
  { } 
  /** 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;
  
  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 
  ClassDef(AliFMDDisplay,0)  // FMD specialised event display
};

#endif
//____________________________________________________________________
//
// Local Variables:
//   mode: C++
// End:
//
// EOF
//
Commit	Line	Data
bf000c32	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	*/
c2fc1258	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	*/
bf000c32	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"
a9579262	22	#include <TObjArray.h>
bf000c32	23	class TCanvas;
	24	class TPad;
	25	class TButton;
a9579262	26	class TSlider;
a9579262	27	class TH1;
bf000c32	28
bf000c32	29	//___________________________________________________________________
9f662337	30	/** @class AliFMDDisplay
	31	@brief Utility class to visualize FMD data in geometry.
	32	@ingroup FMD_util
	33	*/
bf000c32	34	class AliFMDDisplay : public AliFMDInput
	35	{
	36	public:
9f662337	37	/** Constructor
a9579262	38	@param onlyFMD Only show the FMD
9f662337	39	@param gAliceFile galice file*/
a9579262	40	AliFMDDisplay(Bool_t onlyFMD=kTRUE, const char* gAliceFile="galice.root");
9f662337	41	/** DTOR */
a9579262	42	virtual ~AliFMDDisplay();
9f662337	43	/** Singleton access function
9f662337	44	@return Singleton object. */
bf000c32	45	static AliFMDDisplay* Instance();
bf000c32	46
9f662337	47	/** Continue to next event */
bf000c32	48	void Continue() { fWait = kFALSE; }
9f662337	49	/** Zoom mode */
bf000c32	50	void Zoom() { fZoomMode = kTRUE; }
9f662337	51	/** Pick mode */
bf000c32	52	void Pick() { fZoomMode = kFALSE; }
a9579262	53	/** Redisplay the event */
a9579262	54	virtual void Redisplay(); // MENU
d98fbfa5	55	/** Break */
	56	virtual void Break();
	57	/** Render in 3D */
	58	virtual void Render();
	59
a9579262	60	/** Change cut */
a9579262	61	virtual void ChangeCut();
d98fbfa5	62	/** Change cut */
d98fbfa5	63	virtual void ChangeFactor();
9f662337	64	/** Called when a mouse or similar event happens in the display.
	65	@param event Event type
	66	@param px where the event happened in pixels along X
	67	@param py where the event happened in pixels along Y */
a9579262	68	virtual void ExecuteEvent(Int_t event, Int_t px, Int_t py);
9f662337	69	/** Calculate distance from point @f$ (p_x,p_y)@f$ to this object.
	70	@param px Pixel X coordinate
	71	@param py Pixel Y coordinate
	72	@return distance. */
a9579262	73	virtual Int_t DistancetoPrimitive(Int_t px, Int_t py);
9f662337	74	/** Paint into canvas
9f662337	75	@param option Not used */
a9579262	76	virtual void Paint(Option_t* option="") { (void)option; }
bf000c32	77
9f662337	78	/** Initialize
9f662337	79	@return @c false on error */
bf000c32	80	virtual Bool_t Init();
9f662337	81	/** Called at beginning of an event
	82	@param event Event number
	83	@return @c false on error */
bf000c32	84	virtual Bool_t Begin(Int_t event);
9f662337	85	/** Called at end of an event
9f662337	86	@return @c false on error */
bf000c32	87	virtual Bool_t End();
9f662337	88	/** Visualize a hit
	89	@param hit Hit
	90	@param p Track
	91	@return @c false on error */
bf000c32	92	virtual Bool_t ProcessHit(AliFMDHit* hit, TParticle* p);
9f662337	93	/** Visualize a digit
	94	@param digit Digit to draw
	95	@return @c false on error */
bf000c32	96	virtual Bool_t ProcessDigit(AliFMDDigit* digit);
42f1b2f5	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);
9f662337	101	/** Visualize a raw digit
	102	@param digit Raw digit.
	103	@return @c false on error */
d760ea03	104	virtual Bool_t ProcessRaw(AliFMDDigit* digit);
9f662337	105	/** Visualize a reconstructed point.
	106	@param recpoint Reconstructed point
	107	@return @c false on error */
bf000c32	108	virtual Bool_t ProcessRecPoint(AliFMDRecPoint* recpoint);
a9579262	109	/** Process ESD data for the FMD. Users should overload this to
	110	deal with ESD data.
	111	@param d Detector number (1-3)
	112	@param r Ring identifier ('I' or 'O')
	113	@param s Sector number (0-19, or 0-39)
	114	@param t Strip number (0-511, or 0-255)
	115	@param eta Psuedo-rapidity
	116	@param mult Psuedo-multiplicity
	117	@return @c false on error */
	118	virtual Bool_t ProcessESD(UShort_t d, Char_t r, UShort_t s, UShort_t t,
	119	Float_t eta, Float_t mult);
9f662337	120	/** Look up a color index, based on the value @a x and the maximum
	121	value of @a x
	122	@param x Value
	123	@param max Maximum (for example 1023 for digits)
	124	@return @c false on error */
d98fbfa5	125	virtual Int_t LookupColor(Float_t x, Float_t min, Float_t max) const;
bf000c32	126	protected:
15b17c89	127	/** Copy constructor
15b17c89	128	@param o Object to copy from */
b5ee4425	129	AliFMDDisplay(const AliFMDDisplay& o)
	130	: AliFMDInput(o),
	131	fWait(kFALSE),
	132	fMarkers(0),
	133	fHits(0),
	134	fCanvas(0),
	135	fPad(0),
2b893216	136	fButtons(0),
a9579262	137	fSlider(0),
d98fbfa5	138	fFactor(0),
b5ee4425	139	fZoomMode(0),
	140	fX0(0),
	141	fY0(0),
	142	fX1(0),
	143	fY1(0),
b5ee4425	144	fXPixel(0),
	145	fYPixel(0),
	146	fOldXPixel(0),
	147	fOldYPixel(0),
2b893216	148	fLineDrawn(0),
	149	fOnlyFMD(kTRUE),
	150	fSpec(0),
	151	fSpecCut(0),
d98fbfa5	152	fAux(0),
d98fbfa5	153	fReturn(kFALSE)
b5ee4425	154	{ }
15b17c89	155	/** Assignment operator
15b17c89	156	@return Reference to this object */
02a27b50	157	AliFMDDisplay& operator=(const AliFMDDisplay&) { return *this; }
d98fbfa5	158	/** Add a marker to the display
	159	@param x X position
	160	@param y Y position
	161	@param z Z position
	162	@param o Object to refer to
	163	@param s Signal
	164	@param max Maximum of signal */
	165	virtual void AddMarker(Float_t x, Float_t y, Float_t z,
	166	TObject* o, Float_t s, Float_t min, Float_t max);
15b17c89	167	/** Add a marker to the display
	168	@param det Detector
	169	@param rng Ring
	170	@param sec Sector
	171	@param str Strip
	172	@param o Object to refer to
	173	@param s Signal
	174	@param max Maximum of signal */
a9579262	175	virtual void AddMarker(UShort_t det, Char_t rng, UShort_t sec, UShort_t str,
d98fbfa5	176	TObject* o, Float_t s, Float_t min, Float_t max);
a9579262	177
	178	/** Show only the FMD detectors. */
	179	void ShowOnlyFMD();
	180	/** Make base canvas */
	181	virtual void MakeCanvas(const char** which);
	182	virtual void MakeAux();
	183	virtual void DrawAux();
	184	virtual void Idle();
	185	virtual void AtEnd();
d98fbfa5	186	virtual Bool_t InsideCut(Float_t v, const Float_t& min,
d98fbfa5	187	const Float_t& max) const;
02a27b50	188
bf000c32	189	static AliFMDDisplay* fgInstance; // Static instance
	190	Bool_t fWait; // Wait until user presses `Continue'
	191	TObjArray* fMarkers; // Cache of markers
	192	TObjArray* fHits; // Cache of `hits'
	193	TCanvas* fCanvas; // Canvas to draw in
	194	TPad* fPad; // View pad.
a9579262	195	TObjArray fButtons; // Continue button
a9579262	196	TSlider* fSlider; // Cut slider
d98fbfa5	197	TSlider* fFactor; // Factor slider
bf000c32	198	Bool_t fZoomMode; // Whether we're in Zoom mode
	199	Float_t fX0; // X at lower left corner or range
	200	Float_t fY0; // Y at lower left corner or range
	201	Float_t fX1; // X at upper right corner or range
	202	Float_t fY1; // Y at upper right corner or range
	203	Int_t fXPixel; // X pixel of mark
	204	Int_t fYPixel; // Y pixel of mark
	205	Int_t fOldXPixel; // Old x pixel of mark
	206	Int_t fOldYPixel; // Old y pixel of mark
	207	Bool_t fLineDrawn; // Whether we're drawing a box
5c96b03f	208	Bool_t fOnlyFMD; // Whether to only do FMD
	209	TH1* fSpec; // Spectra
	210	TH1* fSpecCut; // Cut spectra
	211	TCanvas* fAux; // Aux canvas.
d98fbfa5	212	Bool_t fReturn; // Stop
bf000c32	213	ClassDef(AliFMDDisplay,0) // FMD specialised event display
	214	};
	215
	216	#endif
	217	//____________________________________________________________________
	218	//
	219	// Local Variables:
	220	// mode: C++
	221	// End:
	222	//
	223	// EOF
	224	//