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

From The SBN Wiki
Jump to navigation Jump to search
m (: Update for geom 1.2.1)
(Update for 1.3.0.0 Geometry release)
Line 1: Line 1:
 
The geometry dictionary is a ''discipline dictionary'', which means that its classes will appear in the ''<Discipline_Area>'' at the bottom of the ''<Observation_Area>'' in observational product labels (and in the ''<Context_Area>'', if appropriate, in non-observational products).  The classes in this dictionary define the observational geometry relevant to the data objects presented in the product.
 
The geometry dictionary is a ''discipline dictionary'', which means that its classes will appear in the ''<Discipline_Area>'' at the bottom of the ''<Observation_Area>'' in observational product labels (and in the ''<Context_Area>'', if appropriate, in non-observational products).  The classes in this dictionary define the observational geometry relevant to the data objects presented in the product.
  
''Last update: 26 January 2016, for Geometry dictionary version 1.2.0.0.''
+
''Begin update: 30 March 2016, for Geometry dictionary version 1.3.0.0.''
  
 
== <Geometry> ==
 
== <Geometry> ==
Line 7: Line 7:
 
''REQUIRED''
 
''REQUIRED''
  
This is the wrapper class that for the Geometry Dictionary.  It must be used whenever you want or need to include geometry information in a label. All of the subclasses are optional, but obviously you'll need to include at least one.  Practically speaking, any mission using NAIF software to calculate geometry should include the ''&lt;SPICE_Kernel_Files&gt;'' class; you'll likely need to include the ''&lt;Image_Display_Geometry&gt;'' class for anything image-like; and there's not much point in having a ''Geometry'' class without at least one of either ''&lt;Geometry_Orbiter&gt;'' or ''&lt;Geometry_Lander&gt;''.
+
This is the wrapper class that for the Geometry Dictionary.  It must be used whenever you want or need to include geometry information in a label. Any mission using NAIF software to calculate geometry should include the ''&lt;SPICE_Kernel_Files&gt;'' class; you'll likely need to include the ''&lt;Image_Display_Geometry&gt;'' class for anything image-like; and one of either ''&lt;Geometry_Orbiter&gt;'' or ''&lt;Geometry_Lander&gt;'' is required.
  
 
{| class="wikitable" style="background-color: yellow"
 
{| class="wikitable" style="background-color: yellow"
Line 36: Line 36:
 
''OPTIONAL''
 
''OPTIONAL''
  
This class provides geometric information relevant to a landed spacecraft, including rovers. You may repeat this class if appropriate.
+
This class provides geometric information relevant to a landed spacecraft, including rovers. One of either this class or ''Geometry_Orbiter'' is required; you may have both. You may also repeat this class if appropriate.
  
 
* [[Filling out the Geometry_Lander Class]]
 
* [[Filling out the Geometry_Lander Class]]
Line 44: Line 44:
 
''OPTIONAL''
 
''OPTIONAL''
  
This class provides detailed geometry (positions, orientations, velocities, and so on) appropriate for orbiting and fly-by spacecraft.  You may repeat this class if appropriate.
+
This class provides detailed geometry (positions, orientations, velocities, and so on) appropriate for orbiting and fly-by spacecraft.  One of this class or ''Geometry_Lander'' is required; you may have both. You may also repeat this class if appropriate.
  
 
* [[Filling out the Geometry_Orbiter Class]]
 
* [[Filling out the Geometry_Orbiter Class]]

Revision as of 13:00, 30 March 2016

The geometry dictionary is a discipline dictionary, which means that its classes will appear in the <Discipline_Area> at the bottom of the <Observation_Area> in observational product labels (and in the <Context_Area>, if appropriate, in non-observational products). The classes in this dictionary define the observational geometry relevant to the data objects presented in the product.

Begin update: 30 March 2016, for Geometry dictionary version 1.3.0.0.

<Geometry>

REQUIRED

This is the wrapper class that for the Geometry Dictionary. It must be used whenever you want or need to include geometry information in a label. Any mission using NAIF software to calculate geometry should include the <SPICE_Kernel_Files> class; you'll likely need to include the <Image_Display_Geometry> class for anything image-like; and one of either <Geometry_Orbiter> or <Geometry_Lander> is required.

Note: As of this writing, spacecraft-oriented flyby, orbiter, and lander geometry classes are provided in this dictionary. If you have other types of geometry to document in your labels, ask your PDS node consultant for the preferred method of recording this information.

These classes are necessarily fairly complex, so the descriptions have been broken into separate pages corresponding to the major subclasses. You may, if you need to, have more than one <Geometry> class in your label.

<SPICE_Kernel_Files>

OPTIONAL

This class is used to cite the SPICE kernel files used in calculating the associated geometric values (for missions using the NAIF SPICE Toolkit). Your PDS node will likely require you to use this class if the NAIF software was used. It may appear only once in each <Geometry> class.

<Image_Display_Geometry>

OPTIONAL

This class is used to provide orientation to fundamental directions (North, East, etc.) with respect to a declared display orientation. If your data object is an image or image-like thing (a 2D spectrum, say), you will be required to include this class in your geometry info. You may repeat this class if you have more than one image-like thing to describe in your label.

<Geometry_Lander>

OPTIONAL

This class provides geometric information relevant to a landed spacecraft, including rovers. One of either this class or Geometry_Orbiter is required; you may have both. You may also repeat this class if appropriate.

<Geometry_Orbiter>

OPTIONAL

This class provides detailed geometry (positions, orientations, velocities, and so on) appropriate for orbiting and fly-by spacecraft. One of this class or Geometry_Lander is required; you may have both. You may also repeat this class if appropriate.