% Class for controlling Tektronix RSA5103 and RSA5106 spectrum analyzers 

classdef MyRsa < MyScpiInstrument & MyDataSource & MyCommCont
    
    properties (SetAccess = protected, GetAccess = public)
        acq_trace = [] % Last read trace
    end
    
    methods (Access = public)
        function this = MyRsa(varargin)
            P = MyClassParser(this);
            processInputs(P, this, varargin{:});
            
            this.Trace.unit_x = 'Hz';
            this.Trace.unit_y = '$\mathrm{V}^2/\mathrm{Hz}$';
            this.Trace.name_y = 'Power';
            this.Trace.name_x = 'Frequency';
        end
    end
    
    
    methods (Access = protected)
        
        function createCommandList(this)
            addCommand(this, 'rbw', ':DPX:BAND:RES', ...
                'format',   '%e', ...
                'info',     'Resolution bandwidth (Hz)', ...
                'default',  1e3);
            
            addCommand(this, 'auto_rbw', ':DPX:BAND:RES:AUTO', ...
                'format',   '%b', ...
                'default',  true);
            
            addCommand(this, 'span', ':DPX:FREQ:SPAN', ...
                'format',   '%e', ...
                'info',     '(Hz)', ...
                'default',  1e6);
            
            addCommand(this,  'start_freq',':DPX:FREQ:STAR',...
                'format',   '%e', ...
                'info',     '(Hz)', ...
                'default',  1e6);
            
            addCommand(this, 'stop_freq',':DPX:FREQ:STOP',...
                'format',   '%e', ...
                'info',     '(Hz)', ...
                'default',  2e6);
            
            addCommand(this, 'cent_freq',':DPX:FREQ:CENT',...
                'format',   '%e', ...
                'info',     '(Hz)', ...
                'default',  1.5e6);
            
            % Continuous triggering
            addCommand(this, 'init_cont', ':INIT:CONT', ...
                'format',   '%b',...
                'info',     'Continuous triggering on/off', ...
                'default',  true);
            
            % Number of points in trace
            addCommand(this, 'point_no', ':DPSA:POIN:COUN', ...
                'format',       'P%i', ...
                'value_list',   {801, 2401, 4001, 10401}, ...
                'default',      10401);
            
            % Reference level (dB)
            addCommand(this, 'ref_level',':INPut:RLEVel', ...
                'format',   '%e',...
                'info',     '(dB)', ...
                'default',  0);
            
            % Display scale per division (dBm/div)
            addCommand(this, 'disp_y_scale', ':DISPlay:DPX:Y:PDIVision',...
                'format',   '%e', ...
                'info',     '(dBm/div)', ...
                'default',  10);
            
            % Display vertical offset (dBm)
            addCommand(this, 'disp_y_offset', ':DISPLAY:DPX:Y:OFFSET', ...
                'format',   '%e', ...
                'info',     '(dBm)', ...
                'default',  0);
            
            % Parametric commands
            for i = 1:3
                i_str = num2str(i);
                
                % Display trace
                addCommand(this, ['disp_trace',i_str], ...
                    [':TRAC',i_str,':DPX'], ...
                    'format',   '%b', ...
                    'info',     'on/off', ...
                    'default',  false);
                
                % Trace Detection
                addCommand(this, ['det_trace',i_str],...
                    [':TRAC',i_str,':DPX:DETection'],...
                    'format',       '%s', ...
                    'value_list',   {'AVERage', 'NEGative', 'POSitive'},...
                    'default',      'average');
                
                % Trace Function
                addCommand(this, ['func_trace',i_str], ...
                    [':TRAC',i_str,':DPX:FUNCtion'], ...
                    'format',       '%s', ...
                    'value_list',   {'AVERage', 'HOLD', 'NORMal'},...
                    'default',      'average');
                
                % Number of averages
                addCommand(this, ['average_no',i_str], ...
                    [':TRAC',i_str,':DPX:AVER:COUN'], ...
                    'format',   '%i', ...
                    'default',  1);
                
                % Count completed averages
                addCommand(this, ['cnt_trace',i_str], ...
                    [':TRACe',i_str,':DPX:COUNt:ENABle'], ...
                    'format',   '%b', ...
                    'info',     'Count completed averages', ...
                    'default',  false);
            end
        end
    end
    
    
    methods (Access = public)
        function readSingle(this, n_trace)
            fetch_cmd = sprintf('fetch:dpsa:res:trace%i?', n_trace);  
            fwrite(this.Device, fetch_cmd);
            data = binblockread(this.Device,'float');
            readProperty(this, 'start_freq','stop_freq','point_no');
            x_vec=linspace(this.start_freq,this.stop_freq,...
                this.point_no);
            %Calculates the power spectrum from the data, which is in dBm.
            %Output is in V^2/Hz
            power_spectrum = (10.^(data/10))/this.rbw*50*0.001;
            %Trace object is created containing the data and its units
            this.Trace.x = x_vec;
            this.Trace.y = power_spectrum;
            
            this.acq_trace = n_trace;

            %Trigger acquired data event (inherited from MyInstrument)
            triggerNewData(this);
        end
        
        % Abort data acquisition        
        function abort(this)
            writeCommand(this, ':ABORt');
        end
        
        % Initiate data acquisition
        function init(this)
            writeCommand(this, ':INIT');
        end
        
        % Extend readHeader function
        function Hdr = readHeader(this)
            
            %Call parent class method and then append parameters
            Hdr = readHeader@MyScpiInstrument(this);
            
            %Hdr should contain single field
            addParam(Hdr, Hdr.field_names{1}, ...
                'acq_trace', this.acq_trace, ...
                'comment', 'Last read trace');
        end
    end
end