source: ammosreader/doc/ammosreader/PDW.md@ 6914dbb

AmmosSource guix
Last change on this file since 6914dbb was 6914dbb, checked in by Enrico Schwass <ennoausberlin@…>, 2 years ago

remove DEBUG parameter and update package to new logger mechanism
  • Property mode set to 100644
File size: 3.4 KB
Line 
1Module ammosreader.PDW
2======================
3I store the information of a single PDW block.
4
5Classes
6-------
7
8`PDW(time_of_arrival, pdw_format_identifier, center_frequency, is_valid, is_pulse, level_unit, signal_start_missing, signal_end_missing, pulse_width, frequency_shift_or_bandwidth, pulse_level_or_pulse_field_strength, region_of_interest, azimuth_confidence, modulation, sector, polarity, df_quality, elevation, azimuth, channel)`
9: I store information from a single ppdw data block.
10
11 .. automethod:: __init__
12
13 I return an instance of an Pulse Data word.
14
15 :param time_of_arrival: nanoseconds since 1970-01-01 00:00:00
16 :type time_of_arrival: Integer
17 :param pdw_format: format code
18 :type pdw_format: Integer
19 :param center_frequency: center frequency in KHz
20 :type center_frequency: Integer
21 :param is_valid: flag to mark if pdw data body is valid
22 :type is_valid: Boolean
23 :param is_pulse: flag to mark if pdw data body contains a pulse or a continuous wave signal
24 :type is_pulse: Boolean
25 :param level_unit: 0 means dBµV - 1 means dBµV/m
26 :type level_unit: Integer
27 :param signal_start_missing: signal started before time of arrival
28 :type signal_start_missing: Boolean
29 :param signal_end_missing: signal stops after time of arrival
30 :type signal_end_missing: Boolean
31 :param pulse_width: pulse width in nanoseconds - Zero if no valid pulse detected
32 :type pulse_width: Integer
33 :param frequency_shift_or_bandwidth: Value in KHz - Value set to 1048575 means Unknown
34 :type frequency_shift_or_bandwidth: Integer
35 :param pulse_level_or_pulse_field_strength: Pulse level or Pulse Field Strength depending on level_unit \
36 (-200.0...200.0) in 0.1 steps / minus 204.8 means no valid level detected
37 :type pulse_level_or_pulse_field_strength: Float
38 :param region_of_interest: Marks if signal is from region of interest
39 :type region_of_interest: Boolean
40 :param azimuth_confidence: degree in steps of 0.1 (0.0-6.2) / 6.3 means confidence unknown
41 :type azimuth_confidence: Float
42 :param modulation: type of modulation (e.g. PSK-2, PSK-4, FM etc.)
43 :type modulation: String
44 :param sector: reference antenna sector (0-15)
45 :type sector: Integer
46 :param polarity: Horizontal, Vertical, Clockwise, Counter clockwise
47 :type polarity: String
48 :param df_quality: Direction finding quality in percent (0-100) - Zero means unknown
49 :type df_quality: Integer
50 :param elevation: elevation of incoming signal (from -90 to 90 degree) in steps of 0.1 degree \
51 minus 102.4 means unknown
52 :type elevation: Float
53 :param azimuth: azimuth of incoming signal (from 0 to 359.9 degree) in steps of 0.1 degree \
54 plus 409.5 means unknown
55 :type azimuth: Float
56 :param channel: detecting channel (0-16) - Zero means unknown
57 :type channel: Integer
58 :return: An instance of class PDW with attributes set according to the data of a data body
59 :rtype: PDW
60
61 ### Static methods
62
63 `from_bytes(byte_string)`
64 : I create an instance of class PDW from data body (8 * 32 bits).
65
66 :param byte_string: a byte string containing a single data body read from a ppdw file
67 :type byte_string: byte string
68
69 :return: an instance of class PDW with attributes set according to the data of a data body
70 :rtype: PDW
71
72 ### Methods
73
74 `is_valid(self)`
75 :
76
77 `to_json(self)`
78 :
Note: See TracBrowser for help on using the repository browser.