Tool: encode_ldp
Description
This tool takes arbitrary data and encodes it into a single
Swift large data product.
Option Summary
| Option | Argument Type | Default Value |
|---|
| -apid |
Integer |
1344 |
| -checksum |
Boolean |
true |
| -delta_time |
Real |
0.05 |
| -extra_header_size |
Integer |
0 |
| -infile |
String |
- |
| -nobs |
Integer |
1 |
| -ntarget |
Integer |
0 |
| -outfile |
String |
- |
| -product |
Integer |
0 |
| -sequence |
Integer |
0 |
| -size |
Integer |
940 |
| -time |
Real |
0. |
Only the initial unique characters of each option are
significant. Each option must be followed by an argument
of the given type. Boolean "true" and "false" are indicated
with "y" and "n" respectively. A boolean option without a
value is assumed to be "true".
For filename arguments, "-" means either stdin or stdout
as appropriate.
Each option is described in detail below.
Parameters
- apid Integer (default = 1344)
- This is the APID to be used in all the packets in decimal.
The XRT will use 1344 for all it's LDPs. The BAT will (probably) use
299 for real-time engineering data,
481 for recorded engineering data,
527 for burst data, and
528 for survey data.
- checksum Boolean (default = true)
- Should each LDP packet include a checksum? Checksums are optional,
but both the BAT and XRT have decided to use them.
- delta_time Real (default = 0.05)
- The interval in seconds between the secondary header times of
consecutive packets. In reality these times will not increment so regularly
but this program assumes they do for simplicity.
- extra_header_size Integer (default = 0)
- The Header of an LDP contains a standard part followed
by a non-standard part. This program generates the standard part and then
assumes that the first "extra_header_size" bytes of the input file make
up the non-standard header.
- infile String (default = -)
- The data to be encoded in the LDP are taken from this file.
- nobs Integer (default = 1)
- The observation counter. This currently must fit in a one byte
unsigned integer. The current plan is for this counter to start at 1.
- ntarget Integer (default = 0)
- The target ID number This currently must fit in a three byte
unsigned integer.
- outfile String (default = -)
- File to contain the encoded LDP packets.
- product Integer (default = 0)
- The product number identifying this product. This must fit in
a two byte unsigned unteger.
- sequence Integer (default = 0)
- The sequence counter value to use in the CCSDS primary header
of the first packet.
- size Integer (default = 940)
- The maximum number of bytes to include in the data part of each packet.
Note that this does not include the headers, product number, page number,
or checksum.
- time Real (default = 0.)
- The time in seconds to use in the standard part of the LDP header as
well as in the secondary header of the first packet. In general these will
not be same, but this program assumes they are for simplicity.