Difference between revisions of "Standard Values Quick Reference"

From The SBN Wiki
Jump to navigation Jump to search
m (1 revision: Extracted from "Questions")
(Extracted from Questions page)
Line 1: Line 1:
== Asked Questions ==
 
 
Doesn't matter if they're "frequently asked" at this point - if you have a question, please add it to this page.  We'll try to get an answer posted ASAP.
 
 
-----
 
 
=== Where Can I Find...? ===
 
 
;PDS4 documentation
 
:http://pds.nasa.gov/pds4/doc/index.shtml
 
:This site lists the manuals and guides produced by PDS for PDS4 users.  Here you'll find the Standards Reference, the Data Dictionary, the Information Model Specification, and a collection of tutorials and handbooks on various subjects.  Be careful of version numbers while PDS4 is still in development!
 
 
;PDS4 Schemas
 
:http://pds.nasa.gov/pds4/schema/index.shtml
 
:Here, too, be very careful of version numbers...
 
 
;PDS2010 Software
 
:http://pds.nasa.gov/pds4/software/index.shtml
 
:This includes the PDS ''validator'' software, which you should probably learn to use.
 
 
;Standard Value Lists for PDS4 keywords?
 
:There are three places:
 
:#The Data Dictionary document.  This is a contextual dictionary, in other words the standard value list will be dependent on what class the keyword appears in, and will be different for different classes.  There's a tutorial available from the documentation page, above, on how to use the Data Dictionary.
 
:#In the Schematron file.  If you prefer reading code to reading the Data Dictionary, or you just find it easier to search ASCII text, open the corresponding Schematron file and look for the class containing the keyword, and then the keyword itself.  You should find one rule that enumerates the entire standard value list.
 
:#On the [[Standard Values Quick Reference]] page of this wiki, maintained for the convenience of SBN data preparers.
 
 
:Unfortunately, none of these currently have definitions for any of the standard values.
 
-----
 
<div id="stdValueList"></div>
 
 
=== What Do I Put For...? ===
 
 
 
A number of attributes in the PDS common classes have standard value lists.  You can look the standard values up in either the ''Data Dictionary - Abridged'' document or the Schematron file that comes with the PDS4 master schema.  Both can be rather tedious to sort through.  Following are the most commonly used standard value lists for quick reference.  We'll try to keep these updated.
 
A number of attributes in the PDS common classes have standard value lists.  You can look the standard values up in either the ''Data Dictionary - Abridged'' document or the Schematron file that comes with the PDS4 master schema.  Both can be rather tedious to sort through.  Following are the most commonly used standard value lists for quick reference.  We'll try to keep these updated.
  
 
Note that spelling counts - including capitalization and use of underscores vs. blanks.  Type these values '''exactly''' as they're shown below or you will get a validation error from the Schematron file.
 
Note that spelling counts - including capitalization and use of underscores vs. blanks.  Type these values '''exactly''' as they're shown below or you will get a validation error from the Schematron file.
  
==== In ''&lt;Primary_Result_Summary&gt;'' ====
+
== In ''&lt;Primary_Result_Summary&gt;'' ==
  
===== &lt;data_regime&gt; =====
+
=== &lt;data_regime&gt; ===
 
{|
 
{|
 
|-
 
|-
Line 62: Line 30:
 
|}
 
|}
  
===== &lt;type&gt; =====
+
=== &lt;type&gt; ===
 
{|
 
{|
 
|-
 
|-
Line 85: Line 53:
 
|}
 
|}
  
===== &lt;purpose&gt; =====
+
=== &lt;purpose&gt; ===
 
{|
 
{|
 
|-
 
|-
Line 96: Line 64:
 
|}
 
|}
  
===== &lt;processing_level_id&gt; =====
+
=== &lt;processing_level_id&gt; ===
 
{|
 
{|
 
|-
 
|-
Line 106: Line 74:
 
|}
 
|}
  
==== In &lt;Observing_System_Component&gt; ====
+
== In &lt;Observing_System_Component&gt; ==
  
===== &lt;observing_system_component_type&gt; =====
+
=== &lt;observing_system_component_type&gt; ===
 
{|
 
{|
 
|-
 
|-
Line 123: Line 91:
 
|}
 
|}
  
===== &lt;reference_type&gt; =====
+
=== &lt;reference_type&gt; ===
 
{|
 
{|
 
|-
 
|-
Line 141: Line 109:
 
Let me know if you run across anything else that doesn't fit.
 
Let me know if you run across anything else that doesn't fit.
  
==== In &lt;Target_Identification&gt; ====
+
== In &lt;Target_Identification&gt; ==
  
===== &lt;type&gt; =====
+
=== &lt;type&gt; ===
  
 
{|
 
{|
Line 176: Line 144:
 
Clearly this list is not sufficient for small bodies, but at the moment a target is only allowed to have one ''&lt;type&gt;'' designation anyway, which is also problematic.  So if you have an issue with target types, contact your PDS node consultant.
 
Clearly this list is not sufficient for small bodies, but at the moment a target is only allowed to have one ''&lt;type&gt;'' designation anyway, which is also problematic.  So if you have an issue with target types, contact your PDS node consultant.
  
==== For &lt;data_type&gt; in ... ====
+
== &lt;data_type&gt; in ... ==
  
===== ...Character table fields (fixed width or delimited): =====
+
=== In character table fields (fixed width or delimited) ===
 
{|
 
{|
 
|-
 
|-
Line 215: Line 183:
  
  
===== ...Binary table fields: =====
+
=== In binary table fields ===
 
{|
 
{|
 
|-
 
|-
 
| valign="top" |
 
| valign="top" |
 
* IEEE754LSBDouble
 
* IEEE754LSBDouble
 
 
* IEEE754LSBSingle  
 
* IEEE754LSBSingle  
 
* IEEE754MSBDouble  
 
* IEEE754MSBDouble  
 
* IEEE754MSBSingle  
 
* IEEE754MSBSingle  
 
* ComplexLSB16
 
* ComplexLSB16
 
 
* ComplexLSB8  
 
* ComplexLSB8  
 
* ComplexMSB16
 
* ComplexMSB16
 
 
* ComplexMSB8  
 
* ComplexMSB8  
 
| valign="top" |
 
| valign="top" |
 
* SignedBitString
 
* SignedBitString
 
 
* SignedByte  
 
* SignedByte  
 
* SignedLSB2
 
* SignedLSB2
 
 
* SignedLSB4
 
* SignedLSB4
 
* SignedLSB8
 
* SignedLSB8
 
 
* SignedMSB2
 
* SignedMSB2
 
 
* SignedMSB4
 
* SignedMSB4
 
 
* SignedMSB8
 
* SignedMSB8
 
 
* UnsignedBitString
 
* UnsignedBitString
 
 
* UnsignedByte
 
* UnsignedByte
 
 
* UnsignedLSB2
 
* UnsignedLSB2
 
 
* UnsignedLSB4
 
* UnsignedLSB4
 
 
* UnsignedLSB8
 
* UnsignedLSB8
 
 
* UnsignedMSB2
 
* UnsignedMSB2
 
 
* UnsignedMSB4
 
* UnsignedMSB4
 
 
* UnsignedMSB8
 
* UnsignedMSB8
 
| valign="top" |
 
| valign="top" |
 
* ASCII_AnyURI
 
* ASCII_AnyURI
 
 
* ASCII_Boolean
 
* ASCII_Boolean
 
 
* ASCII_DOI
 
* ASCII_DOI
 
 
* ASCII_Date
 
* ASCII_Date
 
 
* ASCII_Date_DOY
 
* ASCII_Date_DOY
 
 
* ASCII_Date_Time  
 
* ASCII_Date_Time  
 
* ASCII_Date_Time_DOY  
 
* ASCII_Date_Time_DOY  
Line 278: Line 225:
 
* ASCII_Directory_Path_Name  
 
* ASCII_Directory_Path_Name  
 
* ASCII_File_Name
 
* ASCII_File_Name
 
 
* ASCII_File_Specification_Name  
 
* ASCII_File_Specification_Name  
 
* ASCII_Integer
 
* ASCII_Integer
Line 284: Line 230:
 
* ASCII_LID
 
* ASCII_LID
 
* ASCII_LIDVID
 
* ASCII_LIDVID
 
 
* ASCII_LIDVID_LID
 
* ASCII_LIDVID_LID
 
 
* ASCII_MD5_Checksum  
 
* ASCII_MD5_Checksum  
 
* ASCII_NonNegative_Integer
 
* ASCII_NonNegative_Integer
 
 
* ASCII_Numeric_Base16  
 
* ASCII_Numeric_Base16  
 
* ASCII_Numeric_Base2
 
* ASCII_Numeric_Base2
 
 
* ASCII_Numeric_Base8
 
* ASCII_Numeric_Base8
 
 
* ASCII_Real  
 
* ASCII_Real  
 
* ASCII_String
 
* ASCII_String
 
* ASCII_Time
 
* ASCII_Time
 
 
* ASCII_VID  
 
* ASCII_VID  
 
* UTF8_String  
 
* UTF8_String  
 
|}
 
|}
  
==== In &lt;Element_Array&gt; (Array Elements) ====
+
=== In array elements ===
  
===== &lt;data_type&gt; =====
 
 
{|
 
{|
 
|-
 
|-
Line 313: Line 252:
 
* IEEE754MSBDouble  
 
* IEEE754MSBDouble  
 
* IEEE754MSBSingle
 
* IEEE754MSBSingle
 
 
* ComplexLSB16
 
* ComplexLSB16
 
 
* ComplexLSB8  
 
* ComplexLSB8  
 
* ComplexMSB16  
 
* ComplexMSB16  
Line 323: Line 260:
 
* SignedBitString  
 
* SignedBitString  
 
* SignedByte
 
* SignedByte
 
 
* SignedLSB2  
 
* SignedLSB2  
 
* SignedLSB4  
 
* SignedLSB4  
Line 341: Line 277:
 
|}
 
|}
  
==== &lt;reference_type&gt; in... ====
+
== &lt;reference_type&gt; in... ==
  
===== &lt;Observing_System_Component&gt;/&lt;Internal_Reference&gt; =====
+
=== &lt;Observing_System_Component&gt;/&lt;Internal_Reference&gt; ===
  
 
{|
 
{|
Line 356: Line 292:
 
|}
 
|}
  
===== &lt;Reference_List&gt;/&lt;Internal_Reference&gt; in Bundles =====
+
=== &lt;Reference_List&gt;/&lt;Internal_Reference&gt; in Bundles ===
  
 
{|
 
{|
Line 365: Line 301:
 
|}
 
|}
  
===== &lt;Reference_List&gt;/&lt;Internal_Reference&gt; in Collections =====
+
=== &lt;Reference_List&gt;/&lt;Internal_Reference&gt; in Collections ===
  
 
{|
 
{|
Line 387: Line 323:
 
|}
 
|}
  
===== &lt;Reference_List&gt;/&lt;Internal_Reference&gt; in Document Products =====
+
=== &lt;Reference_List&gt;/&lt;Internal_Reference&gt; in Document Products ===
  
 
{|
 
{|
Line 399: Line 335:
 
|}
 
|}
  
===== &lt;Reference_list&gt;/&lt;Internal_Reference&gt; in Observational Products =====
+
=== &lt;Reference_list&gt;/&lt;Internal_Reference&gt; in Observational Products ===
  
 
{|
 
{|
Line 418: Line 354:
  
  
==== &lt;external_standard_id&gt; in...====
+
== &lt;external_standard_id&gt; in...==
  
===== &lt;Document_File&gt; =====
+
=== &lt;Document_File&gt; ===
  
 
{|
 
{|
Line 442: Line 378:
 
|}
 
|}
  
==== &lt;Collection&gt;/&lt;collection_type&gt; ====
+
== &lt;collection_type&gt; ==
  
 
{|
 
{|

Revision as of 00:29, 24 January 2013

A number of attributes in the PDS common classes have standard value lists. You can look the standard values up in either the Data Dictionary - Abridged document or the Schematron file that comes with the PDS4 master schema. Both can be rather tedious to sort through. Following are the most commonly used standard value lists for quick reference. We'll try to keep these updated.

Note that spelling counts - including capitalization and use of underscores vs. blanks. Type these values exactly as they're shown below or you will get a validation error from the Schematron file.

In <Primary_Result_Summary>

<data_regime>

  • Dust
  • Electric_Field
  • Electrons
  • Far_Infrared
  • Gamma_Ray
  • Infrared
  • Ions
  • Magnetic_Field
  • Microwave
  • Millimeter
  • Near_Infrared
  • Particles
  • Radio
  • Sub-Millimeter
  • Ultraviolet
  • Visible
  • X-Ray

<type>

  • Altimetry
  • Astrometry
  • Count
  • E/B-Field_Vectors
  • Gravity_Model
  • Image
  • Magnetometry
  • Map
  • Null_Result
  • Occultation
  • Photometry
  • Polarimetry
  • Radiometry
  • Shape_Model
  • Spectrum

<purpose>

  • Calibration
  • Checkout
  • Engineering
  • Navigation
  • Science

<processing_level_id>

  • Calibrated
  • Derived
  • Raw
  • Reduced

In <Observing_System_Component>

<observing_system_component_type>

  • Analyst ← Never use this. Credit authors and editors in the Citation class.
  • Artificial_Illumination
  • Ground-based_Laboratory
  • Ground-based_Observatory
  • Ground-based_Telescope
  • Instrument
  • Literature_Search
  • PDS_Archived_Data ← Never use this. It's logically ridiculous.
  • Spacecraft

<reference_type>

  • is_instrument
  • is_instrument_host

Note: Clearly these values are not sufficient for groundbased data, or indeed anything other than a spacecraft-mounted instrument. Following are some additional fake values we'll use until the above problem is fixed. These values will generate validation errors:

  • is_observatory
  • is_telescope

Let me know if you run across anything else that doesn't fit.

In <Target_Identification>

<type>

  • Asteroid
  • Comet
  • Dust
  • Dwarf_Planet
  • Galaxy
  • Globular_Cluster
  • Meteorite
  • Meteoroid
  • Meteoroid_Stream
  • Nebula
  • Open_Cluster
  • Planet
  • Planetary_Nebula
  • Planetary_System
  • Plasma_Cloud
  • Ring
  • Satellite
  • Star
  • Star_Cluster
  • Sun
  • Terrestrial_Sample
  • Trans-Neptunian_Object

Clearly this list is not sufficient for small bodies, but at the moment a target is only allowed to have one <type> designation anyway, which is also problematic. So if you have an issue with target types, contact your PDS node consultant.

<data_type> in ...

In character table fields (fixed width or delimited)

  • ASCII_AnyURI
  • ASCII_Boolean
  • ASCII_DOI
  • ASCII_Date
  • ASCII_Date_DOY
  • ASCII_Date_Time
  • ASCII_Date_Time_DOY
  • ASCII_Date_Time_UTC
  • ASCII_Date_Time_YMD
  • ASCII_Date_YMD
  • ASCII_Directory_Path_Name
  • ASCII_File_Name
  • ASCII_File_Specification_Name
  • ASCII_Integer
  • ASCII_LID
  • ASCII_LIDVID
  • ASCII_LIDVID_LID
  • ASCII_MD5_Checksum
  • ASCII_NonNegative_Integer
  • ASCII_Numeric_Base16
  • ASCII_Numeric_Base2
  • ASCII_Numeric_Base8
  • ASCII_Real
  • ASCII_String
  • ASCII_Time
  • ASCII_VID
  • UTF8_String


In binary table fields

  • IEEE754LSBDouble
  • IEEE754LSBSingle
  • IEEE754MSBDouble
  • IEEE754MSBSingle
  • ComplexLSB16
  • ComplexLSB8
  • ComplexMSB16
  • ComplexMSB8
  • SignedBitString
  • SignedByte
  • SignedLSB2
  • SignedLSB4
  • SignedLSB8
  • SignedMSB2
  • SignedMSB4
  • SignedMSB8
  • UnsignedBitString
  • UnsignedByte
  • UnsignedLSB2
  • UnsignedLSB4
  • UnsignedLSB8
  • UnsignedMSB2
  • UnsignedMSB4
  • UnsignedMSB8
  • ASCII_AnyURI
  • ASCII_Boolean
  • ASCII_DOI
  • ASCII_Date
  • ASCII_Date_DOY
  • ASCII_Date_Time
  • ASCII_Date_Time_DOY
  • ASCII_Date_Time_UTC
  • ASCII_Date_Time_YMD
  • ASCII_Date_YMD
  • ASCII_Directory_Path_Name
  • ASCII_File_Name
  • ASCII_File_Specification_Name
  • ASCII_Integer
  • ASCII_LID
  • ASCII_LIDVID
  • ASCII_LIDVID_LID
  • ASCII_MD5_Checksum
  • ASCII_NonNegative_Integer
  • ASCII_Numeric_Base16
  • ASCII_Numeric_Base2
  • ASCII_Numeric_Base8
  • ASCII_Real
  • ASCII_String
  • ASCII_Time
  • ASCII_VID
  • UTF8_String

In array elements

  • IEEE754LSBDouble
  • IEEE754LSBSingle
  • IEEE754MSBDouble
  • IEEE754MSBSingle
  • ComplexLSB16
  • ComplexLSB8
  • ComplexMSB16
  • ComplexMSB8
  • SignedBitString
  • SignedByte
  • SignedLSB2
  • SignedLSB4
  • SignedLSB8
  • SignedMSB2
  • SignedMSB4
  • SignedMSB8
  • UnsignedBitString
  • UnsignedByte
  • UnsignedLSB2
  • UnsignedLSB4
  • UnsignedLSB8
  • UnsignedMSB2
  • UnsignedMSB4
  • UnsignedMSB8

<reference_type> in...

<Observing_System_Component>/<Internal_Reference>

  • is_instrument
  • is_instrument_host
Note: Clearly these values are not sufficient for this context in SBN data (there are no values for ground-based observing, for a start).

<Reference_List>/<Internal_Reference> in Bundles

  • bundle_to_errata
  • bundle_to_document

<Reference_List>/<Internal_Reference> in Collections

  • collection_to_resource
  • collection_to_associate
  • collection_to_calibration
  • collection_to_geometry
  • collection_to_spice_kernel
  • collection_curated_by_node
  • collection_to_document
  • collection_to_browse
  • collection_to_context
  • collection_to_data
  • collection_to_document
  • collection_to_schema
  • collection_to_errata
  • collection_to_bundle

<Reference_List>/<Internal_Reference> in Document Products

  • document_to_associate
  • document_to_investigation
  • document_to_instrument_host
  • document_to_instrument
  • document_to_target

<Reference_list>/<Internal_Reference> in Observational Products

  • data_to_resource
  • data_to_calibration_document
  • data_to_calibration_product
  • data_to_raw_product
  • data_to_calibrated_product
  • data_to_geometry
  • data_to_spice_kernel
  • data_to_thumbnail
  • data_to_document
  • data_to_browse
  • data_curated_by_node


<external_standard_id> in...

<Document_File>

  • ASCII
  • Encapsulated_Postscript
  • GIF
  • HTML
  • JPEG
  • LaTEX
  • Microsoft_Word
  • PDF
  • PDF-A
  • PNG
  • Postscript
  • Rich_Text
  • TIFF
  • UTF-8

<collection_type>

  • Browse
  • Calibration
  • Context
  • Data
  • Document
  • Geometry
  • Miscellaneous
  • SPICE
  • Schema