pyitm package

Submodules

pyitm.itm module

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)

pyitm.itm.ITMVersion()
exception pyitm.itm.InputError(expression, message)

Bases: Exception

Custom Exception raised for errors in the input.

expression -- input expression in which the error occurred
message -- explanation of the error
class pyitm.itm.PropType

Bases: object

Class to model the prop_type struct

aref

reference attenuation. This is calculated in lrprop

Type

float

dist

Distance between terminals

Type

float

hg

Heights of the antennas above the ground [Tx, Rx]

Type

list

wn

Wave number of the radio frequency

Type

float

dh

Terrain irregularity parameter

Type

float

ens

Surface Refractivity

Type

float

gme

Effective curvature of the earth

Type

float

zgndreal

Surface transfer impedance (real)

Type

float

zgndimag

Surface transfer impedance (imag)

Type

float

he

Effect antenna heights [Tx, Rx]

Type

list

dl

Horizon distances [Tx, Rx]

Type

list

the

Horizon elevation angles [Tx, Rx]

Type

list

kwx

Error marker code

Type

int

mdp

Mode of the propagation model

Type

int

class pyitm.itm.PropaType

Bases: object

Class to model the propa_type struct. Note that this object is used for internal calculations only

dlsa
Type

float

dx
Type

float

ael
Type

float

ak1
Type

float

ak2
Type

float

aed
Type

float

emd
Type

float

aes
Type

float

ems
Type

float

dls
Type

list

dla
Type

float

tha
Type

float

class pyitm.itm.PropvType

Bases: object

Class to model propv_type struct

sgc

Standard deviation of the confidence

Type

float

lvar

Level to which coefficients in AVAR must be defined

Type

int

mdvar

Mode of variability

Type

int

klim

Climate code

Type

int

pyitm.itm.adiff(d, prop, propa)
Parameters
Returns

Return type

adiffv (float)

pyitm.itm.alos(d, prop, propa)
Parameters

  • d –

  • prop –

  • propa –

Returns

Return type

alosv (float)

pyitm.itm.area(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) –

    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. [0.5 - 3000]

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

  • 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] errnum (int): 0- No Error.

1- Warning: Some parameters are nearly out of range.

Results should be used with caution.

2- Note: Default parameters have been substituted for

impossible ones.

3- Warning: A combination of parameters is out of range.

Results are probably invalid.

Return type

dbloss (float)

pyitm.itm.ascat(d, prop, propa)
Parameters
Returns

Return type

ascatv (float)

pyitm.itm.avar(zzt, zzl, zzc, prop, propv)
Parameters

  • zzt (float) –

  • zzl (float) –

  • zzc (float) –

  • prop (PropType) –

  • propv (PropvType) –

Returns

Return type

avarv (float)

pyitm.itm.lrprop(d, prop, propa)
Parameters

  • d (float) – Distance between terminals in meters

  • prop (PropType) – PropType instance

  • propa (PropaType) – PropaType instance

Returns

None

pyitm.itm.qlra(kst, klimx, mdvarx, prop, propv)
Parameters

  • kst (list) – Siting criterion code for each terminal [Tx, Rx]

  • klimx (int) – Climate code

  • mdvarx (int) – Mode of variability

  • prop (PropType) – prop object

  • propv (PropvType) – propv object

Returns

None

pyitm.itm.qlrps(fmhz, zsys, en0, ipol, eps, sgm, prop)

Function to prepare parameters for area prediction mode. Prior to calling this function one should define HG, DH, WN, ENS, GME, ZGND in Prop object

Parameters

  • fmhz (float) – Frequency of signal in MHz

  • zsys (float) – Avg elevation above sea level of the system; if 0, en0 will be interpreted as ENS

  • en0 (float) – Minimum monthly mean surface refractivity reduced to sea level; if it is desired to introduce ENS instead, then set ZSYS=0.

  • ipol (int) – Antenna polarization; 0 - horizontal, 1 - vertical

  • eps (float) – Ground permitivity

  • sgm (float) – Ground conductance

  • prop (PropType) – Prop object

Returns

None

pyitm.util module

pyitm.util.abq_alos(r)
pyitm.util.ahd(td)
pyitm.util.aknfe(v2)
pyitm.util.curve(c1, c2, x1, x2, x3, de)
pyitm.util.deg2rad(d)
pyitm.util.fht(x, pk)
pyitm.util.fortran_dim(x, y)
pyitm.util.h0f(r, et)
pyitm.util.qerf(z)
pyitm.util.qerfi(q)

Module contents