API

API documentation

pyitm.itm.ITMAreadBLoss(ModVar, deltaH, tht_m, rht_m, dist_km, TSiteCriteria, RSiteCriteria, eps_dielect, sgm_conductivity, eno_ns_surfref, frq_mhz, radio_climate, pol, pctTime, pctLoc, pctConf)
Parameters

  • ModVar (int) – Mode of variability. 0 - [Single] pctConf is “Time/Situation/Location”, pctTime, pctLoc not used. 1 - [ Individual] pctTime is “Situation/Location”, pctConf is “Confidence”, pctLoc not used. 2 - [Mobile] pctTime is “Time/Locations (Reliability)”, pctConf is “Confidence”, pctLoc not used. 3 - [Broadcast] pctTime is “Time”, pctLoc is “Location”, pctConf is “Confidence”.

  • deltaH (float) – Terrain irregularity parameter [m]. This is the interdecile range of terrain elevation between Tx/Rx sites. For average terrain use 90. Other recommendations are: Flat (or smooth water): 0; Plains: 30; Hills: 90; Mountains: 200; Rugged Mountains: 500.

  • tht_m (float) – Transmitter antenna height [m]. The height is determined by the center of the radiating element above ground.

  • rht_m (float) – Receiver antenna height [m]. The height is determined by the center of the radiating element above ground.

  • dist_km (float) – Distance between antennas [km]. The model is valid for distances in the range 1km - 2000km.

  • TSiteCriteria (int) – Tx Antenna deployment sitting criteria: 0 - random, 1 - careful, 2 - very careful

  • RSiteCriteria (int) – Rx Antenna deployment sitting criteria: 0 - random, 1 - careful, 2 - very careful

  • eps_dielect (float) – Relative Permittivity of the earth

  • sgm_conductivity (float) – Conductivity of the earth

  • eno_ns_surfref (float) – Surface Refractivity [250 - 400 N-units]

  • frq_mhz (float) – Carrier frequency [MHz]; The model is valid for frequencies in the range 20MHz - 20GHz

  • radio_climate (int) – 1-Equatorial, 2-Continental Subtropical, 3-Maritime Tropical, 4-Desert, 5-Continental Temperate, 6-Maritime Temperate, Over Land, 7-Maritime Temperate, Over Sea

  • pol (int) – Antenna polarization; 0-Horizontal, 1-Vertical. It is assumed that both antenna elements have the same polarization.

  • pctTime (float) – Time Reliability Percentage [.01 to .99]

  • pctLoc (float) – Location Reliability Percentage [.01 to .99]

  • pctConf (float) – Confidence Interval Percentage [.01 to .99]

Returns

RF propogation loss [dB]

Return type

dbloss (float)