ViewDrift.hh

Go to the documentation of this file.

#ifndef G_VIEW_DRIFT
#define G_VIEW_DRIFT
 
#include <Rtypes.h>
 
#include <array>
#include <cstddef>
#include <mutex>
#include <vector>
 
#include "Garfield/GarfieldConstants.hh"
#include "Garfield/ViewBase.hh"
 
namespace Garfield {

 
class ViewDrift : public ViewBase {
 public:
  ViewDrift();
  ~ViewDrift() = default;

  void Clear();

  void Plot(const bool twod = false, const bool axis = true,
            const bool snapshot = false);
  void Plot2d(const bool axis = true, const bool snapshot = false);
  void Plot3d(const bool axis = true, const bool ogl = true,
              const bool snapshot = false);

  void EnableClusterMarkers(const bool on = true) { m_drawClusters = on; }
  void SetClusterMarkerSize(const double size);
  void SetCollisionMarkerSize(const double size);

  void SetColourElectrons(const short col) { m_colElectron = col; }
  void SetColourHoles(const short col) { m_colHole = col; }
  void SetColourNegativeIons(const short col) { m_colNegativeIon = col; }
  void SetColourIons(const short col) { m_colIon = col; }
  void SetColourTracks(const short col) { m_colTrack = col; }
  void SetColourPhotons(const short col) { m_colPhoton = col; }
  void SetColourExcitations(const short col) { m_colExcitation = col; }
  void SetColourIonisations(const short col) { m_colIonisation = col; }
  void SetColourAttachments(const short col) { m_colAttachment = col; }
  void SetElectronsToFront() { m_eTop = true; }

  std::size_t GetNumberOfDriftLines() const { return m_driftLines.size(); }
  void GetDriftLine(const std::size_t i,
                    std::vector<std::array<float, 3> >& driftLine,
                    bool& electron) const;
 
  // Functions used by the transport classes.
  std::size_t NewDriftLine(const Particle particle, const std::size_t np,
                           const float x0, const float y0, const float z0);
  void NewChargedParticleTrack(const std::size_t np, std::size_t& id,
                               const float x0, const float y0, const float z0);
 
  void SetDriftLinePoint(const std::size_t iL, const std::size_t iP,
                         const float x, const float y, const float z);
  void AddDriftLinePoint(const std::size_t iL, const float x, const float y,
                         const float z);
  void SetTrackPoint(const std::size_t iL, const std::size_t iP, const float x,
                     const float y, const float z);
  void AddTrackPoint(const std::size_t iL, const float x, const float y,
                     const float z);
  void AddExcitation(const float x, const float y, const float z);
  void AddIonisation(const float x, const float y, const float z);
  void AddAttachment(const float x, const float y, const float z);
 
  void AddPhoton(const float x0, const float y0, const float z0, const float x1,
                 const float y1, const float z1);
 
  friend class ViewFEMesh;
 
 private:
  std::mutex m_mutex;
 
  std::vector<std::pair<std::vector<std::array<float, 3> >, Particle> >
      m_driftLines;
 
  std::vector<std::vector<std::array<float, 3> > > m_tracks;
  std::vector<std::array<std::array<float, 3>, 2> > m_photons;
 
  std::vector<std::array<float, 3> > m_exc;
  std::vector<std::array<float, 3> > m_ion;
  std::vector<std::array<float, 3> > m_att;
 
  double m_markerSizeCluster = 0.01;
  double m_markerSizeCollision = 0.5;
 
  short m_colTrack = kGreen + 3;
  short m_colPhoton = kBlue + 1;
  short m_colElectron = kOrange - 3;
  short m_colHole = kRed + 1;
  short m_colIon = kRed + 1;
  short m_colNegativeIon = kGray + 2;
  short m_colExcitation = kGreen + 3;
  short m_colIonisation = kOrange - 3;
  short m_colAttachment = kCyan + 3;
 
  bool m_drawClusters = false;
 
  bool m_eTop = false;
 
  bool SetPlotLimits2d();
  bool SetPlotLimits3d();
  void DrawMarkers2d(const std::vector<std::array<float, 3> >& points,
                     const short col, const double size);
  void DrawMarkers3d(const std::vector<std::array<float, 3> >& points,
                     const short col, const double size);
};
}  // namespace Garfield
#endif