SourceRead Class Reference

Read a source file sequence. More...

#include <SourceRead.h>

Inheritance diagram for SourceRead:

Collaboration diagram for SourceRead:

Public Member Functions
double	GetAstroDeclinationDeg (void)
	Returns the astro-particle declination in [deg].
double	GetAstroEnergy (void)
	Returns the astro-particle energy [keV].
double	GetAstroPhip (void)
	Returns the astro-particle \(\varphi'\) [rad].
double	GetAstroRightAscensionDeg (void)
	Returns the astro-particle right-ascension in [deg].
double	GetAstroThetap (void)
	Returns the astro-particle \(\theta'\) [rad].
ULong64_t	GetAstroTime (void)
	Returns the astro-particle time [ms].
double	GetCosConeAngle (const ULong64_t aTime)
	Returns the source cone angle cosine at a given time.
TGraph *	GetCosConeAngle (void)
	Returns the source cone angle cosine as a function of time.
double	GetDeclinationDeg (const ULong64_t aTime)
	Returns the source declination in [deg] at a given time.
TH2D *	GetFlux (void)
	Returns the source flux.
TH1D *	GetLightCurve (const double aEnergyMin=0.0, const double aEnergyMax=-1.0)
	Returns the source light curve between two energies.
string	GetName (void)
	Returns the source name.
double	GetPhip (const ULong64_t aTime)
	Returns the source position angle \(\varphi'\) [rad]$ at a given time.
TGraph *	GetPhip (void)
	Returns the source position angle \(\varphi'\) [rad]$ as a function of time.
TH2D *	GetRate (void)
	Returns the source rate.
double	GetRightAscensionDeg (const ULong64_t aTime)
	Returns the source right ascension in [deg] at a given time.
TH1D *	GetSpectrum (const double aTimeMin=0.0, const double aTimeMax=-1.0)
	Returns the source energy spectrum between two times.
double	GetThetap (const ULong64_t aTime)
	Returns the source position angle \(\theta'\) [rad] at a given time.
TGraph *	GetThetap (void)
	Returns the source position angle \(\theta'\) [rad] as a function of time.
double	GetTimeMax (void)
	Returns the source time end [ms].
double	GetTimeMin (void)
	Returns the source time start [ms].
int	GetType (void)
	Returns the source type (see Source::sourcetype).
Constructors and destructors
	SourceRead (const string aFilePattern, const string aName)
	SourceRead class constuctor.
virtual	~SourceRead (void)
	SourceRead class destructor.

Private Attributes
double	astro_energy
	astroparticle energy [keV].
double	astro_phip
	astroparticle phi prime.
double	astro_thetap
	astroparticle \(\theta'\).
ULong64_t	astro_time
	astroparticle time [ms].
TGraph *	src_cosconeangle
	source cone angle [rad].
string	src_name
	source name.
TGraph *	src_phip
	source \(\varphi'_{S}\).
SpecTime *	src_sp
	source SpecTime object (read-only).
TGraph *	src_thetap
	source \(\theta'_{S}\).
int	src_type
	source type, see Source::sourcetype.

Detailed Description

Read a source file sequence.

A source object, created with the Source class, can be saved in a sequence of root files (see Source). This class can be used to read the resulting source file sequence. The SourceRead object should be seen as a TChain object which can be used to browse the astro-particles generated with the source (using TChain::GetEntry()).

Author

Florent Robinet

Constructor & Destructor Documentation

SourceRead()

SourceRead::SourceRead	(	const string	aFilePattern,
		const string	aName
	)

SourceRead class constuctor.

The source sequence is extracted from the list of ROOT files given in argument.

Parameters

[in]	aFilePattern	ROOT file pattern where the source sequence is saved.
[in]	aName	Source name (sub-directories are supported).

~SourceRead()

SourceRead::~SourceRead ( void  )

virtual

SourceRead class destructor.

Member Function Documentation

GetAstroDeclinationDeg()

double SourceRead::GetAstroDeclinationDeg ( void  )

inline

Returns the astro-particle declination in [deg].

Use the TChain methods to navigate in the entries.

GetAstroEnergy()

double SourceRead::GetAstroEnergy ( void  )

inline

Returns the astro-particle energy [keV].

Use the TChain methods to navigate in the entries.

GetAstroPhip()

double SourceRead::GetAstroPhip ( void  )

inline

Returns the astro-particle \(\varphi'\) [rad].

Use the TChain methods to navigate in the entries.

GetAstroRightAscensionDeg()

double SourceRead::GetAstroRightAscensionDeg ( void  )

inline

Returns the astro-particle right-ascension in [deg].

Use the TChain methods to navigate in the entries.

GetAstroThetap()

double SourceRead::GetAstroThetap ( void  )

inline

Returns the astro-particle \(\theta'\) [rad].

Use the TChain methods to navigate in the entries.

GetAstroTime()

ULong64_t SourceRead::GetAstroTime ( void  )

inline

Returns the astro-particle time [ms].

Use the TChain methods to navigate in the entries.

GetCosConeAngle() [1/2]

double SourceRead::GetCosConeAngle ( const ULong64_t  aTime )

inline

Returns the source cone angle cosine at a given time.

Parameters

[in]

aTime

Time [ms].

GetCosConeAngle() [2/2]

TGraph * SourceRead::GetCosConeAngle ( void  )

inline

Returns the source cone angle cosine as a function of time.

GetDeclinationDeg()

double SourceRead::GetDeclinationDeg ( const ULong64_t  aTime )

inline

Returns the source declination in [deg] at a given time.

Parameters

[in]

aTime

Time [ms].

GetFlux()

TH2D * SourceRead::GetFlux ( void  )

inline

Returns the source flux.

GetLightCurve()

TH1D * SourceRead::GetLightCurve ( const double  aEnergyMin = 0.0, const double  aEnergyMax = -1.0  )

inline

Returns the source light curve between two energies.

See also

SpecTime::GetLightCurve().

Parameters

[in]	aEnergyMin	Minimum energy, \(E_{min}\), in \([\mathrm{keV}]\).
[in]	aEnergyMax	Maximum energy, \(E_{max}\), in \([\mathrm{keV}]\).

GetName()

string SourceRead::GetName ( void  )

inline

Returns the source name.

GetPhip() [1/2]

double SourceRead::GetPhip ( const ULong64_t  aTime )

inline

Returns the source position angle \(\varphi'\) [rad]$ at a given time.

Parameters

[in]

aTime

Time [ms].

GetPhip() [2/2]

TGraph * SourceRead::GetPhip ( void  )

inline

Returns the source position angle \(\varphi'\) [rad]$ as a function of time.

GetRate()

TH2D * SourceRead::GetRate ( void  )

inline

Returns the source rate.

GetRightAscensionDeg()

double SourceRead::GetRightAscensionDeg ( const ULong64_t  aTime )

inline

Returns the source right ascension in [deg] at a given time.

Parameters

[in]

aTime

Time [ms].

GetSpectrum()

TH1D * SourceRead::GetSpectrum ( const double  aTimeMin = 0.0, const double  aTimeMax = -1.0  )

inline

Returns the source energy spectrum between two times.

See also

SpecTime::GetSpectrum().

Parameters

[in]	aTimeMin	Minimum time, \(t_{min}\), in \([\mathrm{ms}]\).
[in]	aTimeMax	Maximum time, \(t_{max}\), in \([\mathrm{ms}]\).

GetThetap() [1/2]

double SourceRead::GetThetap ( const ULong64_t  aTime )

inline

Returns the source position angle \(\theta'\) [rad] at a given time.

Parameters

[in]

aTime

Time [ms].

GetThetap() [2/2]

TGraph * SourceRead::GetThetap ( void  )

inline

Returns the source position angle \(\theta'\) [rad] as a function of time.

GetTimeMax()

double SourceRead::GetTimeMax ( void  )

inline

Returns the source time end [ms].

GetTimeMin()

double SourceRead::GetTimeMin ( void  )

inline

Returns the source time start [ms].

GetType()

int SourceRead::GetType ( void  )

inline

Returns the source type (see Source::sourcetype).

Member Data Documentation

astro_energy

double SourceRead::astro_energy

private

astroparticle energy [keV].

astro_phip

double SourceRead::astro_phip

private

astroparticle phi prime.

astro_thetap

double SourceRead::astro_thetap

private

astroparticle \(\theta'\).

astro_time

ULong64_t SourceRead::astro_time

private

astroparticle time [ms].

src_cosconeangle

TGraph* SourceRead::src_cosconeangle

private

source cone angle [rad].

src_name

string SourceRead::src_name

private

source name.

src_phip

TGraph* SourceRead::src_phip

private

source \(\varphi'_{S}\).

src_sp

SpecTime* SourceRead::src_sp

private

source SpecTime object (read-only).

src_thetap

TGraph* SourceRead::src_thetap

private

source \(\theta'_{S}\).

src_type

int SourceRead::src_type

private

source type, see Source::sourcetype.

---

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

• src/Source/SourceRead.h
• src/Source/SourceRead.cc