imdd_silas/Classes/01_transmit/PAMsource.m

classdef PAMsource
    %NAME Summary of this class goes here
    %   Detailed explanation goes here

    properties(Access=public)
        order
        useprbs
        M
        fsym
        randkey

        db_precode
        db_encode
        duobinary_mode

        mrds_code
        mrds_blocklength

        applypulseform
        pulseformer

        fs_out

        applyclipping
        clipfactor
    end

    methods (Access=public)
        function obj = PAMsource(options)
            %NAME Construct an instance of this class
            %   Detailed explanation goes here

            arguments
                options.order = 16;
                options.useprbs = true;
                options.M = true
                options.fsym = 112e9;
                options.randkey = 0;

                options.db_precode = 0;
                options.db_encode = 0;
                options.duobinary_mode = db_mode.no_db;

                options.mrds_code = 0;
                options.mrds_blocklength = 512;

                options.applypulseform = 1;
                options.pulseformer;

                options.fs_out ;

                options.applyclipping = 0;
                options.clipfactor = 10;
            end


            fn = fieldnames(options);
            for n = 1:numel(fn)
                try
                    obj.(fn{n}) = options.(fn{n});
                end
            end

            if obj.applypulseform && isempty(obj.pulseformer)
                warning('No Pulseformer given. Proceeding with RRC and alpha 0.05');
                options.pulseformer = Pulseformer("fsym",obj.fsym,"fdac",obj.fs_out,"pulse","rrc","pulselength",16,"rrcalpha",0.05);
            end



        end

        function  [digi_sig,symbols,bits] = process(obj)

            %%%%% PRBS Generation in correct shape for Modulation Format %%%%%%
            bitpattern=[];

            if obj.useprbs
                %     O = obj.order; %order of prbs
                %     N = 2^(O-1); %length of prbs
                %     [~,seed] = prbs(O,1); %initialize first seed of prbs
                %     % for i = 1:log2(obj.M)
                %     %     [bitpattern(:,i),seed] = prbs(O,N,seed);
                %     % end

                %%%%% MOVE-IT PRMS %%%%
                state = struct();

                para = struct();

                if obj.M == 6
                    para.bl = 2^(obj.order-2);
                    para.dimension = 5;
                else
                    para.bl = 2^(obj.order-1);
                    para.dimension = log2(obj.M); %2.5bits/sym -> 2 bit/sym
                end

                para.rand = 0;

                para.order = floor(obj.order / log2(obj.M));
                para.skip =0;
                para.bruijn = 0;
                para.reset_prms = 0;
                para.method = 1;

               
                data_in = [];
                global loop;
                loop = 0;
                [data_out,state_] = prms(data_in, state, para);
                loop = 1;
                [data_out,state_out] = prms(data_in, state_, para);
                bitpattern = data_out';

                %%%%% END MOVE-IT %%%%%%%

            else
                s = RandStream('twister','Seed',obj.randkey);
                for i = 1:log2(obj.M)
                    N = 2^(obj.order-1); %length of prbs
                    bitpattern(:,i) = randi(s,[0 1], N, 1);
                end
            end

            if obj.M == 6
                bitpattern = reshape(bitpattern',[],1);
                bitpattern = bitpattern(1:end-mod(length(bitpattern),5));
            end

            bits = Informationsignal(bitpattern);
            bits = bits.logbookentry(['Generate bit stream with size: ', num2str(size(bitpattern))]);

            symbols = PAMmapper(obj.M,0).map(bits);
            symbols.fs = obj.fsym;

            %%%%%% Duobinary %%%%%%%%%%%

            % this is translation from user input to db_mode which was added later... "precode" und "encode" sind auch besser zu verstehen an dieser stelle daher hab ichs gelassen
            if obj.db_precode
                obj.duobinary_mode = db_mode.db_precoded;
            end
            if obj.db_encode
                obj.duobinary_mode = db_mode.db_encoded;
            end

            switch obj.duobinary_mode

                case db_mode.no_db

                case db_mode.db_precoded
                    % symbols = Duobinary().precode(symbols);
                    symbols = Partialresponse().precode(symbols);
                case db_mode.db_encoded
                    % symbols = Duobinary().precode(symbols);
                    % symbols = Duobinary().encode(symbols);
                    symbols = Partialresponse().precode(symbols);
                    symbols = Partialresponse().encode(symbols);
            end


            %%%%%% MRDS %%%%%%%%%%%

            if obj.mrds_code
                symbols = MRDS_coding("blocklength",obj.mrds_blocklength).encode(symbols);
            end

            %%%%%% SAVE MIN-MAX FOR CLIP %%%%%%%%%%%

            if obj.applyclipping
                sym_min = min(symbols.signal);
                sym_max = max(symbols.signal);
            end

            %%%%% Pulse-forming %%%%%%
            if obj.applypulseform
                %%% MY CODE
                if 1
                    digi_sig = obj.pulseformer.process(symbols);

                else
                    %%% MOVEIT WRAPPER BETA
                    % symbols.spectrum("fignum",111,"displayname","1) RAW SIGNAL");

                    pulsf = Moveit_wrapper('pulsef');
                    pulsf.para.alpharacos = obj.pulseformer.alpha;
                    pulsf.para.f_sym = obj.pulseformer.fsym;
                    pulsf.para.fs = obj.pulseformer.fdac;
                    pulsf.para.pulse = 1;

                    digi_sig = pulsf.process(symbols);
                    digi_sig.fs = obj.pulseformer.fdac;
                    
                end
                % Design raised cosine filter with given order in symbols
                % digi_sig = symbols;
                % sps = 4;
                % nsym = 128;
                % rctFilt3 = comm.RaisedCosineTransmitFilter(...
                %     Shape='Square root', ...
                %     RolloffFactor=1, ...
                %     FilterSpanInSymbols=nsym, ...
                %     OutputSamplesPerSymbol=sps);
                % 
                % digi_sig.signal = rctFilt3([symbols.signal; zeros(nsym/2,1)]);
                % % Correct for propagation delay by removing filter transients
                % fltDelay = nsym / (2*obj.fsym);
                % digi_sig.signal = digi_sig.signal(fltDelay*sps*obj.fsym+1:end);
                % 
                % digi_sig.fs = sps .* symbols.fs;


            else
                digi_sig = symbols;
            end


            %%%%% Re-sample to f DAC %%%%%%
            n = 10;
            digi_sig = digi_sig.resample("fs_in",digi_sig.fs,"fs_out",obj.fs_out,"n",n,"beta",5);
            % digi_sig.spectrum("fignum",111,"displayname",['3) Shaped + Resampled; n: ',num2str(n)]);


            %%%%% Hard clip digital signal to PAM range before DAC %%%%%%
            if obj.applyclipping
                try
                    digi_sig.signal = clip(digi_sig.signal  ,  sym_min * obj.clipfactor  ,  sym_max * obj.clipfactor);
                catch
                    digi_sig.signal(digi_sig.signal > sym_max * obj.clipfactor) = sym_max * obj.clipfactor;
                    digi_sig.signal(digi_sig.signal < sym_min * obj.clipfactor) = sym_min * obj.clipfactor;
                end
            end

            % append to logbook
            lbdesc = ['Generated PAM Signal'];
            digi_sig  = digi_sig.logbookentry(lbdesc);

        end


    end

end