FixedLength¶
- class ccsdspy.FixedLength(fields)[source]¶
Bases:
_BasePacket
Define a fixed length packet to decode binary data.
Fixed length packets correspond to packets that are the same length and layout every time. A common example of this is housekeeping or status messages.
- Parameters:
- fieldslist of
PacketField
orPacketArray
Layout of packet fields contained in the definition.
- fieldslist of
- Raises:
- ValueError
one or more of the arguments are invalid
Methods Summary
load
(file[, include_primary_header, ...])Decode a file-like object containing a sequence of these packets.
Methods Documentation
- load(file, include_primary_header=False, reset_file_obj=False)[source]¶
Decode a file-like object containing a sequence of these packets.
- Parameters:
- filestr
Path to file on the local file system, or file-like object
- include_primary_headerbool
If True, provides the primary header in the output. The names of the fields are:
CCSDS_VERSION_NUMBER
,CCSDS_PACKET_TYPE
,CCSDS_SECONDARY_FLAG
,CCSDS_SEQUENCE_FLAG
,CCSDS_APID
,CCSDS_SEQUENCE_COUNT
, andCCSDS_PACKET_LENGTH
- reset_file_objbool
If True, leave the file object, when it is file buffer, where it was before load is called. Otherwise, (default), leave the file stream pos after the read packets. Does not apply when file is a string.
- Returns:
- field_arraysdict, string to NumPy array
dictionary mapping field names to NumPy arrays, with key order matching the order of fields in the packet.
- Warns:
- UserWarning
If the ccsds sequence count is not in order
- UserWarning
If the ccsds sequence count is missing packets
- UserWarning
If there are more than one APID