ostk.astrodynamics.conjunction.message.ccsds.CDM¶

class CDM(self: ostk.astrodynamics.conjunction.message.ccsds.CDM, header: ostk::astrodynamics::conjunction::message::ccsds::CDM::Header, relative_metadata: ostk::astrodynamics::conjunction::message::ccsds::CDM::RelativeMetadata, objects_metadata_array: list[ostk::astrodynamics::conjunction::message::ccsds::CDM::Metadata], objects_data_array: list[ostk::astrodynamics::conjunction::message::ccsds::CDM::Data])¶

Bases: pybind11_object

Conjunction Data Message.

Ref: https://public.ccsds.org/Pubs/508x0b1e2s.pdf

Constructor.

Parameters:

header (CDM::Header) -- The CDM header.
relative_metadata (CDM::RelativeMetadata) -- The relative metadata.
objects_metadata_array (Array<CDM::Metadata>) -- The objects metadata array.
objects_data_array (Array<CDM::Data>) -- The objects data array.

Methods

`dictionary`	Get the CDM dictionary.
`get_ccsds_cdm_version`	Get the CCSDS CDM version.
`get_collision_probability`	Get the collision probability.
`get_collision_probability_method`	Get the collision probability method.
`get_creation_instant`	Get the creation instant.
`get_data_array`	Get the objects data array.
`get_header`	Get the CDM header.
`get_message_for`	Get the message for.
`get_message_id`	Get the message ID.
`get_metadata_array`	Get the objects metadata array.
`get_miss_distance`	Get the miss distance.
`get_object_data_at`	Get the object data at the specified index.
`get_object_metadata_at`	Get the object metadata at the specified index.
`get_originator`	Get the originator.
`get_relative_metadata`	Get the relative metadata.
`get_relative_position`	Get the relative position.
`get_relative_velocity`	Get the relative velocity.
`get_time_of_closest_approach`	Get the time of closest approach.
`is_defined`	Check if the CDM is defined.
`load`	Load a CDM from a file.
`object_type_from_string`	Get the object type from a string.
`parse`	Parse a CDM from a string.
`undefined`	Get an undefined CDM.

class Data( self: ostk.astrodynamics.conjunction.message.ccsds.CDM.Data, time_last_observation_start: ostk.physics.time.Instant, time_last_observation_end: ostk.physics.time.Instant, recommended_od_span: ostk.physics.time.Duration, actual_od_span: ostk.physics.time.Duration, observations_available: ostk.core.type.Integer, observations_used: ostk.core.type.Integer, tracks_available: ostk.core.type.Integer, tracks_used: ostk.core.type.Integer, residuals_accepted: ostk.core.type.Real, weighted_rms: ostk.core.type.Real, area_pc: ostk.core.type.Real, area_drag: ostk.core.type.Real, area_srp: ostk.core.type.Real, mass: ostk.physics.unit.Mass, cd_area_over_mass: ostk.core.type.Real, cr_area_over_mass: ostk.core.type.Real, thrust_acceleration: ostk.core.type.Real, sedr: ostk.core.type.Real, state: ostk.astrodynamics.trajectory.State = undefined, covariance_matrix: numpy.ndarray[numpy.float64[m, n]] = array([[0., 0., 0., 0., 0., 0., 0., 0., 0.], [0., 0., 0., 0., 0., 0., 0., 0., 0.], [0., 0., 0., 0., 0., 0., 0., 0., 0.], [0., 0., 0., 0., 0., 0., 0., 0., 0.], [0., 0., 0., 0., 0., 0., 0., 0., 0.], [0., 0., 0., 0., 0., 0., 0., 0., 0.], [0., 0., 0., 0., 0., 0., 0., 0., 0.], [0., 0., 0., 0., 0., 0., 0., 0., 0.], [0., 0., 0., 0., 0., 0., 0., 0., 0.]]), )¶

Bases: pybind11_object

Conjunction Data Message data.

Ref: https://public.ccsds.org/Pubs/508x0b1e2s.pdf

Constructor.

Parameters:

time_last_observation_start (Instant) -- The time of the last observation start.
time_last_observation_end (Instant) -- The time of the last observation end.
recommended_od_span (Duration) -- The recommended OD span.
actual_od_span (Duration) -- The actual OD span.
observations_available (int) -- The number of observations available.
observations_used (int) -- The number of observations used.
tracks_available (int) -- The number of tracks available.
tracks_used (int) -- The number of tracks used.
residuals_accepted (float) -- The residuals accepted.
weighted_rms (float) -- The weighted RMS.
area_pc (float) -- The area PC.
area_drag (float) -- The area drag.
area_srp (float) -- The area SRP.
mass (Mass) -- The mass.
cd_area_over_mass (float) -- The CD area over mass.
cr_area_over_mass (float) -- The CR area over mass.
thrust_acceleration (float) -- The thrust acceleration.
sedr (float) -- The SEDR.
state (State) -- The state.
covariance_matrix (MatrixXd) -- The covariance matrix.

property actual_od_span¶: The actual OD span.

property area_drag¶: The area drag.

property area_pc¶: The area PC.

property area_srp¶: The area SRP.

property cd_area_over_mass¶: The CD area over mass.

property covariance_matrix¶: The covariance matrix.

property cr_area_over_mass¶: The CR area over mass.

property mass¶: The mass.

property observations_available¶: The number of observations available.

property observations_used¶: The number of observations used.

property recommended_od_span¶: The recommended OD span.

property residuals_accepted¶: The residuals accepted.

property sedr¶: The SEDR.

property state¶: The state.

property thrust_acceleration¶: The thrust acceleration.

property time_last_observation_end¶: The time of the last observation end.

property time_last_observation_start¶: The time of the last observation start.

property tracks_available¶: The number of tracks available.

property tracks_used¶: The number of tracks used.

property weighted_rms¶: The weighted RMS.

class Header( self: ostk.astrodynamics.conjunction.message.ccsds.CDM.Header, *, ccsds_cdm_version: ostk.core.type.String, comment: ostk.core.type.String = String.empty(), creation_date: ostk.physics.time.Instant, originator: ostk.core.type.String, message_for: ostk.core.type.String = String.empty(), message_id: ostk.core.type.String, )¶

Bases: pybind11_object

Conjunction Data Message header.

Ref: https://public.ccsds.org/Pubs/508x0b1e2s.pdf

Constructor.

Parameters:

ccsds_cdm_version (str) -- The CCSDS CDM version.
comment (str) -- The comment.
creation_date (Instant) -- The creation date.
originator (str) -- The originator.
message_for (str) -- The message for.
message_id (str) -- The message ID.

property ccsds_cdm_version¶: The CCSDS CDM version.

property comment¶: The comment.

property creation_date¶: The creation date.

property message_for¶: The message for.

property message_id¶: The message ID.

property originator¶: The originator.

class Metadata( self: ostk.astrodynamics.conjunction.message.ccsds.CDM.Metadata, *, comment: ostk.core.type.String = String.empty(), object: ostk.core.type.String, object_designator: ostk.core.type.Integer, catalog_name: ostk.core.type.String = String.empty(), object_name: ostk.core.type.String, international_designator: ostk.core.type.String, object_type: ostk.astrodynamics.conjunction.message.ccsds.CDM.ObjectType, operator_contact_position: ostk.core.type.String = String.empty(), operator_organization: ostk.core.type.String = String.empty(), operator_phone: ostk.core.type.String = String.empty(), operator_email: ostk.core.type.String = String.empty(), ephemeris_name: ostk.core.type.String, covariance_method: ostk.core.type.String, maneuverable: ostk.core.type.String, orbit_center: ostk.core.type.String = String.empty(), reference_frame: ostk.core.type.String, gravity_model: ostk.core.type.String = String.empty(), atmospheric_model: ostk.core.type.String = String.empty(), n_body_perturbations: ostk.core.type.String = String.empty(), solar_radiation_pressure: bool = False, earth_tides: bool = False, in_track_thrust: bool = False, )¶

Bases: pybind11_object

Conjunction Data Message metadata.

Ref: https://public.ccsds.org/Pubs/508x0b1e2s.pdf

Constructor.

Parameters:

comment (str) -- The comment.
object (str) -- The object.
object_designator (int) -- The object designator.
catalog_name (str) -- The catalog name.
object_name (str) -- The object name.
international_designator (str) -- The international designator.
object_type (ObjectType) -- The object type.
operator_contact_position (str) -- The operator contact position.
operator_organization (str) -- The operator organization.
operator_phone (str) -- The operator phone.
operator_email (str) -- The operator email.
ephemeris_name (str) -- The ephemeris name.
covariance_method (str) -- The covariance method.
maneuverable (str) -- The maneuverable.
orbit_center (str) -- The orbit center.
reference_frame (str) -- The reference frame.
gravity_model (str) -- The gravity model.
atmospheric_model (str) -- The atmospheric model.
n_body_perturbations (str) -- The n-body perturbations.
solar_radiation_pressure (bool) -- The solar radiation pressure.
earth_tides (bool) -- The earth tides.
in_track_thrust (bool) -- The in-track thrust.

property atmospheric_model¶: The atmospheric model.

property catalog_name¶: The catalog name.

property comment¶: The comment.

property covariance_method¶: The covariance method.

property earth_tides¶: The earth tides.

property ephemeris_name¶: The ephemeris name.

property gravity_model¶: The gravity model.

property in_track_thrust¶: The in-track thrust.

property international_designator¶: The international designator.

property maneuverable¶: The maneuverable.

property n_body_perturbations¶: The n-body perturbations.

property object¶: The object.

property object_designator¶: The object designator.

property object_name¶: The object name.

property object_type¶: The object type.

property operator_contact_position¶: The operator contact position.

property operator_email¶: The operator email.

property operator_organization¶: The operator organization.

property operator_phone¶: The operator phone.

property orbit_center¶: The orbit center.

property reference_frame¶: The reference frame.

property solar_radiation_pressure¶: The solar radiation pressure.

class ObjectType( self: ostk.astrodynamics.conjunction.message.ccsds.CDM.ObjectType, value: int, )¶

Bases: pybind11_object

Object type.

Members:

Payload : Payload

RocketBody : Rocket Body

Debris : Debris

Unknown : Unknown

Other : Other

property name¶

class RelativeMetadata( self: ostk.astrodynamics.conjunction.message.ccsds.CDM.RelativeMetadata, *, comment: ostk.core.type.String = String.empty(), time_of_closest_approach: ostk.physics.time.Instant, miss_distance: ostk.physics.unit.Length, relative_position: ostk.physics.coordinate.Position = Position.undefined(), relative_velocity: ostk.physics.coordinate.Velocity = Velocity.undefined(), start_screen_period: ostk.physics.time.Instant, end_screen_period: ostk.physics.time.Instant, screen_volume_frame: ostk.core.type.String = String.empty(), screen_volume_shape: ostk.core.type.String = String.empty(), screen_volume_x: ostk.core.type.Real = Real.undefined(), screen_volume_y: ostk.core.type.Real = Real.undefined(), screen_volume_z: ostk.core.type.Real = Real.undefined(), screen_entry_time: ostk.physics.time.Instant, screen_exit_time: ostk.physics.time.Instant, collision_probability: ostk.core.type.Real, collision_probability_method: ostk.core.type.String, )¶

Bases: pybind11_object

Relative metadata.

Ref: https://public.ccsds.org/Pubs/508x0b1e2s.pdf

Constructor.

Parameters:

comment (str) -- The comment.
time_of_closest_approach (Instant) -- The time of closest approach.
miss_distance (Distance) -- The miss distance.
relative_position (Position) -- The relative position.
relative_velocity (Velocity) -- The relative velocity.
start_screen_period (Instant) -- The start screen period.
end_screen_period (Instant) -- The end screen period.
screen_volume_frame (str) -- The screen volume frame.
screen_volume_shape (str) -- The screen volume shape.
screen_volume_x (float) -- The screen volume x.
screen_volume_y (float) -- The screen volume y.
screen_volume_z (float) -- The screen volume z.
screen_entry_time (Instant) -- The screen entry time.
screen_exit_time (Instant) -- The screen exit time.
collision_probability (Probability) -- The collision probability.
collision_probability_method (str) -- The collision probability method.

property collision_probability¶: The collision probability.

property collision_probability_method¶: The collision probability method.

property comment¶: The comment.

property end_screen_period¶: The end screen period.

property miss_distance¶: The miss distance.

property relative_position¶: The relative position.

property relative_velocity¶: The relative velocity.

property screen_entry_time¶: The screen entry time.

property screen_exit_time¶: The screen exit time.

property screen_volume_frame¶: The screen volume frame.

property screen_volume_shape¶: The screen volume shape.

property screen_volume_x¶: The screen volume x.

property screen_volume_y¶: The screen volume y.

property screen_volume_z¶: The screen volume z.

property start_screen_period¶: The start screen period.

property time_of_closest_approach¶: The time of closest approach.

static dictionary( dictionary: ostk.core.container.Dictionary, ) → ostk.astrodynamics.conjunction.message.ccsds.CDM¶

Get the CDM dictionary.

Returns:: The CDM dictionary.
Return type:: Dictionary

get_ccsds_cdm_version( self: ostk.astrodynamics.conjunction.message.ccsds.CDM, ) → ostk.core.type.String¶

Get the CCSDS CDM version.

Returns:: The CCSDS CDM version.
Return type:: str

get_collision_probability( self: ostk.astrodynamics.conjunction.message.ccsds.CDM, ) → ostk.core.type.Real¶

Get the collision probability.

Returns:: The collision probability.
Return type:: Probability

get_collision_probability_method( self: ostk.astrodynamics.conjunction.message.ccsds.CDM, ) → ostk.core.type.String¶

Get the collision probability method.

Returns:: The collision probability method.
Return type:: str

get_creation_instant( self: ostk.astrodynamics.conjunction.message.ccsds.CDM, ) → ostk.physics.time.Instant¶

Get the creation instant.

Returns:: The creation instant.
Return type:: Instant

get_data_array( self: ostk.astrodynamics.conjunction.message.ccsds.CDM, ) → list[ostk::astrodynamics::conjunction::message::ccsds::CDM::Data]¶

Get the objects data array.

Returns:: The objects data array.
Return type:: Array<CDM::Data>

get_header( self: ostk.astrodynamics.conjunction.message.ccsds.CDM, ) → ostk::astrodynamics::conjunction::message::ccsds::CDM::Header¶

Get the CDM header.

Returns:: The CDM header.
Return type:: CDM::Header

get_message_for( self: ostk.astrodynamics.conjunction.message.ccsds.CDM, ) → ostk.core.type.String¶

Get the message for.

Returns:: The message for.
Return type:: str

get_message_id( self: ostk.astrodynamics.conjunction.message.ccsds.CDM, ) → ostk.core.type.String¶

Get the message ID.

Returns:: The message ID.
Return type:: str

get_metadata_array( self: ostk.astrodynamics.conjunction.message.ccsds.CDM, ) → list[ostk::astrodynamics::conjunction::message::ccsds::CDM::Metadata]¶

Get the objects metadata array.

Returns:: The objects metadata array.
Return type:: Array<CDM::Metadata>

get_miss_distance( self: ostk.astrodynamics.conjunction.message.ccsds.CDM, ) → ostk.physics.unit.Length¶

Get the miss distance.

Returns:: The miss distance.
Return type:: Distance

get_object_data_at( self: ostk.astrodynamics.conjunction.message.ccsds.CDM, index: int, ) → ostk::astrodynamics::conjunction::message::ccsds::CDM::Data¶

Get the object data at the specified index.

Parameters:: index (int) -- The index of the object data.
Returns:: The object data.
Return type:: Data

get_object_metadata_at( self: ostk.astrodynamics.conjunction.message.ccsds.CDM, index: int, ) → ostk::astrodynamics::conjunction::message::ccsds::CDM::Metadata¶

Get the object metadata at the specified index.

Parameters:: index (int) -- The index of the object metadata.
Returns:: The object metadata.
Return type:: CDM::Metadata

get_originator( self: ostk.astrodynamics.conjunction.message.ccsds.CDM, ) → ostk.core.type.String¶

Get the originator.

Returns:: The originator.
Return type:: str

get_relative_metadata( self: ostk.astrodynamics.conjunction.message.ccsds.CDM, ) → ostk::astrodynamics::conjunction::message::ccsds::CDM::RelativeMetadata¶