Par04Hit Class Reference

Hit class to store energy deposited in the sensitive detector. More...

#include <Doxymodules_parameterisations.h>

Inheritance diagram for Par04Hit:

Public Member Functions
	Par04Hit ()
	Par04Hit (const Par04Hit &aRight)
virtual	~Par04Hit ()
const Par04Hit &	operator= (const Par04Hit &aRight)
int	operator== (const Par04Hit &aRight) const
void *	operator new (size_t)
void	operator delete (void *aHit)
virtual void	Draw () final
	Visualise hits.
virtual const std::map< G4String, G4AttDef > *	GetAttDefs () const final
	Retrieve atributes' names in order to allow filtering.
virtual std::vector< G4AttValue > *	CreateAttValues () const final
	Create attributes for the visualisation.
virtual void	Print () final
	Print hit properties.
void	SetPos (G4ThreeVector aXYZ)
	Set position.
G4ThreeVector	GetPos () const
	Get position.
void	SetRot (G4RotationMatrix aXYZ)
	Set rotation.
G4RotationMatrix	GetRot () const
	Get rotation.
void	SetEdep (G4double aEdep)
	Set energy.
void	AddEdep (G4double aEdep)
	Add energy to previous value.
G4double	GetEdep () const
	Get energy.
void	SetNdep (G4int aNdep)
	Set number of deposits per hit/cell.
void	AddNdep (G4int aNdep=1)
	Add number of deposits to previous value, by defualt increment.
G4int	GetNdep () const
	Get number of deposits per hit/cell.
void	SetZid (G4int aZ)
	Set Z id of the cell in the readout segmentation.
G4int	GetZid () const
	Get Z id of the cell in the readout segmentation.
void	SetRhoId (G4int aRho)
	Set Rho id of the cell in the readout segmentation.
G4int	GetRhoId () const
	Get rho id of the cell in the readout segmentation.
void	SetPhiId (G4int aPhi)
	Set phi id of the cell in the readout segmentation.
G4int	GetPhiId () const
	Get phi id of the cell in the readout segmentation.
void	SetTime (G4double aTime)
	Set time.
G4double	GetTime () const
	Get time.
void	SetType (G4int aType)
	Set type (0 = full sim, 1 = fast sim)
G4int	GetType () const
	Get type (0 = full sim, 1 = fast sim)
void	SetLogV (G4LogicalVolume *aLogVol)
const G4LogicalVolume *	GetLogVol ()

Public Attributes
G4double	fEdep = 0
	Energy deposit.
G4int	fNdep = 0
	Counter of deposits in a hit/cell.
G4int	fZId = -1
	Z ID of readout cell.
G4int	fRhoId = -1
	Rho ID of readout cell.
G4int	fPhiId = -1
	Phi ID of readout cell.
G4ThreeVector	fPos = { -1, -1, -1 }
	Position.
G4RotationMatrix	fRot
	Rotation.
G4double	fTime = -1
	Time.
G4int	fType = -1
	Type: 0 = full sim, 1 = fast sim.
G4LogicalVolume *	fLogVol = nullptr
	Pointer to logical volume for visualisation.

Detailed Description

Hit class to store energy deposited in the sensitive detector.

Hit class registers position and energy deposited within the sensitive detector. Cell ID is stored using identifiers of readout segmentation (z, phi, rho). Additionally, pointer to cell logical volume, its position and rotation are saved for visualisation purposes. Time allows to filter hits in visualisation. Type of hit allows to distinguish between hits originating from full simulation (type 0) and fast simulation (type 1).

Definition at line 83 of file Doxymodules_parameterisations.h.

Constructor & Destructor Documentation

Par04Hit() [1/2]

Par04Hit::Par04Hit

(

)

Definition at line 53 of file Par04Hit.cc.

  : G4VHit()
{}

Par04Hit() [2/2]

Par04Hit::Par04Hit

(

const Par04Hit &

aRight

)

Definition at line 63 of file Par04Hit.cc.

  : G4VHit()
{
  fEdep   = aRight.fEdep;
  fNdep   = aRight.fNdep;
  fZId    = aRight.fZId;
  fRhoId  = aRight.fRhoId;
  fPhiId  = aRight.fPhiId;
  fTime   = aRight.fTime;
  fPos    = aRight.fPos;
  fRot    = aRight.fRot;
  fType   = aRight.fType;
  fLogVol = aRight.fLogVol;
}

~Par04Hit()

Par04Hit::~Par04Hit ( )

virtualdefault

Member Function Documentation

operator=()

const Par04Hit & Par04Hit::operator=

(

const Par04Hit &

aRight

)

Definition at line 80 of file Par04Hit.cc.

{
  fEdep   = aRight.fEdep;
  fNdep   = aRight.fNdep;
  fZId    = aRight.fZId;
  fRhoId  = aRight.fRhoId;
  fPhiId  = aRight.fPhiId;
  fTime   = aRight.fTime;
  fPos    = aRight.fPos;
  fRot    = aRight.fRot;
  fType   = aRight.fType;
  fLogVol = aRight.fLogVol;
  return *this;
}

operator==()

int Par04Hit::operator==

(

const Par04Hit &

aRight

)

const

Definition at line 97 of file Par04Hit.cc.

{
  return (fRhoId == aRight.fRhoId && fPhiId == aRight.fPhiId && fZId == aRight.fZId);
}

operator new()

void * Par04Hit::operator new ( size_t  )

inline

Definition at line 149 of file Par04Hit.hh.

{
  if(!Par04HitAllocator)
    Par04HitAllocator = new G4Allocator<Par04Hit>;
  return (void*) Par04HitAllocator->MallocSingle();
}

operator delete()

void Par04Hit::operator delete ( void *  aHit )

inline

Definition at line 156 of file Par04Hit.hh.

{
  Par04HitAllocator->FreeSingle((Par04Hit*) aHit);
}

Draw()

void Par04Hit::Draw ( )

finalvirtual

Visualise hits.

If pointer to the logical volume was set, cell shape is drawn taking into account proper radial position (taken from fRhoId)

Arbitrary size corresponds to the example macros

Definition at line 104 of file Par04Hit.cc.

{
  /// Arbitrary size corresponds to the example macros
  G4ThreeVector meshSize(2.325 * mm, 2 * CLHEP::pi / 50. * CLHEP::rad, 3.4 * mm);
  G4int numPhiCells           = CLHEP::pi * 2. / meshSize.y();
  G4VVisManager* pVVisManager = G4VVisManager::GetConcreteInstance();
  // Hits can be filtered out in visualisation
  if(!pVVisManager->FilterHit(*this))
    return;
  // Do not plot hits from parallel world
  if(fType >= 2)
    return;
  // Do not draw empty hits
  if(fEdep <= 0)
    return;
  // Do not plot if default values were not changed
  if(fRhoId == -1 && fZId == -1 && fPhiId == -1)
    return;
  if(pVVisManager)
  {
    G4Transform3D trans(fRot, fPos);
    G4VisAttributes attribs;
    G4Tubs solid("draw", fRhoId * meshSize.x(), (fRhoId + 1) * meshSize.x(), meshSize.z() / 2.,
                 (-numPhiCells / 2. + fPhiId) * meshSize.y(), meshSize.y());
    // Set colours depending on type of hit (full/fast sim)
    G4double colR = fType == 0 ? 0 : 1;
    G4double colG = fType == 0 ? 1 : 0;
    G4double colB = 0;
    // Set transparency depending on the energy
    // Arbitrary formula
    G4double alpha = 2 * std::log10(fEdep + 1);
    G4Colour colour(colR, colG, colB, alpha);
    attribs.SetColour(colour);
    attribs.SetForceSolid(true);
    pVVisManager->Draw(solid, attribs, trans);
  }
}

GetAttDefs()

const std::map< G4String, G4AttDef > * Par04Hit::GetAttDefs ( ) const

finalvirtual

Retrieve atributes' names in order to allow filtering.

Definition at line 144 of file Par04Hit.cc.

{
  G4bool isNew;
  std::map<G4String, G4AttDef>* store = G4AttDefStore::GetInstance("Par04Hit", isNew);
  if(isNew)
  {
    (*store)["HitType"] = G4AttDef("HitType", "Hit Type", "Physics", "", "G4String");
    (*store)["Energy"] =
      G4AttDef("Energy", "Energy Deposited", "Physics", "G4BestUnit", "G4double");
    (*store)["Time"] = G4AttDef("Time", "Time", "Physics", "G4BestUnit", "G4double");
    (*store)["Pos"]  = G4AttDef("Pos", "Position", "Physics", "G4BestUnit", "G4ThreeVector");
  }
  return store;
}

CreateAttValues()

std::vector< G4AttValue > * Par04Hit::CreateAttValues ( ) const

finalvirtual

Create attributes for the visualisation.

Definition at line 161 of file Par04Hit.cc.

{
  std::vector<G4AttValue>* values = new std::vector<G4AttValue>;
  values->push_back(G4AttValue("HitType", "HadPar04Hit", ""));
  values->push_back(G4AttValue("Energy", G4BestUnit(fEdep, "Energy"), ""));
  values->push_back(G4AttValue("Time", G4BestUnit(fTime, "Time"), ""));
  values->push_back(G4AttValue("Pos", G4BestUnit(fPos, "Length"), ""));
  return values;
}

Print()

void Par04Hit::Print ( )

finalvirtual

Print hit properties.

Definition at line 173 of file Par04Hit.cc.

{
  std::cout << "\tHit " << fEdep / MeV << " MeV from " << fNdep << " deposits at " << fPos / cm
            << " cm rotation " << fRot << " (R,phi,z)= (" << fRhoId << ", " << fPhiId
            << ", " << fZId << "), " << fTime << " ns" << std::endl;
}

SetPos()

void Par04Hit::SetPos ( G4ThreeVector  aXYZ )

inline

Set position.

Definition at line 78 of file Par04Hit.hh.

{ fPos = aXYZ; }

GetPos()

G4ThreeVector Par04Hit::GetPos ( ) const

inline

Get position.

Definition at line 80 of file Par04Hit.hh.

{ return fPos; }

SetRot()

void Par04Hit::SetRot ( G4RotationMatrix  aXYZ )

inline

Set rotation.

Definition at line 82 of file Par04Hit.hh.

{ fRot = aXYZ; }

GetRot()

G4RotationMatrix Par04Hit::GetRot ( ) const

inline

Get rotation.

Definition at line 84 of file Par04Hit.hh.

{ return fRot; }

SetEdep()

void Par04Hit::SetEdep ( G4double  aEdep )

inline

Set energy.

Definition at line 86 of file Par04Hit.hh.

{ fEdep = aEdep; }

AddEdep()

void Par04Hit::AddEdep ( G4double  aEdep )

inline

Add energy to previous value.

Definition at line 88 of file Par04Hit.hh.

{ fEdep += aEdep; }

GetEdep()

G4double Par04Hit::GetEdep ( ) const

inline

Get energy.

Definition at line 90 of file Par04Hit.hh.

{ return fEdep; }

SetNdep()

void Par04Hit::SetNdep ( G4int  aNdep )

inline

Set number of deposits per hit/cell.

Definition at line 92 of file Par04Hit.hh.

{ fNdep = aNdep; }

AddNdep()

void Par04Hit::AddNdep ( G4int  aNdep = 1 )

inline

Add number of deposits to previous value, by defualt increment.

Definition at line 94 of file Par04Hit.hh.

{ fNdep += aNdep; }

GetNdep()

G4int Par04Hit::GetNdep ( ) const

inline

Get number of deposits per hit/cell.

Definition at line 96 of file Par04Hit.hh.

{ return fNdep; }

SetZid()

void Par04Hit::SetZid ( G4int  aZ )

inline

Set Z id of the cell in the readout segmentation.

Definition at line 98 of file Par04Hit.hh.

{ fZId = aZ; }

GetZid()

G4int Par04Hit::GetZid ( ) const

inline

Get Z id of the cell in the readout segmentation.

Definition at line 100 of file Par04Hit.hh.

{ return fZId; }

SetRhoId()

void Par04Hit::SetRhoId ( G4int  aRho )

inline

Set Rho id of the cell in the readout segmentation.

Definition at line 102 of file Par04Hit.hh.

{ fRhoId = aRho; }

GetRhoId()

G4int Par04Hit::GetRhoId ( ) const

inline

Get rho id of the cell in the readout segmentation.

Definition at line 104 of file Par04Hit.hh.

{ return fRhoId; }

SetPhiId()

void Par04Hit::SetPhiId ( G4int  aPhi )

inline

Set phi id of the cell in the readout segmentation.

Definition at line 106 of file Par04Hit.hh.

{ fPhiId = aPhi; }

GetPhiId()

G4int Par04Hit::GetPhiId ( ) const

inline

Get phi id of the cell in the readout segmentation.

Definition at line 108 of file Par04Hit.hh.

{ return fPhiId; }

SetTime()

void Par04Hit::SetTime ( G4double  aTime )

inline

Set time.

Definition at line 110 of file Par04Hit.hh.

{ fTime = aTime; }

GetTime()

G4double Par04Hit::GetTime ( ) const

inline

Get time.

Definition at line 112 of file Par04Hit.hh.

{ return fTime; }

SetType()

void Par04Hit::SetType ( G4int  aType )

inline

Set type (0 = full sim, 1 = fast sim)

Definition at line 114 of file Par04Hit.hh.

{ fType = aType; }

GetType()

G4int Par04Hit::GetType ( ) const

inline

Get type (0 = full sim, 1 = fast sim)

Definition at line 116 of file Par04Hit.hh.

{ return fType; }

SetLogV()

void Par04Hit::SetLogV ( G4LogicalVolume *  aLogVol )

inline

Definition at line 118 of file Par04Hit.hh.

{ fLogVol = aLogVol; }

GetLogVol()

const G4LogicalVolume * Par04Hit::GetLogVol ( )

inline

Definition at line 120 of file Par04Hit.hh.

{ return fLogVol; }

Member Data Documentation

fEdep

G4double Par04Hit::fEdep = 0

Energy deposit.

Definition at line 124 of file Par04Hit.hh.

fNdep

G4int Par04Hit::fNdep = 0

Counter of deposits in a hit/cell.

Definition at line 126 of file Par04Hit.hh.

fZId

G4int Par04Hit::fZId = -1

Z ID of readout cell.

Definition at line 128 of file Par04Hit.hh.

fRhoId

G4int Par04Hit::fRhoId = -1

Rho ID of readout cell.

Definition at line 130 of file Par04Hit.hh.

fPhiId

G4int Par04Hit::fPhiId = -1

Phi ID of readout cell.

Definition at line 132 of file Par04Hit.hh.

fPos

G4ThreeVector Par04Hit::fPos = { -1, -1, -1 }

Position.

Definition at line 134 of file Par04Hit.hh.

{ -1, -1, -1 };

fRot

G4RotationMatrix Par04Hit::fRot

Rotation.

Definition at line 136 of file Par04Hit.hh.

fTime

G4double Par04Hit::fTime = -1

Time.

Definition at line 138 of file Par04Hit.hh.

fType

G4int Par04Hit::fType = -1

Type: 0 = full sim, 1 = fast sim.

Definition at line 140 of file Par04Hit.hh.

fLogVol

G4LogicalVolume* Par04Hit::fLogVol = nullptr

Pointer to logical volume for visualisation.

Definition at line 142 of file Par04Hit.hh.

---

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

• .doxygen/Doxymodules_parameterisations.h
• extended/parameterisations/Par04/include/Par04Hit.hh
• extended/parameterisations/Par04/src/Par04Hit.cc