Difference between revisions of "Filling Out the Geometry Vector Classes"

From The SBN Wiki
Jump to navigation Jump to search
(Creation - Safety Save)
(Creation - Safety Save)
Line 67: Line 67:
 
:::* Planetographic
 
:::* Planetographic
 
:::* Spherical
 
:::* Spherical
 +
|}
 +
 +
Your ''coordinate_system_type'' must be consistent with the general vector type.  You may not, for example, define ''<Spacecraft_To_Target_Position_Vector_Cartesian>'' as having a ''coordinate_system_type'' of '''Planetocentric'''.
 +
 +
{| class="wikitable" style="background-color: yellow"
 +
|
 +
'''Note:''' This is not currently enforced by the schema.  Type carefully.
 
|}
 
|}
  
Line 100: Line 107:
 
=== <Observer_Identification> ===
 
=== <Observer_Identification> ===
  
''REQUIRED'' &nbsp;&mdash;&nbsp; ''This subclass is optional in specific vector classes.''
+
''REQUIRED'' &nbsp;&mdash;&nbsp; ''This subclass is omitted in specific vector classes.''
  
 
{| class="wikitable" style="background-color: yellow"
 
{| class="wikitable" style="background-color: yellow"
Line 109: Line 116:
 
=== <Target_Identification> ===
 
=== <Target_Identification> ===
  
''REQUIRED'' &nbsp;&mdash;&nbsp; ''This subclass is optional in specific vector classes.''
+
''REQUIRED'' &nbsp;&mdash;&nbsp; ''This subclass is omitted in specific vector classes.''
  
 
{| class="wikitable" style="background-color: yellow"
 
{| class="wikitable" style="background-color: yellow"
Line 115: Line 122:
 
''Waiting on SPICE changes''
 
''Waiting on SPICE changes''
 
|}
 
|}
 
 
  
  
Line 145: Line 150:
 
''REQUIRED''
 
''REQUIRED''
  
This attribute indicates which light time corrections, if any, have been applied in deriving this position.  It must have one of these values:
+
This attribute indicates which light time corrections, if any, have been applied in deriving this velocity.  It must have one of these values:
 +
 
 +
{|
 +
| valign="top" |
 +
::* Received_Light_Time
 +
::* Received_Light_Time_Stellar_Abb
 +
| valign="top" |
 +
::* Transmitted_Light_Time
 +
::* Transmitted_Light_Time_Stellar_Abb
 +
| valign="top" |
 +
::* None
 +
|}
 +
 
 +
=== <Coordinate_System> ===
 +
 
 +
''OPTIONAL''
 +
 
 +
This class contains all the attributes needed to define a coordinate system: reference frame, origin, coordinate type, and a reference time.  It is filled out identically to the class of the same name in ''[[#.3CCoordinate_System.3E|<Position_Vector_Cartesian_Generic>]]''
 +
 
 +
{| class="wikitable" style="background-color: yellow"
 +
|
 +
'''''Note'':''' ''If you are submitting data to the SBN and you are defining a generic vector, you '''must''' indicate the coordinate system of the vector.''
 +
|}
 +
 
 +
=== <Observer_Identification> ===
 +
 
 +
''REQUIRED'' &nbsp;&mdash;&nbsp; ''This subclass is omitted in specific vector classes.''
 +
 
 +
 
 +
This class is filled out identically to the class of the same name in ''[[#.3CObserver_Identification.3E|<Position_Vector_Cartesian_Generic>]]''.
 +
 
 +
{| class="wikitable" style="background-color: yellow"
 +
|
 +
''Waiting on SPICE changes''
 +
|}
 +
 
 +
=== <Target_Identification> ===
 +
 
 +
''REQUIRED'' &nbsp;&mdash;&nbsp; ''This subclass is omitted in specific vector classes.''
 +
 
 +
This class is filled out identically to the class of the same name in ''[[#.3CTarget_Identification.3E|<Position_Vector_Cartesian_Generic>]]''.
 +
 
 +
{| class="wikitable" style="background-color: yellow"
 +
|
 +
''Waiting on SPICE changes''
 +
|}
 +
 
 +
 
 +
== <Acceleration_Vector_Cartesian_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 acceleration.  It must have one of these values:
 +
 
 +
{|
 +
| valign="top" |
 +
::* Received_Light_Time
 +
::* Received_Light_Time_Stellar_Abb
 +
| valign="top" |
 +
::* Transmitted_Light_Time
 +
::* Transmitted_Light_Time_Stellar_Abb
 +
| valign="top" |
 +
::* None
 +
|}
 +
 
 +
=== <Coordinate_System> ===
 +
 
 +
''OPTIONAL''
 +
 
 +
This class contains all the attributes needed to define a coordinate system: reference frame, origin, coordinate type, and a reference time.  It is filled out identically to the class of the same name in ''[[#.3CCoordinate_System.3E|<Position_Vector_Cartesian_Generic>]]''
 +
 
 +
{| class="wikitable" style="background-color: yellow"
 +
|
 +
'''''Note'':''' ''If you are submitting data to the SBN and you are defining a generic vector, you '''must''' indicate the coordinate system of the vector.''
 +
|}
 +
 
 +
=== <Observer_Identification> ===
 +
 
 +
''REQUIRED'' &nbsp;&mdash;&nbsp; ''This subclass is omitted in specific vector classes.''
 +
 
 +
 
 +
This class is filled out identically to the class of the same name in ''[[#.3CObserver_Identification.3E|<Position_Vector_Cartesian_Generic>]]''.
 +
 
 +
{| class="wikitable" style="background-color: yellow"
 +
|
 +
''Waiting on SPICE changes''
 +
|}
 +
 
 +
=== <Target_Identification> ===
 +
 
 +
''REQUIRED'' &nbsp;&mdash;&nbsp; ''This subclass is omitted in specific vector classes.''
 +
 
 +
This class is filled out identically to the class of the same name in ''[[#.3CTarget_Identification.3E|<Position_Vector_Cartesian_Generic>]]''.
 +
 
 +
{| class="wikitable" style="background-color: yellow"
 +
|
 +
''Waiting on SPICE changes''
 +
|}
 +
 
 +
 
 +
 
 +
== <Position_Vector_Planetocentric_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.  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 velocity.  It must have one of these values:
 +
 
 +
{|
 +
| valign="top" |
 +
::* Received_Light_Time
 +
::* Received_Light_Time_Stellar_Abb
 +
| valign="top" |
 +
::* Transmitted_Light_Time
 +
::* Transmitted_Light_Time_Stellar_Abb
 +
| valign="top" |
 +
::* None
 +
|}
 +
 
 +
=== <Coordinate_System> ===
 +
 
 +
''OPTIONAL''
 +
 
 +
This class contains all the attributes needed to define a coordinate system: reference frame, origin, coordinate type, and a reference time.  It is filled out identically to the class of the same name in ''[[#.3CCoordinate_System.3E|<Position_Vector_Cartesian_Generic>]]''
 +
 
 +
{| class="wikitable" style="background-color: yellow"
 +
|
 +
'''''Note'':''' ''If you are submitting data to the SBN and you are defining a generic vector, you '''must''' indicate the coordinate system of the vector.''
 +
|}
 +
 
 +
=== <Observer_Identification> ===
 +
 
 +
''REQUIRED'' &nbsp;&mdash;&nbsp; ''This subclass is omitted in specific vector classes.''
 +
 
 +
 
 +
This class is filled out identically to the class of the same name in ''[[#.3CObserver_Identification.3E|<Position_Vector_Cartesian_Generic>]]''.
 +
 
 +
{| class="wikitable" style="background-color: yellow"
 +
|
 +
''Waiting on SPICE changes''
 +
|}
 +
 
 +
=== <Target_Identification> ===
 +
 
 +
''REQUIRED'' &nbsp;&mdash;&nbsp; ''This subclass is omitted in specific vector classes.''
 +
 
 +
This class is filled out identically to the class of the same name in ''[[#.3CTarget_Identification.3E|<Position_Vector_Cartesian_Generic>]]''.
 +
 
 +
{| class="wikitable" style="background-color: yellow"
 +
|
 +
''Waiting on SPICE changes''
 +
|}
 +
 
 +
 
 +
== <Velocity_Vector_Planetocentric_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 velocity.  It must have one of these values:
  
 
{|
 
{|
Line 171: Line 399:
 
=== <Observer_Identification> ===
 
=== <Observer_Identification> ===
  
''REQUIRED'' &nbsp;&mdash;&nbsp; ''This subclass is optional in specific vector classes.''
+
''REQUIRED'' &nbsp;&mdash;&nbsp; ''This subclass is omitted in specific vector classes.''
  
  
Line 183: Line 411:
 
=== <Target_Identification> ===
 
=== <Target_Identification> ===
  
''REQUIRED'' &nbsp;&mdash;&nbsp; ''This subclass is optional in specific vector classes.''
+
''REQUIRED'' &nbsp;&mdash;&nbsp; ''This subclass is omitted in specific vector classes.''
  
 
This class is filled out identically to the class of the same name in ''[[#.3CTarget_Identification.3E|<Position_Vector_Cartesian_Generic>]]''.
 
This class is filled out identically to the class of the same name in ''[[#.3CTarget_Identification.3E|<Position_Vector_Cartesian_Generic>]]''.

Revision as of 13:46, 15 May 2015

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 Earth_To_Spacecraft_Position_Vector_Cartesian, 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.

<Position_Vector_Cartesian_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

<Coordinate_System>

OPTIONAL

This class contains all the attributes needed to define a coordinate system: reference frame, origin, coordinate type, and a reference time.

Note: If you are submitting data to the SBN and you are defining a generic vector, you must indicate the coordinate system of the vector.

<coordinate_system_type>

REQUIRED

This indicates the type of components comprising the vector. It must be one of the following values:

  • Azimuth-Elevation
  • Cartesian
  • Planetocentric
  • Planetodetic
  • Planetographic
  • Spherical

Your coordinate_system_type must be consistent with the general vector type. You may not, for example, define <Spacecraft_To_Target_Position_Vector_Cartesian> as having a coordinate_system_type of Planetocentric.

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

<coordinate_system_time>

REQUIRED

This attribute defines the instantiation time for the coordinate system. This must be given in the standard "YYYY-MM-DDThh:mm:ss.sss" format. Include the Z zone indicator if this is a UTC time.

Note: If you are submitting data to the SBN that makes use of this class, you must provide a UTC time for this attribute.

<Coordinate_System_Origin_Identification>

REQUIRED

Waiting on SPICE changes

<Reference_Frame_Identification>

REQUIRED

Waiting on SPICE changes

<Observer_Identification>

REQUIRED  —  This subclass is omitted in specific vector classes.

Waiting on SPICE changes

<Target_Identification>

REQUIRED  —  This subclass is omitted in specific vector classes.

Waiting on SPICE changes


<Velocity_Vector_Cartesian_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 velocity. It must have one of these values:

  • Received_Light_Time
  • Received_Light_Time_Stellar_Abb
  • Transmitted_Light_Time
  • Transmitted_Light_Time_Stellar_Abb
  • None

<Coordinate_System>

OPTIONAL

This class contains all the attributes needed to define a coordinate system: reference frame, origin, coordinate type, and a reference time. It is filled out identically to the class of the same name in <Position_Vector_Cartesian_Generic>

Note: If you are submitting data to the SBN and you are defining a generic vector, you must indicate the coordinate system of the vector.

<Observer_Identification>

REQUIRED  —  This subclass is omitted in specific vector classes.


This class is filled out identically to the class of the same name in <Position_Vector_Cartesian_Generic>.

Waiting on SPICE changes

<Target_Identification>

REQUIRED  —  This subclass is omitted in specific vector classes.

This class is filled out identically to the class of the same name in <Position_Vector_Cartesian_Generic>.

Waiting on SPICE changes


<Acceleration_Vector_Cartesian_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 acceleration. It must have one of these values:

  • Received_Light_Time
  • Received_Light_Time_Stellar_Abb
  • Transmitted_Light_Time
  • Transmitted_Light_Time_Stellar_Abb
  • None

<Coordinate_System>

OPTIONAL

This class contains all the attributes needed to define a coordinate system: reference frame, origin, coordinate type, and a reference time. It is filled out identically to the class of the same name in <Position_Vector_Cartesian_Generic>

Note: If you are submitting data to the SBN and you are defining a generic vector, you must indicate the coordinate system of the vector.

<Observer_Identification>

REQUIRED  —  This subclass is omitted in specific vector classes.


This class is filled out identically to the class of the same name in <Position_Vector_Cartesian_Generic>.

Waiting on SPICE changes

<Target_Identification>

REQUIRED  —  This subclass is omitted in specific vector classes.

This class is filled out identically to the class of the same name in <Position_Vector_Cartesian_Generic>.

Waiting on SPICE changes


<Position_Vector_Planetocentric_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. 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 velocity. It must have one of these values:

  • Received_Light_Time
  • Received_Light_Time_Stellar_Abb
  • Transmitted_Light_Time
  • Transmitted_Light_Time_Stellar_Abb
  • None

<Coordinate_System>

OPTIONAL

This class contains all the attributes needed to define a coordinate system: reference frame, origin, coordinate type, and a reference time. It is filled out identically to the class of the same name in <Position_Vector_Cartesian_Generic>

Note: If you are submitting data to the SBN and you are defining a generic vector, you must indicate the coordinate system of the vector.

<Observer_Identification>

REQUIRED  —  This subclass is omitted in specific vector classes.


This class is filled out identically to the class of the same name in <Position_Vector_Cartesian_Generic>.

Waiting on SPICE changes

<Target_Identification>

REQUIRED  —  This subclass is omitted in specific vector classes.

This class is filled out identically to the class of the same name in <Position_Vector_Cartesian_Generic>.

Waiting on SPICE changes


<Velocity_Vector_Planetocentric_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 velocity. It must have one of these values:

  • Received_Light_Time
  • Received_Light_Time_Stellar_Abb
  • Transmitted_Light_Time
  • Transmitted_Light_Time_Stellar_Abb
  • None

<Coordinate_System>

OPTIONAL

This class contains all the attributes needed to define a coordinate system: reference frame, origin, coordinate type, and a reference time. It is filled out identically to the class of the same name in <Position_Vector_Cartesian_Generic>

Note: If you are submitting data to the SBN and you are defining a generic vector, you must indicate the coordinate system of the vector.

<Observer_Identification>

REQUIRED  —  This subclass is omitted in specific vector classes.


This class is filled out identically to the class of the same name in <Position_Vector_Cartesian_Generic>.

Waiting on SPICE changes

<Target_Identification>

REQUIRED  —  This subclass is omitted in specific vector classes.

This class is filled out identically to the class of the same name in <Position_Vector_Cartesian_Generic>.

Waiting on SPICE changes