Painter for EclData that shows common event characteristics on 1D histograms. More...

#include <EclPainterCommon.h>

Inheritance diagram for EclPainterCommon:

Public Types
enum	Type { ENERGY , ENERGY_SUM , TIME }
	Subtype of histogram to draw. More...

Public Member Functions
	EclPainterCommon (EclData *data, Type type)
	Constructor for EclPainter subclass.

virtual	~EclPainterCommon ()
	Destructor for EclPainter subclass.

Type	getType ()
	Return subtype of ECLPainterCommon.

virtual void	getInformation (int px, int py, MultilineWidget *panel) override
	Sets the information to be displayed in the provided MultilineWidget.

void	Draw () override
	Redraw the canvas.

void	setData (EclData *data)
	Set EclData to display in painter.

EclData *	getData ()
	Return currently displayed EclData.

const EclData *	getData () const
	Return currently displayed EclData.

void	setMapper (ECL::ECLChannelMapper *mapper)
	Set ECLChannelMapper for CellID <-> (crate, shaper, chid) conversion.

ECL::ECLChannelMapper *	getMapper ()
	Return currently set ECLChannelMapper.

void	setDisplayedSubsystem (EclData::EclSubsystem sys)
	Change between the displayed ECL subsystem (barrel, forward and backward endcaps).

EclData::EclSubsystem	getDisplayedSubsystem ()
	Get currently displayed ECL subsystem.

TString	getSubsystemTitle (EclData::EclSubsystem subsys)
	Return title of ECL subsystem to use in painter.

virtual EclPainter *	handleClick (int px, int py)
	Some EclPainters can shift to another view upon click.

virtual void	setXRange (int x1, int x2)
	Set XRange for histogram in EclPainter.

Protected Member Functions
void	getNewRootObjectName (char *buf, int size)
	Make unique name for next root object.

Private Member Functions
int	getMinX ()
	Return m_x_min.

int	getMaxX ()
	Return m_x_max.

void	initHisto ()
	Initialize histogram.

void	setTitles ()
	Update titles of the histogram.

void	cloneFrom (const EclPainter &other)
	Clone attributes from other EclPainter.

Private Attributes
Type	m_type
	Display subtypes of this class.

TH1F *	m_hist
	Histogram for energy distribution.

EclData *	m_ecl_data
	Data to draw.

ECL::ECLChannelMapper *	m_mapper
	mapper for CellID <-> (crate, shaper, chid) conversion.

EclData::EclSubsystem	displayed_subsys
	Identifier of displayed ECL subsystem.

Static Private Attributes
static int	m_obj_counter = 0
	Counter to make unique names for new root objects.

Detailed Description

Painter for EclData that shows common event characteristics on 1D histograms.

Definition at line 27 of file EclPainterCommon.h.

Member Enumeration Documentation

◆ Type

enum Type

Subtype of histogram to draw.

Enumerator
ENERGY	Energy per channel distribution.
ENERGY_SUM	Energy per event distribution.
TIME	Time distribution.

Definition at line 30 of file EclPainterCommon.h.

              {
      ENERGY, 
      ENERGY_SUM, 
      TIME 
    };

Constructor & Destructor Documentation

◆ EclPainterCommon()

EclPainterCommon	(	EclData *	data,
		Type	type
	)

Constructor for EclPainter subclass.

Definition at line 16 of file EclPainterCommon.cc.

                                                           :
  EclPainter(data)
{
  m_type = type;
 
  initHisto();
  m_hist->GetXaxis()->CenterTitle();
  m_hist->GetXaxis()->SetTitleOffset(1.1);
  m_hist->GetYaxis()->SetTitleOffset(1.1);
}

◆ ~EclPainterCommon()

~EclPainterCommon ( )

virtual

Destructor for EclPainter subclass.

Definition at line 27 of file EclPainterCommon.cc.

{
  delete m_hist;
}

Member Function Documentation

◆ cloneFrom()

void cloneFrom ( const EclPainter & other )

privateinherited

Clone attributes from other EclPainter.

Definition at line 93 of file EclPainter.cc.

{
  m_ecl_data = new EclData(*other.m_ecl_data);
  m_mapper = other.m_mapper;
  displayed_subsys = other.displayed_subsys;
}

◆ Draw()

void Draw ( )

overridevirtual

Redraw the canvas.

Implements EclPainter.

Definition at line 74 of file EclPainterCommon.cc.

{
  EclData* data = getData();
 
  setTitles();
  m_hist->Reset();
 
  switch (getType()) {
    case ENERGY:
      data->fillEnergyHistogram(m_hist, getMinX(), getMaxX(), getDisplayedSubsystem());
      break;
    case ENERGY_SUM:
      data->fillEnergySumHistogram(m_hist, getMinX(), getMaxX(), getDisplayedSubsystem());
      break;
    case TIME:
      data->fillTimeHistogram(m_hist, getMinX(), getMaxX(), getDisplayedSubsystem());
      break;
  }
 
  m_hist->Draw();
}

◆ getData() [1/2]

EclData * getData ( )

inlineinherited

Return currently displayed EclData.

Definition at line 46 of file EclPainter.h.

46{ return m_ecl_data; }

◆ getData() [2/2]

const EclData * getData ( ) const

inlineinherited

Return currently displayed EclData.

Definition at line 48 of file EclPainter.h.

48{ return m_ecl_data; }

◆ getDisplayedSubsystem()

EclData::EclSubsystem getDisplayedSubsystem ( )

inherited

Get currently displayed ECL subsystem.

Definition at line 51 of file EclPainter.cc.

{
  return displayed_subsys;
}

◆ getInformation()

void getInformation	(	int	px,
		int	py,
		MultilineWidget *	panel
	)

overridevirtual

Sets the information to be displayed in the provided MultilineWidget.

Parameters

px	X coordinate of mouse cursor.
py	Y coordinate of mouse cursor.
panel	MultilineWidget to display the information

Reimplemented from EclPainter.

Definition at line 69 of file EclPainterCommon.cc.

{
  EclPainter::getInformation(px, py, panel);
}

◆ getMapper()

ECL::ECLChannelMapper * getMapper ( )

inherited

Return currently set ECLChannelMapper.

Definition at line 41 of file EclPainter.cc.

{
  return m_mapper;
}

◆ getMaxX()

int getMaxX ( )

private

Return m_x_max.

Definition at line 46 of file EclPainterCommon.cc.

{
  switch (m_type) {
    case ENERGY:
      return 150;
    case ENERGY_SUM:
      return 2500;
    case TIME:
      return 2048;
  }
 
  return 0;
}

◆ getMinX()

int getMinX ( )

private

Return m_x_min.

Definition at line 32 of file EclPainterCommon.cc.

{
  switch (m_type) {
    case ENERGY:
      return 0;
    case ENERGY_SUM:
      return 0;
    case TIME:
      return -2048;
  }
 
  return 0;
}

◆ getNewRootObjectName()

void getNewRootObjectName	(	char *	buf,
		int	size
	)

protectedinherited

Make unique name for next root object.

Definition at line 88 of file EclPainter.cc.

{
  snprintf(buf, n, "ECL DATA_%d", m_obj_counter++);
}

◆ getSubsystemTitle()

TString getSubsystemTitle ( EclData::EclSubsystem subsys )

inherited

Return title of ECL subsystem to use in painter.

Definition at line 56 of file EclPainter.cc.

{
  switch (subsys) {
    case EclData::BARR:
      return TString("Barrel");
    case EclData::FORW:
      return TString("Forward endcap");
    case EclData::BACKW:
      return TString("Backward endcap");
    case EclData::ALL:
      return TString("Full ECL");
    default:
      return TString();
  }
}

◆ getType()

EclPainterCommon::Type getType ( )

Return subtype of ECLPainterCommon.

Definition at line 120 of file EclPainterCommon.cc.

{
  return m_type;
}

◆ handleClick()

EclPainter * handleClick	(	int	px,
		int	py
	)

virtualinherited

Some EclPainters can shift to another view upon click.

(For example, clicking on crate reveals histogram of shapers in that crate)

Returns: EclPainter with new perspective/range.

Reimplemented in EclPainter1D.

Definition at line 79 of file EclPainter.cc.

{
  return nullptr;
}

◆ initHisto()

void initHisto ( )

private

Initialize histogram.

Definition at line 60 of file EclPainterCommon.cc.

{
 
  char obj_name[255];
  getNewRootObjectName(obj_name, 255);
  m_hist = new TH1F(obj_name, "title", getMaxX() / 10,
                    getMinX(), getMaxX());
}

◆ setData()

void setData ( EclData * data )

inlineinherited

Set EclData to display in painter.

Definition at line 44 of file EclPainter.h.

44{ m_ecl_data = data; }

◆ setDisplayedSubsystem()

void setDisplayedSubsystem ( EclData::EclSubsystem sys )

inherited

Change between the displayed ECL subsystem (barrel, forward and backward endcaps).

Definition at line 46 of file EclPainter.cc.

{
  displayed_subsys = sys;
}

◆ setMapper()

void setMapper ( ECL::ECLChannelMapper * mapper )

inherited

Set ECLChannelMapper for CellID <-> (crate, shaper, chid) conversion.

Definition at line 36 of file EclPainter.cc.

{
  m_mapper = mapper;
}

◆ setTitles()

void setTitles ( )

private

Update titles of the histogram.

Definition at line 97 of file EclPainterCommon.cc.

{
  const char* name[3] = {
    "Energy per channel",
    "Energy sum per event",
    "Time"
  };
  const char* xname[3] = {
    "Energy (MeV)",
    "Energy (MeV)",
    "Time (ns)"
  };
 
  int type = (int)getType();
 
  TString title = TString(name[type]) + " (" +
                  getSubsystemTitle(getDisplayedSubsystem()) + ")";
  m_hist->SetTitle(title);
 
  m_hist->SetXTitle(xname[type]);
  m_hist->SetYTitle("");
}

◆ setXRange()

void setXRange	(	int	x1,
		int	x2
	)

virtualinherited

Set XRange for histogram in EclPainter.

Reimplemented in EclPainter1D.

Definition at line 84 of file EclPainter.cc.

85{

86}

Member Data Documentation

◆ displayed_subsys

EclData::EclSubsystem displayed_subsys

privateinherited

Identifier of displayed ECL subsystem.

Definition at line 116 of file EclPainter.h.

◆ m_ecl_data

EclData* m_ecl_data

privateinherited

Data to draw.

Definition at line 111 of file EclPainter.h.

◆ m_hist

TH1F* m_hist

private

Histogram for energy distribution.

Definition at line 49 of file EclPainterCommon.h.

◆ m_mapper

ECL::ECLChannelMapper* m_mapper

privateinherited

mapper for CellID <-> (crate, shaper, chid) conversion.

Definition at line 113 of file EclPainter.h.

◆ m_obj_counter

int m_obj_counter = 0

staticprivateinherited

Counter to make unique names for new root objects.

Definition at line 109 of file EclPainter.h.

◆ m_type

Type m_type

private

Display subtypes of this class.

Definition at line 47 of file EclPainterCommon.h.

The documentation for this class was generated from the following files:

ecl/modules/eclDisplay/include/EclPainterCommon.h
ecl/modules/eclDisplay/src/EclPainterCommon.cc

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ EclPainterCommon()

◆ ~EclPainterCommon()

Member Function Documentation

◆ cloneFrom()

◆ Draw()

◆ getData() [1/2]

◆ getData() [2/2]

◆ getDisplayedSubsystem()

◆ getInformation()

◆ getMapper()

◆ getMaxX()

◆ getMinX()

◆ getNewRootObjectName()

◆ getSubsystemTitle()

◆ getType()

◆ handleClick()

◆ initHisto()

◆ setData()

◆ setDisplayedSubsystem()

◆ setMapper()

◆ setTitles()

◆ setXRange()

Member Data Documentation

◆ displayed_subsys

◆ m_ecl_data

◆ m_hist

◆ m_mapper

◆ m_obj_counter

◆ m_type