src/buildings/doc/source/buildings-testing.rst
author mmiozzo
Tue, 08 Nov 2011 15:18:19 +0100
changeset 8307 e059b2c2f2e4
parent 8299 src/buildings/doc/source/lte-pathloss-testing.rst@f3fff6722a1a
parent 8259 src/buildings/doc/source/lte-pathloss-testing.rst@591bfffeda6a
child 8554 39c5b84b1ad1
permissions -rw-r--r--
Merge with ns-3-lena-dev changeset: 7937:2228db567a14
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
8214
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
     1
+++++++++++++++++++++++++++++++++++++
8259
591bfffeda6a revised section titles in buildings doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8257
diff changeset
     2
 Testing Documentation
8214
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
     3
+++++++++++++++++++++++++++++++++++++
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
     4
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
     5
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
     6
Overview
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
     7
********
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
     8
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
     9
To test and validate the ns-3 Building Pathloss module, a test suites is provided which are integrated with the ns-3 test framework in the lte module.
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    10
To run them, you need to have configured the build of the simulator in this way::
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    11
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    12
    ./waf configure --enable-tests --enable-modules=lte --enable-examples
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    13
    ./test.py
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    14
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    15
The above will run not only the test suites belonging to the LTE module, but also those belonging to all the other ns-3 modules on which the LTE module depends. See the ns-3 manual for generic information on the testing framework.
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    16
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    17
You can get a more detailed report in HTML format in this way::
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    18
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    19
    ./test.py -w results.html
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    20
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    21
After the above command has run, you can view the detailed result for each test by opening the file ``results.html`` with a web browser. 
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    22
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    23
You can run each test suite separately using this command::
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    24
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    25
    ./test.py -s test-suite-name
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    26
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    27
For more details about ``test.py`` and the ns-3 testing framework, please refer to the ns-3 manual.
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    28
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    29
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    30
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    31
Description of the test suite
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    32
*****************************
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    33
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    34
The test suite ``lte-pathloss-model`` creates different test cases with
8229
32337df80523 Add documentation on shadowing test
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8226
diff changeset
    35
both unit and system tests. The formers validate the single component model and the pathloss logic behavior. The latter proof the integration of the pathloss model in the ns3 framework and more in specifically in the lte module. Finally. a unit test is provided in order to test the shadowing characterization.
8214
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    36
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    37
Unit Tests
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    38
~~~~~~~~~~
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    39
8226
8b6e2e92ebae Address Nicola's comment on lte-pathloss-testing
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8214
diff changeset
    40
The unit tests are carried out by comparing the expected results of the pathloss module in specific scenarios with pre calculated values obtained offline with an Octave script (/test/reference/lte-pathloss.m). The tests are considered passed if the two values differs only for a predefined tolerance (0.1) that accounts for the approximations due to floating point arithmetics.
8b6e2e92ebae Address Nicola's comment on lte-pathloss-testing
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8214
diff changeset
    41
8b6e2e92ebae Address Nicola's comment on lte-pathloss-testing
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8214
diff changeset
    42
In the following we detailed the scenarios considered, their selection has been done for covering the wide set of possible pathloss logic combinations. The pathloss logic results therefore implicitly tested.
8214
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    43
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    44
Test #1 Okumura Hata
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    45
--------------------
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    46
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    47
In this test we test the standard Okumura Hata model; therefore both eNB and UE are placed outside at a distance of 2000 m. The frequency used is the E-UTRA band #5, which correspond to 869 MHz (see table 5.5-1 of 36.101). The test includes also the validation of the areas extensions (i.e., urban, suburban and open-areas) and of the city size (small, medium and large).
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    48
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    49
Test #2 COST231 Model
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    50
---------------------
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    51
8229
32337df80523 Add documentation on shadowing test
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8226
diff changeset
    52
This test is aimed at validating the COST231 model. The test is similar to the Okumura Hata one, except that the frequency used is the EUTRA band #1 (2140 MHz) and that the test can be performed only for large and small cities in urban scenarios due to model limitations.
8214
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    53
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    54
Test #3 2.6 GHz model
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    55
---------------------
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    56
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    57
This test validates the 2.6 empirical model [pl26ghz]_. The test is similar to Okumura Hata one except that the frequency is the EUTRA band #7 (2620 MHz) and the test can be performed only in urban scenario.
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    58
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    59
Test #4 ITU1411 LoS model
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    60
-------------------------
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    61
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    62
This test is aimed at validating the ITU1411 model in case of line of sight within street canyons transmissions. In this case the UE is placed at 100 meters far from the eNB, since the threshold for switching between LoS and NLoS is left to default one (i.e., 200 m.).
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    63
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    64
Test #5 ITU1411 NLoS model
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    65
--------------------------
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    66
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    67
This test is aimed at validating the ITU1411 model in case of non line of sight over the rooftop transmissions. In this case the UE is placed at 900 meters far from the eNB, in order to be above the threshold for switching between LoS and NLoS is left to default one (i.e., 200 m.).
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    68
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    69
Test #6 ITUP1238 model
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    70
----------------------
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    71
8226
8b6e2e92ebae Address Nicola's comment on lte-pathloss-testing
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8214
diff changeset
    72
This test is aimed at validating the ITUP1238 model in case of indoor transmissions. In this case both the UE and the eNB are placed in a residential building with walls made of concrete with windows. Ue is placed at the second floor and distances 30 meters far from the eNB, which is placed at the first floor.
8214
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    73
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    74
Test #7 Outdoor -> Indoor with Okumura Hata model
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    75
-------------------------------------------------
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    76
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    77
This test validates the outdoor to indoor transmissions for large distances. In this case the UE is placed in a residential building with wall made of concrete with windows and distances 2000 meters from the outdoor eNB.
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    78
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    79
Test #8 Outdoor -> Indoor with ITU1411 model
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    80
-------------------------------------------------
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    81
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    82
This test validates the outdoor to indoor transmissions for short distances. In this case the UE is placed in a residential building with walls made of concrete with windows and distances 100 meters from the outdoor eNB.
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    83
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    84
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    85
Test #9 Indoor -> Outdoor with ITU1411 model
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    86
-------------------------------------------------
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    87
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    88
This test validates the outdoor to indoor transmissions for very short distances. In this case the eNB is placed in the second floor of a residential building with walls made of concrete with windows and distances 100 meters from the outdoor UE (i.e., LoS communication). Therefore the height gain has to be included in the pathloss evaluation.
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    89
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    90
Test #10 Indoor -> Outdoor with ITU1411 model
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    91
-------------------------------------------------
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    92
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    93
This test validates the outdoor to indoor transmissions for short distances. In this case the eNB is placed in the second floor of a residential building with walls made of concrete with windows and distances 500 meters from the outdoor UE (i.e., NLoS communication). Therefore the height gain has to be included in the pathloss evaluation.
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    94
e68383edb9f1 Add pathloss testing documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    95
8229
32337df80523 Add documentation on shadowing test
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8226
diff changeset
    96
Shadowing Test
32337df80523 Add documentation on shadowing test
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8226
diff changeset
    97
~~~~~~~~~~~~~~
32337df80523 Add documentation on shadowing test
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8226
diff changeset
    98
32337df80523 Add documentation on shadowing test
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8226
diff changeset
    99
This unit test is intended to verify the statistics distribution characteristics of the shadowing are the one expected. The shadowing is modeled according to a normal distribution with mean 0 and variable standard deviation (usually called sigma), according to the standard models used in literature.
32337df80523 Add documentation on shadowing test
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8226
diff changeset
   100
The test generates 10,000 samples of shadowing by subtracting the deterministic component from the total loss returned by the ``BuildingPathlossModel``. The mean and variance of the shadowing samples are then used to verify whether the 99% confidence interval is respected by the sequence generated by the simulator.
32337df80523 Add documentation on shadowing test
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8226
diff changeset
   101