MuSR_td_PSI_bin Class Reference

List of all members.

Public Member Functions
	MuSR_td_PSI_bin ()
	Simple Constructor setting some pointers and variables.
	~MuSR_td_PSI_bin ()
	Simple Destructor clearing some pointers and variables.
int	read (const char *fileName)
	Method to read a PSI-bin or an MDU file.
int	readbin (const char *fileName)
	Method to read a PSI-bin file.
int	readmdu (const char *fileName)
	Method to read a MuSR MDU file.
bool	readingOK () const
	Method to obtain if reading and processing of the data file was OK.
string	ReadStatus () const
	Method to obtain error/success information after reading.
string	Filename () const
	Method to obtain the file name.
int	Show () const
	Method to show current values of member variables.
int	Clear ()
	Method to clear member variables before using instance for next read.
int	get_histo_int (int histo_num, int j)
	Method to return the value of a single bin as integer.
double	get_histo (int histo_num, int j)
	Method to return the value of a single bin as double.
int *	get_histo_array_int (int histo_num)
	Method to obtain an array of type integer containing the values of the histogram <histo_num>.
double *	get_histo_array (int histo_num, int binning)
	Method to obtain an array of type double containing the values of the histogram <histo_num> with binning <binning>.
vector< double >	get_histo_vector (int histo_num, int binning)
	Method to obtain a vector of double containing the values of the histogram <histo_num> with binning <binning>.
vector< double >	get_histo_vector_no0 (int histo_num, int binning)
	Method to obtain a vector of double containing the values of the histogram <histo_num> with binning <binning> but where the bins with zero counts are replaced by a count 0.1.
double *	get_histo_fromt0_array (int histo_num, int binning, int offset=0)
	Method to obtain an array of type double containing the values of the histogram <histo_num> with binning <binning> from the point t0. An <offset> can also be specified (otherwise = 0).
vector< double >	get_histo_fromt0_vector (int histo_num, int binning, int offset=0)
	Method to obtain a vector of double containing the values of the histogram <histo_num> with binning <binning> from the point t0. An <offset> can also be specified (otherwise = 0).
double *	get_histo_goodBins_array (int histo_num, int binning)
	Method to obtain an array of type double containing the values of the histogram <histo_num> with binning <binning> from the point first_good until last_good.
vector< double >	get_histo_goodBins_vector (int histo_num, int binning)
	Method to obtain a vector of double containing the values of the histogram <histo_num> with binning <binning> from the point first_good until last_good.
double *	get_histo_fromt0_minus_bckgrd_array (int histo_num, int lower_bckgdr, int higher_bckgdr, int binning, int offset=0)
	Method to obtain an array of type double containing the values of the histogram <histo_num> with binning <binning> from the point t0. A background calculated from the points <lower_bckgrd> and <higher_bckgrd> is subtracted. An <offset> can also be specified (otherwise = 0.
vector< double >	get_histo_fromt0_minus_bckgrd_vector (int histo_num, int lower_bckgdr, int higher_bckgdr, int binning, int offset=0)
	Method to obtain a vector of double containing the values of the histogram <histo_num> with binning <binning> from the point t0. A background calculated from the points <lower_bckgrd> and <higher_bckgrd> is subtracted. An <offset> can also be specified (otherwise = 0).
double *	get_histo_goodBins_minus_bckgrd_array (int histo_num, int lower_bckgrd, int higher_bckgrd, int binning)
	Method to obtain an array of type double containing the values of the histogram <histo_num> with binning <binning> from the point first_good until the point last_good. A background calculated from the points <lower_bckgrd> and <higher_bckgrd> is subtracted.
vector< double >	get_histo_goodBins_minus_bckgrd_vector (int histo_num, int lower_bckgrd, int higher_bckgrd, int binning)
	Method to obtain a vector of double containing the values of the histogram <histo_num> with binning <binning> from the point first_good until the point last_good. A background calculated from the points <lower_bckgrd> and <higher_bckgrd> is subtracted.
double *	get_asymmetry_array (int histo_num_plus, int histo_num_minus, double alpha_param, int binning, int lower_bckgrd_plus, int higher_bckgrd_plus, int lower_bckgrd_minus, int higher_bckgrd_minus, int offset=0, double y_offset=0.)
	Method to obtain an array of double containing the values of the asymmetry between 2 histograms.
vector< double >	get_asymmetry_vector (int histo_num_plus, int histo_num_minus, double alpha_param, int binning, int lower_bckgrd_plus, int higher_bckgrd_plus, int lower_bckgrd_minus, int higher_bckgrd_minus, int offset=0, double y_offset=0.)
	Method to obtain a vector of double containing the values of the asymmetry between 2 histograms.
double *	get_error_asymmetry_array (int histo_num_plus, int histo_num_minus, double alpha_param, int binning, int lower_bckgrd_plus, int higher_bckgrd_plus, int lower_bckgrd_minus, int higher_bckgrd_minus, int offset=0)
	Method to obtain an array of double containing the values of the error of the asymmetry between 2 histograms.
vector< double >	get_error_asymmetry_vector (int histo_num_plus, int histo_num_minus, double alpha_param, int binning, int lower_bckgrd_plus, int higher_bckgrd_plus, int lower_bckgrd_minus, int higher_bckgrd_minus, int offset=0)
	Method to obtain a vector of double containing the values of the error of the asymmetry between 2 histograms.
double *	get_asymmetry_goodBins_array (int histo_num_plus, int histo_num_minus, double alpha_param, int binning, int lower_bckgrd_plus, int higher_bckgrd_plus, int lower_bckgrd_minus, int higher_bckgrd_minus)
	Method to obtain an array of double containing the values of the asymmetry between 2 histograms.
vector< double >	get_asymmetry_goodBins_vector (int histo_num_plus, int histo_num_minus, double alpha_param, int binning, int lower_bckgrd_plus, int higher_bckgrd_plus, int lower_bckgrd_minus, int higher_bckgrd_minus)
	Method to obtain a vector of double containing the values of the asymmetry between 2 histograms.
double *	get_error_asymmetry_goodBins_array (int histo_num_plus, int histo_num_minus, double alpha_param, int binning, int lower_bckgrd_plus, int higher_bckgrd_plus, int lower_bckgrd_minus, int higher_bckgrd_minus)
	Method to obtain an array of double containing the values of the error of the asymmetry between 2 histograms.
vector< double >	get_error_asymmetry_goodBins_vector (int histo_num_plus, int histo_num_minus, double alpha_param, int binning, int lower_bckgrd_plus, int higher_bckgrd_plus, int lower_bckgrd_minus, int higher_bckgrd_minus)
	Method to obtain a vector of double containing the values of the error of the asymmetry between 2 histograms.
double	get_binWidth_ps ()
	Method returning a double representing the bin-width in picoseconds.
double	get_binWidth_ns ()
	Method returning a double representing the bin-width in nanoseconds.
double	get_binWidth_us ()
	Method returning a double representing the bin-width in microseconds.
int	get_histoLength_bin ()
	Method returning an integer representing the histogram length in bins.
int	get_numberHisto_int ()
	Method returning an integer representing the number of histograms.
string	get_nameHisto (int i)
	Method returning a string containing the name of the histogram <i>.
vector< string >	get_histoNames_vector ()
	Method returning a vector of strings containing the names of the histograms.
long	get_eventsHisto_long (int i)
	Method returning a long representing the number of events in a specified histograms.
vector< long >	get_eventsHisto_vector ()
	Method returning a vector of long containing the number of events in the histograms.
long	get_totalEvents_long ()
	Method returning a long representing the total number of events.
int	get_numberScaler_int ()
	Method returning an integer representing the number of histograms.
vector< long >	get_scalers_vector ()
	Method providing a vector of long containing the values of the scalers.
vector< string >	get_scalersNames_vector ()
	Method returning a vector of strings containing the names of the scalers.
int	get_default_binning ()
	Method returning an integer representing the default binning.
int	get_t0_int (int i)
	Method returning an integer representing the t0 point (from the "integer" t0 in the header) for a specified histogram.
vector< int >	get_t0_vector ()
	Method returning a vector of integer containing the t0 values of the histograms specified in the header.
double	get_t0_double (int i)
	Method returning a double representing the t0 point (from the "real" t0 in the header) for a specified histogram.
int	get_max_t0_int ()
	Method to determine the maximum value of the t0 bins.
int	get_max_2_t0_int (int k, int j)
	Method to determine the maximum value of the last good bins of 2 histograms.
int	get_min_t0_int ()
	Method to determine the minimum value of the t0 bins.
int	get_min_2_t0_int (int k, int j)
	Method to determine the minimum value of the last good bins of 2 histograms.
int	get_firstGood_int (int i)
	Method returning an integer representing the first good bin specified in the header for a specified histogram.
vector< int >	get_firstGood_vector ()
	Method returning a vector of integer containing the first good bin values of the histograms specified in the header.
int	put_firstGood_int (int i, int j)
	Method to modify the first good bin (value <j>) of the histogram <i>.
int	get_lastGood_int (int i)
	Method returning an integer representing the last good bin specified in the header for a specified histogram.
vector< int >	get_lastGood_vector ()
	Method returning a vector of integer containing the last good bin values of the histograms specified in the header.
int	put_lastGood_int (int i, int j)
	Method to modify the last good bin (value <j>) of the histogram <i>.
int	get_max_lastGood_int ()
	Method returning an integer containing the maximum value of the "last good bins" of all histograms.
int	get_max_2_lastGood_int (int k, int j)
	Method to determine the maximum value of the "last good bins" of 2 histograms.
int	get_min_lastGood_int ()
	Method providing the minimum value of the last good bins.
int	get_min_2_lastGood_int (int k, int j)
	Method to determine the minimum value of the last good bins of 2 histograms.
int	get_runNumber_int ()
	Method returning an integer containing the run number.
int	put_runNumber_int (int i)
	Method to modify the run number (value <i>).
string	get_sample ()
	Method returning a string containing the sample name.
string	get_field ()
	Method returning a string containing the field specified in the title.
string	get_orient ()
	Method returning a string containing the orientation specified in the title.
string	get_temp ()
	Method returning a string containing the temperature specified in the title.
string	get_comment ()
	Method returning a string containing the comment specified in the title.
vector< string >	get_timeStart_vector ()
	Method returning a vector of strings containing 1) the date when the run was started and 2) the time when the run was started.
vector< string >	get_timeStop_vector ()
	Method returning a vector of strings containing 1) the date when the run was stopped and 2) the time when the run was stopped.
int	get_numberTemperature_int ()
	Method returning an integer representing the number of temperatures.
vector< double >	get_temperatures_vector ()
	Method returning a vector of doubles containing monitored values (usually temperatures).
vector< double >	get_devTemperatures_vector ()
	Method returning a vector of doubles containing standard deviations of the monitored values (usually temperatures).
Public Attributes
vector< vector< double > >	histos_vector

Detailed Description

Examples:: main.cpp.

Definition at line 50 of file MuSR_td_PSI_bin.h.

Member Function Documentation

string MuSR_td_PSI_bin::Filename ( ) const

Method to obtain the file name.

This method gives back:

<filename>

Examples:: main.cpp.

Definition at line 1467 of file MuSR_td_PSI_bin.cpp.

double * MuSR_td_PSI_bin::get_asymmetry_array	(	int	histo_num_plus,
		int	histo_num_minus,
		double	alpha_param,
		int	binning,
		int	lower_bckgrd_plus,
		int	higher_bckgrd_plus,
		int	lower_bckgrd_minus,
		int	higher_bckgrd_minus,
		int	offset = `0`,
		double	y_offset = `0.`
	)

Method to obtain an array of double containing the values of the asymmetry between 2 histograms.

The asymmetry is calculated between the histograms <histo_num_plus> and <histo_num_minus> with an alpha parameter <alpha_param>. This method requires also a binning value <binning>, as well as the background limits for both histograms. An <offset> value from t_0 can also be specified (otherwise = 0). Also an <y_offset> can be given to shift artificially the curve on the y-axis (otherwise = 0).

This method gives back:

a array of double
the NULL pointer if one provides
- an invalid histogram number
- a binning smaller than 1
- invalid background limits
- allocate failed

The first parameters of the method are the integers <histo_num_plus> and <histo_num_minus>, as well as the double <alpha_param>. Integers for the binning and for the background limits for both histograms.are also required.

Definition at line 2079 of file MuSR_td_PSI_bin.cpp.

double * MuSR_td_PSI_bin::get_asymmetry_goodBins_array	(	int	histo_num_plus,
		int	histo_num_minus,
		double	alpha_param,
		int	binning,
		int	lower_bckgrd_plus,
		int	higher_bckgrd_plus,
		int	lower_bckgrd_minus,
		int	higher_bckgrd_minus
	)

Method to obtain an array of double containing the values of the asymmetry between 2 histograms.

The array has a size corresponding to the minimum interval between first_good and last_good. It begins at the first_good coming at the latest after the corresponding t_0. The asymmetry is calculated between the histograms <histo_num_plus> and <histo_num_minus> with an alpha parameter <alpha_param>. This method requires also a binning value <binning>, as well as the background limits for both histograms.

This method gives back:

a array of double
the NULL pointer if one provides
- an invalid histogram number
- a binning smaller than 1
- invalid background limits
  - allocate failed

The first parameters of the method are the integers <histo_num_plus> and <histo_num_minus>, as well as the double <alpha_param>. Integers for the binning and for the background limits for both histograms.are also required.

Definition at line 2373 of file MuSR_td_PSI_bin.cpp.

vector< double > MuSR_td_PSI_bin::get_asymmetry_goodBins_vector	(	int	histo_num_plus,
		int	histo_num_minus,
		double	alpha_param,
		int	binning,
		int	lower_bckgrd_plus,
		int	higher_bckgrd_plus,
		int	lower_bckgrd_minus,
		int	higher_bckgrd_minus
	)

Method to obtain a vector of double containing the values of the asymmetry between 2 histograms.

The vector has a size corresponding to the minimum interval between first_good and last_good. It begins at the first_good coming at the latest after the corresponding t_0. The asymmetry is calculated between the histograms <histo_num_plus> and <histo_num_minus> with an alpha parameter <alpha_param>. This method requires also a binning value <binning>, as well as the background limits for both histograms.

This method gives back:

a vector of double
an empty vector of double if one provides
- an invalid histogram number
- a binning smaller than 1
- invalid background limits

The first parameters of the method are the integers <histo_num_plus> and <histo_num_minus>, as well as the double <alpha_param>. Integers for the binning and for the background limits for both histograms.are also required.

Definition at line 2447 of file MuSR_td_PSI_bin.cpp.

vector< double > MuSR_td_PSI_bin::get_asymmetry_vector	(	int	histo_num_plus,
		int	histo_num_minus,
		double	alpha_param,
		int	binning,
		int	lower_bckgrd_plus,
		int	higher_bckgrd_plus,
		int	lower_bckgrd_minus,
		int	higher_bckgrd_minus,
		int	offset = `0`,
		double	y_offset = `0.`
	)

Method to obtain a vector of double containing the values of the asymmetry between 2 histograms.

The asymmetry is calculated between the histograms <histo_num_plus> and <histo_num_minus> with an alpha parameter <alpha_param>. This method requires also a binning value <binning>, as well as the background limits for both histograms. An <offset> value from t_0 can also be specified (otherwise = 0). Also an <y_offset> can be given to shift artificially the curve on the y-axis (otherwise = 0).

This method gives back:

a vector of double
an empty vector of double if one provides
- an invalid histogram number
- a binning smaller than 1
- invalid background limits

The first parameters of the method are the integers <histo_num_plus> and <histo_num_minus>, as well as the double <alpha_param>. Integers for the binning and for the background limits for both histograms.are also required.

Definition at line 2152 of file MuSR_td_PSI_bin.cpp.

int MuSR_td_PSI_bin::get_default_binning ( )

Method returning an integer representing the default binning.

Definition at line 2915 of file MuSR_td_PSI_bin.cpp.

double * MuSR_td_PSI_bin::get_error_asymmetry_array	(	int	histo_num_plus,
		int	histo_num_minus,
		double	alpha_param,
		int	binning,
		int	lower_bckgrd_plus,
		int	higher_bckgrd_plus,
		int	lower_bckgrd_minus,
		int	higher_bckgrd_minus,
		int	offset = `0`
	)

Method to obtain an array of double containing the values of the error of the asymmetry between 2 histograms.

The error of the asymmetry is calculated with the histograms <histo_num_plus> and <histo_num_minus> with an alpha parameter <alpha_param>. This method requires also a binning value <binning>, as well as the background limits for both histograms. An <offset> value from t_0 can also be specified (otherwise = 0)

This method gives back:

a array of double
the NULL pointer if one provides
- an invalid histogram number
- a binning smaller than 1
- invalid background limits
  - allocate failed

The first parameters of the method are the integers <histo_num_plus> and <histo_num_minus>, as well as the double <alpha_param>. Integers for the binning and for the background limits for both histograms.are also required.

Definition at line 2224 of file MuSR_td_PSI_bin.cpp.

double * MuSR_td_PSI_bin::get_error_asymmetry_goodBins_array	(	int	histo_num_plus,
		int	histo_num_minus,
		double	alpha_param,
		int	binning,
		int	lower_bckgrd_plus,
		int	higher_bckgrd_plus,
		int	lower_bckgrd_minus,
		int	higher_bckgrd_minus
	)

Method to obtain an array of double containing the values of the error of the asymmetry between 2 histograms.

The size is calculated as the asymmetry array. The error of the asymmetry is calculated with the histograms <histo_num_plus> and <histo_num_minus> with an alpha parameter <alpha_param>. This method requires also a binning value <binning>, as well as the background limits for both histograms.

This method gives back:

a array of double
the NULL pointer if one provides
- an invalid histogram number
- a binning smaller than 1
- invalid background limits
- allocate failed

The first parameters of the method are the integers <histo_num_plus> and <histo_num_minus>, as well as the double <alpha_param>. Integers for the binning and for the background limits for both histograms are also required.

Definition at line 2521 of file MuSR_td_PSI_bin.cpp.

vector< double > MuSR_td_PSI_bin::get_error_asymmetry_goodBins_vector	(	int	histo_num_plus,
		int	histo_num_minus,
		double	alpha_param,
		int	binning,
		int	lower_bckgrd_plus,
		int	higher_bckgrd_plus,
		int	lower_bckgrd_minus,
		int	higher_bckgrd_minus
	)

Method to obtain a vector of double containing the values of the error of the asymmetry between 2 histograms.

The size is calculated as the asymmetry array. The error of the asymmetry is calculated with the histograms <histo_num_plus> and <histo_num_minus> with an alpha parameter <alpha_param>. This method requires also a binning value <binning>, as well as the background limits for both histograms.

This method gives back:

a vector of double
an empty vector of double if one provides
- an invalid histogram number
- a binning smaller than 1
- invalid background limits

The first parameters of the method are the integers <histo_num_plus> and <histo_num_minus>, as well as the double <alpha_param>. Integers for the binning and for the background limits for both histograms.are also required.

Definition at line 2605 of file MuSR_td_PSI_bin.cpp.

vector< double > MuSR_td_PSI_bin::get_error_asymmetry_vector	(	int	histo_num_plus,
		int	histo_num_minus,
		double	alpha_param,
		int	binning,
		int	lower_bckgrd_plus,
		int	higher_bckgrd_plus,
		int	lower_bckgrd_minus,
		int	higher_bckgrd_minus,
		int	offset = `0`
	)

Method to obtain a vector of double containing the values of the error of the asymmetry between 2 histograms.

The error of the asymmetry is calculated with the histograms <histo_num_plus> and <histo_num_minus> with an alpha parameter <alpha_param>. This method requires also a binning value <binning>, as well as the background limits for both histograms. An <offset> value from t_0 can also be specified (otherwise = 0)

This method gives back:

a vector of double
an empty vector of double if one provides
- an invalid histogram number
- a binning smaller than 1
- invalid background limits

The first parameters of the method are the integers <histo_num_plus> and <histo_num_minus>, as well as the double <alpha_param>. Integers for the binning and for the background limits for both histograms.are also required.

Definition at line 2297 of file MuSR_td_PSI_bin.cpp.

long MuSR_td_PSI_bin::get_eventsHisto_long ( int i )

Method returning a long representing the number of events in a specified histograms.

A value of -1 is returned if the value of the histogram specified is invalid.

Definition at line 2865 of file MuSR_td_PSI_bin.cpp.

int MuSR_td_PSI_bin::get_firstGood_int ( int i )

Method returning an integer representing the first good bin specified in the header for a specified histogram.

A value of -1 is returned if the value of the histogram specified is invalid.

Examples:: main.cpp.

Definition at line 2967 of file MuSR_td_PSI_bin.cpp.

double MuSR_td_PSI_bin::get_histo	(	int	histo_num,
		int	j
	)

Method to return the value of a single bin as double.

This method gives back:

bin value as double
0 if an invalid histogram number or bin is choosen

Examples:: main.cpp.

Definition at line 1503 of file MuSR_td_PSI_bin.cpp.

double * MuSR_td_PSI_bin::get_histo_array	(	int	histo_num,
		int	binning
	)

Method to obtain an array of type double containing the values of the histogram <histo_num> with binning <binning>.

This method gives back:

an pointer of a double array
the NULL pointer if an invalid histogram number or binning is choosen or allocation failed

The parameters of the method are the integers <histo_num> and <binning> representing the desired histogram number and binning.

Definition at line 1531 of file MuSR_td_PSI_bin.cpp.

int * MuSR_td_PSI_bin::get_histo_array_int ( int histo_num )

Method to obtain an array of type integer containing the values of the histogram <histo_num>.

This method gives back:

an pointer of an integer array
the NULL pointer if an invalid histogram number is choosen or allocate failed

The parameter of the method is the integer <histo_num> representing the desired histogram number.

Examples:: main.cpp.

Definition at line 1648 of file MuSR_td_PSI_bin.cpp.

double * MuSR_td_PSI_bin::get_histo_fromt0_array	(	int	histo_num,
		int	binning,
		int	offset = `0`
	)

Method to obtain an array of type double containing the values of the histogram <histo_num> with binning <binning> from the point t0. An <offset> can also be specified (otherwise = 0).

This method gives back:

a pointer of a double array
the NULL pointer if an invalid histogram number or binning is choosen or allocation failed

The parameters of the method are the integers <histo_num> and <binning> representing the desired histogram number and binning.

Definition at line 1685 of file MuSR_td_PSI_bin.cpp.

double * MuSR_td_PSI_bin::get_histo_fromt0_minus_bckgrd_array	(	int	histo_num,
		int	lower_bckgrd,
		int	higher_bckgrd,
		int	binning,
		int	offset = `0`
	)

Method to obtain an array of type double containing the values of the histogram <histo_num> with binning <binning> from the point t0. A background calculated from the points <lower_bckgrd> and <higher_bckgrd> is subtracted. An <offset> can also be specified (otherwise = 0.

This method gives back:

a pointer of a double array
the NULL pointer if one provides
- an invalid histogram number
- a binning smaller than 1
- invalid background limits
- allocate failed

The first parameters of the method are the integers <histo_num> and <binning> representing the desired histogram number and binning. Also the parameters <lower_bckgrd> and <higher_bckgrd> define the limits between which the background is calculated.

Definition at line 1849 of file MuSR_td_PSI_bin.cpp.

vector< double > MuSR_td_PSI_bin::get_histo_fromt0_minus_bckgrd_vector	(	int	histo_num,
		int	lower_bckgrd,
		int	higher_bckgrd,
		int	binning,
		int	offset = `0`
	)

Method to obtain a vector of double containing the values of the histogram <histo_num> with binning <binning> from the point t0. A background calculated from the points <lower_bckgrd> and <higher_bckgrd> is subtracted. An <offset> can also be specified (otherwise = 0).

This method gives back:

a vector of double
an empty vector of double if one provides
- an invalid histogram number
- a binning smaller than 1
- invalid background limits

The first parameters of the method are the integers <histo_num> and <binning> representing the desired histogram number and binning. Also the parameters <lower_bckgrd> and <higher_bckgrd> define the limits between which the background is calculated.

Examples:: main.cpp.

Definition at line 1906 of file MuSR_td_PSI_bin.cpp.

vector< double > MuSR_td_PSI_bin::get_histo_fromt0_vector	(	int	histo_num,
		int	binning,
		int	offset = `0`
	)

Method to obtain a vector of double containing the values of the histogram <histo_num> with binning <binning> from the point t0. An <offset> can also be specified (otherwise = 0).

This method gives back:

a vector of double
an empty vector of double if an invalid histogram number or binning is choosen

The parameters of the method are the integers <histo_num> and <binning> representing the desired histogram number and binning.

Definition at line 1725 of file MuSR_td_PSI_bin.cpp.

double * MuSR_td_PSI_bin::get_histo_goodBins_array	(	int	histo_num,
		int	binning
	)

Method to obtain an array of type double containing the values of the histogram <histo_num> with binning <binning> from the point first_good until last_good.

This method gives back:

an pointer of a double array
the NULL pointer if an invalid histogram number or binning is choosen or allocate failed The parameters of the method are the integers <histo_num> and <binning> representing the desired histogram number and binning.

Definition at line 1764 of file MuSR_td_PSI_bin.cpp.

double * MuSR_td_PSI_bin::get_histo_goodBins_minus_bckgrd_array	(	int	histo_num,
		int	lower_bckgrd,
		int	higher_bckgrd,
		int	binning
	)

Method to obtain an array of type double containing the values of the histogram <histo_num> with binning <binning> from the point first_good until the point last_good. A background calculated from the points <lower_bckgrd> and <higher_bckgrd> is subtracted.

This method gives back:

a pointer of a double array
the NULL pointer if one provides
- an invalid histogram number
- a binning smaller than 1
- invalid background limits
  - allocate failed

The first parameters of the method are the integers <histo_num> and <binning> representing the desired histogram number and binning. Also the parameters <lower_bckgrd> and <higher_bckgrd> define the limits between which the background is calculated.

Definition at line 1963 of file MuSR_td_PSI_bin.cpp.

vector< double > MuSR_td_PSI_bin::get_histo_goodBins_minus_bckgrd_vector	(	int	histo_num,
		int	lower_bckgrd,
		int	higher_bckgrd,
		int	binning
	)

Method to obtain a vector of double containing the values of the histogram <histo_num> with binning <binning> from the point first_good until the point last_good. A background calculated from the points <lower_bckgrd> and <higher_bckgrd> is subtracted.

This method gives back:

a vector of double
an empty vector of double if one provides
- an invalid histogram number
- a binning smaller than 1
- invalid background limits

The first parameters of the method are the integers <histo_num> and <binning> representing the desired histogram number and binning. Also the parameters <lower_bckgrd> and <higher_bckgrd> define the limits between which the background is calculated.

Examples:: main.cpp.

Definition at line 2020 of file MuSR_td_PSI_bin.cpp.

vector< double > MuSR_td_PSI_bin::get_histo_goodBins_vector	(	int	histo_num,
		int	binning
	)

Method to obtain a vector of double containing the values of the histogram <histo_num> with binning <binning> from the point first_good until last_good.

This method gives back:

a vector of double
an empty vector of double if an invalid histogram number or binning is choosen

The parameters of the method are the integers <histo_num> and <binning> representing the desired histogram number and binning.

Definition at line 1803 of file MuSR_td_PSI_bin.cpp.

int MuSR_td_PSI_bin::get_histo_int	(	int	histo_num,
		int	j
	)

Method to return the value of a single bin as integer.

This method gives back:

bin value as int
0 if an invalid histogram number or bin is choosen

Examples:: main.cpp.

Definition at line 1481 of file MuSR_td_PSI_bin.cpp.

vector< double > MuSR_td_PSI_bin::get_histo_vector	(	int	histo_num,
		int	binning
	)

Method to obtain a vector of double containing the values of the histogram <histo_num> with binning <binning>.

This method gives back:

a vector of double
an empty vector of double if an invalid number or binning is choosen

The parameters of the method are the integers <histo_num> and <binning> representing the desired histogram number and binning.

Examples:: main.cpp.

Definition at line 1568 of file MuSR_td_PSI_bin.cpp.

vector< double > MuSR_td_PSI_bin::get_histo_vector_no0	(	int	histo_num,
		int	binning
	)

Method to obtain a vector of double containing the values of the histogram <histo_num> with binning <binning> but where the bins with zero counts are replaced by a count 0.1.

This method gives back:

a vector of double
an empty vector of double if an invalid number or binning is choosen

The parameters of the method are the integers <histo_num> and <binning> representing the desired histogram number and binning.

Definition at line 1606 of file MuSR_td_PSI_bin.cpp.

int MuSR_td_PSI_bin::get_lastGood_int ( int i )

Method returning an integer representing the last good bin specified in the header for a specified histogram.

A value of -1 is returned if the value of the histogram specified is invalid.

Examples:: main.cpp.

Definition at line 3024 of file MuSR_td_PSI_bin.cpp.

int MuSR_td_PSI_bin::get_max_2_lastGood_int	(	int	k,
		int	j
	)

Method to determine the maximum value of the "last good bins" of 2 histograms.

returns -1 if something is invalid

Definition at line 3081 of file MuSR_td_PSI_bin.cpp.

int MuSR_td_PSI_bin::get_max_2_t0_int	(	int	k,
		int	j
	)

Method to determine the maximum value of the last good bins of 2 histograms.

returns -1 if the numbers of the histograms are invalid

Definition at line 2723 of file MuSR_td_PSI_bin.cpp.

int MuSR_td_PSI_bin::get_min_2_lastGood_int	(	int	k,
		int	j
	)

Method to determine the minimum value of the last good bins of 2 histograms.

returns -1 if something is invalid

Definition at line 3127 of file MuSR_td_PSI_bin.cpp.

int MuSR_td_PSI_bin::get_min_2_t0_int	(	int	k,
		int	j
	)

Method to determine the minimum value of the last good bins of 2 histograms.

returns -1 if the numbers of the histograms are invalid

Definition at line 2745 of file MuSR_td_PSI_bin.cpp.

string MuSR_td_PSI_bin::get_nameHisto ( int i )

Method returning a string containing the name of the histogram .

returns NULL if the histogram specified is invalid

Definition at line 3290 of file MuSR_td_PSI_bin.cpp.

double MuSR_td_PSI_bin::get_t0_double ( int i )

Method returning a double representing the t0 point (from the "real" t0 in the header) for a specified histogram.

A value of -1. is returned if the value of the histogram specified is invalid.

Definition at line 2899 of file MuSR_td_PSI_bin.cpp.

int MuSR_td_PSI_bin::get_t0_int ( int i )

Method returning an integer representing the t0 point (from the "integer" t0 in the header) for a specified histogram.

A value of -1 is returned if the value of the histogram specified is invalid.

Examples:: main.cpp.

Definition at line 2932 of file MuSR_td_PSI_bin.cpp.

int MuSR_td_PSI_bin::put_firstGood_int	(	int	i,
		int	j
	)

Method to modify the first good bin (value <j>) of the histogram .

returns -1 if the histogram specified was invalid

Definition at line 3003 of file MuSR_td_PSI_bin.cpp.

int MuSR_td_PSI_bin::put_lastGood_int	(	int	i,
		int	j
	)

Method to modify the last good bin (value <j>) of the histogram .

returns -1 if the histogram specified was invalid

Definition at line 3152 of file MuSR_td_PSI_bin.cpp.

int MuSR_td_PSI_bin::put_runNumber_int ( int i )

Method to modify the run number (value ).

returns -1 if the integer specified was wrong

Definition at line 3186 of file MuSR_td_PSI_bin.cpp.

int MuSR_td_PSI_bin::read ( const char * fileName )

Method to read a PSI-bin or an MDU file.

This method gives back:

0 for succesful reading
1 if the open file action or the reading of the header failed
2 for an unsupported version of the data
3 for an error when allocating data buffer
4 if number of histograms per record not equals 1
5 if the number of histograms is less than 1
6 if reading data failed

The parameter of the method is a const char * representing the name of the file to be opened.

Examples:: main.cpp.

Definition at line 85 of file MuSR_td_PSI_bin.cpp.

int MuSR_td_PSI_bin::readbin ( const char * fileName )

Method to read a PSI-bin file.

This method gives back:

0 for succesful reading
1 if the open file action or the reading of the header failed
2 for an unsupported version of the data
3 for an error when allocating data buffer
4 if number of histograms per record not equals 1
5 if the number of histograms is less than 1
6 if reading data failed

The parameter of the method is a const char * representing the name of the file to be opened.

Definition at line 202 of file MuSR_td_PSI_bin.cpp.

bool MuSR_td_PSI_bin::readingOK ( ) const

Method to obtain if reading and processing of the data file was OK.

This method gives back:

true if reading was OK
false if reading was NOT OK

Examples:: main.cpp.

Definition at line 1440 of file MuSR_td_PSI_bin.cpp.

int MuSR_td_PSI_bin::readmdu ( const char * fileName )

Method to read a MuSR MDU file.

This method gives back:

0 for succesful reading
1 if the open file action or the reading of the header failed
2 for an unsupported version of the data
3 for an error when allocating data buffer
5 if the number of histograms is less than 1
6 if reading data failed

The parameter of the method is a const char * representing the name of the file to be opened.

Definition at line 775 of file MuSR_td_PSI_bin.cpp.

string MuSR_td_PSI_bin::ReadStatus ( ) const

Method to obtain error/success information after reading.

This method gives back:

"SUCCESS" if reading was OK
"ERROR <message>" if reading was NOT OK

Examples:: main.cpp.

Definition at line 1454 of file MuSR_td_PSI_bin.cpp.

Member Data Documentation

vector< vector<double> > MuSR_td_PSI_bin::histos_vector

< this public variable provides a direct read/write access to the histograms. However all public methods use the protected variable histo. Histogram information returned by ..._vector or ..._array methods return information based on histo bin .

NOTE: Histogram information returned by <pointer_to_array> = ..._array() methods should be freed by delete [] <pointer_to_array>;

Examples:: main.cpp.

Definition at line 114 of file MuSR_td_PSI_bin.h.

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

MuSR_td_PSI_bin Class Reference

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation