musrfit 1.10.0
Public Member Functions | Private Attributes | List of all members
PMsrGlobalBlock Class Reference

#include <PMusr.h>

Public Member Functions

 PMsrGlobalBlock ()
 
virtual ~PMsrGlobalBlock ()
 
virtual Bool_t IsPresent ()
 
virtual Double_t GetRRFFreq (const char *unit)
 
virtual TString GetRRFUnit ()
 
virtual Int_t GetRRFUnitTag ()
 
virtual Double_t GetRRFPhase ()
 
virtual Int_t GetRRFPacking ()
 
virtual Int_t GetFitType ()
 
virtual Int_t GetDataRange (UInt_t idx)
 
virtual UInt_t GetT0BinSize ()
 
virtual Double_t GetT0Bin (UInt_t idx=0)
 
virtual UInt_t GetAddT0BinEntries ()
 
virtual Int_t GetAddT0BinSize (UInt_t addRunIdx)
 
virtual Double_t GetAddT0Bin (UInt_t addRunIdx, UInt_t histoIdx)
 
virtual Bool_t IsFitRangeInBin ()
 
virtual Double_t GetFitRange (UInt_t idx)
 
virtual Int_t GetFitRangeOffset (UInt_t idx)
 
virtual Int_t GetPacking ()
 
virtual Double_t GetEstimatedAlpha ()
 
virtual TString GetDeadTimeCorrection ()
 
virtual void SetGlobalPresent (Bool_t bval)
 
virtual void SetRRFFreq (Double_t freq, const char *unit)
 
virtual void SetRRFPhase (Double_t phase)
 
virtual void SetRRFPacking (Int_t pack)
 
virtual void SetFitType (Int_t ival)
 
virtual void SetDataRange (Int_t ival, Int_t idx)
 
virtual void SetT0Bin (Double_t dval, Int_t idx=-1)
 
virtual void SetAddT0Bin (Double_t dval, UInt_t addRunIdx, UInt_t histoNoIdx)
 
virtual void SetFitRangeInBins (Bool_t bval)
 
virtual void SetFitRange (Double_t dval, UInt_t idx)
 
virtual void SetFitRangeOffset (Int_t ival, UInt_t idx)
 
virtual void SetPacking (Int_t ival)
 
virtual void SetDeadTimeCorrection (TString str)
 

Private Attributes

Bool_t fGlobalPresent
 flag showing if a GLOBAL block is present at all.
 
Double_t fRRFFreq
 RRF frequency given in units of (MHz, Mc, T)
 
Int_t fRRFUnitTag
 RRF unit tag.
 
Double_t fRRFPhase
 RRF phase in (°)
 
Int_t fRRFPacking
 RRF packing.
 
Int_t fFitType
 fit type: 0=single histo fit, 1=single histo RRF fit, 2=asymmetry fit, 4=mu^- single histo fit, 8=non muSR fit
 
Int_t fDataRange [4]
 data bin range (fit type 0, 1, 2, 4)
 
PDoubleVector fT0
 t0 bins (fit type 0, 1, 2, 4). if fit type 0 -> f0, f1, f2, ...; if fit type 2, 4 -> f0, b0, f1, b1, ...
 
std::vector< PDoubleVector > fAddT0
 addt0 bins (fit type 0, 1, 2, 4). if fit type 0 -> f0, f1, f2, ...; if fit type 2, 4 -> f0, b0, f1, b1, ...
 
Bool_t fFitRangeInBins
 flag telling if fit range is given in time or in bins
 
Double_t fFitRange [2]
 fit range in (us)
 
Int_t fFitRangeOffset [2]
 if fit range is given in bins it can have the form fit fgb+n0 lgb-n1. This variable holds the n0 and n1.
 
Int_t fPacking
 packing/rebinning
 
Double_t fAlpha
 estimated alpha value from F/B counts
 
TString fDeadTimeCorrection
 tells if deadtime correction (pulsed sources) should be applied. Possible value: 'no' (default), 'file', 'estimate'
 

Detailed Description

Container for GLOBAL block information in MSR files.

The GLOBAL block defines settings that apply to all RUN blocks, including fit type, data ranges, time-zero bins, rotating reference frame (RRF) parameters, and packing. This block is optional - if absent, all settings must be specified individually in each RUN block.

Example use: When fitting multiple runs with identical experimental setup, the GLOBAL block avoids repetition by centralizing common parameters like RRF frequency, fit range, and t0 bins.

Definition at line 1037 of file PMusr.h.

Constructor & Destructor Documentation

◆ PMsrGlobalBlock()

PMsrGlobalBlock::PMsrGlobalBlock ( )

Constructor

Definition at line 804 of file PMusr.cpp.

References fDataRange, fFitRange, fFitRangeInBins, fFitRangeOffset, fFitType, fGlobalPresent, fPacking, fRRFFreq, fRRFPacking, fRRFPhase, fRRFUnitTag, PMUSR_UNDEFINED, RRF_FREQ_UNDEF, and RRF_UNIT_UNDEF.

◆ ~PMsrGlobalBlock()

virtual PMsrGlobalBlock::~PMsrGlobalBlock ( )
inlinevirtual

Definition at line 1040 of file PMusr.h.

Member Function Documentation

◆ GetAddT0Bin()

Double_t PMsrGlobalBlock::GetAddT0Bin ( UInt_t addRunIdx,
UInt_t histoIdx )
virtual

get add T0 of the addrun (index addRunIdx) at index histoIdx

return:

  • addt0 value, if indices are within proper boundaries
  • -1, otherwise
Parameters
addRunIdxindex of the addrun
histoIdxindex of the add backward histo number value

Definition at line 1070 of file PMusr.cpp.

References fAddT0.

◆ GetAddT0BinEntries()

virtual UInt_t PMsrGlobalBlock::GetAddT0BinEntries ( )
inlinevirtual

Definition at line 1052 of file PMusr.h.

References fAddT0.

◆ GetAddT0BinSize()

Int_t PMsrGlobalBlock::GetAddT0BinSize ( UInt_t addRunIdx)
virtual

get add T0 size of the addrun at index addRunIdx

return:

  • addt0 value, if idx is within proper boundaries
  • -1, otherwise
Parameters
addRunIdxindex of the addrun

Definition at line 1046 of file PMusr.cpp.

References fAddT0.

◆ GetDataRange()

Int_t PMsrGlobalBlock::GetDataRange ( UInt_t idx)
virtual

get data range at position idx

return:

  • data range value, if idx is within proper boundaries
  • -1, otherwise
Parameters
idxindex of the data range to be returned

Definition at line 964 of file PMusr.cpp.

References fDataRange.

◆ GetDeadTimeCorrection()

virtual TString PMsrGlobalBlock::GetDeadTimeCorrection ( )
inlinevirtual

Definition at line 1060 of file PMusr.h.

References fDeadTimeCorrection.

◆ GetEstimatedAlpha()

virtual Double_t PMsrGlobalBlock::GetEstimatedAlpha ( )
inlinevirtual

Definition at line 1059 of file PMusr.h.

References fAlpha.

◆ GetFitRange()

Double_t PMsrGlobalBlock::GetFitRange ( UInt_t idx)
virtual

get fit range value at position idx. idx: 0=fit range start, 1=fit range end.

return:

  • fit range value, if idx is within proper boundaries
  • PMUSR_UNDEFINED, otherwise
Parameters
idxindex of the fit range value to be returned

Definition at line 1120 of file PMusr.cpp.

References fFitRange, and PMUSR_UNDEFINED.

Referenced by PFitter::ExecuteSave(), PRunAsymmetry::GetProperFitRange(), PRunAsymmetryBNMR::GetProperFitRange(), PRunAsymmetryRRF::GetProperFitRange(), PRunMuMinus::GetProperFitRange(), PRunSingleHisto::GetProperFitRange(), PRunSingleHistoRRF::GetProperFitRange(), and PFitter::PFitter().

◆ GetFitRangeOffset()

Int_t PMsrGlobalBlock::GetFitRangeOffset ( UInt_t idx)
virtual

get fit range offset value at position idx. idx: 0=fit range offset start, 1=fit range offset end.

return:

  • fit range offset value, if idx is within proper boundaries
  • -1, otherwise
Parameters
idxindex of the fit range value to be returned

Definition at line 1157 of file PMusr.cpp.

References fFitRangeOffset.

Referenced by PRunAsymmetry::GetProperFitRange(), PRunAsymmetryBNMR::GetProperFitRange(), PRunAsymmetryRRF::GetProperFitRange(), PRunMuMinus::GetProperFitRange(), PRunSingleHisto::GetProperFitRange(), and PRunSingleHistoRRF::GetProperFitRange().

◆ GetFitType()

virtual Int_t PMsrGlobalBlock::GetFitType ( )
inlinevirtual

Definition at line 1048 of file PMusr.h.

References fFitType.

Referenced by PMusrCanvas::UpdateDataTheoryPad().

◆ GetPacking()

virtual Int_t PMsrGlobalBlock::GetPacking ( )
inlinevirtual

Definition at line 1058 of file PMusr.h.

References fPacking.

Referenced by main().

◆ GetRRFFreq()

Double_t PMsrGlobalBlock::GetRRFFreq ( const char * unit)
virtual

get RRF frequency value in specific units. If units is unknown, RRF_UNDEF_FREQ will be returned.

Parameters
unitunit string in which the units shall be given

Definition at line 831 of file PMusr.cpp.

References fRRFFreq, fRRFUnitTag, GAMMA_BAR_MUON, RRF_FREQ_UNDEF, RRF_UNIT_Mcs, RRF_UNIT_MHz, RRF_UNIT_T, and RRF_UNIT_UNDEF.

Referenced by PMsrHandler::HandleGlobalEntry(), PRunAsymmetryRRF::PrepareFitData(), PRunSingleHistoRRF::PrepareFitData(), and PRunAsymmetryRRF::PrepareViewData().

◆ GetRRFPacking()

virtual Int_t PMsrGlobalBlock::GetRRFPacking ( )
inlinevirtual

Definition at line 1047 of file PMusr.h.

References fRRFPacking.

Referenced by PRunSingleHistoRRF::PRunSingleHistoRRF().

◆ GetRRFPhase()

virtual Double_t PMsrGlobalBlock::GetRRFPhase ( )
inlinevirtual

Definition at line 1046 of file PMusr.h.

References fRRFPhase.

Referenced by PRunAsymmetryRRF::PrepareFitData(), PRunSingleHistoRRF::PrepareFitData(), and PRunAsymmetryRRF::PrepareViewData().

◆ GetRRFUnit()

TString PMsrGlobalBlock::GetRRFUnit ( )
virtual

returns RRF frequency unit.

Definition at line 903 of file PMusr.cpp.

References fRRFUnitTag, RRF_UNIT_G, RRF_UNIT_kHz, RRF_UNIT_Mcs, RRF_UNIT_MHz, RRF_UNIT_T, and RRF_UNIT_UNDEF.

Referenced by PRunSingleHistoRRF::PRunSingleHistoRRF().

◆ GetRRFUnitTag()

virtual Int_t PMsrGlobalBlock::GetRRFUnitTag ( )
inlinevirtual

Definition at line 1045 of file PMusr.h.

References fRRFUnitTag.

◆ GetT0Bin()

Double_t PMsrGlobalBlock::GetT0Bin ( UInt_t idx = 0)
virtual

get T0 bin at position idx

return:

  • T0 bin, if idx is within proper boundaries
  • -1, otherwise
Parameters
idxindex of the T0 bin to be returned

Definition at line 1004 of file PMusr.cpp.

References fT0.

Referenced by PRunAsymmetry::GetProperT0(), PRunAsymmetryBNMR::GetProperT0(), PRunAsymmetryRRF::GetProperT0(), PRunMuMinus::GetProperT0(), PRunSingleHisto::GetProperT0(), PRunSingleHistoRRF::GetProperT0(), and musrFT_groupHistos().

◆ GetT0BinSize()

virtual UInt_t PMsrGlobalBlock::GetT0BinSize ( )
inlinevirtual

Definition at line 1050 of file PMusr.h.

References fT0.

Referenced by PRunAsymmetry::GetProperT0(), PRunAsymmetryBNMR::GetProperT0(), PRunAsymmetryRRF::GetProperT0(), PRunMuMinus::GetProperT0(), PRunSingleHisto::GetProperT0(), PRunSingleHistoRRF::GetProperT0(), and musrFT_groupHistos().

◆ IsFitRangeInBin()

virtual Bool_t PMsrGlobalBlock::IsFitRangeInBin ( )
inlinevirtual

Definition at line 1055 of file PMusr.h.

References fFitRangeInBins.

Referenced by PRunAsymmetry::GetProperFitRange(), PRunAsymmetryBNMR::GetProperFitRange(), PRunAsymmetryRRF::GetProperFitRange(), PRunMuMinus::GetProperFitRange(), PRunSingleHisto::GetProperFitRange(), and PRunSingleHistoRRF::GetProperFitRange().

◆ IsPresent()

virtual Bool_t PMsrGlobalBlock::IsPresent ( )
inlinevirtual

Definition at line 1042 of file PMusr.h.

References fGlobalPresent.

Referenced by PRunSingleHistoRRF::PRunSingleHistoRRF().

◆ SetAddT0Bin()

void PMsrGlobalBlock::SetAddT0Bin ( Double_t dval,
UInt_t addRunIdx,
UInt_t histoNoIdx )
virtual

set add T0 bin of the addrun at index histoNoIdx

Parameters
ivalT0 bin
addRunIdxaddrun index
histoNoIdxindex whithin the fAddT0 vector where to set the value.

Definition at line 1097 of file PMusr.cpp.

References fAddT0.

Referenced by PMsrHandler::HandleGlobalEntry().

◆ SetDataRange()

void PMsrGlobalBlock::SetDataRange ( Int_t ival,
Int_t idx )
virtual

set data range element at position idx

Parameters
ivaldata range element
idxindex of the data range element to be set.

Definition at line 981 of file PMusr.cpp.

References fDataRange.

Referenced by PMsrHandler::HandleGlobalEntry().

◆ SetDeadTimeCorrection()

virtual void PMsrGlobalBlock::SetDeadTimeCorrection ( TString str)
inlinevirtual

Definition at line 1074 of file PMusr.h.

References fDeadTimeCorrection.

Referenced by PMsrHandler::HandleGlobalEntry().

◆ SetFitRange()

void PMsrGlobalBlock::SetFitRange ( Double_t dval,
UInt_t idx )
virtual

set fit range value at position idx

Parameters
dvalvalue to be set
idxindex of the fit range value to be set

Definition at line 1137 of file PMusr.cpp.

References fFitRange.

Referenced by PRunAsymmetry::GetProperFitRange(), PRunAsymmetryBNMR::GetProperFitRange(), PRunAsymmetryRRF::GetProperFitRange(), PRunMuMinus::GetProperFitRange(), PRunSingleHisto::GetProperFitRange(), PRunSingleHistoRRF::GetProperFitRange(), and PMsrHandler::HandleGlobalEntry().

◆ SetFitRangeInBins()

virtual void PMsrGlobalBlock::SetFitRangeInBins ( Bool_t bval)
inlinevirtual

Definition at line 1070 of file PMusr.h.

References fFitRangeInBins.

Referenced by PMsrHandler::HandleGlobalEntry().

◆ SetFitRangeOffset()

void PMsrGlobalBlock::SetFitRangeOffset ( Int_t ival,
UInt_t idx )
virtual

set fit range offset value at position idx. Illegale values will be ignored.

Parameters
ivalvalue to be set
idxindex of the fit range value to be set

Definition at line 1174 of file PMusr.cpp.

References fFitRangeOffset.

Referenced by PMsrHandler::HandleGlobalEntry().

◆ SetFitType()

virtual void PMsrGlobalBlock::SetFitType ( Int_t ival)
inlinevirtual

Definition at line 1066 of file PMusr.h.

References fFitType.

Referenced by PMsrHandler::HandleGlobalEntry().

◆ SetGlobalPresent()

virtual void PMsrGlobalBlock::SetGlobalPresent ( Bool_t bval)
inlinevirtual

Definition at line 1062 of file PMusr.h.

References fGlobalPresent.

Referenced by PMsrHandler::HandleGlobalEntry().

◆ SetPacking()

virtual void PMsrGlobalBlock::SetPacking ( Int_t ival)
inlinevirtual

Definition at line 1073 of file PMusr.h.

References fPacking.

Referenced by PMsrHandler::HandleGlobalEntry().

◆ SetRRFFreq()

void PMsrGlobalBlock::SetRRFFreq ( Double_t freq,
const char * unit )
virtual

set RRF frequency value in specific units. If units is unknown, 0.0 will be set.

Parameters
RRFfrequency value
unitunit string in which the units shall be given

Definition at line 875 of file PMusr.cpp.

References fRRFFreq, fRRFUnitTag, RRF_UNIT_Mcs, RRF_UNIT_MHz, RRF_UNIT_T, and RRF_UNIT_UNDEF.

Referenced by PMsrHandler::HandleGlobalEntry().

◆ SetRRFPacking()

void PMsrGlobalBlock::SetRRFPacking ( Int_t pack)
virtual

set RRF packing.

Parameters
RRFpacking

Definition at line 942 of file PMusr.cpp.

References fRRFPacking.

Referenced by PMsrHandler::HandleGlobalEntry().

◆ SetRRFPhase()

virtual void PMsrGlobalBlock::SetRRFPhase ( Double_t phase)
inlinevirtual

Definition at line 1064 of file PMusr.h.

References fRRFPhase.

Referenced by PMsrHandler::HandleGlobalEntry().

◆ SetT0Bin()

void PMsrGlobalBlock::SetT0Bin ( Double_t dval,
Int_t idx = -1 )
virtual

set T0 bin at position idx

Parameters
ivalT0 bin
idxindex of the T0 bin to be set. If idx==-1, append value

Definition at line 1021 of file PMusr.cpp.

References fT0.

Referenced by PMsrHandler::HandleGlobalEntry().

Member Data Documentation

◆ fAddT0

std::vector<PDoubleVector> PMsrGlobalBlock::fAddT0
private

addt0 bins (fit type 0, 1, 2, 4). if fit type 0 -> f0, f1, f2, ...; if fit type 2, 4 -> f0, b0, f1, b1, ...

Definition at line 1085 of file PMusr.h.

Referenced by GetAddT0Bin(), GetAddT0BinEntries(), GetAddT0BinSize(), and SetAddT0Bin().

◆ fAlpha

Double_t PMsrGlobalBlock::fAlpha
private

estimated alpha value from F/B counts

Definition at line 1090 of file PMusr.h.

Referenced by GetEstimatedAlpha().

◆ fDataRange

Int_t PMsrGlobalBlock::fDataRange[4]
private

data bin range (fit type 0, 1, 2, 4)

Definition at line 1083 of file PMusr.h.

Referenced by GetDataRange(), PMsrGlobalBlock(), and SetDataRange().

◆ fDeadTimeCorrection

TString PMsrGlobalBlock::fDeadTimeCorrection
private

tells if deadtime correction (pulsed sources) should be applied. Possible value: 'no' (default), 'file', 'estimate'

Definition at line 1091 of file PMusr.h.

Referenced by GetDeadTimeCorrection(), and SetDeadTimeCorrection().

◆ fFitRange

Double_t PMsrGlobalBlock::fFitRange[2]
private

fit range in (us)

Definition at line 1087 of file PMusr.h.

Referenced by GetFitRange(), PMsrGlobalBlock(), and SetFitRange().

◆ fFitRangeInBins

Bool_t PMsrGlobalBlock::fFitRangeInBins
private

flag telling if fit range is given in time or in bins

Definition at line 1086 of file PMusr.h.

Referenced by IsFitRangeInBin(), PMsrGlobalBlock(), and SetFitRangeInBins().

◆ fFitRangeOffset

Int_t PMsrGlobalBlock::fFitRangeOffset[2]
private

if fit range is given in bins it can have the form fit fgb+n0 lgb-n1. This variable holds the n0 and n1.

Definition at line 1088 of file PMusr.h.

Referenced by GetFitRangeOffset(), PMsrGlobalBlock(), and SetFitRangeOffset().

◆ fFitType

Int_t PMsrGlobalBlock::fFitType
private

fit type: 0=single histo fit, 1=single histo RRF fit, 2=asymmetry fit, 4=mu^- single histo fit, 8=non muSR fit

Definition at line 1082 of file PMusr.h.

Referenced by GetFitType(), PMsrGlobalBlock(), and SetFitType().

◆ fGlobalPresent

Bool_t PMsrGlobalBlock::fGlobalPresent
private

flag showing if a GLOBAL block is present at all.

Definition at line 1077 of file PMusr.h.

Referenced by IsPresent(), PMsrGlobalBlock(), and SetGlobalPresent().

◆ fPacking

Int_t PMsrGlobalBlock::fPacking
private

packing/rebinning

Definition at line 1089 of file PMusr.h.

Referenced by GetPacking(), PMsrGlobalBlock(), and SetPacking().

◆ fRRFFreq

Double_t PMsrGlobalBlock::fRRFFreq
private

RRF frequency given in units of (MHz, Mc, T)

Definition at line 1078 of file PMusr.h.

Referenced by GetRRFFreq(), PMsrGlobalBlock(), and SetRRFFreq().

◆ fRRFPacking

Int_t PMsrGlobalBlock::fRRFPacking
private

RRF packing.

Definition at line 1081 of file PMusr.h.

Referenced by GetRRFPacking(), PMsrGlobalBlock(), and SetRRFPacking().

◆ fRRFPhase

Double_t PMsrGlobalBlock::fRRFPhase
private

RRF phase in (°)

Definition at line 1080 of file PMusr.h.

Referenced by GetRRFPhase(), PMsrGlobalBlock(), and SetRRFPhase().

◆ fRRFUnitTag

Int_t PMsrGlobalBlock::fRRFUnitTag
private

RRF unit tag.

Definition at line 1079 of file PMusr.h.

Referenced by GetRRFFreq(), GetRRFUnit(), GetRRFUnitTag(), PMsrGlobalBlock(), and SetRRFFreq().

◆ fT0

PDoubleVector PMsrGlobalBlock::fT0
private

t0 bins (fit type 0, 1, 2, 4). if fit type 0 -> f0, f1, f2, ...; if fit type 2, 4 -> f0, b0, f1, b1, ...

Definition at line 1084 of file PMusr.h.

Referenced by GetT0Bin(), GetT0BinSize(), and SetT0Bin().

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