Visualize the potential or electric field of a component or sensor. More...

#include <ViewField.hh>

Inheritance diagram for Garfield::ViewField:

Public Member Functions
	ViewField ()
	Constructor.

	~ViewField ()
	Destructor.

void	SetSensor (Sensor *s)
	Set the sensor from which to retrieve the field.

void	SetComponent (ComponentBase *c)
	Set the component from which to retrieve the field.

void	SetVoltageRange (const double vmin, const double vmax)
	Set the plot limits for the potential.

void	SetElectricFieldRange (const double emin, const double emax)
	Set the plot limits for the electric field.

void	SetWeightingFieldRange (const double wmin, const double wmax)
	Set the plot limits for the weighting field.

void	SetArea (const double xmin, const double ymin, const double xmax, const double ymax)
	Set the viewing area (in local coordinates of the current viewing plane).

void	SetArea ()
	Set the viewing area based on the bounding box of the sensor/component.

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

void	SetDefaultProjection ()
	Set the default viewing plane ( - at ).

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

void	SetNumberOfContours (const unsigned int n)
	Set the number of contour levels (at most 50).

void	SetNumberOfSamples1d (const unsigned int n)
	Set the number of points used for drawing 1D functions.

void	SetNumberOfSamples2d (const unsigned int nx, const unsigned int ny)
	Set the number of points used for drawing 2D functions.

void	PlotContour (const std::string &option="v")

void	PlotSurface (const std::string &option="v")

void	Plot (const std::string &option="v", const std::string &drawopt="arr")

void	PlotProfile (const double x0, const double y0, const double z0, const double x1, const double y1, const double z1, const std::string &option="v")

void	PlotContourWeightingField (const std::string &label, const std::string &option)

void	PlotSurfaceWeightingField (const std::string &label, const std::string &option)

void	PlotWeightingField (const std::string &label, const std::string &option, const std::string &drawopt)

void	PlotProfileWeightingField (const std::string &label, const double x0, const double y0, const double z0, const double x1, const double y1, const double z1, const std::string &option="v")

void	EnableAutoRange (const bool on=true)

void	EnableAcknowledgeStatus (const double v0=0.)

void	DisableAcknowledgeStatus ()
	Ignore the status flag returned by the sensor/component.

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

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

virtual	~ViewBase ()
	Destructor.

void	SetCanvas (TCanvas *c)
	Set the canvas to be painted on.

TCanvas *	GetCanvas ()
	Retrieve the canvas.

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

Protected Member Functions
double	Evaluate2D (double pos, double par)

double	EvaluateProfile (double pos, double par)

Protected Member Functions inherited from Garfield::ViewBase
std::string	FindUnusedFunctionName (const std::string &s) const

std::string	FindUnusedHistogramName (const std::string &s) const

Friends
class	TF1

class	TF2

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

bool	m_debug = false

TCanvas *	m_canvas = nullptr

bool	m_hasExternalCanvas = false

double	m_proj [3][3]

Detailed Description

Visualize the potential or electric field of a component or sensor.

Definition at line 16 of file ViewField.hh.

Constructor & Destructor Documentation

◆ ViewField()

Garfield::ViewField::ViewField ( )

Constructor.

Definition at line 47 of file ViewField.cc.

                     : ViewBase("ViewField") {
  SetDefaultProjection();
}

◆ ~ViewField()

Garfield::ViewField::~ViewField ( )

Destructor.

Definition at line 51 of file ViewField.cc.

                      {
  if (m_f2d) delete m_f2d;
  if (m_f2dW) delete m_f2dW;
  if (m_fProfile) delete m_fProfile;
  if (m_fProfileW) delete m_fProfileW;
}

Member Function Documentation

◆ DisableAcknowledgeStatus()

void Garfield::ViewField::DisableAcknowledgeStatus ( )

inline

Ignore the status flag returned by the sensor/component.

Definition at line 131 of file ViewField.hh.

131{ m_useStatus = false; }

◆ EnableAcknowledgeStatus()

void Garfield::ViewField::EnableAcknowledgeStatus ( const double v0 = 0. )

inline

Make use of the status flag returned by the sensor/component.

Parameters

v0	Value to be used for regions with status != 0.

Definition at line 126 of file ViewField.hh.

                                                     {
    m_useStatus = true;
    m_vBkg = v0;
  }

◆ EnableAutoRange()

void Garfield::ViewField::EnableAutoRange ( const bool on = true )

inline

Definition at line 121 of file ViewField.hh.

121{ m_useAutoRange = on; }

◆ Evaluate2D()

double Garfield::ViewField::Evaluate2D	(	double *	pos,
		double *	par
	)

protected

Definition at line 236 of file ViewField.cc.

                                                     {
  if (!m_sensor && !m_component) return 0.;
 
  // Transform to global coordinates.
  const double u = pos[0];
  const double v = pos[1];
  const double x = m_project[0][0] * u + m_project[1][0] * v + m_project[2][0];
  const double y = m_project[0][1] * u + m_project[1][1] * v + m_project[2][1];
  const double z = m_project[0][2] * u + m_project[1][2] * v + m_project[2][2];
 
  // Determine which quantity to plot.
  const PlotType plotType = static_cast<PlotType>(int(fabs(par[0]) / 10.));
 
  // Compute the field.
  double ex = 0., ey = 0., ez = 0., volt = 0.;
  int status = 0;
  if (par[0] > 0.) {
    // "Drift" electric field.
    Medium* medium = nullptr;
    if (!m_sensor) {
      m_component->ElectricField(x, y, z, ex, ey, ez, volt, medium, status);
    } else {
      m_sensor->ElectricField(x, y, z, ex, ey, ez, volt, medium, status);
    }
  } else {
    // Weighting field.
    if (!m_sensor) {
      if (plotType == Potential) {
        volt = m_component->WeightingPotential(x, y, z, m_electrode);
      } else {
        m_component->WeightingField(x, y, z, ex, ey, ez, m_electrode);
      }
    } else {
      if (plotType == Potential) {
        volt = m_sensor->WeightingPotential(x, y, z, m_electrode);
      } else {
        m_sensor->WeightingField(x, y, z, ex, ey, ez, m_electrode);
      }
    }
  }
 
  if (m_debug) {
    std::cout << m_className << "::Evaluate2D:\n"
              << "    At (u, v) = (" << u << ", " << v << "), "
              << " (x,y,z) = (" << x << "," << y << "," << z << ")\n"
              << "    E = " << ex << ", " << ey << ", " << ez
              << "), V = " << volt << ", status = " << status << "\n";
  }
  if (m_useStatus && status != 0) return m_vBkg;
 
  switch (plotType) {
    case Potential:
      return volt;
      break;
    case Magnitude:
      return sqrt(ex * ex + ey * ey + ez * ez);
      break;
    case Ex:
      return ex;
      break;
    case Ey:
      return ey;
      break;
    case Ez:
      return ez;
      break;
    default:
      break;
  }
  return volt;
}

◆ EvaluateProfile()

double Garfield::ViewField::EvaluateProfile	(	double *	pos,
		double *	par
	)

protected

Definition at line 308 of file ViewField.cc.

                                                          {
  if (!m_sensor && !m_component) return 0.;
 
  // Get the start and end position.
  const double x0 = par[0];
  const double y0 = par[1];
  const double z0 = par[2];
  const double x1 = par[3];
  const double y1 = par[4];
  const double z1 = par[5];
  // Compute the direction.
  const double dx = x1 - x0;
  const double dy = y1 - y0;
  const double dz = z1 - z0;
  // Get the position.
  const double t = pos[0];
  const double x = x0 + t * dx;
  const double y = y0 + t * dy;
  const double z = z0 + t * dz;
  // Determine which quantity to plot.
  const PlotType plotType = static_cast<PlotType>(int(fabs(par[6]) / 10.));
 
  // Compute the field.
  double ex = 0., ey = 0., ez = 0., volt = 0.;
  int status = 0;
  if (par[6] > 0.) {
    Medium* medium = nullptr;
    // "Drift" electric field.
    if (!m_sensor) {
      m_component->ElectricField(x, y, z, ex, ey, ez, volt, medium, status);
    } else {
      m_sensor->ElectricField(x, y, z, ex, ey, ez, volt, medium, status);
    }
  } else {
    // Weighting field.
    if (!m_sensor) {
      if (plotType == Potential) {
        volt = m_component->WeightingPotential(x, y, z, m_electrode);
      } else {
        m_component->WeightingField(x, y, z, ex, ey, ez, m_electrode);
      }
    } else {
      if (plotType == Potential) {
        volt = m_sensor->WeightingPotential(x, y, z, m_electrode);
      } else {
        m_sensor->WeightingField(x, y, z, ex, ey, ez, m_electrode);
      }
    }
  }
  if (m_useStatus && status != 0) volt = m_vBkg;
 
  switch (plotType) {
    case Potential:
      return volt;
      break;
    case Magnitude:
      return sqrt(ex * ex + ey * ey + ez * ez);
      break;
    case Ex:
      return ex;
      break;
    case Ey:
      return ey;
      break;
    case Ez:
      return ez;
      break;
    default:
      break;
  }
  return volt;
}

◆ Plot()

void Garfield::ViewField::Plot	(	const std::string &	option = `"v"`,
		const std::string &	drawopt = `"arr"`
	)

Make a 2D plot of the electric potential or field.

Parameters

option	quantity to be plotted (see PlotContour)
drawopt	option string passed to TF2::Draw

Definition at line 163 of file ViewField.cc.

                                                                      {
  SetupCanvas();
  if (!SetupFunction(option, m_f2d, false, false)) return;
  m_f2d->Draw(drawopt.c_str());
  gPad->SetRightMargin(0.15);
  gPad->Update();
}

Referenced by PlotSurface().

◆ PlotContour()

void Garfield::ViewField::PlotContour ( const std::string & option = "v" )

Make a contour plot of the electric potential or field.

Parameters

option

quantity to be plotted

potential: "v", "voltage", "p", "potential"
magnitude of the electric field: "e", "field"
x-component of the electric field: "ex"
y-component of the electric field: "ey"
z-component of the electric field: "ez"

Definition at line 155 of file ViewField.cc.

                                                   {
  SetupCanvas();
  if (!SetupFunction(option, m_f2d, true, false)) return;
  m_f2d->Draw("CONT4Z");
  gPad->SetRightMargin(0.15);
  gPad->Update();
}

Referenced by main().

◆ PlotContourWeightingField()

void Garfield::ViewField::PlotContourWeightingField	(	const std::string &	label,
		const std::string &	option
	)

Make a contour plot of the weighting potential or field.

Parameters

label	identifier of the electrode
option	quantity to be plotted (see PlotContour)

Definition at line 191 of file ViewField.cc.

                                                                   {
  m_electrode = label;
  SetupCanvas();
  if (!SetupFunction(option, m_f2dW, true, true)) return;
  m_f2dW->Draw("CONT4Z");
  gPad->SetRightMargin(0.15);
  gPad->Update();
}

◆ PlotProfile()

void Garfield::ViewField::PlotProfile	(	const double	x0,
		const double	y0,
		const double	z0,
		const double	x1,
		const double	y1,
		const double	z1,
		const std::string &	option = `"v"`
	)

Make a 1D plot of the electric potential or field along a line.

Parameters

x0,y0,z0	starting point
x1,y1,z1	end point
option	quantity to be plotted (see PlotContour)

Definition at line 171 of file ViewField.cc.

                                                     {
  SetupCanvas();
  if (!SetupProfile(x0, y0, z0, x1, y1, z1, option, m_fProfile, false)) return;
  m_fProfile->Draw();
  gPad->Update();
}

◆ PlotProfileWeightingField()

void Garfield::ViewField::PlotProfileWeightingField	(	const std::string &	label,
		const double	x0,
		const double	y0,
		const double	z0,
		const double	x1,
		const double	y1,
		const double	z1,
		const std::string &	option = `"v"`
	)

Make a 1D plot of the weighting potential or field along a line.

Parameters

label	identifier of the electrode
x0,y0,z0	starting point
x1,y1,z1	end point
option	quantity to be plotted (see PlotContour)

Definition at line 201 of file ViewField.cc.

                                                                   {
  m_electrode = label;
  SetupCanvas();
  if (!SetupProfile(x0, y0, z0, x1, y1, z1, option, m_fProfileW, true)) return;
  m_fProfileW->Draw();
  gPad->Update();
}

◆ PlotSurface()

void Garfield::ViewField::PlotSurface ( const std::string & option = "v" )

inline

Make a surface plot ("SURF4") of the electric potential or field.

Parameters

option quantity to be plotted (see PlotContour)

Definition at line 71 of file ViewField.hh.

71{ Plot(option, "SURF4"); }

Garfield::ViewField::Plot

void Plot(const std::string &option="v", const std::string &drawopt="arr")

Definition: ViewField.cc:163

◆ PlotSurfaceWeightingField()

void Garfield::ViewField::PlotSurfaceWeightingField	(	const std::string &	label,
		const std::string &	option
	)

inline

Make a surface plot ("SURF4") of the weighting potential or field.

Parameters

label	identifier of the electrode
option	quantity to be plotted (see PlotContour)

Definition at line 97 of file ViewField.hh.

                                                          {
    PlotWeightingField(label, option, "SURF4");
  }

◆ PlotWeightingField()

void Garfield::ViewField::PlotWeightingField	(	const std::string &	label,
		const std::string &	option,
		const std::string &	drawopt
	)

Make a 2D plot of the weighting potential or field.

Parameters

label	identifier of the electrode
option	quantity to be plotted (see PlotContour)
drawopt	option string passed to TF2::Draw

Definition at line 180 of file ViewField.cc.

                                                             {
  m_electrode = label;
  SetupCanvas();
  if (!SetupFunction(option, m_f2dW, false, true)) return;
  m_f2dW->Draw(drawopt.c_str());
  gPad->SetRightMargin(0.15);
  gPad->Update();
}

Referenced by PlotSurfaceWeightingField().

◆ Rotate()

void Garfield::ViewField::Rotate ( const double angle )

Rotate the viewing plane (angle in radian).

Definition at line 653 of file ViewField.cc.

                                         {
  // Rotate the axes
  double auxu[3], auxv[3];
  const double ctheta = cos(theta);
  const double stheta = sin(theta);
  for (int i = 0; i < 3; ++i) {
    auxu[i] = ctheta * m_project[0][i] - stheta * m_project[1][i];
    auxv[i] = stheta * m_project[0][i] + ctheta * m_project[1][i];
  }
  for (int i = 0; i < 3; ++i) {
    m_project[0][i] = auxu[i];
    m_project[1][i] = auxv[i];
  }
 
  // Make labels to be placed along the axes
  Labels();
}

◆ SetArea() [1/2]

void Garfield::ViewField::SetArea ( )

inline

Set the viewing area based on the bounding box of the sensor/component.

Definition at line 39 of file ViewField.hh.

39{ m_hasUserArea = false; }

◆ SetArea() [2/2]

void Garfield::ViewField::SetArea	(	const double	xmin,
		const double	ymin,
		const double	xmax,
		const double	ymax
	)

Set the viewing area (in local coordinates of the current viewing plane).

Definition at line 78 of file ViewField.cc.

                                           {
  // Check range, assign if non-null.
  if (xmin == xmax || ymin == ymax) {
    std::cerr << m_className << "::SetArea: Null area range is not permitted.\n"
              << "      " << xmin << " < x < " << xmax << "\n"
              << "      " << ymin << " < y < " << ymax << "\n";
    return;
  }
  m_xmin = std::min(xmin, xmax);
  m_ymin = std::min(ymin, ymax);
  m_xmax = std::max(xmin, xmax);
  m_ymax = std::max(ymin, ymax);
  m_hasUserArea = true;
}

Referenced by main().

◆ SetComponent()

void Garfield::ViewField::SetComponent ( ComponentBase * c )

Set the component from which to retrieve the field.

Definition at line 68 of file ViewField.cc.

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

◆ SetDefaultProjection()

void Garfield::ViewField::SetDefaultProjection ( )

Set the default viewing plane ( $x$ - $y$ at $z = 0$ ).

Definition at line 214 of file ViewField.cc.

                                     {
  // Default projection: x-y at z=0
  m_project[0][0] = 1;
  m_project[1][0] = 0;
  m_project[2][0] = 0;
  m_project[0][1] = 0;
  m_project[1][1] = 1;
  m_project[2][1] = 0;
  m_project[0][2] = 0;
  m_project[1][2] = 0;
  m_project[2][2] = 0;
 
  // Plane description
  m_plane[0] = 0;
  m_plane[1] = 0;
  m_plane[2] = 1;
  m_plane[3] = 0;
 
  // Prepare axis labels.
  Labels();
}

Referenced by ViewField().

◆ SetElectricFieldRange()

void Garfield::ViewField::SetElectricFieldRange	(	const double	emin,
		const double	emax
	)

Set the plot limits for the electric field.

Definition at line 100 of file ViewField.cc.

                                                                          {
  m_emin = std::min(emin, emax);
  m_emax = std::max(emin, emax);
  m_useAutoRange = false;
}

◆ SetNumberOfContours()

void Garfield::ViewField::SetNumberOfContours ( const unsigned int n )

Set the number of contour levels (at most 50).

Definition at line 112 of file ViewField.cc.

                                                        {
  if (n <= m_nMaxContours) {
    m_nContours = n;
  } else {
    std::cerr << m_className << "::SetNumberOfContours:\n"
              << "    Max. number of contours is " << m_nMaxContours << ".\n";
  }
}

Referenced by main().

◆ SetNumberOfSamples1d()

void Garfield::ViewField::SetNumberOfSamples1d ( const unsigned int n )

Set the number of points used for drawing 1D functions.

Definition at line 121 of file ViewField.cc.

                                                         {
  constexpr unsigned int nmin = 10;
  constexpr unsigned int nmax = 100000;
  if (n < nmin || n > nmax) {
    std::cerr << m_className << "::SetNumberOfSamples1d:\n"
              << "    Number of points (" << n << ") out of range.\n"
              << "    " << nmin << " <= n <= " << nmax << "\n";
    return;
  }
 
  m_nSamples1d = n;
}

◆ SetNumberOfSamples2d()

void Garfield::ViewField::SetNumberOfSamples2d	(	const unsigned int	nx,
		const unsigned int	ny
	)

Set the number of points used for drawing 2D functions.

Definition at line 134 of file ViewField.cc.

                                                            {
  constexpr unsigned int nmin = 10;
  constexpr unsigned int nmax = 10000;
  if (nx < nmin || nx > nmax) {
    std::cerr << m_className << "::SetNumberOfSamples2d:\n"
              << "    Number of x-points (" << nx << ") out of range.\n"
              << "    " << nmin << " <= nx <= " << nmax << "\n";
  } else {
    m_nSamples2dX = nx;
  }
 
  if (ny < nmin || ny > nmax) {
    std::cerr << m_className << "::SetNumberOfSamples2d:\n"
              << "    Number of y-points (" << ny << ") out of range.\n"
              << "    " << nmin << " <= ny <= " << nmax << "\n";
  } else {
    m_nSamples2dY = ny;
  }
}

Referenced by main().

◆ SetPlane()

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

Set the projection (viewing plane).

Parameters

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

Definition at line 612 of file ViewField.cc.

                                                                            {
  // Calculate two in-plane vectors for the normal vector
  const double fnorm = sqrt(fx * fx + fy * fy + fz * fz);
  if (fnorm > 0 && fx * fx + fz * fz > 0) {
    const double fxz = sqrt(fx * fx + fz * fz);
    m_project[0][0] = fz / fxz;
    m_project[0][1] = 0;
    m_project[0][2] = -fx / fxz;
    m_project[1][0] = -fx * fy / (fxz * fnorm);
    m_project[1][1] = (fx * fx + fz * fz) / (fxz * fnorm);
    m_project[1][2] = -fy * fz / (fxz * fnorm);
    m_project[2][0] = x0;
    m_project[2][1] = y0;
    m_project[2][2] = z0;
  } else if (fnorm > 0 && fy * fy + fz * fz > 0) {
    const double fyz = sqrt(fy * fy + fz * fz);
    m_project[0][0] = (fy * fy + fz * fz) / (fyz * fnorm);
    m_project[0][1] = -fx * fz / (fyz * fnorm);
    m_project[0][2] = -fy * fz / (fyz * fnorm);
    m_project[1][0] = 0;
    m_project[1][1] = fz / fyz;
    m_project[1][2] = -fy / fyz;
    m_project[2][0] = x0;
    m_project[2][1] = y0;
    m_project[2][2] = z0;
  } else {
    std::cout << m_className << "::SetPlane:\n"
              << "    Normal vector has zero norm. No new projection set.\n";
  }
 
  // Store the plane description
  m_plane[0] = fx;
  m_plane[1] = fy;
  m_plane[2] = fz;
  m_plane[3] = fx * x0 + fy * y0 + fz * z0;
 
  // Make labels to be placed along the axes
  Labels();
}

Referenced by main().

◆ SetSensor()

void Garfield::ViewField::SetSensor ( Sensor * s )

Set the sensor from which to retrieve the field.

Definition at line 58 of file ViewField.cc.

                                   {
  if (!s) {
    std::cerr << m_className << "::SetSensor: Null pointer.\n";
    return;
  }
 
  m_sensor = s;
  m_component = nullptr;
}

Referenced by main().

◆ SetVoltageRange()

void Garfield::ViewField::SetVoltageRange	(	const double	vmin,
		const double	vmax
	)

Set the plot limits for the potential.

Definition at line 94 of file ViewField.cc.

                                                                    {
  m_vmin = std::min(vmin, vmax);
  m_vmax = std::max(vmin, vmax);
  m_useAutoRange = false;
}

◆ SetWeightingFieldRange()

void Garfield::ViewField::SetWeightingFieldRange	(	const double	wmin,
		const double	wmax
	)

Set the plot limits for the weighting field.

Definition at line 106 of file ViewField.cc.

                                                                           {
  m_wmin = std::min(wmin, wmax);
  m_wmax = std::max(wmin, wmax);
  m_useAutoRange = false;
}

Friends And Related Function Documentation

◆ TF1

friend class TF1

friend

Definition at line 133 of file ViewField.hh.

◆ TF2

friend class TF2

friend

Definition at line 134 of file ViewField.hh.

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

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ViewField()

◆ ~ViewField()

Member Function Documentation

◆ DisableAcknowledgeStatus()

◆ EnableAcknowledgeStatus()

◆ EnableAutoRange()

◆ Evaluate2D()

◆ EvaluateProfile()

◆ Plot()

◆ PlotContour()

◆ PlotContourWeightingField()

◆ PlotProfile()

◆ PlotProfileWeightingField()

◆ PlotSurface()

◆ PlotSurfaceWeightingField()

◆ PlotWeightingField()

◆ Rotate()

◆ SetArea() [1/2]

◆ SetArea() [2/2]

◆ SetComponent()

◆ SetDefaultProjection()

◆ SetElectricFieldRange()

◆ SetNumberOfContours()

◆ SetNumberOfSamples1d()

◆ SetNumberOfSamples2d()

◆ SetPlane()

◆ SetSensor()

◆ SetVoltageRange()

◆ SetWeightingFieldRange()

Friends And Related Function Documentation

◆ TF1

◆ TF2