@@ -88,31 +88,19 @@ def HeightGainTerminalCorrectionModel(
8888 R__meter : float ,
8989 clutter_type : ClutterType ,
9090) -> float :
91- """
92- Description
93- -----------
94- Height gain terminal correction model as described in Section 3.1.
91+ """Height gain terminal correction model as described in Section 3.1.
92+
9593 This method gives the median loss due to different terminal surroundings.
9694 This model can be applied to both transmitting and receiving ends of the path.
9795
98- Parameters
99- ----------
100- f__ghz : FLOAT
101- Frequency, in GHz.
102- h__meter : FLOAT
103- Antenna height, in meters.
104- w_s__meter : FLOAT
105- Street width, in meters.
106- R__meter : FLOAT
107- Representative clutter height, in meters.
108- clutter_type : INT # TODO enum
109- Clutter type.
110-
111- Returns
112- -------
113- FLOAT
114- Additional loss (clutter loss), in dB.
115-
96+ :param f__ghz: Frequency, in GHz.
97+ :param h__meter: Antenna height, in meters.
98+ :param w_s__meter: Street width, in meters.
99+ :param R__meter: Representative clutter height, in meters.
100+ :param clutter_type: Clutter type, a ClutterType enum value.
101+ :raises ValueError: If any input parameter is not in its valid range.
102+ :raises Exception: If an unknown error is encountered.
103+ :return: Additional loss (clutter loss), in dB.
116104 """
117105 A_h__db = c_double ()
118106 err_check (
@@ -130,27 +118,16 @@ def HeightGainTerminalCorrectionModel(
130118
131119
132120def TerrestrialStatisticalModel (f__ghz : float , d__km : float , p : float ) -> float :
133- """
134- Description
135- -----------
136- Statistical clutter loss model for terrestrial paths as described
137- in Section 3.2. This model can be applied for urban and suburban
138- clutter loss modelling.
139-
140- Parameters
141- ----------
142- f__ghz : FLOAT
143- Frequency, in GHz.
144- d__km : FLOAT
145- Path distance, in km.
146- p : FLOAT
147- Percentange of locations, in %.
148-
149- Returns
150- -------
151- FLOAT
152- Additional loss (clutter loss), in dB.
153-
121+ """Statistical clutter loss model for terrestrial paths as described in
122+ Section 3.2. This model can be applied for urban and suburban clutter loss
123+ modeling.
124+
125+ :param f__ghz: Frequency, in GHz.
126+ :param d__km: Path distance, in km.
127+ :param p: Percentange of locations, in %.
128+ :raises ValueError: If any input parameter is not in its valid range.
129+ :raises Exception: If an unknown error is encountered.
130+ :return: Additional loss (clutter loss), in dB.
154131 """
155132 L_ctt__db = c_double ()
156133 err_check (
@@ -166,31 +143,21 @@ def TerrestrialStatisticalModel(f__ghz: float, d__km: float, p: float) -> float:
166143
167144
168145def AeronauticalStatisticalModel (f__ghz : float , theta__deg : float , p : float ) -> float :
169- """
170- Description
171- -----------
172- The Earth-space and aeronautical statistical clutter loss
173- model as described in Section 3.3. This model is applicable
174- when one end of the path is within man-made clutter and the
175- other end is a satellite, aeroplane, or other platform
176- above the Earth.
177-
178- Parameters
179- ----------
180- f__ghz : FLOAT
181- Frequency, in GHz.
182- theta__deg : FLOAT
183- Elevation angle, in degrees.
184- p : FLOAT
185- Percentange of locations, in %.
186-
187- Returns
188- -------
189- INT
190- Return code.
191- FLOAT
192- Additional loss (clutter loss), in dB.
193-
146+ """The Earth-space and aeronautical statistical clutter loss model as
147+ described in Section 3.3. This model is applicable when one end of the path
148+ is within man-made clutter and the other end is a satellite, aeroplane, or
149+ other platform above the Earth.
150+
151+ Frequency range: 10 < f < 100 (GHz)
152+ Elevation angle range: 0 < theta < 90 (degrees)
153+ Percentage locations range: 0 < p < 100 (%)
154+
155+ :param f__ghz: Frequency, in GHz.
156+ :param theta__deg: Elevation angle, in degrees.
157+ :param p: Percentange of locations, in %.
158+ :raises ValueError: If any input parameter is not in its valid range.
159+ :raises Exception: If an unknown error is encountered.
160+ :return: Additional loss (clutter loss), in dB.
194161 """
195162 L_ces__db = c_double ()
196163 err_check (
0 commit comments