source: ammosreader/doc/ammosreader/AmmosIFReader.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: 1.5 KB
Line 
1Module ammosreader.AmmosIFReader
2================================
3I provide a specialized Ammos Reader for IF data.
4
5Classes
6-------
7
8`AmmosIFReader(file_name)`
9: I read the IF data embedded in an R&S AMMOS recording.
10
11 I am the standard constructor for Ammos Readers.
12
13 Additional information about the file can be added as key/value pairs in tags
14
15 :param file_name: The file to read Ammos data from
16 :type file_name: str
17
18 ### Ancestors (in MRO)
19
20 * ammosreader.AbstractAmmosReader.AbstractAmmosReader
21 * abc.ABC
22
23 ### Methods
24
25 `payload(self)`
26 :
27
28 `read_next_global_frame_body(self, data_header_length)`
29 : I return the next global frame body read from current position in file.
30
31 :param data_header_length: the length of the data header
32 :type data_header_length: int
33
34 `read_next_global_frame_body_data_header(self)`
35 :
36
37 `read_next_global_frame_body_extended_data_header(self)`
38 : I return the next global frame body extended data header from current position in file.
39
40 :return: the next Ammos Extended IF data header or None if incomplete
41 :rtype: AmmosExtendedIFDataHeader
42
43 `read_next_if_data_body(self, number_of_data_blocks, data_length)`
44 : I return the next data body read from current position in file.
45
46 :param number_of_data_blocks: the number of data blocks inside the body
47 :type number_of_data_blocks: int
48
49 :param data_length: the length of the raw data inside a single block
50 :type data_length: int
Note: See TracBrowser for help on using the repository browser.