PDF construction and log likelihood determination for a given track and particle hypothesis. More...

#include <PDFConstructor.h>

Collaboration diagram for PDFConstructor:

[legend]

Classes
struct	InverseRaytracerDirect
	Structure that enables defining a template function: direct photons. More...

struct	InverseRaytracerReflected
	Structure that enables defining a template function: reflected photons. More...

struct	LogL
	Useful data type for returning the results of log likelihood calculation. More...

struct	PrismSolution
	Solution of inverse raytracing in prism. More...

struct	Pull
	Data type for storing photon pull w.r.t PDF peak. More...

Public Types
enum	EPDFOption { c_Rough = 0 , c_Fine = 1 , c_Optimal = 2 }
	Signal PDF construction options. More...

enum	EStoreOption { c_Reduced = 0 , c_Full = 1 }
	Options for storing signal PDF parameters. More...

Public Member Functions
	PDFConstructor (const TOPTrack &track, const Const::ChargedStable &hypothesis, EPDFOption PDFOption=c_Optimal, EStoreOption storeOption=c_Reduced, double overrideMass=0)
	Class constructor. More...

bool	isValid () const
	Checks the object status. More...

void	switchOffDeltaRayPDF () const
	Exclude delta-ray PDF in log likelihood calculation.

void	switchOnDeltaRayPDF () const
	Include delta-ray PDF in log likelihood calculation (this is default)

void	switchDeltaRayPDF (bool deltaPDFOn) const
	Include or exclude delta-ray PDF in log likelihood calculation. More...

int	getModuleID () const
	Returns slot ID. More...

const Const::ChargedStable &	getHypothesis () const
	Returns particle hypothesis. More...

const std::vector< TOPTrack::SelectedHit > &	getSelectedHits () const
	Returns selected photon hits belonging to this slot. More...

double	getBkgRate () const
	Returns estimated background hit rate. More...

double	getCosTotal () const
	Returns cosine of total reflection angle. More...

double	getCosCerenkovAngle (double E) const
	Returns cosine of Cerenkov angle at given photon energy. More...

const std::vector< SignalPDF > &	getSignalPDF () const
	Returns signal PDF. More...

const BackgroundPDF *	getBackgroundPDF () const
	Returns background PDF. More...

const DeltaRayPDF &	getDeltaRayPDF () const
	Returns delta-ray PDF. More...

double	getExpectedSignalPhotons () const
	Returns the expected number of signal photons within the default time window. More...

double	getExpectedDeltaPhotons () const
	Returns the expected number of delta-ray photons within the default time window. More...

double	getExpectedBkgPhotons () const
	Returns the expected number of background photons within the default time window. More...

double	getExpectedPhotons () const
	Returns the expected number of all photons within the default time window. More...

double	getExpectedSignalPhotons (double minTime, double maxTime) const
	Returns the expected number of signal photons within a given time window. More...

double	getExpectedDeltaPhotons (double minTime, double maxTime) const
	Returns the expected number of delta-ray photons within a given time window. More...

double	getExpectedBkgPhotons (double minTime, double maxTime) const
	Returns the expected number of background photons within a given time window. More...

double	getExpectedPhotons (double minTime, double maxTime) const
	Returns the expected number of all photons within a given time window. More...

double	getPDFValue (int pixelID, double time, double timeErr, double sigt=0) const
	Returns PDF value. More...

LogL	getLogL () const
	Returns extended log likelihood (using the default time window) More...

LogL	getLogL (double t0, double sigt=0) const
	Returns extended log likelihood for PDF shifted in time. More...

LogL	getLogL (double t0, double minTime, double maxTime, double sigt=0) const
	Returns extended log likelihood for PDF shifted in time and using different time window. More...

LogL	getBackgroundLogL () const
	Returns extended log likelihood for background hypothesis using default time window. More...

LogL	getBackgroundLogL (double minTime, double maxTime) const
	Returns extended log likelihood for background hypothesis. More...

const std::vector< LogL > &	getPixelLogLs (double t0, double sigt=0) const
	Returns extended log likelihoods in pixels for PDF shifted in time. More...

const std::vector< LogL > &	getPixelLogLs (double t0, double minTime, double maxTime, double sigt=0) const
	Returns extended log likelihoods in pixels for PDF shifted in time and using diferent time window. More...

const std::vector< Pull > &	getPulls () const
	Returns photon pulls w.r.t PDF peaks. More...

int	getNCalls_setPDF (SignalPDF::EPeakType type) const
	Returns number of calls of template function setSignalPDF<T> for a given peak type. More...

int	getNCalls_expandPDF (SignalPDF::EPeakType type) const
	Returns number of calls of function expandSignalPDF for a given peak type. More...

const std::map< double, YScanner::Derivatives > &	getDerivatives () const
	Returns a collection of derivatives for debugging purposes. More...

void	appendPDFOther (const PDFConstructor *pdfOther)
	Append most probable PDF of other track in this module. More...

void	clearPDFOther ()
	Clear the container of PDF's of other tracks.

Private Member Functions
template<class T >
void	setSignalPDF (T &t, unsigned col, double xD, double zD, int Nxm=0, double xmMin=0, double xmMax=0)
	Template function: sets signal PDF in a pixel column and for specific reflection in x. More...

const InverseRaytracer::CerenkovAngle &	cerenkovAngle (double dE=0)
	Returns cosine and sine of cerenkov angle. More...

void	setSignalPDF ()
	Sets signal PDF.

void	setSignalPDF_direct ()
	Sets signal PDF for direct photons.

void	setSignalPDF_reflected ()
	Sets signal PDF for reflected photons.

void	setSignalPDF_prism ()
	Sets signal PDF for track crossing prism.

void	setSignalPDF_reflected (int Nxm, double xmMin, double xmMax)
	Sets signal PDF for reflected photons at given reflection number. More...

bool	detectionPositionX (double xM, int Nxm, std::vector< double > &xDs, double &minLen)
	Calculates unfolded detection position from known reflection position on the mirror and emission point. More...

bool	doRaytracingCorrections (const InverseRaytracer::Solution &sol, double dFic_dx, double xD)
	Corrects the solution of inverse ray-tracing with fast ray-tracing. More...

double	deltaXD (double dFic, const InverseRaytracer::Solution &sol, double xD)
	Returns the difference in xD between ray-traced solution rotated by dFic and input argument. More...

bool	setDerivatives (YScanner::Derivatives &D, double dL, double de, double dFic)
	Sets the derivatives (numerically) using forward ray-tracing. More...

bool	raytrace (const FastRaytracer &rayTracer, double dL=0, double de=0, double dFic=0)
	Forward ray-tracing (called by setDerivatives) More...

double	propagationLosses (double E, double propLen, int nx, int ny, SignalPDF::EPeakType type) const
	Returns photon propagation losses (bulk absorption, surface reflectivity, mirror reflectivity) More...

void	expandSignalPDF (unsigned col, const YScanner::Derivatives &D, SignalPDF::EPeakType type)
	Expands signal PDF in y (y-scan) More...

bool	rangeOfX (double z, double &xmi, double &xma)
	Estimates range of unfolded x coordinate of the hits on given plane perpendicular to z-axis. More...

double	findReflectionExtreme (double xE, double zE, double zD, int Nxm, double A, const RaytracerBase::Mirror &mirror) const
	Finds the position on the mirror of the extreme reflection. More...

double	derivativeOfReflectedX (double x, double xe, double ze, double zd) const
	Returns the derivative of reflected position at given x. More...

bool	prismRaytrace (const PrismSolution &sol, double dL=0, double dFic=0, double de=0)
	Do forward raytracing of inverse raytracing solution in prism. More...

PrismSolution	prismSolution (const PixelPositions::PixelData &pixel, unsigned k, int nx)
	General solution of inverse raytracing in prism: iterative procedure calling basic solution. More...

PrismSolution	prismSolution (const ROOT::Math::XYZPoint &rD, double L)
	Basic solution of inverse raytracing in prism: assuming straight line particle trajectory. More...

double	pdfValueSignalDelta (int pixelID, double time, double timeErr, double sigt=0) const
	Returns the value of signal + deltaRay PDF normalized to the number of expected photons. More...

double	pdfValue (int pixelID, double time, double timeErr, double sigt=0) const
	Returns the value of PDF normalized to the number of expected photons. More...

void	initializePixelLogLs (double minTime, double maxTime) const
	Initializes pixel log likelihoods. More...

void	appendPulls (const TOPTrack::SelectedHit &hit) const
	Appends pulls of a photon hit. More...

Private Attributes
int	m_moduleID = 0
	slot ID

const TOPTrack &	m_track
	temporary reference to track at TOP

const Const::ChargedStable	m_hypothesis
	particle hypothesis

const InverseRaytracer *	m_inverseRaytracer = 0
	inverse ray-tracer

const FastRaytracer *	m_fastRaytracer = 0
	fast ray-tracer

std::vector< FastRaytracer >	m_rayTracers
	copies of fast ray-tracer used to compute derivatives

const YScanner *	m_yScanner = 0
	PDF expander in y.

const BackgroundPDF *	m_backgroundPDF = 0
	background PDF

DeltaRayPDF	m_deltaRayPDF
	delta-ray PDF

EPDFOption	m_PDFOption = c_Optimal
	signal PDF construction option

EStoreOption	m_storeOption = c_Reduced
	signal PDF storing option

bool	m_valid = false
	cross-check flag, true if track is valid and all the pointers above are valid

double	m_beta = 0
	particle hypothesis beta

double	m_tof = 0
	time-of-flight from IP to average photon emission position

double	m_groupIndex = 0
	group refractive index at mean photon energy

double	m_groupIndexDerivative = 0
	derivative (dn_g/dE) of group refractive index at mean photon energy

double	m_cosTotal = 0
	cosine of total reflection angle

double	m_minTime = 0
	time window lower edge

double	m_maxTime = 0
	time window upper edge

std::vector< TOPTrack::SelectedHit >	m_selectedHits
	selected photon hits

double	m_bkgRate = 0
	estimated background hit rate

std::vector< SignalPDF >	m_signalPDFs
	parameterized signal PDF in pixels (index = pixelID - 1)

double	m_signalPhotons = 0
	expected number of signal photons

double	m_bkgPhotons = 0
	expected number of uniform background photons

double	m_deltaPhotons = 0
	expected number of delta-ray photons

std::map< double, InverseRaytracer::CerenkovAngle >	m_cerenkovAngles
	sine and cosine of Cerenkov angles

double	m_dFic = 0
	temporary storage for dFic used in last call to deltaXD

double	m_Fic = 0
	temporary storage for Cerenkov azimuthal angle

std::map< SignalPDF::EPeakType, int >	m_ncallsSetPDF
	number of calls to setSignalPDF<T>

std::map< SignalPDF::EPeakType, int >	m_ncallsExpandPDF
	number of calls to expandSignalPDF

std::vector< LogL >	m_pixelLLs
	pixel log likelihoods (index = pixelID - 1)

std::vector< Pull >	m_pulls
	photon pulls w.r.t PDF peaks

bool	m_deltaPDFOn = true
	include/exclude delta-ray PDF in likelihood calculation

std::map< double, YScanner::Derivatives >	m_derivatives
	a map of xD and derivatives

std::set< int >	m_zeroPixels
	collection of pixelID's with zero pdfValue

std::vector< const PDFConstructor * >	m_pdfOtherTracks
	most probable PDF's of other tracks in the module

Detailed Description

PDF construction and log likelihood determination for a given track and particle hypothesis.

Definition at line 34 of file PDFConstructor.h.

Member Enumeration Documentation

◆ EPDFOption

enum EPDFOption

Signal PDF construction options.

Enumerator
c_Rough	no dependence on y
c_Fine	y dependent everywhere
c_Optimal	y dependent only where necessary

Definition at line 41 of file PDFConstructor.h.

                       {
         c_Rough = 0,   
         c_Fine = 1,    
         c_Optimal = 2  
       };

◆ EStoreOption

enum EStoreOption

Options for storing signal PDF parameters.

Enumerator
c_Reduced	only PDF peak data
c_Full	also extra information and derivatives

Definition at line 50 of file PDFConstructor.h.

Constructor & Destructor Documentation

◆ PDFConstructor()

PDFConstructor	(	const TOPTrack &	track,
		const Const::ChargedStable &	hypothesis,
		EPDFOption	PDFOption = `c_Optimal`,
		EStoreOption	storeOption = `c_Reduced`,
		double	overrideMass = `0`
	)

Class constructor.

Parameters

track	track at TOP
hypothesis	particle hypothesis
PDFOption	signal PDF construction option
storeOption	signal PDF store option
overrideMass	alternative mass value to be used intestead of the one from hypothesis. Ignored if <= 0.

Definition at line 27 of file PDFConstructor.cc.

                                                                                                        :
       m_moduleID(track.getModuleID()), m_track(track), m_hypothesis(hypothesis),
       m_inverseRaytracer(TOPRecoManager::getInverseRaytracer(m_moduleID)),
       m_fastRaytracer(TOPRecoManager::getFastRaytracer(m_moduleID)),
       m_yScanner(TOPRecoManager::getYScanner(m_moduleID)),
       m_backgroundPDF(TOPRecoManager::getBackgroundPDF(m_moduleID)),
       m_deltaRayPDF(m_moduleID),
       m_PDFOption(PDFOption), m_storeOption(storeOption)
     {
       if (not track.isValid()) {
         B2ERROR("TOP::PDFConstructor: TOPTrack is not valid, cannot continue");
         return;
       }
  
       m_valid = m_inverseRaytracer != 0 and m_fastRaytracer != 0 and m_yScanner != 0 and m_backgroundPDF != 0;
       if (not m_valid) {
         B2ERROR("TOP::PDFConstructor: missing reconstruction objects, cannot continue");
         return;
       }
  
       m_beta = track.getBeta(hypothesis, overrideMass);
       m_yScanner->prepare(track.getMomentumMag(), m_beta, track.getLengthInQuartz());
       m_tof = track.getTOF(hypothesis, 0, overrideMass);
  
       m_groupIndex = TOPGeometryPar::Instance()->getGroupIndex(m_yScanner->getMeanEnergy());
       m_groupIndexDerivative = TOPGeometryPar::Instance()->getGroupIndexDerivative(m_yScanner->getMeanEnergy());
       m_cosTotal = m_yScanner->getCosTotal();
       m_minTime = TOPRecoManager::getMinTime();
       m_maxTime = TOPRecoManager::getMaxTime();
       m_selectedHits = track.getSelectedHits();
       m_bkgRate = track.getBkgRate();
  
       // prepare the memory for storing signal PDF
  
       const auto& pixelPositions = m_yScanner->getPixelPositions();
       int numPixels = pixelPositions.getNumPixels();
       const auto* geo = TOPGeometryPar::Instance()->getGeometry();
       for (int pixelID = 1; pixelID <= numPixels; pixelID++) {
         auto pmtType = pixelPositions.get(pixelID).pmtType;
         const auto& tts = geo->getTTS(pmtType);
         m_signalPDFs.push_back(SignalPDF(pixelID, tts));
       }
  
       // construct PDF
  
       if (m_yScanner->isAboveThreshold()) {
         setSignalPDF();
       }
  
       m_deltaRayPDF.prepare(track, hypothesis);
       m_deltaPhotons = m_deltaRayPDF.getNumPhotons();
  
       m_bkgPhotons = std::max(m_bkgRate * (m_maxTime - m_minTime), 0.1);
  
       // release the memory not needed anymore
  
       m_rayTracers.clear();
     }

Member Function Documentation

◆ appendPDFOther()

void appendPDFOther ( const PDFConstructor * pdfOther )

inline

Append most probable PDF of other track in this module.

Parameters

pdfOther PDF of other track

Definition at line 376 of file PDFConstructor.h.

◆ appendPulls()

void appendPulls ( const TOPTrack::SelectedHit & hit ) const

private

Appends pulls of a photon hit.

Parameters

hit	photon hit

Definition at line 983 of file PDFConstructor.cc.

◆ cerenkovAngle()

const InverseRaytracer::CerenkovAngle & cerenkovAngle ( double dE = 0 )

inlineprivate

Returns cosine and sine of cerenkov angle.

Parameters

dE	energy difference to mean photon energy

Returns: cosine and sine of cerenkov angle

Definition at line 743 of file PDFConstructor.h.

◆ deltaXD()

double deltaXD	(	double	dFic,
		const InverseRaytracer::Solution &	sol,
		double	xD
	)

inlineprivate

Returns the difference in xD between ray-traced solution rotated by dFic and input argument.

Parameters

dFic	rotation angle around track direction (delta Cerenkov azimuthal angle)
sol	solution of inverse raytracing
xD	unfolded detection position in x

Returns: difference in xD

Definition at line 729 of file PDFConstructor.h.

◆ derivativeOfReflectedX()

double derivativeOfReflectedX	(	double	x,
		double	xe,
		double	ze,
		double	zd
	)		const

private

Returns the derivative of reflected position at given x.

This function is used to find the position of reflection extreme. All arguments must be given in the mirror frame and in units of mirror radius.

Parameters

x	position in x on the mirror
xe	unfolded emission position in x
ze	emission position in z
zd	unfolded detection position in z

Returns: the derivative

Definition at line 576 of file PDFConstructor.cc.

◆ detectionPositionX()

bool detectionPositionX	(	double	xM,
		int	Nxm,
		std::vector< double > &	xDs,
		double &	minLen
	)

private

Calculates unfolded detection position from known reflection position on the mirror and emission point.

Parameters

xM	reflection position x on the mirror
Nxm	reflection number before the mirror
xDs	unfolded detection positions (appended at each call) [in/out]
minLen	minimum of propagation lengths (updated at each call) [in/out]

Returns: true on success

Definition at line 216 of file PDFConstructor.cc.

◆ doRaytracingCorrections()

bool doRaytracingCorrections	(	const InverseRaytracer::Solution &	sol,
		double	dFic_dx,
		double	xD
	)

private

Corrects the solution of inverse ray-tracing with fast ray-tracing.

Corrected solution is available in m_fastRaytracer.

Parameters

sol	solution of inverse raytracing
dFic_dx	derivative of Cerenkov azimuthal angle over photon detection coordinate x
xD	unfolded detection position in x

Returns: true on success

Definition at line 236 of file PDFConstructor.cc.

◆ expandSignalPDF()

void expandSignalPDF	(	unsigned	col,
		const YScanner::Derivatives &	D,
		SignalPDF::EPeakType	type
	)

private

Expands signal PDF in y (y-scan)

Parameters

col	pixel column (0-based)
D	derivatives
type	peak type, e.g. direct or reflected

Definition at line 391 of file PDFConstructor.cc.

◆ findReflectionExtreme()

double findReflectionExtreme	(	double	xE,
		double	zE,
		double	zD,
		int	Nxm,
		double	A,
		const RaytracerBase::Mirror &	mirror
	)		const

private

Finds the position on the mirror of the extreme reflection.

Parameters

xE	true emission position in x
zE	emission position in z
zD	detection position in z
Nxm	signed number of reflections before mirror
A	width of the mirror segment
mirror	spherical mirror data

Returns: position of the extreme if exists or -A/2

Definition at line 594 of file PDFConstructor.cc.

◆ getBackgroundLogL() [1/2]

LogL getBackgroundLogL ( ) const

inline

Returns extended log likelihood for background hypothesis using default time window.

Returns: log likelihood

Definition at line 316 of file PDFConstructor.h.

◆ getBackgroundLogL() [2/2]

PDFConstructor::LogL getBackgroundLogL	(	double	minTime,
		double	maxTime
	)		const

Returns extended log likelihood for background hypothesis.

Parameters

minTime	time window lower edge
maxTime	time window upper edge

Returns: log likelihood

Definition at line 891 of file PDFConstructor.cc.

◆ getBackgroundPDF()

const BackgroundPDF* getBackgroundPDF ( ) const

inline

Returns background PDF.

Returns: background PDF

Definition at line 178 of file PDFConstructor.h.

◆ getBkgRate()

double getBkgRate ( ) const

inline

Returns estimated background hit rate.

Returns: background hit rate per module

Definition at line 153 of file PDFConstructor.h.

◆ getCosCerenkovAngle()

double getCosCerenkovAngle ( double E ) const

inline

Returns cosine of Cerenkov angle at given photon energy.

Parameters

E	photon energy [eV]

Returns: cosine of Cerenkov angle

Definition at line 737 of file PDFConstructor.h.

◆ getCosTotal()

double getCosTotal ( ) const

inline

Returns cosine of total reflection angle.

Returns: cosine of total reflection angle at mean photon energy for beta = 1

Definition at line 159 of file PDFConstructor.h.

◆ getDeltaRayPDF()

const DeltaRayPDF& getDeltaRayPDF ( ) const

inline

Returns delta-ray PDF.

Returns: delta-ray PDF

Definition at line 184 of file PDFConstructor.h.

◆ getDerivatives()

const std::map<double, YScanner::Derivatives>& getDerivatives ( ) const

inline

Returns a collection of derivatives for debugging purposes.

The derivatives are available only for EStoreOption::c_Full

Returns: map of xD and derivatives

Definition at line 370 of file PDFConstructor.h.

◆ getExpectedBkgPhotons() [1/2]

double getExpectedBkgPhotons ( ) const

inline

Returns the expected number of background photons within the default time window.

Photons from other tracks in the module are counted here as background.

Returns: expected number of background photons

Definition at line 203 of file PDFConstructor.h.

◆ getExpectedBkgPhotons() [2/2]

double getExpectedBkgPhotons	(	double	minTime,
		double	maxTime
	)		const

inline

Returns the expected number of background photons within a given time window.

Photons from other tracks in the module are counted here as background.

Parameters

minTime	time window lower edge
maxTime	time window upper edge

Returns: expected number of background photons

Definition at line 254 of file PDFConstructor.h.

◆ getExpectedDeltaPhotons() [1/2]

double getExpectedDeltaPhotons ( ) const

inline

Returns the expected number of delta-ray photons within the default time window.

Returns: expected number of delta-ray photons (0 if modeling turned off)

Definition at line 196 of file PDFConstructor.h.

◆ getExpectedDeltaPhotons() [2/2]

double getExpectedDeltaPhotons	(	double	minTime,
		double	maxTime
	)		const

inline

Returns the expected number of delta-ray photons within a given time window.

Parameters

minTime	time window lower edge
maxTime	time window upper edge

Returns: expected number of delta-ray photons (0 if modeling turned off)

Definition at line 242 of file PDFConstructor.h.

◆ getExpectedPhotons() [1/2]

double getExpectedPhotons ( ) const

inline

Returns the expected number of all photons within the default time window.

Returns: expected number of photons (signal + background + delta-ray)

Definition at line 216 of file PDFConstructor.h.

◆ getExpectedPhotons() [2/2]

double getExpectedPhotons	(	double	minTime,
		double	maxTime
	)		const

inline

Returns the expected number of all photons within a given time window.

Parameters

minTime	time window lower edge
maxTime	time window upper edge

Returns: expected number of photons (signal + background + delta-ray)

Definition at line 269 of file PDFConstructor.h.

◆ getExpectedSignalPhotons() [1/2]

double getExpectedSignalPhotons ( ) const

inline

Returns the expected number of signal photons within the default time window.

Returns: expected number of signal photons

Definition at line 190 of file PDFConstructor.h.

◆ getExpectedSignalPhotons() [2/2]

double getExpectedSignalPhotons	(	double	minTime,
		double	maxTime
	)		const

inline

Returns the expected number of signal photons within a given time window.

Parameters

minTime	time window lower edge
maxTime	time window upper edge

Returns: expected number of signal photons

Definition at line 227 of file PDFConstructor.h.

◆ getHypothesis()

const Const::ChargedStable& getHypothesis ( ) const

inline

Returns particle hypothesis.

Returns: particle hypothesis

Definition at line 141 of file PDFConstructor.h.

◆ getLogL() [1/3]

PDFConstructor::LogL getLogL ( ) const

Returns extended log likelihood (using the default time window)

Returns: log likelihood

Definition at line 837 of file PDFConstructor.cc.

◆ getLogL() [2/3]

PDFConstructor::LogL getLogL	(	double	t0,
		double	minTime,
		double	maxTime,
		double	sigt = `0`
	)		const

Returns extended log likelihood for PDF shifted in time and using different time window.

Parameters

t0	time shift
minTime	time window lower edge
maxTime	time window upper edge
sigt	additional time smearing

Returns: log likelihood

Definition at line 864 of file PDFConstructor.cc.

◆ getLogL() [3/3]

LogL getLogL	(	double	t0,
		double	sigt = `0`
	)		const

inline

Returns extended log likelihood for PDF shifted in time.

Parameters

t0	time shift
sigt	additional time smearing

Returns: log likelihood

Definition at line 300 of file PDFConstructor.h.

◆ getModuleID()

int getModuleID ( ) const

inline

Returns slot ID.

Returns: slot ID

Definition at line 135 of file PDFConstructor.h.

◆ getNCalls_expandPDF()

int getNCalls_expandPDF ( SignalPDF::EPeakType type ) const

inline

Returns number of calls of function expandSignalPDF for a given peak type.

Parameters

type	PDF peak type

Returns: number of calls

Definition at line 363 of file PDFConstructor.h.

◆ getNCalls_setPDF()

int getNCalls_setPDF ( SignalPDF::EPeakType type ) const

inline

Returns number of calls of template function setSignalPDF<T> for a given peak type.

Parameters

type	PDF peak type

Returns: number of calls

Definition at line 356 of file PDFConstructor.h.

◆ getPDFValue()

double getPDFValue	(	int	pixelID,
		double	time,
		double	timeErr,
		double	sigt = `0`
	)		const

inline

Returns PDF value.

Parameters

pixelID	pixel ID
time	photon hit time
timeErr	uncertainty of hit time
sigt	additional time smearing

Returns: PDF value

Definition at line 283 of file PDFConstructor.h.

◆ getPixelLogLs() [1/2]

const std::vector< PDFConstructor::LogL > & getPixelLogLs	(	double	t0,
		double	minTime,
		double	maxTime,
		double	sigt = `0`
	)		const

Returns extended log likelihoods in pixels for PDF shifted in time and using diferent time window.

Parameters

t0	time shift
minTime	time window lower edge
maxTime	time window upper edge
sigt	additional time smearing

Returns: pixel log likelihoods (index = pixelID - 1)

Definition at line 921 of file PDFConstructor.cc.

◆ getPixelLogLs() [2/2]

const std::vector<LogL>& getPixelLogLs	(	double	t0,
		double	sigt = `0`
	)		const

inline

Returns extended log likelihoods in pixels for PDF shifted in time.

Parameters

t0	time shift
sigt	additional time smearing

Returns: pixel log likelihoods (index = pixelID - 1)

Definition at line 332 of file PDFConstructor.h.

◆ getPulls()

const std::vector< PDFConstructor::Pull > & getPulls ( ) const

Returns photon pulls w.r.t PDF peaks.

Returns: pulls

Definition at line 971 of file PDFConstructor.cc.

◆ getSelectedHits()

const std::vector<TOPTrack::SelectedHit>& getSelectedHits ( ) const

inline

Returns selected photon hits belonging to this slot.

Returns: selected photon hits

Definition at line 147 of file PDFConstructor.h.

◆ getSignalPDF()

const std::vector<SignalPDF>& getSignalPDF ( ) const

inline

Returns signal PDF.

Returns: signal PDF in pixels (index = pixelID - 1)

Definition at line 172 of file PDFConstructor.h.

◆ initializePixelLogLs()

void initializePixelLogLs	(	double	minTime,
		double	maxTime
	)		const

private

Initializes pixel log likelihoods.

Parameters

minTime	time window lower edge
maxTime	time window upper edge

Definition at line 951 of file PDFConstructor.cc.

◆ isValid()

bool isValid ( ) const

inline

Checks the object status.

Returns: true if track is valid and all requited reconstruction objects are available

Definition at line 113 of file PDFConstructor.h.

◆ pdfValue()

double pdfValue	(	int	pixelID,
		double	time,
		double	timeErr,
		double	sigt = `0`
	)		const

inlineprivate

Returns the value of PDF normalized to the number of expected photons.

Parameters

pixelID	pixel ID
time	photon hit time
timeErr	uncertainty of hit time
sigt	additional time smearing

Returns: PDF value

Definition at line 717 of file PDFConstructor.h.

◆ pdfValueSignalDelta()

double pdfValueSignalDelta	(	int	pixelID,
		double	time,
		double	timeErr,
		double	sigt = `0`
	)		const

inlineprivate

Returns the value of signal + deltaRay PDF normalized to the number of expected photons.

Parameters

pixelID	pixel ID
time	photon hit time
timeErr	uncertainty of hit time
sigt	additional time smearing

Returns: PDF value

Definition at line 706 of file PDFConstructor.h.

◆ prismRaytrace()

bool prismRaytrace	(	const PrismSolution &	sol,
		double	dL = `0`,
		double	dFic = `0`,
		double	de = `0`
	)

private

Do forward raytracing of inverse raytracing solution in prism.

Parameters

sol	solution of inverse raytracing in prism
dL	step in length along trajectory for derivative calculation
dFic	step in Cherenkov azimuthal angle for derivative calculation
de	step in photon energy for derivative calculation

Returns: true on success

Definition at line 760 of file PDFConstructor.cc.

◆ prismSolution() [1/2]

PDFConstructor::PrismSolution prismSolution	(	const PixelPositions::PixelData &	pixel,
		unsigned	k,
		int	nx
	)

private

General solution of inverse raytracing in prism: iterative procedure calling basic solution.

Parameters

pixel	pixel data
k	index of unfolded prism exit window
nx	number of reflections in x

Returns: solution

Definition at line 786 of file PDFConstructor.cc.

◆ prismSolution() [2/2]

PDFConstructor::PrismSolution prismSolution	(	const ROOT::Math::XYZPoint &	rD,
		double	L
	)

private

Basic solution of inverse raytracing in prism: assuming straight line particle trajectory.

Parameters

rD	unfolded pixel position
L	emission position distance along particle trajectory

Returns: solution

Definition at line 808 of file PDFConstructor.cc.

◆ propagationLosses()

double propagationLosses	(	double	E,
		double	propLen,
		int	nx,
		int	ny,
		SignalPDF::EPeakType	type
	)		const

private

Returns photon propagation losses (bulk absorption, surface reflectivity, mirror reflectivity)

Parameters

E	photon energy
propLen	propagation length
nx	total number of reflections in x
ny	total number of reflections in y
type	peak type, e.g. direct or reflected

Returns: survival probability due to propagation losses

Definition at line 485 of file PDFConstructor.cc.

◆ rangeOfX()

bool rangeOfX	(	double	z,
		double &	xmi,
		double &	xma
	)

private

Estimates range of unfolded x coordinate of the hits on given plane perpendicular to z-axis.

Parameters

z	position of the plane
xmi	lower limit [out]
xma	upper limit [out]

Returns: true if at least some photons can reach the plane within the time window

Definition at line 495 of file PDFConstructor.cc.

◆ raytrace()

bool raytrace	(	const FastRaytracer &	rayTracer,
		double	dL = `0`,
		double	de = `0`,
		double	dFic = `0`
	)

private

Forward ray-tracing (called by setDerivatives)

Parameters

rayTracer	forward ray-tracer object
dL	value to be added to trajectory running parameter [cm]
de	value to be added to photon energy [eV]
dFic	value to be added to Cherenkov azimuthal angle

Returns: true on success

Definition at line 357 of file PDFConstructor.cc.

◆ setDerivatives()

bool setDerivatives	(	YScanner::Derivatives &	D,
		double	dL,
		double	de,
		double	dFic
	)

private

Sets the derivatives (numerically) using forward ray-tracing.

Parameters

D	derivatives to be set
dL	step in trajectory running parameter [cm]
de	step in photon energy [eV]
dFic	step in Cherenkov azimuthal angle

Returns: true on success

Definition at line 294 of file PDFConstructor.cc.

◆ setSignalPDF()

void setSignalPDF	(	T &	t,
		unsigned	col,
		double	xD,
		double	zD,
		int	Nxm = `0`,
		double	xmMin = `0`,
		double	xmMax = `0`
	)

private

Template function: sets signal PDF in a pixel column and for specific reflection in x.

Parameters

t	template parameter of type InverseRaytracerDirect or InverseRaytracerReflected
col	pixel column (0-based)
xD	unfolded detection position in x
zD	detection position in z
Nxm	signed number of reflections in x before mirror (dummy for direct PDF)
xmMin	lower limit of the reflection positions on the mirror (dummy for direct PDF)
xmMax	upper limit of the reflection positions on the mirror (dummy for direct PDF)

Definition at line 756 of file PDFConstructor.h.

◆ setSignalPDF_reflected()

void setSignalPDF_reflected	(	int	Nxm,
		double	xmMin,
		double	xmMax
	)

private

Sets signal PDF for reflected photons at given reflection number.

Parameters

Nxm	reflection number in x before mirror
xmMin	lower limit of the reflection positions on the mirror
xmMax	upper limit of the reflection positions on the mirror

Definition at line 176 of file PDFConstructor.cc.

◆ switchDeltaRayPDF()

void switchDeltaRayPDF ( bool deltaPDFOn ) const

inline

Include or exclude delta-ray PDF in log likelihood calculation.

Parameters

deltaPDFOn true = include, false = exclude

Definition at line 129 of file PDFConstructor.h.

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

top/reconstruction_cpp/include/PDFConstructor.h
top/reconstruction_cpp/src/PDFConstructor.cc

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ EPDFOption

◆ EStoreOption

Constructor & Destructor Documentation

◆ PDFConstructor()

Member Function Documentation

◆ appendPDFOther()

◆ appendPulls()

◆ cerenkovAngle()

◆ deltaXD()

◆ derivativeOfReflectedX()

◆ detectionPositionX()

◆ doRaytracingCorrections()

◆ expandSignalPDF()

◆ findReflectionExtreme()

◆ getBackgroundLogL() [1/2]

◆ getBackgroundLogL() [2/2]

◆ getBackgroundPDF()

◆ getBkgRate()

◆ getCosCerenkovAngle()

◆ getCosTotal()

◆ getDeltaRayPDF()

◆ getDerivatives()

◆ getExpectedBkgPhotons() [1/2]

◆ getExpectedBkgPhotons() [2/2]

◆ getExpectedDeltaPhotons() [1/2]

◆ getExpectedDeltaPhotons() [2/2]

◆ getExpectedPhotons() [1/2]

◆ getExpectedPhotons() [2/2]

◆ getExpectedSignalPhotons() [1/2]

◆ getExpectedSignalPhotons() [2/2]

◆ getHypothesis()

◆ getLogL() [1/3]

◆ getLogL() [2/3]

◆ getLogL() [3/3]

◆ getModuleID()

◆ getNCalls_expandPDF()

◆ getNCalls_setPDF()

◆ getPDFValue()

◆ getPixelLogLs() [1/2]

◆ getPixelLogLs() [2/2]

◆ getPulls()

◆ getSelectedHits()

◆ getSignalPDF()

◆ initializePixelLogLs()

◆ isValid()

◆ pdfValue()

◆ pdfValueSignalDelta()

◆ prismRaytrace()

◆ prismSolution() [1/2]

◆ prismSolution() [2/2]

◆ propagationLosses()

◆ rangeOfX()

◆ raytrace()

◆ setDerivatives()

◆ setSignalPDF()

◆ setSignalPDF_reflected()

◆ switchDeltaRayPDF()