Filling Out the Geometry Vector Classes

From The SBN Wiki
Jump to navigation Jump to search

The Geometry Discipline dictionary contains definitions for five generic vectors that provide common terminology for components and related attributes. The generic vectors described are derived from the same parent classes as the specific vectors, like Vector_Cartesian_Position_Earth_To_Target, but also require that you specify the origin ("observer") and end point ("target"). The descriptions below indicate which attributes are omitted from specific vectors derived from the same parents as these generic vectors.

<Vector_Cartesian_Position_Generic>

This vector indicates a position as (x,y,z) components in a specified Cartesian coordinate system.

<x_position>

REQUIRED

X component of the position. You must specify a unit of length for this attribute.

<y_position>

REQUIRED

Y component of the position. You must specify a unit of length for this attribute.

<z_position>

REQUIRED

Z component of the position. You must specify a unit of length for this attribute.

<light_time_correction_applied>

REQUIRED

This attribute indicates which light time corrections, if any, have been applied in deriving this position. It must have one of these values:

  • Received_Light_Time
  • Received_Light_Time_Stellar_Abb
  • Transmitted_Light_Time
  • Transmitted_Light_Time_Stellar_Abb
  • None

This attribute is nillable, so if you don't know the light time correction status of your data and are unable to determine it, you may indicate that by defining this attribute thus:

<light_time_correction_applied xsi:nil="true" nilReason="unknown">


<Coordinate_System_Identification>

OPTIONAL

This class contains all the attributes needed to define a coordinate system: reference frame, origin, coordinate type, and a reference time. Use it if there is no Coordinate_System_Identification class in the containing Geometry_Orbiter class, or if the coordinate system for this vector is different from the system identified at that higher level.

Note that whether you are specifying a Coordinate_System_Identification inside a vector (specific or generic), or letting a vector default to a coordinate system Identified at a higher level, the value of the <coordinate_system_type> attribute of the Coordinate_System_Identification must be consistent with the vector type. You may not, for example, define (explicitly or by default) a <Vector_Cartesian_Position_Spacecraft_To_Target> as having a coordinate_system_type of Planetocentric.

Note: This is not currently enforced by the schema. Type carefully.

This class is filled out identically to the Coordinate_System_Identification class described on the Filling out the Geometry_Orbiter Class page.

<Observer_Identification>

REQUIRED  —  This subclass is omitted in specific vector classes.

This class identifies the starting point of a vector. Apart from the enclosing tag names (Observer_Identification rather than Central_Body_Identification), this class is filled out identically to the Central_Body_Identification class described on the Filling out the Geometry_Orbiter Class page.

<Target_Identification>

REQUIRED  —  This subclass is omitted in specific vector classes.

This class identifies the end point of a vector. Apart from the enclosing tag names (Target_Identification rather than Central_Body_Identification), this class is filled out identically to the Central_Body_Identification class described on the Filling out the Geometry_Orbiter Class page.


<Vector_Cartesian_Velocity_Generic>

This vector indicates a velocity as (x,y,z) components in a specified Cartesian coordinate system.

<x_velocity>

REQUIRED

X component of the velocity. You must specify a unit of velocity (e.g., "km/s") for this attribute.

<y_velocity>

REQUIRED

Y component of the velocity. You must specify a unit of velocity for this attribute.

<z_velocity>

REQUIRED

Z component of the velocity. You must specify a unit of velocity for this attribute.

<light_time_correction_applied>

REQUIRED

This attribute indicates which light time corrections, if any, have been applied in deriving this position. It must have one of these values:

  • Received_Light_Time
  • Received_Light_Time_Stellar_Abb
  • Transmitted_Light_Time
  • Transmitted_Light_Time_Stellar_Abb
  • None

This attribute is nillable, so if you don't know the light time correction status of your data and are unable to determine it, you may indicate that by defining this attribute thus:

<light_time_correction_applied xsi:nil="true" nilReason="unknown">


<Coordinate_System_Identification>

OPTIONAL

This class contains all the attributes needed to define a coordinate system: reference frame, origin, coordinate type, and a reference time. Use it if there is no Coordinate_System_Identification class in the containing Geometry_Orbiter class, or if the coordinate system for this vector is different from the system identified at that higher level.

Note that whether you are specifying a Coordinate_System_Identification inside a vector (specific or generic), or letting a vector default to a coordinate system Identified at a higher level, the value of the <coordinate_system_type> attribute of the Coordinate_System_Identification must be consistent with the vector type. You may not, for example, define (explicitly or by default) a <Vector_Cartesian_Velocity_Target_Relative_To_Spacecraft> as having a coordinate_system_type of Planetocentric.

Note: This is not currently enforced by the schema. Type carefully.

This class is filled out identically to the Coordinate_System_Identification class that is described on the Filling out the Geometry_Orbiter Class page.

<Observer_Identification>

REQUIRED  —  This subclass is omitted in specific vector classes.

This class identifies the starting point of a vector. Apart from the enclosing tag names (Observer_Identification rather than Central_Body_Identification), this class is filled out identically to the Central_Body_Identification class described on the Filling out the Geometry_Orbiter Class page.

<Target_Identification>

REQUIRED  —  This subclass is omitted in specific vector classes.

This class identifies the end point of a vector. Apart from the enclosing tag names (Target_Identification rather than Central_Body_Identification), this class is filled out identically to the Central_Body_Identification class described on the Filling out the Geometry_Orbiter Class page.


<Vector_Cartesian_Acceleration_Generic>

This vector indicates an acceleration as (x,y,z) components in a specified Cartesian coordinate system.

<x_acceleration>

REQUIRED

X component of the acceleration. You must specify a unit of acceleration (e.g., "km/s**2") for this attribute.

<y_acceleration>

REQUIRED

Y component of the acceleration. You must specify a unit of acceleration for this attribute.

<z_acceleration>

REQUIRED

Z component of the acceleration. You must specify a unit of acceleration for this attribute.

<light_time_correction_applied>

REQUIRED

This attribute indicates which light time corrections, if any, have been applied in deriving this position. It must have one of these values:

  • Received_Light_Time
  • Received_Light_Time_Stellar_Abb
  • Transmitted_Light_Time
  • Transmitted_Light_Time_Stellar_Abb
  • None

This attribute is nillable, so if you don't know the light time correction status of your data and are unable to determine it, you may indicate that by defining this attribute thus:

<light_time_correction_applied xsi:nil="true" nilReason="unknown">


<Coordinate_System_Identification>

OPTIONAL

This class contains all the attributes needed to define a coordinate system: reference frame, origin, coordinate type, and a reference time. Use it if there is no Coordinate_System_Identification class in the containing Geometry_Orbiter class, or if the coordinate system for this vector is different from the system identified at that higher level.

Note that whether you are specifying a Coordinate_System_Identification inside a vector (specific or generic), or letting a vector default to a coordinate system Identified at a higher level, the value of the <coordinate_system_type> attribute of the Coordinate_System_Identification must be consistent with the vector type. You may not, for example, define (explicitly or by default) a <Vector_Cartesian_Position_Spacecraft_To_Target> as having a coordinate_system_type of Planetocentric.

Note: This is not currently enforced by the schema. Type carefully.

This class is filled out identically to the Coordinate_System_Identification class that is described on the Filling out the Geometry_Orbiter Class page.

<Observer_Identification>

REQUIRED  —  This subclass is omitted in specific vector classes.

This class identifies the starting point of a vector. Apart from the enclosing tag names (Observer_Identification rather than Central_Body_Identification), this class is filled out identically to the Central_Body_Identification class described on the Filling out the Geometry_Orbiter Class page.

<Target_Identification>

REQUIRED  —  This subclass is omitted in specific vector classes.

This class identifies the end point of a vector. Apart from the enclosing tag names (Target_Identification rather than Central_Body_Identification), this class is filled out identically to the Central_Body_Identification class described on the Filling out the Geometry_Orbiter Class page.


<Vector_Planetocentric_Position_Generic>

This vector indicates a position as planetocentric coordinates (radius, longitude, and latitude).

<radius_position>

REQUIRED

Radial component of the position. You must specify a unit of length (e.g., "km") for this attribute.

<longitude_position>

REQUIRED

Longitudinal component of the position, in the range 0-360°. You must specify a unit of angle (e.g., "deg") for this attribute.

<latitude_position>

REQUIRED

Latitudinal component of the position. You must specify a unit of angle (e.g., "deg") for this attribute.

<light_time_correction_applied>

REQUIRED

This attribute indicates which light time corrections, if any, have been applied in deriving this position. It must have one of these values:

  • Received_Light_Time
  • Received_Light_Time_Stellar_Abb
  • Transmitted_Light_Time
  • Transmitted_Light_Time_Stellar_Abb
  • None

This attribute is nillable, so if you don't know the light time correction status of your data and are unable to determine it, you may indicate that by defining this attribute thus:

<light_time_correction_applied xsi:nil="true" nilReason="unknown">


<Coordinate_System_Identification>

OPTIONAL

This class contains all the attributes needed to define a coordinate system: reference frame, origin, coordinate type, and a reference time. Use it if there is no Coordinate_System_Identification class in the containing Geometry_Orbiter class, or if the coordinate system for this vector is different from the system identified at that higher level.

Note that whether you are specifying a Coordinate_System_Identification inside a vector (specific or generic), or letting a vector default to a coordinate system Identified at a higher level, the value of the <coordinate_system_type> attribute of the Coordinate_System_Identification must be consistent with the vector type. You may not, for example, define (explicitly or by default) a <Vector_Cartesian_Position_Spacecraft_To_Target> as having a coordinate_system_type of Planetocentric.

Note: This is not currently enforced by the schema. Type carefully.

This class is filled out identically to the Coordinate_System_Identification class that is described on the Filling out the Geometry_Orbiter Class page.

<Observer_Identification>

REQUIRED  —  This subclass is omitted in specific vector classes.

This class identifies the starting point of a vector. Apart from the enclosing tag names (Observer_Identification rather than Central_Body_Identification), this class is filled out identically to the <Central_Body_Identification> class described on the Filling out the Geometry_Orbiter Class page.

<Target_Identification>

REQUIRED  —  This subclass is omitted in specific vector classes.

This class identifies the end point of a vector. Apart from the enclosing tag names (Target_Identification rather than Central_Body_Identification), this class is filled out identically to the Central_Body_Identification class described on the Filling out the Geometry_Orbiter Class page.


<Vector_Planetocentric_Velocity_Generic>

This vector indicates a velocity as planetocentric coordinates (radial, longitudinal, and latitudinal).

<radial_velocity>

REQUIRED

Radial component of the velocity. You must specify a unit of linear velocity (e.g., "km/s") for this attribute.

<longitude_velocity>

REQUIRED

Longitudinal component of the velocity. You must specify a unit of angular velocity (e.g., "deg/s") for this attribute.

<latitude_velocity>

REQUIRED

Latitudinal component of the velocity. You must specify a unit of angular velocity (e.g., "deg/day") for this attribute.

<light_time_correction_applied>

REQUIRED

This attribute indicates which light time corrections, if any, have been applied in deriving this position. It must have one of these values:

  • Received_Light_Time
  • Received_Light_Time_Stellar_Abb
  • Transmitted_Light_Time
  • Transmitted_Light_Time_Stellar_Abb
  • None

This attribute is nillable, so if you don't know the light time correction status of your data and are unable to determine it, you may indicate that by defining this attribute thus:

<light_time_correction_applied xsi:nil="true" nilReason="unknown">


<Coordinate_System_Identification>

OPTIONAL

This class contains all the attributes needed to define a coordinate system: reference frame, origin, coordinate type, and a reference time. Use it if there is no Coordinate_System_Identification class in the containing Geometry_Orbiter class, or if the coordinate system for this vector is different from the system identified at that higher level.

Note that whether you are specifying a Coordinate_System_Identification inside a vector (specific or generic), or letting a vector default to a coordinate system Identified at a higher level, the value of the <coordinate_system_type> attribute of the Coordinate_System_Identification must be consistent with the vector type. You may not, for example, define (explicitly or by default) a <Vector_Cartesian_Position_Spacecraft_To_Target> as having a coordinate_system_type of Planetocentric.

Note: This is not currently enforced by the schema. Type carefully.

This class is filled out identically to the Coordinate_System_Identification class that is described on the Filling out the Geometry_Orbiter Class page.

<Observer_Identification>

REQUIRED  —  This subclass is omitted in specific vector classes.

This class identifies the starting point of a vector. Apart from the enclosing tag names (Observer_Identification rather than Central_Body_Identification), this class is filled out identically to the Central_Body_Identification class described on the Filling out the Geometry_Orbiter Class page.

<Target_Identification>

REQUIRED  —  This subclass is omitted in specific vector classes.

This class identifies the end point of a vector. Apart from the enclosing tag names (Target_Identification rather than Central_Body_Identification), this class is filled out identically to the Central_Body_Identification class described on the Filling out the Geometry_Orbiter Class page.