wssuschannel.h

Go to the documentation of this file.

/*-*-c++-*-*****************************************************************
                          wssuschannel.h  -  MIMO WSSUS channel classes
                             -------------------
    begin                : May 2003
    copyright            : (C) 2003 by Christian Stimming
    email                : stimming@tuhh.de
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This library is free software; you can redistribute it and/or         *
 *   modify it under the terms of the GNU Lesser General Public            *
 *   License as published by the Free Software Foundation; either          *
 *   version 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
 *   MA  02111-1307  USA                                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef WSSUSCHANNEL_H
#define WSSUSCHANNEL_H

#include <iostream>
#include <fstream>
#include <complex>

#include <simthetic/phbib.h>
#include <simthetic/phrand.h>
#include <simthetic/signals.h>
#include <simthetic/basicdevice.h>
#include <simthetic/interfaces.h>

#include <simtheticlib/delayprofile.h>

namespace simthlib {
    class OfdmReceiver;
    class OfdmTransmitter;
}

using namespace simthlib;

#include "matrixseq.h"
#include "mimo-channel.h"

// MIMO channels are only available if the matrix data types are
// available

namespace mimo {

class PathParam {
   public:
      double phase;

      double dopp_freq;

      int delay;

      double delta_phi;

      double alpha;

      double beta;

      mimo::CVector v_alpha;

      mimo::CVector v_beta;

      double ampl;
};

class WSSUSChannel : public MIMOChannel
{
  private:

    double rice_factor;

  protected:
    unsigned num_paths;

    double max_delay;

    typedef std::vector<PathParam> PathContainer;

    PathContainer paths;

    AntennaArray *array_geometry;

    double delta_t;

  private:
    int num_freq; //actually num_freq is zero at any time

   protected:
    VectorTimeSignal::storage_type prevsym;
    bool firstSequence;

    int roundTimeToSamples(double value) const;

   private:
    enum Normalization_Mode {
    STD,
    TIME,
    FREQ,
    TIME_TOTAL,
    FREQ_TOTAL
    };
    Normalization_Mode normMode;
    double normFactor;
    void resetNormalizeFactor();
    double freqDist;  
    int numFreqs;
    unsigned normDuration;
    unsigned normDurationLeft;

    // Possibly being used for the amplitude
    RayleighRng rayleigh_rng;
    
    void adjustDeltaT(double newDeltaT);

    DiscreteUniformRng AoARng;
    DiscreteUniformRng AoDRng;

    simth::UniformRng coupling_phase_rng;

  protected:
    // sequence to store the (ideal) estimated transfer factors in
    // order avoid (unessecary) multiple estimations in
    // getTransfer(..)
    mutable MatrixFreqSignal::storage_type cacheTransfer;
    mutable int cacheTime;
    mutable bool isTransferCacheValid;
    // Whether this channel is time variant at all
    bool timevariant;

  private:
    // Needed for broadband Rayleigh fading channel
    simthlib::OfdmReceiver *ofdm_recv;
    simthlib::OfdmTransmitter *ofdm_trans;
      
    // Needed for broadband Rayleigh fading channel
    unsigned num_carrier;
    double carrier_dist;
    unsigned maxantenna;

    // Needed for broadband Rayleigh fading channel
    std::vector<TimeSignal*> time_samples;
    std::vector<ModSeq*> freq_samples;
    CVectorSeq::storage_type freq_vectors_in;
    CVectorSeq::storage_type freq_vectors_out;

    //------------------------------

  protected:
    virtual double diceNewDelay() const = 0;

    virtual double diceNewPhase() const = 0;

    virtual double diceNewAmpl() const;

    virtual double diceNewDopplerFreq() const = 0;

    virtual double diceNewAoA() const;

    virtual double diceNewAoD() const;

  public:
    WSSUSChannel(int deviceID, 
         DeviceSystemIntf* system,
         const simth::PropertyList& pl,
         double maxDelay);

    virtual ~WSSUSChannel();

    virtual void refresh();

    void getTransfer(int relative_time, MatrixFreqSignal& trans) const;

    void transmit(const VectorTimeSignal &insym, VectorTimeSignal& outsym);

    void setRiceFactor(double rf);

    void setRiceFactor_dB(double rf);


    void setTimeNormalization(unsigned duration = 0);

    void setFreqNormalization(double freqDist, int numFreqs, 
                  unsigned duration = 0);

    virtual void startOfSimulation();

    virtual void print(std::ostream &os) const;

   protected:
    void getImpulseResponse(int relative_time, MatrixTimeSignal &t) const;

};


inline int WSSUSChannel::roundTimeToSamples(double value) const
{
    /*if(DEBUG) {
      int returnValue = int(value / delta_t + 0.5);
      if(returnValue < 0) {
      std::cerr<<std::endl<<"delta_t: "<<delta_t<<" value: "<<value<<std::endl;
      throw std::out_of_range("inline int WSSUSChannel::roundTimeToSamples(double value) : error 1"
      " (deltaT to small !?)");
      }
      return returnValue;
      }*/
    return int(value / delta_t + 0.5);
}






class WSSUSChannelJakesUniform : public WSSUSChannel
{
  private:
    UniformRng uniformPhaseRng;
    JakesRng* jakesDoppFreqRng;
  protected:
    virtual double diceNewPhase() const;
    virtual double diceNewDopplerFreq() const;
  public:
    WSSUSChannelJakesUniform(int deviceID, 
                 DeviceSystemIntf* system,
                 const simth::PropertyList& pl,
                 double max_doppler,
                             double maxDelay);
    virtual ~WSSUSChannelJakesUniform();
};


class WSSUSChannelExpDelay : public WSSUSChannelJakesUniform
{
  private:
    ExponentialDelayProfile *expDelay;
  protected:
    virtual double diceNewDelay() const;
    WSSUSChannelExpDelay(int deviceID, 
             DeviceSystemIntf* system,
             const simth::PropertyList& pl,
             double max_doppler, double delayAttenuation,
                         double max_delay);
  public:
    WSSUSChannelExpDelay(int deviceID, 
             DeviceSystemIntf* system,
             const simth::PropertyList& pl);

    virtual ~WSSUSChannelExpDelay();
};



class WSSUSChannelBU : public WSSUSChannelJakesUniform
{
  private:
    BuDelayProfile buDelay;
  protected:
    virtual double diceNewDelay() const;
  public:
    WSSUSChannelBU(int deviceID, 
           DeviceSystemIntf* system,
           const simth::PropertyList& pl);
    virtual ~WSSUSChannelBU() {};

};


class WSSUSChannelHT : public WSSUSChannelJakesUniform
{
  private:
    HtDelayProfile htDelay;

  protected:
    virtual double diceNewDelay() const;
  public:
    WSSUSChannelHT(int deviceID, 
           DeviceSystemIntf* system,
           const simth::PropertyList& pl);

    virtual ~WSSUSChannelHT() {};

};


class WSSUSChannelScattering : public WSSUSChannelExpDelay
{
  public:
    WSSUSChannelScattering(int deviceID, 
               DeviceSystemIntf* system,
               const simth::PropertyList& pl)
    : WSSUSChannelExpDelay(deviceID, system, pl,
                   pl.getProperty<double>("max_doppler"), 
                   (-log(DELAY_THRESHOLD)/pl.getProperty<double>("max_signal_delay")), 
                   pl.getProperty<double>("max_signal_delay")) {};
};


class WSSUSChannelFreqTimeCorr : public WSSUSChannelExpDelay
{
  public:
    WSSUSChannelFreqTimeCorr(int deviceID, 
                 DeviceSystemIntf* system,
                 const simth::PropertyList& pl);
};

class WSSUSChannelRA : public WSSUSChannelExpDelay
{
  public:
    WSSUSChannelRA(int deviceID, 
           DeviceSystemIntf* system,
           const simth::PropertyList& pl)
        :WSSUSChannelExpDelay(deviceID, system, pl,
                  pl.getProperty<double>("max_doppler"), 
                  1e6*9.2,
                  0.7e-6) {} 
};

class WSSUSChannelTU : public WSSUSChannelExpDelay
{
  public:
    WSSUSChannelTU(int deviceID, 
           DeviceSystemIntf* system,
           const simth::PropertyList& pl)
        :WSSUSChannelExpDelay(deviceID, system, pl,
                  pl.getProperty<double>("max_doppler"), 
                  1e6,
                  7e-6) {};
};


// ------------------------------------------------------------

class FileWssusChannel : public WSSUSChannel 
{
   private:
      std::string filename;
      unsigned realiz_index;

   public:
      FileWssusChannel(int deviceID, 
               DeviceSystemIntf* system,
               const simth::PropertyList& pl);
      ~FileWssusChannel();

      void refresh();

      double diceNewDelay() const { return 0; };
      double diceNewPhase() const { return 0; };
      double diceNewDopplerFreq() const { return 0; };

      void setSNR(double snr);
      void startOfSimulation();

};


} // namespace mimo




#endif /* WSSUSCHANNEL_H */

---