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

From The SBN Wiki
Jump to navigation Jump to search
(Creation - Safety Save)
(Update for 1.3.0.0 Geometry release)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
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.
+
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.
  
== <Position_Vector_Cartesian_Generic> ==
+
== <Vector_Cartesian_Position_Generic> ==
  
 
This vector indicates a position as (x,y,z) components in a specified Cartesian coordinate system.   
 
This vector indicates a position as (x,y,z) components in a specified Cartesian coordinate system.   
Line 40: Line 40:
 
|}
 
|}
  
=== <Coordinate_System> ===
+
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:
 +
<center><code>&lt;light_time_correction_applied xsi:nil="true" nilReason="unknown"&gt;</code></center>
  
''OPTIONAL''
 
  
This class contains all the attributes needed to define a coordinate system: reference frame, origin, coordinate type, and a reference time.
+
=== <Coordinate_System_Identification> ===
  
{| class="wikitable" style="background-color: yellow"
+
''OPTIONAL''
|
 
'''''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> ====
+
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.
 
 
''REQUIRED''
 
 
 
This indicates the type of components comprising the vector. It must be one of the following values:
 
 
 
{|
 
| valign="top" |
 
:::* Azimuth-Elevation
 
:::* Cartesian
 
| valign="top" |
 
:::* Planetocentric
 
:::* Planetodetic
 
| valign="top" |
 
:::* Planetographic
 
:::* Spherical
 
|}
 
  
Your ''coordinate_system_type'' must be consistent with the general vector type.  You may not, for example, define ''&lt;Spacecraft_To_Target_Position_Vector_Cartesian&gt;'' as having a ''coordinate_system_type'' of '''Planetocentric'''.
+
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 ''&lt;coordinate_system_type&gt;'' attribute of the ''Coordinate_System_Identification'' '''''must''''' be consistent with the vector type.  You may not, for example, define (explicitly or by default) a ''&lt;Vector_Cartesian_Position_Spacecraft_To_Target&gt;'' as having a ''coordinate_system_type'' of '''Planetocentric'''.
  
 
{| class="wikitable" style="background-color: yellow"
 
{| class="wikitable" style="background-color: yellow"
Line 76: Line 57:
 
|}
 
|}
  
==== <coordinate_system_time> ====
+
This class is filled out identically to the ''[[Filling_out_the_Geometry_Orbiter_Class#.3CCoordinate_System_Identification.3E|Coordinate_System_Identification]]'' class described on the [[Filling_out_the_Geometry_Orbiter_Class|Filling out the Geometry_Orbiter Class]] page.
 
 
''REQUIRED''
 
 
 
This attribute defines the instantiation time for the coordinate system.  This must be given in the standard "''YYYY-MM-DD'''''T'''''hh:mm:ss.sss''" format.  Include the '''Z''' zone indicator if this is a UTC time.
 
 
 
{| class="wikitable" style="background-color: yellow"
 
|
 
'''''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''
 
 
 
{| class="wikitable" style="background-color: yellow"
 
|
 
''Waiting on SPICE changes''
 
|}
 
 
 
==== <Reference_Frame_Identification> ====
 
 
 
''REQUIRED''
 
 
 
{| class="wikitable" style="background-color: yellow"
 
|
 
''Waiting on SPICE changes''
 
|}
 
  
 
=== <Observer_Identification> ===
 
=== <Observer_Identification> ===
Line 109: Line 63:
 
''REQUIRED'' &nbsp;&mdash;&nbsp; ''This subclass is omitted in specific vector classes.''
 
''REQUIRED'' &nbsp;&mdash;&nbsp; ''This subclass is omitted in specific vector classes.''
  
{| class="wikitable" style="background-color: yellow"
+
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 ''[[Filling_out_the_Geometry_Orbiter_Class#.3CCentral_Body_Identification.3E|Central_Body_Identification]]'' class described on the [[Filling_out_the_Geometry_Orbiter_Class|Filling out the Geometry_Orbiter Class]] page.
|  
 
''Waiting on SPICE changes''
 
|}
 
  
 
=== <Target_Identification> ===
 
=== <Target_Identification> ===
Line 118: Line 69:
 
''REQUIRED'' &nbsp;&mdash;&nbsp; ''This subclass is omitted in specific vector classes.''
 
''REQUIRED'' &nbsp;&mdash;&nbsp; ''This subclass is omitted in specific vector classes.''
  
{| class="wikitable" style="background-color: yellow"
+
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 ''[[Filling_out_the_Geometry_Orbiter_Class#.3CCentral_Body_Identification.3E|Central_Body_Identification]]'' class described on the [[Filling_out_the_Geometry_Orbiter_Class|Filling out the Geometry_Orbiter Class]] page.
|  
 
''Waiting on SPICE changes''
 
|}
 
  
  
== <Velocity_Vector_Cartesian_Generic> ==
+
== <Vector_Cartesian_Velocity_Generic> ==
  
 
This vector indicates a velocity as (x,y,z) components in a specified Cartesian coordinate system.   
 
This vector indicates a velocity as (x,y,z) components in a specified Cartesian coordinate system.   
Line 150: Line 98:
 
''REQUIRED''
 
''REQUIRED''
  
This attribute indicates which light time corrections, if any, have been applied in deriving this velocity.  It must have one of these values:
+
This attribute indicates which light time corrections, if any, have been applied in deriving this position.  It must have one of these values:
  
 
{|
 
{|
Line 163: Line 111:
 
|}
 
|}
  
=== <Coordinate_System> ===
+
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:
 +
<center><code>&lt;light_time_correction_applied xsi:nil="true" nilReason="unknown"&gt;</code></center>
 +
 
 +
 
 +
=== <Coordinate_System_Identification> ===
  
 
''OPTIONAL''
 
''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>]]''
+
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 ''&lt;coordinate_system_type&gt;'' attribute of the ''Coordinate_System_Identification'' '''''must''''' be consistent with the vector type. You may not, for example, define (explicitly or by default) a ''&lt;Vector_Cartesian_Velocity_Target_Relative_To_Spacecraft&gt;'' as having a ''coordinate_system_type'' of '''Planetocentric'''.
  
 
{| class="wikitable" style="background-color: yellow"
 
{| 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.''
+
'''Note:''' This is not currently enforced by the schema.  Type carefully.
 
|}
 
|}
 +
 +
This class is filled out identically to the ''[[Filling_out_the_Geometry_Orbiter_Class#.3CCoordinate_System_Identification.3E|Coordinate_System_Identification]]'' class that is described on the [[Filling_out_the_Geometry_Orbiter_Class|Filling out the Geometry_Orbiter Class]] page.
  
 
=== <Observer_Identification> ===
 
=== <Observer_Identification> ===
Line 178: Line 134:
 
''REQUIRED'' &nbsp;&mdash;&nbsp; ''This subclass is omitted in specific vector classes.''
 
''REQUIRED'' &nbsp;&mdash;&nbsp; ''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 ''[[Filling_out_the_Geometry_Orbiter_Class#.3CCentral_Body_Identification.3E|Central_Body_Identification]]'' class described on the [[Filling_out_the_Geometry_Orbiter_Class|Filling out the Geometry_Orbiter Class]] page.
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> ===
 
=== <Target_Identification> ===
Line 190: Line 140:
 
''REQUIRED'' &nbsp;&mdash;&nbsp; ''This subclass is omitted 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 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 ''[[Filling_out_the_Geometry_Orbiter_Class#.3CCentral_Body_Identification.3E|Central_Body_Identification]]'' class described on the [[Filling_out_the_Geometry_Orbiter_Class|Filling out the Geometry_Orbiter Class]] page.
 
 
{| class="wikitable" style="background-color: yellow"
 
|
 
''Waiting on SPICE changes''
 
|}
 
  
  
== <Acceleration_Vector_Cartesian_Generic> ==
+
== <Vector_Cartesian_Acceleration_Generic> ==
  
 
This vector indicates an acceleration as (x,y,z) components in a specified Cartesian coordinate system.   
 
This vector indicates an acceleration as (x,y,z) components in a specified Cartesian coordinate system.   
Line 224: Line 169:
 
''REQUIRED''
 
''REQUIRED''
  
This attribute indicates which light time corrections, if any, have been applied in deriving this acceleration.  It must have one of these values:
+
This attribute indicates which light time corrections, if any, have been applied in deriving this position.  It must have one of these values:
  
 
{|
 
{|
Line 237: Line 182:
 
|}
 
|}
  
=== <Coordinate_System> ===
+
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:
 +
<center><code>&lt;light_time_correction_applied xsi:nil="true" nilReason="unknown"&gt;</code></center>
 +
 
 +
 
 +
=== <Coordinate_System_Identification> ===
  
 
''OPTIONAL''
 
''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>]]''
+
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 ''&lt;coordinate_system_type&gt;'' attribute of the ''Coordinate_System_Identification'' '''''must''''' be consistent with the vector type. You may not, for example, define (explicitly or by default) a ''&lt;Vector_Cartesian_Position_Spacecraft_To_Target&gt;'' as having a ''coordinate_system_type'' of '''Planetocentric'''.
  
 
{| class="wikitable" style="background-color: yellow"
 
{| 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.''
+
'''Note:''' This is not currently enforced by the schema.  Type carefully.
 
|}
 
|}
 +
 +
This class is filled out identically to the ''[[Filling_out_the_Geometry_Orbiter_Class#.3CCoordinate_System_Identification.3E|Coordinate_System_Identification]]'' class that is described on the [[Filling_out_the_Geometry_Orbiter_Class|Filling out the Geometry_Orbiter Class]] page.
  
 
=== <Observer_Identification> ===
 
=== <Observer_Identification> ===
Line 252: Line 205:
 
''REQUIRED'' &nbsp;&mdash;&nbsp; ''This subclass is omitted in specific vector classes.''
 
''REQUIRED'' &nbsp;&mdash;&nbsp; ''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 ''[[Filling_out_the_Geometry_Orbiter_Class#.3CCentral_Body_Identification.3E|Central_Body_Identification]]'' class described on the [[Filling_out_the_Geometry_Orbiter_Class|Filling out the Geometry_Orbiter Class]] page.
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> ===
 
=== <Target_Identification> ===
Line 264: Line 211:
 
''REQUIRED'' &nbsp;&mdash;&nbsp; ''This subclass is omitted 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 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 ''[[Filling_out_the_Geometry_Orbiter_Class#.3CCentral_Body_Identification.3E|Central_Body_Identification]]'' class described on the [[Filling_out_the_Geometry_Orbiter_Class|Filling out the Geometry_Orbiter Class]] page.
  
{| class="wikitable" style="background-color: yellow"
 
|
 
''Waiting on SPICE changes''
 
|}
 
  
 
+
== <Vector_Planetocentric_Position_Generic> ==
 
 
== <Position_Vector_Planetocentric_Generic> ==
 
  
 
This vector indicates a position as planetocentric coordinates (radius, longitude, and latitude).
 
This vector indicates a position as planetocentric coordinates (radius, longitude, and latitude).
Line 287: Line 228:
 
''REQUIRED''
 
''REQUIRED''
  
Longitudinal component of the position.  You must specify a unit of angle (e.g., "deg") for this attribute.
+
Longitudinal component of the position, in the range 0-360&deg;.  You must specify a unit of angle (e.g., "deg") for this attribute.
  
 
=== <latitude_position> ===
 
=== <latitude_position> ===
Line 299: Line 240:
 
''REQUIRED''
 
''REQUIRED''
  
This attribute indicates which light time corrections, if any, have been applied in deriving this velocity.  It must have one of these values:
+
This attribute indicates which light time corrections, if any, have been applied in deriving this position.  It must have one of these values:
  
 
{|
 
{|
Line 312: Line 253:
 
|}
 
|}
  
=== <Coordinate_System> ===
+
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:
 +
<center><code>&lt;light_time_correction_applied xsi:nil="true" nilReason="unknown"&gt;</code></center>
 +
 
 +
 
 +
=== <Coordinate_System_Identification> ===
  
 
''OPTIONAL''
 
''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>]]''
+
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 ''&lt;coordinate_system_type&gt;'' attribute of the ''Coordinate_System_Identification'' '''''must''''' be consistent with the vector type. You may not, for example, define (explicitly or by default) a ''&lt;Vector_Cartesian_Position_Spacecraft_To_Target&gt;'' as having a ''coordinate_system_type'' of '''Planetocentric'''.
  
 
{| class="wikitable" style="background-color: yellow"
 
{| 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.''
+
'''Note:''' This is not currently enforced by the schema.  Type carefully.
 
|}
 
|}
 +
 +
This class is filled out identically to the ''[[Filling_out_the_Geometry_Orbiter_Class#.3CCoordinate_System_Identification.3E|Coordinate_System_Identification]]'' class that is described on the [[Filling_out_the_Geometry_Orbiter_Class|Filling out the Geometry_Orbiter Class]] page.
  
 
=== <Observer_Identification> ===
 
=== <Observer_Identification> ===
Line 327: Line 276:
 
''REQUIRED'' &nbsp;&mdash;&nbsp; ''This subclass is omitted in specific vector classes.''
 
''REQUIRED'' &nbsp;&mdash;&nbsp; ''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 [[Filling_out_the_Geometry_Orbiter_Class#.3CCentral_Body_Identification.3E|<Central_Body_Identification>]] class described on the [[Filling_out_the_Geometry_Orbiter_Class|Filling out the Geometry_Orbiter Class]] page.
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> ===
 
=== <Target_Identification> ===
Line 339: Line 282:
 
''REQUIRED'' &nbsp;&mdash;&nbsp; ''This subclass is omitted 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 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 ''[[Filling_out_the_Geometry_Orbiter_Class#.3CCentral_Body_Identification.3E|Central_Body_Identification]]'' class described on the [[Filling_out_the_Geometry_Orbiter_Class|Filling out the Geometry_Orbiter Class]] page.
 
 
{| class="wikitable" style="background-color: yellow"
 
|
 
''Waiting on SPICE changes''
 
|}
 
  
  
== <Velocity_Vector_Planetocentric_Generic> ==
+
== <Vector_Planetocentric_Velocity_Generic> ==
  
 
This vector indicates a velocity as planetocentric coordinates (radial, longitudinal, and latitudinal).
 
This vector indicates a velocity as planetocentric coordinates (radial, longitudinal, and latitudinal).
Line 373: Line 311:
 
''REQUIRED''
 
''REQUIRED''
  
This attribute indicates which light time corrections, if any, have been applied in deriving this velocity.  It must have one of these values:
+
This attribute indicates which light time corrections, if any, have been applied in deriving this position.  It must have one of these values:
  
 
{|
 
{|
Line 386: Line 324:
 
|}
 
|}
  
=== <Coordinate_System> ===
+
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:
 +
<center><code>&lt;light_time_correction_applied xsi:nil="true" nilReason="unknown"&gt;</code></center>
 +
 
 +
 
 +
=== <Coordinate_System_Identification> ===
  
 
''OPTIONAL''
 
''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>]]''
+
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 ''&lt;coordinate_system_type&gt;'' attribute of the ''Coordinate_System_Identification'' '''''must''''' be consistent with the vector type. You may not, for example, define (explicitly or by default) a ''&lt;Vector_Cartesian_Position_Spacecraft_To_Target&gt;'' as having a ''coordinate_system_type'' of '''Planetocentric'''.
  
 
{| class="wikitable" style="background-color: yellow"
 
{| 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.''
+
'''Note:''' This is not currently enforced by the schema.  Type carefully.
 
|}
 
|}
 +
 +
This class is filled out identically to the ''[[Filling_out_the_Geometry_Orbiter_Class#.3CCoordinate_System_Identification.3E|Coordinate_System_Identification]]'' class that is described on the [[Filling_out_the_Geometry_Orbiter_Class|Filling out the Geometry_Orbiter Class]] page.
  
 
=== <Observer_Identification> ===
 
=== <Observer_Identification> ===
Line 401: Line 347:
 
''REQUIRED'' &nbsp;&mdash;&nbsp; ''This subclass is omitted in specific vector classes.''
 
''REQUIRED'' &nbsp;&mdash;&nbsp; ''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 ''[[Filling_out_the_Geometry_Orbiter_Class#.3CCentral_Body_Identification.3E|Central_Body_Identification]]'' class described on the [[Filling_out_the_Geometry_Orbiter_Class|Filling out the Geometry_Orbiter Class]] page.
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> ===
 
=== <Target_Identification> ===
Line 413: Line 353:
 
''REQUIRED'' &nbsp;&mdash;&nbsp; ''This subclass is omitted 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 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 ''[[Filling_out_the_Geometry_Orbiter_Class#.3CCentral_Body_Identification.3E|Central_Body_Identification]]'' class described on the [[Filling_out_the_Geometry_Orbiter_Class|Filling out the Geometry_Orbiter Class]] page.
 
 
{| class="wikitable" style="background-color: yellow"
 
|
 
''Waiting on SPICE changes''
 
|}
 

Latest revision as of 14:29, 31 March 2016

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.