Draw the mesh of a field-map component. More...

#include <ViewFEMesh.hh>

Inheritance diagram for Garfield::ViewFEMesh:

Public Member Functions
	ViewFEMesh ()
	Constructor.

	~ViewFEMesh ()=default
	Destructor.

void	SetComponent (ComponentFieldMap *cmp)
	Set the component from which to retrieve the mesh and field.

void	SetPlane (const double fx, const double fy, const double fz, const double x0, const double y0, const double z0) override

void	SetPlane (const double fx, const double fy, const double fz, const double x0, const double y0, const double z0, const double hx, const double hy, const double hz) override
	Set the projection plane specifying a hint for the in-plane x axis.

void	SetXaxis (TGaxis *ax)

void	SetYaxis (TGaxis *ay)

void	SetXaxisTitle (const std::string &xtitle)

void	SetYaxisTitle (const std::string &ytitle)

void	EnableAxes ()

void	DisableAxes ()

bool	Plot ()
	Plot method to be called by user.

void	SetFillMesh (const bool f)
	Element fill switch; 2D only, set false for wireframe mesh.

void	SetDrawViewRegion (bool do_draw)
	Display intersection of projection plane with viewing area.

bool	GetDrawViewRegion (void) const

void	SetColor (int matID, int colorID)

void	SetFillColor (int matID, int colorID)

void	SetViewDrift (ViewDrift *vd)
	Set the optional associated ViewDrift.

void	SetFillMeshWithBorders ()
	Show filled mesh elements.

void	CreateDefaultAxes ()
	Create a default set of custom-made axes.

void	DisableMaterial (int materialID)
	Disable a material so that its mesh cells are not drawn.

Public Member Functions inherited from Garfield::ViewBase
	ViewBase ()=delete
	Default constructor.

	ViewBase (const std::string &name)
	Constructor.

virtual	~ViewBase ()=default
	Destructor.

void	SetCanvas (TPad *pad)
	Set the canvas to be painted on.

void	SetCanvas ()
	Unset an external canvas.

TPad *	GetCanvas ()
	Retrieve the canvas.

void	SetArea (const double xmin, const double ymin, const double xmax, const double ymax)

virtual void	SetArea (const double xmin, const double ymin, const double zmin, const double xmax, const double ymax, const double zmax)
	Set a bounding box (if applicable).

void	SetArea ()

virtual void	SetPlane (const double fx, const double fy, const double fz, const double x0, const double y0, const double z0)

virtual void	SetPlane (const double fx, const double fy, const double fz, const double x0, const double y0, const double z0, const double hx, const double hy, const double hz)
	Set the projection plane specifying a hint for the in-plane x axis.

void	Rotate (const double angle)
	Rotate the viewing plane (angle in radian).

void	SetPlaneXY ()
	Set the viewing plane to x-y.

void	SetPlaneXZ ()
	Set the viewing plane to x-z.

void	SetPlaneYZ ()
	Set the viewing plane to y-z.

void	EnableDebugging (const bool on=true)
	Switch on/off debugging output.

Additional Inherited Members
Static Public Member Functions inherited from Garfield::ViewBase
static std::string	FindUnusedFunctionName (const std::string &s)
	Find an unused function name.

static std::string	FindUnusedHistogramName (const std::string &s)
	Find an unused histogram name.

static std::string	FindUnusedCanvasName (const std::string &s)
	Find an unused canvas name.

Protected Member Functions inherited from Garfield::ViewBase
void	UpdateProjectionMatrix ()

template<typename T >
void	ToPlane (const T x, const T y, const T z, T &xp, T &yp) const

template<typename T >
bool	InBox (const std::array< T, 3 > &x) const

void	Clip (const std::array< float, 3 > &x0, const std::array< float, 3 > &x1, std::array< float, 3 > &xc) const

void	DrawLine (const std::vector< std::array< float, 3 > > &xl, const short col, const short lw)

std::string	LabelX ()

std::string	LabelY ()

std::string	PlaneDescription ()

bool	PlotLimits (Sensor *sensor, double &xmin, double &ymin, double &xmax, double &ymax) const

bool	PlotLimits (Component *cmp, double &xmin, double &ymin, double &xmax, double &ymax) const

bool	PlotLimitsFromUserBox (double &xmin, double &ymin, double &xmax, double &ymax) const

bool	PlotLimits (std::array< double, 3 > &bbmin, std::array< double, 3 > &bbmax, double &xmin, double &ymin, double &xmax, double &ymax) const

bool	RangeSet (TPad *)

void	SetRange (TPad *pad, const double x0, const double y0, const double x1, const double y1)

Protected Attributes inherited from Garfield::ViewBase
std::string	m_className = "ViewBase"

bool	m_debug = false

bool	m_userPlotLimits = false

double	m_xMinPlot = -1.

double	m_xMaxPlot = 1.

double	m_yMinPlot = -1.

double	m_yMaxPlot = 1.

bool	m_userBox = false

double	m_xMinBox = -1.

double	m_xMaxBox = 1.

double	m_yMinBox = -1.

double	m_yMaxBox = 1.

double	m_zMinBox = -1.

double	m_zMaxBox = 1.

std::array< std::array< double, 3 >, 3 >	m_proj

std::array< double, 4 >	m_plane {{0, 0, 1, 0}}

std::array< std::array< double, 3 >, 3 >	m_prmat

Detailed Description

Draw the mesh of a field-map component.

Definition at line 21 of file ViewFEMesh.hh.

Constructor & Destructor Documentation

◆ ViewFEMesh()

Garfield::ViewFEMesh::ViewFEMesh ( )

Constructor.

Definition at line 19 of file ViewFEMesh.cc.

19: ViewBase("ViewFEMesh") {}

Garfield::ViewBase::ViewBase

ViewBase()=delete

Default constructor.

◆ ~ViewFEMesh()

Garfield::ViewFEMesh::~ViewFEMesh ( )

default

Destructor.

Member Function Documentation

◆ CreateDefaultAxes()

void Garfield::ViewFEMesh::CreateDefaultAxes ( )

Create a default set of custom-made axes.

Definition at line 224 of file ViewFEMesh.cc.

                                   {
  // Create a new x and y axis.
  if (!GetPlotLimits()) {
    std::cerr << m_className << "::CreateDefaultAxes:\n"
              << "    Cannot determine the axis limits.\n";
    return;
  } 
  const double dx = std::abs(m_xMaxPlot - m_xMinPlot) * 0.1;
  const double dy = std::abs(m_yMaxPlot - m_yMinPlot) * 0.1;
  const double x0 = m_xMinPlot + dx;
  const double y0 = m_yMinPlot + dy;
  const double x1 = m_xMaxPlot - dx;
  const double y1 = m_yMaxPlot - dy;
  m_xaxis = new TGaxis(x0, y0, x1, y0, x0, x1, 2405, "x");
  m_yaxis = new TGaxis(x0, y0, x0, y1, y0, y1, 2405, "y");
 
  // Label sizes
  m_xaxis->SetLabelSize(0.025);
  m_yaxis->SetLabelSize(0.025);
 
  // Titles
  m_xaxis->SetTitleSize(0.03);
  m_xaxis->SetTitle(LabelX().c_str());
  m_yaxis->SetTitleSize(0.03);
  m_yaxis->SetTitle(LabelY().c_str());
}

◆ DisableAxes()

void Garfield::ViewFEMesh::DisableAxes ( )

inline

Definition at line 43 of file ViewFEMesh.hh.

43{ m_drawAxes = false; }

◆ DisableMaterial()

void Garfield::ViewFEMesh::DisableMaterial ( int materialID )

inline

Disable a material so that its mesh cells are not drawn.

Definition at line 75 of file ViewFEMesh.hh.

                                       {
    m_disabledMaterial[materialID] = true;
  }

◆ EnableAxes()

void Garfield::ViewFEMesh::EnableAxes ( )

inline

Definition at line 42 of file ViewFEMesh.hh.

42{ m_drawAxes = true; }

Referenced by main().

◆ GetDrawViewRegion()

bool Garfield::ViewFEMesh::GetDrawViewRegion ( void ) const

inline

Definition at line 53 of file ViewFEMesh.hh.

53{ return m_drawViewRegion; }

◆ Plot()

bool Garfield::ViewFEMesh::Plot ( )

Plot method to be called by user.

Definition at line 32 of file ViewFEMesh.cc.

                      {
  if (!m_component) {
    std::cerr << m_className << "::Plot: Component is not defined.\n";
    return false;
  }
 
  double pmin = 0., pmax = 0.;
  if (!m_component->GetVoltageRange(pmin, pmax)) {
    std::cerr << m_className << "::Plot: Component is not ready.\n";
    return false;
  }
 
  if (!GetPlotLimits()) return false;
 
  auto pad = GetCanvas();
  pad->cd();
  if (!RangeSet(pad)) {
    SetRange(pad, m_xMinPlot, m_yMinPlot, m_xMaxPlot, m_yMaxPlot);
  }
 
  if (m_drawAxes) {
    if (!m_xaxis && !m_yaxis) {
      // Draw default axes.
      auto frame = pad->DrawFrame(m_xMinPlot, m_yMinPlot,
                                  m_xMaxPlot, m_yMaxPlot);
      if (m_xaxisTitle.empty()) {
        frame->GetXaxis()->SetTitle(LabelX().c_str());
      } else { 
        frame->GetXaxis()->SetTitle(m_xaxisTitle.c_str());
      }
      if (m_yaxisTitle.empty()) {
        frame->GetYaxis()->SetTitle(LabelY().c_str());
      } else {
        frame->GetYaxis()->SetTitle(m_yaxisTitle.c_str());
      }
    } else {
      // Draw custom axes.
      if (m_xaxis) m_xaxis->Draw();
      if (m_yaxis) m_yaxis->Draw();
    }
  }
 
  // Plot the mesh elements.
  ComponentCST* componentCST = dynamic_cast<ComponentCST*>(m_component);
  if (componentCST) {
    std::cout << m_className << "::Plot: CST component. Calling DrawCST.\n";
    DrawCST(componentCST);
  } else {
    DrawElements();
  }
  
  // If we have an associated ViewDrift object, plot the drift lines.
  if (m_viewDrift) {
    // Plot a 2D projection of the drift line.
    for (const auto& dline : m_viewDrift->m_driftLines) {
      TGraph gr;
      if (dline.second == ViewDrift::Particle::Electron) {
        gr.SetLineColor(kOrange - 3);
      } else {
        gr.SetLineColor(kRed + 1);
      }
      std::vector<float> xgr;
      std::vector<float> ygr;
      // Loop over the points.
      for (const auto& point : dline.first) {
        // Project this point onto the plane.
        float xp = 0., yp = 0.;
        ToPlane(point[0], point[1], point[2], xp, yp);
        // Add this point if it is within the view.
        if (InView(xp, yp)) {
          xgr.push_back(xp);
          ygr.push_back(yp);
        }
      }
      if (!xgr.empty()) {
        gr.DrawGraph(xgr.size(), xgr.data(), ygr.data(), "lsame");
      }
    }
  }
 
  if (m_drawViewRegion && !m_viewRegionX.empty()) {
    TPolyLine poly;
    poly.SetLineColor(kSpring + 4);
    poly.SetLineWidth(3);
    std::vector<double> xv = m_viewRegionX;
    std::vector<double> yv = m_viewRegionY;
    // Close the polygon.
    xv.push_back(m_viewRegionX[0]);
    yv.push_back(m_viewRegionY[0]);
    poly.DrawPolyLine(xv.size(), xv.data(), yv.data(), "same");
  }
  gPad->Update();
  // Draw axes again so they are on top
  gPad->RedrawAxis("g");
  return true;
}

Referenced by main().

◆ SetColor()

void Garfield::ViewFEMesh::SetColor	(	int	matID,
		int	colorID
	)

inline

Associate a color with each element material map ID; Uses ROOT color numberings

Definition at line 57 of file ViewFEMesh.hh.

57{ m_colorMap[matID] = colorID; }

Referenced by main().

◆ SetComponent()

void Garfield::ViewFEMesh::SetComponent ( ComponentFieldMap * cmp )

Set the component from which to retrieve the mesh and field.

Definition at line 21 of file ViewFEMesh.cc.

                                                    {
  if (!cmp) {
    std::cerr << m_className << "::SetComponent: Null pointer.\n";
    return;
  }
 
  m_component = cmp;
}

Referenced by main().

◆ SetDrawViewRegion()

void Garfield::ViewFEMesh::SetDrawViewRegion ( bool do_draw )

inline

Display intersection of projection plane with viewing area.

Definition at line 52 of file ViewFEMesh.hh.

52{ m_drawViewRegion = do_draw; }

◆ SetFillColor()

void Garfield::ViewFEMesh::SetFillColor	(	int	matID,
		int	colorID
	)

inline

Definition at line 58 of file ViewFEMesh.hh.

                                            {
    m_colorMap_fill[matID] = colorID;
  }

◆ SetFillMesh()

void Garfield::ViewFEMesh::SetFillMesh ( const bool f )

inline

Element fill switch; 2D only, set false for wireframe mesh.

Definition at line 49 of file ViewFEMesh.hh.

49{ m_fillMesh = f; }

Referenced by main().

◆ SetFillMeshWithBorders()

void Garfield::ViewFEMesh::SetFillMeshWithBorders ( )

inline

Show filled mesh elements.

Definition at line 66 of file ViewFEMesh.hh.

                                {
    m_plotMeshBorders = true;
    m_fillMesh = true;
  }

◆ SetPlane() [1/2]

void Garfield::ViewFEMesh::SetPlane	(	const double	fx,
		const double	fy,
		const double	fz,
		const double	x0,
		const double	y0,
		const double	z0
	)

overridevirtual

Set the projection (viewing plane), if applicable.

Parameters

fx,fy,fz	normal vector
x0,y0,z0	in-plane point

Reimplemented from Garfield::ViewBase.

Definition at line 202 of file ViewFEMesh.cc.

                                                                             {
  if (fy * fy + fz * fz > 0) {
    SetPlane(fx, fy, fz, x0, y0, z0, 1, 0, 0);
  } else {
    SetPlane(fx, fy, fz, x0, y0, z0, 0, 1, 0);
  }
}

Referenced by main(), and SetPlane().

◆ SetPlane() [2/2]

void Garfield::ViewFEMesh::SetPlane	(	const double	fx,
		const double	fy,
		const double	fz,
		const double	x0,
		const double	y0,
		const double	z0,
		const double	hx,
		const double	hy,
		const double	hz
	)

overridevirtual

Set the projection plane specifying a hint for the in-plane x axis.

Reimplemented from Garfield::ViewBase.

Definition at line 211 of file ViewFEMesh.cc.

                                                                             {
  ViewBase::SetPlane(fx, fy, fz, x0, y0, z0, hx, hy, hz);
}

◆ SetViewDrift()

void Garfield::ViewFEMesh::SetViewDrift ( ViewDrift * vd )

inline

Set the optional associated ViewDrift.

Definition at line 63 of file ViewFEMesh.hh.

63{ m_viewDrift = vd; }

Referenced by main().

◆ SetXaxis()

void Garfield::ViewFEMesh::SetXaxis ( TGaxis * ax )

Definition at line 218 of file ViewFEMesh.cc.

218{ m_xaxis = ax; }

◆ SetXaxisTitle()

void Garfield::ViewFEMesh::SetXaxisTitle ( const std::string & xtitle )

inline

Definition at line 40 of file ViewFEMesh.hh.

40{ m_xaxisTitle = xtitle; }

Referenced by main().

◆ SetYaxis()

void Garfield::ViewFEMesh::SetYaxis ( TGaxis * ay )

Definition at line 221 of file ViewFEMesh.cc.

221{ m_yaxis = ay; }

◆ SetYaxisTitle()

void Garfield::ViewFEMesh::SetYaxisTitle ( const std::string & ytitle )

inline

Definition at line 41 of file ViewFEMesh.hh.

41{ m_yaxisTitle = ytitle; }

Referenced by main().

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ViewFEMesh()

◆ ~ViewFEMesh()

Member Function Documentation

◆ CreateDefaultAxes()

◆ DisableAxes()

◆ DisableMaterial()

◆ EnableAxes()

◆ GetDrawViewRegion()

◆ Plot()

◆ SetColor()

◆ SetComponent()

◆ SetDrawViewRegion()

◆ SetFillColor()

◆ SetFillMesh()

◆ SetFillMeshWithBorders()

◆ SetPlane() [1/2]

◆ SetPlane() [2/2]

◆ SetViewDrift()

◆ SetXaxis()

◆ SetXaxisTitle()

◆ SetYaxis()

◆ SetYaxisTitle()