Garfield++ 4.0
A toolkit for the detailed simulation of particle detectors based on ionisation measurement in gases and semiconductors
|
Visualize the potential or electric field of a component or sensor. More...
#include <ViewField.hh>
Public Member Functions | |
ViewField () | |
Constructor. | |
~ViewField ()=default | |
Destructor. | |
void | SetSensor (Sensor *s) |
Set the sensor for which to plot the field. | |
void | SetComponent (Component *c) |
Set the component for which to plot 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 | SetNumberOfContours (const unsigned int n) |
Set the number of contour levels. | |
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 | 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", const bool normalised=true) |
void | PlotContourWeightingField (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", const bool normalised=true) |
void | EnableAutoRange (const bool on=true, const bool samplePotential=true) |
void | AcknowledgeStatus (const bool on, const double v0=0.) |
void | PlotFieldLines (const std::vector< double > &x0, const std::vector< double > &y0, const std::vector< double > &z0, const bool electron=true, const bool axis=true, const short col=kOrange - 3) |
Draw electric field lines from a set of starting points. | |
bool | EqualFluxIntervals (const double x0, const double y0, const double z0, const double x1, const double y1, const double z1, std::vector< double > &xf, std::vector< double > &yf, std::vector< double > &zf, const unsigned int nPoints=20) const |
Generates point along a line, spaced by equal flux intervals. | |
bool | FixedFluxIntervals (const double x0, const double y0, const double z0, const double x1, const double y1, const double z1, std::vector< double > &xf, std::vector< double > &yf, std::vector< double > &zf, const double interval=10.) const |
Generate points along a line, spaced by a given flux interval. | |
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 |
Visualize the potential or electric field of a component or sensor.
Definition at line 15 of file ViewField.hh.
Garfield::ViewField::ViewField | ( | ) |
|
default |
Destructor.
|
inline |
Make use (or not) of the status flag returned by the sensor/component.
on | Take status flag into account (true) or ignore it (false). |
v0 | Value to be used for regions with status != 0. |
Definition at line 106 of file ViewField.hh.
|
inline |
Determine the range of the potential/field automatically (true) or set it explicitly (false).
Definition at line 96 of file ViewField.hh.
bool Garfield::ViewField::EqualFluxIntervals | ( | const double | x0, |
const double | y0, | ||
const double | z0, | ||
const double | x1, | ||
const double | y1, | ||
const double | z1, | ||
std::vector< double > & | xf, | ||
std::vector< double > & | yf, | ||
std::vector< double > & | zf, | ||
const unsigned int | nPoints = 20 |
||
) | const |
Generates point along a line, spaced by equal flux intervals.
Definition at line 642 of file ViewField.cc.
bool Garfield::ViewField::FixedFluxIntervals | ( | const double | x0, |
const double | y0, | ||
const double | z0, | ||
const double | x1, | ||
const double | y1, | ||
const double | z1, | ||
std::vector< double > & | xf, | ||
std::vector< double > & | yf, | ||
std::vector< double > & | zf, | ||
const double | interval = 10. |
||
) | const |
Generate points along a line, spaced by a given flux interval.
Definition at line 738 of file ViewField.cc.
void Garfield::ViewField::Plot | ( | const std::string & | option = "v" , |
const std::string & | drawopt = "arr" |
||
) |
Make a 2D plot of the electric potential or field.
option | quantity to be plotted (see PlotContour) |
drawopt | option string passed to TF2::Draw |
Definition at line 126 of file ViewField.cc.
Referenced by main().
void Garfield::ViewField::PlotContour | ( | const std::string & | option = "v" | ) |
Make a contour plot of the electric potential or field.
option | quantity to be plotted
|
Definition at line 122 of file ViewField.cc.
Referenced by main().
void Garfield::ViewField::PlotContourWeightingField | ( | const std::string & | label, |
const std::string & | option | ||
) |
Make a contour plot of the weighting potential or field.
label | identifier of the electrode |
option | quantity to be plotted (see PlotContour) |
Definition at line 149 of file ViewField.cc.
void Garfield::ViewField::PlotFieldLines | ( | const std::vector< double > & | x0, |
const std::vector< double > & | y0, | ||
const std::vector< double > & | z0, | ||
const bool | electron = true , |
||
const bool | axis = true , |
||
const short | col = kOrange - 3 |
||
) |
Draw electric field lines from a set of starting points.
Definition at line 572 of file ViewField.cc.
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" , |
||
const bool | normalised = true |
||
) |
Make a 1D plot of the electric potential or field along a line.
x0,y0,z0 | starting point |
x1,y1,z1 | end point |
option | quantity to be plotted (see PlotContour) |
normalised | flag whether to use normalised x-axis coordinates |
Definition at line 137 of file ViewField.cc.
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" , |
||
const bool | normalised = true |
||
) |
Make a 1D plot of the weighting potential or field along a line.
label | identifier of the electrode |
x0,y0,z0 | starting point |
x1,y1,z1 | end point |
option | quantity to be plotted (see PlotContour) |
normalised | flag whether to use normalised x-axis coordinates |
Definition at line 154 of file ViewField.cc.
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.
label | identifier of the electrode |
option | quantity to be plotted (see PlotContour) |
drawopt | option string passed to TF2::Draw |
Definition at line 143 of file ViewField.cc.
void Garfield::ViewField::SetComponent | ( | Component * | c | ) |
Set the component for which to plot the field.
Definition at line 81 of file ViewField.cc.
void Garfield::ViewField::SetElectricFieldRange | ( | const double | emin, |
const double | emax | ||
) |
Set the plot limits for the electric field.
Definition at line 96 of file ViewField.cc.
void Garfield::ViewField::SetNumberOfContours | ( | const unsigned int | n | ) |
Set the number of contour levels.
Definition at line 108 of file ViewField.cc.
Referenced by main().
void Garfield::ViewField::SetNumberOfSamples1d | ( | const unsigned int | n | ) |
Set the number of points used for drawing 1D functions.
Definition at line 112 of file ViewField.cc.
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 116 of file ViewField.cc.
Referenced by main().
void Garfield::ViewField::SetSensor | ( | Sensor * | s | ) |
Set the sensor for which to plot the field.
Definition at line 72 of file ViewField.cc.
Referenced by main().
void Garfield::ViewField::SetVoltageRange | ( | const double | vmin, |
const double | vmax | ||
) |
Set the plot limits for the potential.
Definition at line 90 of file ViewField.cc.
void Garfield::ViewField::SetWeightingFieldRange | ( | const double | wmin, |
const double | wmax | ||
) |
Set the plot limits for the weighting field.
Definition at line 102 of file ViewField.cc.