Public Member Functions | Protected Member Functions | List of all members
gar::detinfo::DetectorProperties Class Referenceabstract

#include <DetectorProperties.h>

Inheritance diagram for gar::detinfo::DetectorProperties:
gar::detinfo::DetectorPropertiesStandard

Public Member Functions

 DetectorProperties (const DetectorProperties &)=delete
 
 DetectorProperties (DetectorProperties &&)=delete
 
DetectorPropertiesoperator= (const DetectorProperties &)=delete
 
DetectorPropertiesoperator= (DetectorProperties &&)=delete
 
virtual ~DetectorProperties ()=default
 
virtual double Efield (unsigned int planegap=0) const =0
 Returns the nominal electric field in the specified volume. More...
 
virtual double DriftVelocity (double efield=0., double temperature=0., bool cmPerns=true) const =0
 
virtual double ElectronLifetime () const =0
 
virtual double Density (double temperature) const =0
 Returns argon density at a given temperature. More...
 
virtual double Temperature () const =0
 
virtual double Eloss (double mom, double mass, double tcut) const =0
 Restricted mean energy loss ( $ dE/dx $) More...
 
virtual double ElossVar (double mom, double mass) const =0
 Energy loss fluctuation ( $ \sigma_{E}^2 / x $) More...
 
virtual double Density () const
 Returns argon density at the temperature from Temperature() More...
 
virtual double SamplingRate () const =0
 
virtual double ElectronsToADC () const =0
 
virtual unsigned int NumberTimeSamples () const =0
 
virtual int TriggerOffset () const =0
 
virtual double ConvertXToTicks (double X) const =0
 
virtual double ConvertTicksToX (double ticks) const =0
 
virtual double ConvertTDCToTicks (double tdc) const =0
 
virtual double ConvertTicksToTDC (double ticks) const =0
 
virtual double EffectivePixel () const =0
 
virtual double LightYield () const =0
 
virtual double SiPMGain () const =0
 
virtual double IntercalibrationFactor () const =0
 
virtual double ADCSaturation () const =0
 
virtual double TimeResolution () const =0
 
virtual double MeVtoMIP () const =0
 
virtual double NoisePx () const =0
 

Protected Member Functions

 DetectorProperties ()=default
 

Detailed Description

Definition at line 22 of file DetectorProperties.h.

Constructor & Destructor Documentation

gar::detinfo::DetectorProperties::DetectorProperties ( const DetectorProperties )
delete
gar::detinfo::DetectorProperties::DetectorProperties ( DetectorProperties &&  )
delete
virtual gar::detinfo::DetectorProperties::~DetectorProperties ( )
virtualdefault
gar::detinfo::DetectorProperties::DetectorProperties ( )
protecteddefault

Member Function Documentation

virtual double gar::detinfo::DetectorProperties::ADCSaturation ( ) const
pure virtual
virtual double gar::detinfo::DetectorProperties::ConvertTDCToTicks ( double  tdc) const
pure virtual
virtual double gar::detinfo::DetectorProperties::ConvertTicksToTDC ( double  ticks) const
pure virtual
virtual double gar::detinfo::DetectorProperties::ConvertTicksToX ( double  ticks) const
pure virtual
virtual double gar::detinfo::DetectorProperties::ConvertXToTicks ( double  X) const
pure virtual
virtual double gar::detinfo::DetectorProperties::Density ( double  temperature) const
pure virtual

Returns argon density at a given temperature.

Parameters
temperaturethe temperature in kelvin
Returns
argon density in g/cm^3

Implemented in gar::detinfo::DetectorPropertiesStandard.

virtual double gar::detinfo::DetectorProperties::Density ( ) const
inlinevirtual

Returns argon density at the temperature from Temperature()

Reimplemented in gar::detinfo::DetectorPropertiesStandard.

Definition at line 90 of file DetectorProperties.h.

90 { return Density(Temperature()); }
virtual double Temperature() const =0
virtual double Density() const
Returns argon density at the temperature from Temperature()
virtual double gar::detinfo::DetectorProperties::DriftVelocity ( double  efield = 0.,
double  temperature = 0.,
bool  cmPerns = true 
) const
pure virtual
virtual double gar::detinfo::DetectorProperties::EffectivePixel ( ) const
pure virtual
virtual double gar::detinfo::DetectorProperties::Efield ( unsigned int  planegap = 0) const
pure virtual

Returns the nominal electric field in the specified volume.

Parameters
planegapvolume specification (default: 0, the big drift volume)
Returns
electric field in the volume, in kV/cm

The electric field is "nominal", i.e., a completely uniform field is assumed.

The planegap argument identifies which volume to return the field value for. The relation between planegap and readout plane is not perfectly formalized yet. In general, a good rule is that planegap N describes the volume on the cathode side of wire plane N. This rule is formally valid also for ArgoNeuT/LArIAT, where three wire planes are present. But only two of them are instrumented and read, that are called "readout plane 0" and "readout plane 1", but effectively correspond to planegap 1 and 2.

Note that all TPCs are assumed to have the same electric field values.

Implemented in gar::detinfo::DetectorPropertiesStandard.

virtual double gar::detinfo::DetectorProperties::ElectronLifetime ( ) const
pure virtual
virtual double gar::detinfo::DetectorProperties::ElectronsToADC ( ) const
pure virtual
virtual double gar::detinfo::DetectorProperties::Eloss ( double  mom,
double  mass,
double  tcut 
) const
pure virtual

Restricted mean energy loss ( $ dE/dx $)

Parameters
mommomentum of incident particle [GeV/c]
massmass of incident particle [GeV/c^2]
tcutmaximum kinetic energy of delta rays [MeV]; 0 for unlimited
Returns
the restricted mean energy loss (dE/dx) in units of MeV/cm

Returned value is always positive. For unrestricted mean energy loss, set tcut = 0 (special case), or tcut large.

Implemented in gar::detinfo::DetectorPropertiesStandard.

virtual double gar::detinfo::DetectorProperties::ElossVar ( double  mom,
double  mass 
) const
pure virtual

Energy loss fluctuation ( $ \sigma_{E}^2 / x $)

Parameters
mommomentum of incident particle in [GeV/c]
Returns
energy loss fluctuation in MeV^2/cm

Implemented in gar::detinfo::DetectorPropertiesStandard.

virtual double gar::detinfo::DetectorProperties::IntercalibrationFactor ( ) const
pure virtual
virtual double gar::detinfo::DetectorProperties::LightYield ( ) const
pure virtual
virtual double gar::detinfo::DetectorProperties::MeVtoMIP ( ) const
pure virtual
virtual double gar::detinfo::DetectorProperties::NoisePx ( ) const
pure virtual
virtual unsigned int gar::detinfo::DetectorProperties::NumberTimeSamples ( ) const
pure virtual
DetectorProperties& gar::detinfo::DetectorProperties::operator= ( const DetectorProperties )
delete
DetectorProperties& gar::detinfo::DetectorProperties::operator= ( DetectorProperties &&  )
delete
virtual double gar::detinfo::DetectorProperties::SamplingRate ( ) const
pure virtual
virtual double gar::detinfo::DetectorProperties::SiPMGain ( ) const
pure virtual
virtual double gar::detinfo::DetectorProperties::Temperature ( ) const
pure virtual
virtual double gar::detinfo::DetectorProperties::TimeResolution ( ) const
pure virtual
virtual int gar::detinfo::DetectorProperties::TriggerOffset ( ) const
pure virtual

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