multitau Namespace Reference

Functions
def	channel_size (lin_corrs, series_size, bin_ratio)
def	x_tics (lin_corrs, series_size, bin_ratio)
def	points_scale_template (lin_corrs, series_size, bin_ratio)
def	bin_ratio_scale (lin_corrs, series_size, bin_ratio)
def	tau_max (lin_corrs, series_size, bin_ratio)
def	time_axis_s (tau_axis, gate_time_ms)
def	points_norm (lin_corrs, series_size, bin_ratio, LC0_points)

Function Documentation

bin_ratio_scale()

def multitau.bin_ratio_scale	(		lin_corrs,
			series_size,
			bin_ratio
	)

        Returns an array of size `channel_size` that scales as per the `multitau scheme` bin ratio.

channel_size()

def multitau.channel_size	(		lin_corrs,
			series_size,
			bin_ratio
	)

Returns the expected channel size based on the multi-tau parameters.

points_norm()

def multitau.points_norm	(		lin_corrs,
			series_size,
			bin_ratio,
			LC0_points
	)

    Generates and returns a list of normalisation values based on the data points fed to 
    the 0th Linear Correlator.

points_scale_template()

def multitau.points_scale_template	(		lin_corrs,
			series_size,
			bin_ratio
	)

    Generates and returns a list of normalisation values, which when multiplied by the points
    fed to the 0th linear Correlator - gives a list of points normalization values for all
    the tau values.

tau_max()

def multitau.tau_max	(		lin_corrs,
			series_size,
			bin_ratio
	)

    Returns the maximum tau-value for the given multi-tau configuration.

time_axis_s()

def multitau.time_axis_s	(		tau_axis,
			gate_time_ms
	)

    Returns the converted time axis in seconds based 
    on gate_time(minimum resolution) in microseconds.

x_tics()

def multitau.x_tics	(		lin_corrs,
			series_size,
			bin_ratio
	)

Generates and returns a list of x-ticks that can be used for plotting, using the 
multi-tau parameters.