Difference between revisions of "Standard Values Quick Reference"

From The SBN Wiki
Jump to navigation Jump to search
m (Wordsmithing on the intro)
m (Spacing; typos)
Line 1: Line 1:
 
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.   
 
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.  They're sorted first by the attribute name, then by the context in which it appears (many of these appear in several different classes, and the standard value lists depend on which class they attribute appears in). We'll try to keep these updated.
+
Following are the most commonly used standard value lists for quick reference.  They're sorted first by the attribute name, then by the context in which it appears. Many of these appear in several different classes, and the standard value lists depend on which class the attribute appears in, and sometimes - as in the case of ''<reference_type>'' - it depends on the containing class one or two levels above that. We'll try to keep these updated as changes and additions propagate to the master schema.
  
 
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.
----
+
 
 
== <collection_type> ==
 
== <collection_type> ==
  
Line 21: Line 21:
 
* Schema
 
* Schema
 
|}
 
|}
----
+
 
 +
 
 
== <data_regime> ==
 
== <data_regime> ==
  
Line 49: Line 50:
 
* X-Ray
 
* X-Ray
 
|}
 
|}
----
+
 
 +
 
 
== <data_type> ==
 
== <data_type> ==
  
Line 148: Line 150:
 
* UTF8_String  
 
* UTF8_String  
 
|}
 
|}
 +
  
 
=== In array elements ===
 
=== In array elements ===
Line 182: Line 185:
 
* UnsignedMSB8
 
* UnsignedMSB8
 
|}
 
|}
----
+
 
 +
 
 
== <external_standard_id> ==
 
== <external_standard_id> ==
  
Line 206: Line 210:
 
* UTF-8
 
* UTF-8
 
|}
 
|}
----
+
 
 +
 
 
== <observing_system_component_type> ==
 
== <observing_system_component_type> ==
  
Line 224: Line 229:
 
* Spacecraft
 
* Spacecraft
 
|}
 
|}
----
+
 
 +
 
 
== <processing_level_id> ==
 
== <processing_level_id> ==
  
Line 237: Line 243:
 
* Reduced
 
* Reduced
 
|}
 
|}
 +
  
 
== <purpose> ==
 
== <purpose> ==
Line 251: Line 258:
 
* Science
 
* Science
 
|}
 
|}
----
+
 
== <reference_type> in... ==
+
 
 +
== <reference_type> ==
  
 
=== <Observing_System_Component>/<Internal_Reference> ===
 
=== <Observing_System_Component>/<Internal_Reference> ===
Line 333: Line 341:
 
* data_curated_by_node
 
* data_curated_by_node
 
|}
 
|}
----
+
 
 +
 
 
== <type> ==
 
== <type> ==
  

Revision as of 03:24, 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. They're sorted first by the attribute name, then by the context in which it appears. Many of these appear in several different classes, and the standard value lists depend on which class the attribute appears in, and sometimes - as in the case of <reference_type> - it depends on the containing class one or two levels above that. We'll try to keep these updated as changes and additions propagate to the master schema.

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.

<collection_type>

<Collection>

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


<data_regime>

<Primary_Result_Summary>

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


<data_type>

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


<external_standard_id>

<Document_File>

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


<observing_system_component_type>

<Observing_System_Component>

  • 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


<processing_level_id>

<Primary_Result_Summary>

  • Calibrated
  • Derived
  • Raw
  • Reduced


<purpose>

<Primary_Result_Summary>

  • Calibration
  • Checkout
  • Engineering
  • Navigation
  • Science


<reference_type>

<Observing_System_Component>/<Internal_Reference>

  • 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.

<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


<type>

<Primary_Result_Summary>

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

<Target_Identification>

  • 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