Tracking Data Message (TDM)¶

class ccsds_ndm.Tdm(*, header, body)¶

Tracking Data Message (TDM).

The TDM specifies a standard message format for use in exchanging spacecraft tracking data between space agencies. Such exchanges are used for distributing tracking data output from routine interagency cross-supports.

Tracking data includes data types such as: - Doppler - Transmit/Received frequencies - Range - Angles - Delta-DOR - Media correction (ionosphere, troposphere) - Meteorological data

Parameters:

header (TdmHeader) – The message header. (Mandatory)
body (TdmBody) – The message body containing segments. (Mandatory)

body¶

The message body.

Type:: TdmBody

static from_file(path, format=None)¶

Create a TDM message from a file.

Parameters:

path (str) – Path to the input file.
format (str, optional) – Format (‘kvn’ or ‘xml’). Auto-detected if None. (Optional)

Returns:

The parsed TDM object.

Return type:

Tdm

static from_str(data, format=None)¶

Create a TDM message from a string.

Parameters:

data (str) – Input string/content.
format (str, optional) – Format (‘kvn’ or ‘xml’). Auto-detected if None. (Optional)

Returns:

The parsed TDM object.

Return type:

Tdm

header¶

Tracking Data Message (TDM).

Tracking data includes data types such as: - Doppler - Transmit/Received frequencies - Range - Angles - Delta-DOR - Media correction (ionosphere, troposphere) - Meteorological data

Type:: TdmHeader

id¶

The message identifier.

Type:: Optional[str]

segments¶

Shortcut to access segments directly from the body.

Type:: list[TdmSegment]

to_file(path, format, validate=True)¶

Write to file.

Parameters:

path (str) – Output file path.
format (str) – Output format (‘kvn’ or ‘xml’).
validate (bool, optional) – Whether to validate the message before writing (default: True).

to_str(format, validate=True)¶

Serialize to string.

Parameters:

format (str) – Output format (‘kvn’ or ‘xml’).
validate (bool, optional) – Whether to validate the message before writing (default: True).

Returns:

The serialized string.

Return type:

str

validate(strict=True)¶

Validate the message against CCSDS rules.

Parameters:: strict (bool, optional) – If True (default), raises ValueError on the first error found. If False, returns a list of validation error messages (or None if valid).

version¶

The message version.

Type:: str

class ccsds_ndm.TdmHeader(*, originator, creation_date, message_id=None, comment=None)¶

Represents the tdmHeader complex type.

Parameters:

originator (str) – Creating agency. Value should be an entry from the SANA Organizations Registry. (Mandatory)
creation_date (str) – Data creation date/time in UTC. (Mandatory)
message_id (str, optional) – ID that uniquely identifies a message from a given originator. (Optional)
comment (list[str], optional) – Comments. (Optional)

comment¶

Comments (allowed in the TDM Header only immediately after the TDM version number). (See 4.5 for formatting rules.)

Examples: This is a comment

Type:: list[str]

creation_date¶

Data creation date/time in UTC. (For format specification, see 4.3.9.)

Examples: 2001-11-06T11:17:33, 2002-204T15:56:23.4, 2006-001T00:00:00Z

Type:: str

message_id¶

ID that uniquely identifies a message from a given originator. The format and content of the message identifier value are at the discretion of the originator.

Examples: 201113719185

Type:: Optional[str]

originator¶

Creating agency. Value should be an entry from the ‘Abbreviation’ column in the SANA Organizations Registry, <https://sanaregistry.org/r/organizations/organizations.html> (reference [11]).

Examples: CNES, ESA, GSFC, DLR, JPL, JAXA

Type:: str

class ccsds_ndm.TdmBody(*, segments)¶

The TDM Body consists of one or more TDM Segments.

Parameters:: segments (list[TdmSegment]) – List of data segments.

segments¶

List of TDM segments.

Each segment consists of a Metadata Section and a Data Section.

Type:: list[TdmSegment]

class ccsds_ndm.TdmSegment(*, metadata, data)¶

Represents a single segment of a TDM.

A segment consists of a Metadata Section (configuration details) and a Data Section (tracking data records).

Parameters:

metadata (TdmMetadata) – Segment metadata. (Mandatory)
data (TdmData) – Segment data. (Mandatory)

data¶

Data section for this TDM segment.

Type:: TdmData

metadata¶

Metadata section for this TDM segment.

Type:: TdmMetadata

class ccsds_ndm.TdmMetadata(*, participant_1, time_system=None, track_id=None, data_types=None, start_time=None, stop_time=None, participant_2=None, participant_3=None, participant_4=None, participant_5=None, mode=None, path=None, path_1=None, path_2=None, transmit_band=None, receive_band=None, turnaround_numerator=None, turnaround_denominator=None, timetag_ref=None, integration_interval=None, integration_ref=None, freq_offset=None, range_mode=None, range_modulus=None, range_units=None, angle_type=None, reference_frame=None, interpolation=None, interpolation_degree=None, doppler_count_bias=None, doppler_count_scale=None, doppler_count_rollover=None, transmit_delay_1=None, transmit_delay_2=None, transmit_delay_3=None, transmit_delay_4=None, transmit_delay_5=None, receive_delay_1=None, receive_delay_2=None, receive_delay_3=None, receive_delay_4=None, receive_delay_5=None, data_quality=None, correction_angle_1=None, correction_angle_2=None, correction_doppler=None, correction_mag=None, correction_range=None, correction_rcs=None, correction_receive=None, correction_transmit=None, correction_aberration_yearly=None, correction_aberration_diurnal=None, corrections_applied=None, ephemeris_name_1=None, ephemeris_name_2=None, ephemeris_name_3=None, ephemeris_name_4=None, ephemeris_name_5=None, comment=None)¶

Represents the Metadata Section of a TDM Segment.

Contains configuration details applicable to the Data Section in the same TDM Segment.

Mandatory Parameters¶

time_systemstr: Time system used for timetags (e.g., “UTC”, “TAI”).
participant_1str: First participant in the tracking session.

Optional Parameters¶

Many optional parameters are available to describe the tracking configuration, signal path, frequencies, and corrections. See CCSDS TDM Blue Book for full details.

angle_type¶

The ANGLE_TYPE keyword shall indicate the type of antenna geometry represented in the angle data (ANGLE_1 and ANGLE_2 keywords).

Examples: AZEL, RADEC, XEYN, XSYE

Type:: Optional[str]

comment¶

Comments.

Type:: list[str]

correction_aberration_diurnal¶

A correction value for diurnal aberration.