Diffusion Instrument Control (FreqRINCal) Browse

MyAvgTrace.m
e56e879eb69bFreqRINCal

MyAvgTrace.m
View Options

			% Adds averaging capabilities to MyTrace
			%
			% The averaging type is 'lin' (or 'linear')/ 'exp' (or 'exponential').
			% Linear averaging is a simple mean
			% x=\sum_{n=0}^N x_n,
			% exponential is an unlimited weighted sum
			% x=(1-exp(-1/n_avg))*\sum_{n=0}^\inf x_n exp(-n/n_avg).

			classdef MyAvgTrace < MyTrace

			properties (Access = public)

			% Target number of averages, when it is reached or exceeded
			% AveragingDone event is triggered
			n_avg = 1

			avg_type = 'lin'
			end

			properties (GetAccess = public, SetAccess = protected)

			% Counter for the averaging function, can be reset by clearData
			avg_count = 0
			end

			methods (Access=public)

			% Adds data to the average accumulator. When the averaging counter
			% reaches n_avg (or exceeds it in the exponential case), completed
			% is set to 'true', otherwise 'false'.
			% In exponential regime the averaging proceeds indefinitely so that
			% avg_count can exceed n_avg.
			% In linear regime when the averaging counter exceeds n_avg, new
			% data is discarded.
			function completed = addAverage(this, b)
			assert(isa(b,'MyTrace'), ['Second argument must be a ' ...
			'MyTrace object']);

			if isempty(this) \|\| length(this.x)~=length(b.x) \|\| ...
			any(this.x~=b.x)
			% Initialize new data and return
			this.x=b.x;
			this.y=b.y;

			this.name_x=b.name_x;
			this.unit_x=b.unit_x;
			this.name_y=b.name_y;
			this.unit_y=b.unit_y;
			this.avg_count=1;

			completed=(this.avg_count>=this.n_avg);
			return
			end

			assert(length(b.y)==length(this.y), ...
			['New vector of y values must be of the same', ...
			'length as the exisiting y data of MyTrace in ', ...
			'order to perform averanging'])

			switch this.avg_type
			case 'lin'
			if this.avg_count<this.n_avg
			% Increase the counter and update the data
			this.avg_count=this.avg_count+1;
			this.y = (this.y*(this.avg_count-1)+b.y)/...
			this.avg_count;
			% Return completed==true if the averaging is
			% finished at this iteration
			completed=(this.avg_count==this.n_avg);
			else
			% New data is discarded
			completed=false;
			end
			case 'exp'
			% In the exponential case averaging proceeds
			% indefinitely, so do not check if avg_count<n_avg
			this.avg_count=this.avg_count+1;
			this.y = b.y*(1-exp(-1/this.n_avg))+ ...
			this.y*exp(-1/this.n_avg);
			completed=(this.avg_count>=this.n_avg);
			otherwise
			error('Averaging type %s is not supported', ...
			this.avg_type)
			end
			end

			% Provide restricted access to the trace averaging counter
			function resetCounter(this)
			this.avg_count = 0;
			end

			% Overload clearData so that it reset the averaging counter in
			% addition to clearing the x and y values
			function clearData(this)
			this.x = [];
			this.y = [];
			resetCounter(this);
			end

			% Extend the info stored in trace metadata compare to MyTrace
			function Mdt=makeMetadata(this)
			Mdt=makeMetadata@MyTrace(this);
			addParam(Mdt,'Info','avg_type',this.avg_type, ...
			'comment','Averaging type, linear or exponential');
			addParam(Mdt,'Info','avg_count',this.avg_count, 'comment', ...
			'Number of accomplished averages');
			addParam(Mdt,'Info','n_avg',this.n_avg, 'comment', ...
			['Target number of averages (lin) or exponential ' ...
			'averaging constant (exp)']);
			end

			function setFromMetadata(this, MdtS)
			if isfield(MdtS, 'Info')
			if isparam(MdtS.Info, 'avg_type')
			this.avg_type = getParam(MdtS.Info, 'avg_type');
			end
			if isparam(MdtS.Info, 'n_avg')
			this.n_avg = getParam(MdtS.Info, 'n_avg');
			end
			if isparam(MdtS.Info, 'avg_count')
			this.avg_count = getParam(MdtS.Info, 'avg_count');
			end
			end

			setFromMetadata@MyTrace(this, MdtS);
			end
			end

			%% Set and get methods

			methods

			% Ensure the supplied value for averaging mode is assigned in its
			% standard form - lowercase and abbreviated
			function set.avg_type(this, val)
			old_val=this.avg_type;

			switch lower(val)
			case {'lin', 'linear'}
			this.avg_type='lin';
			case {'exp', 'exponential'}
			this.avg_type='exp';
			otherwise
			error(['Averaging type must be ''lin'' ' ...
			'(''linear'') or ''exp'' (''exponential'')'])
			end
			% Clear data if the averaging type was changed
			if this.avg_type~=old_val
			clearData(this);
			end
			end

			function set.n_avg(this, val)
			% The number of averages should be integer not smaller than one
			this.n_avg=max(1, round(val));
			end

			end
			end

rINSTCONTROL/@MyAvgTrace/MyAvgTrace.me56e879eb69bFreqRINCal

MyAvgTrace.mView Options

rINSTCONTROL/@MyAvgTrace/MyAvgTrace.m
e56e879eb69bFreqRINCal

MyAvgTrace.m
View Options