Difference between revisions of "Standard Values Quick Reference"

From The SBN Wiki
Jump to navigation Jump to search
(→‎<type>: Added target types)
Line 647: Line 647:
 
* Other Investigation
 
* Other Investigation
 
|}
 
|}
 +
 +
=== In &lt;Observation_Area&gt; (or &lt;Context_Area&gt;)/&lt;Target_Identification&gt; ===
 +
 +
{|
 +
|-
 +
| valign="top" |
 +
* Asteroid
 +
* Calibration ''(see note below)''
 +
* Comet
 +
* Dust
 +
* Dwarf Planet
 +
* Galaxy
 +
* Globular Cluster
 +
* Meteorite
 +
* Meteroid
 +
* Meteroid Stream
 +
* Nebula
 +
* Open Cluster
 +
 +
| valign="top" |
 +
* Planet
 +
* Planetary Nebula
 +
* Planetary System
 +
* Plasma Cloud
 +
* Ring
 +
* Satellite
 +
* Star
 +
* Star Cluster
 +
* Sun
 +
* Terrestrial_Sample
 +
* Trans-Neptunian Object
 +
|}
 +
 +
{| class="wikitable" style="background-color:yellow"
 +
| '''Note:''' ''Do not use '''Calibration''' as a target ''&lt;type&gt;'' value in data labels submitted to the SBN.  "Calibration" is a reason to take an observation, and is noted in the ''&lt;Primary_Result_Summary&gt;''.
 +
|}
 +
 +
Some targets, particularly small body targets, correspond to more than one of the listed ''type'' values.  The <code>&lt;type&gt;</code> attribute may be repeated in these cases. If you have observed something that does not have a reasonable, corresponding ''type'' value in the above list, please contact your PDS node consultant as soon as possible with details.
 +
  
 
=== In &lt;Observing_System_Component&gt; ===
 
=== In &lt;Observing_System_Component&gt; ===

Revision as of 15:55, 4 August 2015

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.


As of 2014-04-29, these have been updated to reflect the Release 1.4.0.0 schemas.



Contents

<bundle_type>

In <Bundle>

  • Archive
  • Supplemental

<collection_type>

In <Collection>

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

<coordinate_source>

NOTE: As of this writing, this attribute is required to contain one of the following values, but all of these values are also deprecated. Here's what SBN recommends:
  • If you know your coordinates come from one of these sources, then use the corresponding value.
  • If the coordinates came from a different known source, put that in this field.
  • If you don't know where the coordinates came from, put Unknown here.
  • If you don't have coordinates listed at all, put Not Applicable here.

In any event, you'll have to ignore either an error or a warning about this field.

In <Telescope>

  • Aerial survey - North American (1983) datum
  • Astronomical
  • Doppler determined - WGS 72 datum
  • Geodetic - Adindan datum
  • Geodetic - Australian datum
  • Geodetic - Campo Inchauspe (Argentina) datum
  • Geodetic - Cape (South Africa) datum
  • Geodetic - Corregio Alegre (Brazil) datum
  • Geodetic - European 1979 datum
  • Geodetic - European datum
  • Geodetic - GRS 80 datum
  • Geodetic - Hermannskogel datum
  • Geodetic - Indian datum
  • Geodetic - La Canoa (Venezuela) datum* Geodetic - New Zealand datum
  • Geodetic - North American (1927) datum
  • Geodetic - Old Hawaiian datum
  • Geodetic - Ordnance Survey of Great Britain (1936) datum
  • Geodetic - Ordnance Survey of Great Britain (SN) 1980 datum
  • Geodetic - Potsdam datum
  • Geodetic - Puerto Rican (1940) datum
  • Geodetic - South American datum
  • Geodetic - Tokyo datum* Geodetic - WGS 84 datum
  • Geodetic - datum unknown
  • Satellite determined - datum unknown
  • Unknown

<data_type>

Follow the links below for a thumbnail description of each data type.

In character table fields (fixed width or delimited)

In binary table fields

In array elements

<discipline_name>

In <Primary_Result_Summary>/<Science_Facets>

  • Atmospheres
  • Fields
  • Flux Measurements
  • Imaging
  • Particles
  • Ring-Moon Systems
  • Small Bodies
  • Spectroscopy

<document_standard_id>

In <Document_File>

  • 7-bit ASCII Text
  • Encapsulated Postscript
  • GIF
  • HTML 2.0
  • HTML 3.2
  • HTML 4.0
  • HTML 4.01
  • JPEG
  • LaTEX
  • Microsoft Excel
  • Microsoft Word
  • PDF
  • PDF/A
  • PNG
  • Postscript
  • Rich Text
  • TIFF
  • UTF-8 Text

<domain>

In <Primary_Result_Summary>/<Science_Facets>

  • Atmosphere
  • Heliosphere
  • Interior
  • Interstellar
  • Ionosphere
  • Magnetosphere
  • Surface

<facetN>

In <Primary_Result_Summary>/<Science_Facets>

The allowed values for <facet1> and <facet2> depend on the value of <discipline_name>, but are independent of each other. Not all disciplines have a facet2 value list, and there is no requirement to use these values if they are not applicable to your data. This table shows the discipline_name/facet correspondences:

discipline_name facet1 facet2
Atmospheres
  • Structure
  • Meteorology

not used

Fields
  • Electric
  • Magnetic
  • Background
  • Waves
Flux Measurements
  • Photometry
  • Polarimetry

not used

Imaging
  • Grayscale
  • Color
  • Movie
  • Color Movie

not used

Particles
  • Ions
  • Electrons
  • Neutrals
  • Cosmic Ray
  • Solar Energetic
  • Energetic
  • Plasma
Ring-Moon Systems
  • Satellite Astrometry
  • Ring Compositional Map
  • Ring Occultation Profile
  • Ring Thermal Map

not used

Small Bodies
  • Dynamical Properties
  • Lightcurve
  • Meteoritics
  • Physical Properties
  • Production Rates
  • Shape Model
  • Taxonomy
  • Dust Study
  • Historical Reference
  • Gas Study

not used

Spectroscopy
  • 2D
  • Linear
  • Spectral Cube
  • Spectral Image
  • Tabulated

not used

If you have suggestions for additional facet values, please contact your PDS node representative.

<field_delimiter>

  • Comma
  • Horizontal Tab
  • Semicolon
  • Vertical Bar

<local_reference_type>

This attribute, defined in the core PDS4 namespace, will be assigned enumerated value lists in discipline and mission dictionaries. The contexts listed below refer to these namespaces by their PDS-assigned prefixes:

In <disp:Display_Settings>

  • display_settings_to_array

<member_status>

In <Bundle_Member_Entry>

  • Primary
  • Secondary

<parsing_standard_id>

In <Header>

  • 7-bit ASCII Text
  • CDF 3.4 ISTP/IACG
  • FITS 3.0
  • ISIS2
  • ISIS2 History Label
  • ISIS3
  • PDS DSV 1
  • PDS ODL 2
  • PDS3
  • Pre-PDS3
  • UTF-8 Text
  • VICAR1
  • VICAR2

In <Inventory>

  • PDS DSV 1

In <Table_Delimited>

  • PDS DSV 1

<processing_level>

In <Primary_Result_Summary>

  • Calibrated
  • Derived
  • Partially Processed [data that is reduced but not Calibrated]
  • Raw
  • Telemetry

<purpose>

In <Primary_Result_Summary>

  • Calibration
  • Checkout
  • Engineering
  • Navigation
  • Science

<record_delimiter>

  • Carriage-Return Line-Feed

<reference_type>

In <Bundle_Member_Entry>

  • bundle_has_browse_collection
  • bundle_has_calibration_collection
  • bundle_has_context_collection
  • bundle_has_data_collection
  • bundle_has_document_collection
  • bundle_has_geometry_collection
  • bundle_has_member_collection
  • bundle_has_schema_collection
  • bundle_has_spice_kernel_collection

In <Inventory>

  • inventory_has_member_product

In <Investigation_Area>/<Internal_Reference>

  • bundle_to_investigation in Product_Bundle
  • collection_to_investigation in Product_Collection
  • document_to_investigation in Product_Document
  • data_to_investigation in Product_Observational

In <Observing_System_Component>/<Internal_Reference>

  • is_facility
  • is_instrument
  • is_instrument_host
  • is_other
  • is_telescope

Use is_facility for ground-based observatories and labs. Use is_other for anything that doesn't clearly fit in one of the other categories.


In <Reference_List>/<Internal_Reference> in Bundles

  • bundle_to_errata
  • bundle_to_document
  • bundle_to_investigation
  • bundle_to_instrument
  • bundle_to_instrument_host
  • bundle_to_resource
  • bundle_to_target
  • bundle_to_associate

In <Reference_List>/<Internal_Reference> in Collections

  • collection_to_associate
  • collection_to_bundle
  • collection_to_browse
  • collection_to_calibration
  • collection_to_context
  • collection_curated_by_node
  • collection_to_data
  • collection_to_document
  • collection_to_errata
  • collection_to_geometry
  • collection_to_instrument
  • collection_to_instrument_host
  • collection_to_investigation
  • collection_to_personnel
  • collection_to_resource
  • collection_to_schema
  • collection_to_spice_kernel
  • collection_to_target

In <Reference_List>/<Internal_Reference> in Context Products

  • context_to_associate
  • instrument_to_document
  • instrument_to_instrument_host
  • instrument_host_to_document
  • instrument_host_to_instrument
  • instrument_host_to_investigation
  • instrument_host_to_target
  • investigation_to_document
  • investigation_to_instrument
  • investigation_to_instrument_host
  • investigation_to_target
  • node_to_personnel
  • node_to_agency
  • node_to_manager
  • node_to_operator
  • node_to_data_archivist
  • resource_to_instrument
  • resource_to_instrument_host
  • resource_to_investigation
  • resource_to_target
  • target_to_document
  • target_to_instrument
  • target_to_instrument_host
  • target_to_investigation

In <Reference_List>/<Internal_Reference> in Document Products

  • document_to_associate
  • document_to_investigation
  • document_to_instrument_host
  • document_to_instrument
  • document_to_target

In <Reference_List>/<Internal_Reference> in Observational Products

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


<type>

In <Investigation_Area>

  • Individual Investigation
  • Mission
  • Observing Campaign
  • Other Investigation

In <Observation_Area> (or <Context_Area>)/<Target_Identification>

  • Asteroid
  • Calibration (see note below)
  • Comet
  • Dust
  • Dwarf Planet
  • Galaxy
  • Globular Cluster
  • Meteorite
  • Meteroid
  • Meteroid Stream
  • Nebula
  • Open Cluster
  • Planet
  • Planetary Nebula
  • Planetary System
  • Plasma Cloud
  • Ring
  • Satellite
  • Star
  • Star Cluster
  • Sun
  • Terrestrial_Sample
  • Trans-Neptunian Object
Note: Do not use Calibration as a target <type> value in data labels submitted to the SBN. "Calibration" is a reason to take an observation, and is noted in the <Primary_Result_Summary>.

Some targets, particularly small body targets, correspond to more than one of the listed type values. The <type> attribute may be repeated in these cases. If you have observed something that does not have a reasonable, corresponding type value in the above list, please contact your PDS node consultant as soon as possible with details.


In <Observing_System_Component>

  • Artificial_Illumination
  • Instrument
  • Laboratory
  • Literature Search
  • Naked Eye
  • Observatory
  • Spacecraft
  • Telescope

In <Product_Context>/<Facility>

  • Laboratory
  • Observatory

In <Product_Context>/<Instrument>

  • Accelerometer
  • Alpha Particle Detector
  • Altimeter
  • Anemometer
  • Atomic Force Microscope
  • Barometer
  • Biology Experiments
  • Bolometer
  • Camera
  • Cosmic Ray Detector
  • Drilling Tool
  • Dust Detector
  • Electrical Probe
  • Energetic Particle Detector
  • Gamma Ray Detector
  • Gas Analyzer
  • Grinding Tool
  • Hygrometer
  • Imager
  • Imaging Spectrometer
  • Inertial Measurement Unit
  • Infrared Spectrometer
  • Laser Induced Breakdown Spectrometer
  • Magnetometer
  • Mass Spectrometer
  • Microwave Spectrometer
  • Moessbauer Spectrometer
  • Naked Eye
  • Neutral Particle Detector
  • Neutron Detector
  • Photometer
  • Plasma Analyzer
  • Plasma Detector
  • Plasma Wave Spectrometer
  • Polarimeter
  • RADAR
  • Radio Science
  • Radio Spectrometer
  • Radio Telescope
  • Radiometer
  • Reflectometer
  • Spectrograph Imager
  • Spectrometer
  • Thermal Imager
  • Thermal Probe
  • Thermometer
  • Ultraviolet Spectrometer
  • Wet Chemistry Laboratory
  • X-ray Detector
  • X-ray Fluorescence Spectrometer

In <Product_Context>/<Instrument_Host>

  • Earth-based
  • Lander
  • Rover
  • Spacecraft

In <Product_Context>/<Investigation>

  • Individual Investigation
  • Mission
  • Observing Campaign
  • Other Investigation

In <Product_Context>/<Target>

  • Asteroid
  • Comet
  • Dust
  • Dwarf Planet
  • Galaxy
  • Globular Cluster
  • Meteorite
  • Meteroid
  • Meteroid Stream
  • Nebula
  • Open Cluster
  • Planet
  • Planetary Nebula
  • Planetary System
  • Plasma Cloud
  • Ring
  • Satellite
  • Star
  • Star Cluster
  • Sun
  • Terrestrial_Sample
  • Trans-Neptunian Object

<wavelength_range>

In <Primary_Result_Summary>/<Science_Facets>

  • Far Infrared
  • Gamma Ray
  • Infrared
  • Microwave
  • Millimeter
  • Near Infrared
  • Radio
  • Submillimeter
  • Ultraviolet
  • Visible
  • X-ray