Difference between revisions of "Standard Values Quick Reference"
(→<domain>: Update for IM 1.14.0.0) |
(Update for IM 1.14.0.0 completed) |
||
(16 intermediate revisions by the same user not shown) | |||
Line 7: | Line 7: | ||
---- | ---- | ||
− | ''As of | + | ''As of 2020-07-27, these have been updated to reflect the Release 1.714.0.0 (1E00) schemas.'' |
---- | ---- | ||
Line 504: | Line 504: | ||
| valign="top" | | | valign="top" | | ||
* 7-Bit ASCII Text | * 7-Bit ASCII Text | ||
+ | * PDS3 | ||
* UTF-8 Text | * UTF-8 Text | ||
|} | |} | ||
Line 576: | Line 577: | ||
* bundle_has_geometry_collection | * bundle_has_geometry_collection | ||
* bundle_has_member_collection | * bundle_has_member_collection | ||
+ | * bundle_has_miscellaneous_collection | ||
* bundle_has_schema_collection | * bundle_has_schema_collection | ||
* bundle_has_spice_kernel_collection | * bundle_has_spice_kernel_collection | ||
Line 593: | Line 595: | ||
|- | |- | ||
| valign="top" | | | valign="top" | | ||
+ | * ancillary_to_investigation ''in '''Product_Ancillary''''' | ||
* bundle_to_investigation ''in '''Product_Bundle''''' | * bundle_to_investigation ''in '''Product_Bundle''''' | ||
* collection_to_investigation ''in '''Product_Collection''''' | * collection_to_investigation ''in '''Product_Collection''''' | ||
Line 662: | Line 665: | ||
| valign="top" | | | valign="top" | | ||
* ancillary_to_data | * ancillary_to_data | ||
+ | * ancillary_to_document | ||
|} | |} | ||
Line 669: | Line 673: | ||
|- | |- | ||
| valign="top" | | | valign="top" | | ||
+ | * browse_to_browse | ||
* browse_to_data | * browse_to_data | ||
+ | | valign="top" | | ||
+ | * browse_to_document | ||
* browse_to_thumbnail | * browse_to_thumbnail | ||
|} | |} | ||
Line 679: | Line 686: | ||
| valign="top" | | | valign="top" | | ||
* context_to_associate | * context_to_associate | ||
+ | | ||
+ | * facility_to_instrument | ||
+ | * facility_to_investigation | ||
+ | * facility_to_telescope | ||
+ | |||
+ | | valign="top" | | ||
* instrument_to_document | * instrument_to_document | ||
+ | * instrument_to_facility | ||
* instrument_to_instrument_host | * instrument_to_instrument_host | ||
+ | * instrument_to_observatory | ||
+ | * instrument_to_telescope | ||
* instrument_host_to_document | * instrument_host_to_document | ||
* instrument_host_to_instrument | * instrument_host_to_instrument | ||
* instrument_host_to_investigation | * instrument_host_to_investigation | ||
* instrument_host_to_target | * instrument_host_to_target | ||
− | |||
| valign="top" | | | valign="top" | | ||
+ | * investigation_to_document | ||
+ | * investigation_to_facility | ||
* investigation_to_instrument | * investigation_to_instrument | ||
* investigation_to_instrument_host | * investigation_to_instrument_host | ||
* investigation_to_target | * investigation_to_target | ||
+ | * investigation_to_telescope | ||
+ | |||
+ | | valign="top" | | ||
* node_to_personnel | * node_to_personnel | ||
* node_to_agency | * node_to_agency | ||
Line 696: | Line 716: | ||
* node_to_operator | * node_to_operator | ||
* node_to_data_archivist | * node_to_data_archivist | ||
− | + | | |
− | |||
* resource_to_instrument | * resource_to_instrument | ||
* resource_to_instrument_host | * resource_to_instrument_host | ||
* resource_to_investigation | * resource_to_investigation | ||
* resource_to_target | * resource_to_target | ||
+ | |||
+ | | valign="top" | | ||
* target_to_document | * target_to_document | ||
* target_to_instrument | * target_to_instrument | ||
* target_to_instrument_host | * target_to_instrument_host | ||
* target_to_investigation | * target_to_investigation | ||
+ | | ||
+ | * telescope_to_airborne | ||
+ | * telescope_to_facility | ||
+ | * telescope_to_instrument | ||
+ | * telescope_to_observatory | ||
|} | |} | ||
Line 725: | Line 751: | ||
|- | |- | ||
| valign="top" | | | valign="top" | | ||
+ | * data_curated_by_node | ||
* data_to_ancillary_data | * data_to_ancillary_data | ||
* data_to_associate | * data_to_associate | ||
Line 731: | Line 758: | ||
* data_to_calibration_document | * data_to_calibration_document | ||
* data_to_calibration_product | * data_to_calibration_product | ||
− | |||
| valign="top" | | | valign="top" | | ||
* data_to_derived_product | * data_to_derived_product | ||
Line 796: | Line 822: | ||
| valign="top" | | | valign="top" | | ||
* Asteroid | * Asteroid | ||
− | * | + | * Astrophysical |
* Calibration Field | * Calibration Field | ||
* Calibrator | * Calibrator | ||
+ | * Centaur ''(see note below)'' | ||
* Comet | * Comet | ||
* Dust | * Dust | ||
Line 805: | Line 832: | ||
* Exoplanet System | * Exoplanet System | ||
* Galaxy | * Galaxy | ||
− | * | + | * Laboratory Analog |
− | * | + | * Magnetic Field |
− | |||
* Meteroid | * Meteroid | ||
* Meteroid Stream | * Meteroid Stream | ||
Line 813: | Line 839: | ||
| valign="top" | | | valign="top" | | ||
* Nebula | * Nebula | ||
− | |||
* Planet | * Planet | ||
* Planetary Nebula | * Planetary Nebula | ||
Line 820: | Line 845: | ||
* Plasma Stream | * Plasma Stream | ||
* Ring | * Ring | ||
+ | * Sample | ||
* Satellite | * Satellite | ||
* Star | * Star | ||
* Star Cluster | * Star Cluster | ||
* Sun | * Sun | ||
− | |||
− | |||
* Trans-Neptunian Object | * Trans-Neptunian Object | ||
|} | |} | ||
{| class="wikitable" style="background-color:yellow" | {| class="wikitable" style="background-color:yellow" | ||
− | | '''Note:''' ''Do not use ''' | + | | '''Note:''' ''Do not use '''Centaur''' as the only value of ''<type>'' for any target in data labels submitted to SBN.''. |
|} | |} | ||
− | Some targets, particularly small body targets, correspond to more than one of the listed ''type'' values. The <code><type></code> attribute may be repeated in these cases. If you have observed something that does not have a reasonable | + | Some targets, particularly small body targets, correspond to more than one of the listed ''type'' values. The <code><type></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 <Observing_System_Component> === | === In <Observing_System_Component> === | ||
+ | |||
+ | {| class="wikitable" style="background-color:yellow" | ||
+ | | '''Note:''' ''PDS has gutted the type list below. If you are preparing data for submission to SBN, please use values from the following list, and note that validation will produce error messages as those values are no longer included in IM schemas starting with version 1E00. If you are producing data for any other node, please consult the current Information Model Specification or Data Dictionary for valid values.'' | ||
+ | |} | ||
{| | {| | ||
Line 866: | Line 894: | ||
=== In <Product_Context>/<Instrument> === | === In <Product_Context>/<Instrument> === | ||
+ | {| class="wikitable" style="background-color:yellow" | ||
+ | | '''Note:''' <type> ''in the ''Instrument'' context product has been deprecated since IM release 1.12.0.0 (the 1C00 schema files) and replaced by the ''<Type_List_Area>'' subclass. Please contact your PDS Node for assistance with this if you find yourself faced with the prospect of creating an ''Instrument'' context object.'' | ||
+ | |} | ||
+ | <!-- This section removed | ||
{| | {| | ||
|- | |- | ||
Line 936: | Line 968: | ||
* X-ray Flourescence Spectrometer | * X-ray Flourescence Spectrometer | ||
|} | |} | ||
+ | --> | ||
=== In <Product_Context>/<Instrument_Host> === | === In <Product_Context>/<Instrument_Host> === | ||
Line 942: | Line 975: | ||
|- | |- | ||
| valign="top" | | | valign="top" | | ||
− | * | + | * Aircraft |
+ | * Balloon | ||
* Lander | * Lander | ||
* Rover | * Rover | ||
* Spacecraft | * Spacecraft | ||
+ | * Suborbital Rocket | ||
|} | |} | ||
Line 953: | Line 988: | ||
|- | |- | ||
| valign="top" | | | valign="top" | | ||
+ | * Field Campaign | ||
* Individual Investigation | * Individual Investigation | ||
* Mission | * Mission | ||
Line 965: | Line 1,001: | ||
| valign="top" | | | valign="top" | | ||
* Asteroid | * Asteroid | ||
− | * | + | * Astrophysical |
* Calibration Field | * Calibration Field | ||
* Calibrator | * Calibrator | ||
+ | * Centaur | ||
* Comet | * Comet | ||
* Dust | * Dust | ||
Line 974: | Line 1,011: | ||
* Exoplanet System | * Exoplanet System | ||
* Galaxy | * Galaxy | ||
− | |||
− | |||
− | |||
* Meteroid | * Meteroid | ||
* Meteroid Stream | * Meteroid Stream | ||
| valign="top" | | | valign="top" | | ||
* Nebula | * Nebula | ||
− | |||
* Planet | * Planet | ||
* Planetary Nebula | * Planetary Nebula | ||
Line 991: | Line 1,024: | ||
* Star | * Star | ||
* Star Cluster | * Star Cluster | ||
− | |||
− | |||
− | |||
* Trans-Neptunian Object | * Trans-Neptunian Object | ||
|} | |} |
Latest revision as of 20:33, 27 July 2020
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 2020-07-27, these have been updated to reflect the Release 1.714.0.0 (1E00) schemas.
Contents
- 1 <bundle_type>
- 2 <collection_type>
- 3 <data_type>
- 4 <discipline_name>
- 5 <document_standard_id>
- 6 <domain>
- 7 <facetN>
- 8 <field_delimiter>
- 9 <geom:kernel_provenance>
- 10 <local_reference_type>
- 10.1 In <disp:Display_Settings>
- 10.2 In <geom:Coordinate_Space_Reference>
- 10.3 In <geom:Expanded_Geometry>
- 10.4 In <geom:Image_Display_Geometry>
- 10.5 In <part:Particle_Observation>
- 10.6 In <spec:Axis_Bin_Set>
- 10.7 In <spec:Axis_Uniformly_Sampled>
- 10.8 In <spec:Spectral_Characteristics>
- 10.9 In <spec:Spectral_Lookup>
- 10.10 In <wave:Wave_Observation>
- 11 <member_status>
- 12 nilReason
- 13 <parsing_standard_id>
- 14 <processing_level>
- 15 <purpose>
- 16 <record_delimiter>
- 17 <reference_type>
- 17.1 In <Bundle_Member_Entry>
- 17.2 In <Inventory>
- 17.3 In <Investigation_Area>/<Internal_Reference>
- 17.4 In <Observing_System_Component>/<Internal_Reference>
- 17.5 In <Reference_List>/<Internal_Reference> in Bundles
- 17.6 In <Reference_List>/<Internal_Reference> in Collections
- 17.7 In <Reference_List>/<Internal_Reference> in Ancillary Products
- 17.8 In <Reference_List>/<Internal_Reference> in Browse Products
- 17.9 In <Reference_List>/<Internal_Reference> in Context Products
- 17.10 In <Reference_List>/<Internal_Reference> in Document Products
- 17.11 In <Reference_List>/<Internal_Reference> in Observational Products
- 17.12 In <Reference_List>/<Source_Product_External>
- 17.13 In <Reference_List>/<Source_Product_Internal>
- 17.14 In <Target_Identification>/<Internal_Reference>
- 18 <type>
- 18.1 In <Investigation_Area>
- 18.2 In <Observation_Area> (or <Context_Area>)/<Target_Identification>
- 18.3 In <Observing_System_Component>
- 18.4 In <Product_Context>/<Facility>
- 18.5 In <Product_Context>/<Instrument>
- 18.6 In <Product_Context>/<Instrument_Host>
- 18.7 In <Product_Context>/<Investigation>
- 18.8 In <Product_Context>/<Target>
- 19 <wavelength_range>
<bundle_type>
In <Bundle>
|
<collection_type>
In <Collection>
|
<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
In bit fields
<discipline_name>
In <Primary_Result_Summary>/<Science_Facets>
|
|
<document_standard_id>
In <Document_File>
|
|
<domain>
In <Primary_Result_Summary>/<Science_Facets>
|
|
<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 |
|
not used |
Fields |
|
|
Flux Measurements |
|
not used |
Imaging |
|
not used |
Particles |
|
|
Ring-Moon Systems |
|
not used |
Small Bodies |
|
not used |
Spectroscopy |
|
not used |
If you have suggestions for additional facet values, please contact your PDS node representative.
<field_delimiter>
- Comma
- Horizontal Tab
- Semicolon
- Vertical Bar
<geom:kernel_provenance>
This attribute occurs in the Geometry discipline dictionary and namespace.
- Mixed
- Predicted
- Provenance Not Applicable
- Reconstructed
<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
In <geom:Coordinate_Space_Reference>
- to_reference_coordinate_space
In <geom:Expanded_Geometry>
- to_expanded_geometry
In <geom:Image_Display_Geometry>
- display_to_data_object
In <part:Particle_Observation>
- particle_observation_to_aligned_values
- particle_observation_to_axis_values
- particle_observation_to_face_values
- particle_observation_to_observation_values
In <spec:Axis_Bin_Set>
- spectral_characteristics_to_array_axis
In <spec:Axis_Uniformly_Sampled>
- spectral_characteristics_to_array_axis
In <spec:Spectral_Characteristics>
- spectral_characteristics_to_array_object
In <spec:Spectral_Lookup>
- spectral_characteristics_to_bin_center_values
- spectral_characteristics_to_bin_width_values
In <wave:Wave_Observation>
- wave_observation_to_axis_values
- wave_observation_to_face_values
- wave_observation_to_observation_values
<member_status>
In <Bundle_Member_Entry>
|
nilReason
This is actually an XML attribute that appears inside an element tag when that element is being explicitly defined as 'nil'. Very few PDS label attributes can be declared to be 'nil', but here's an example of what it might look like if you are, for example, labelling a product that doesn't really have a data collection time span:
<start_date_time xsi:nil="true" nilReason="inapplicable"/>
The allowed values for nilReason are:
- inapplicable
- anticipated
- missing
- unknown
<parsing_standard_id>
In <Header>
|
|
In <Inventory>
|
In <SPICE_Kernel>
|
In <Stream_Text>
|
In <Table_Delimited>
|
In <XML_Schema>
|
<processing_level>
In <Primary_Result_Summary>
|
<purpose>
In <Primary_Result_Summary>
|
<record_delimiter>
Everywhere in PDS4 where this attribute occurs it is required to have the same value:
- Carriage-Return Line-Feed
<reference_type>
In <Bundle_Member_Entry>
|
|
In <Inventory>
|
In <Investigation_Area>/<Internal_Reference>
|
In <Observing_System_Component>/<Internal_Reference>
|
Use is_facility for ground-based observatories and labs. Use is_airborne for balloons, aircraft, sounding rockets, etc., that serve as observing platforms. Use is_other for anything that doesn't clearly fit in one of the other categories.
In <Reference_List>/<Internal_Reference> in Bundles
|
In <Reference_List>/<Internal_Reference> in Collections
|
|
In <Reference_List>/<Internal_Reference> in Ancillary Products
|
In <Reference_List>/<Internal_Reference> in Browse Products
|
|
In <Reference_List>/<Internal_Reference> in Context Products
|
|
|
|
|
In <Reference_List>/<Internal_Reference> in Document Products
|
In <Reference_List>/<Internal_Reference> in Observational Products
|
|
In <Reference_List>/<Source_Product_External>
|
In <Reference_List>/<Source_Product_Internal>
|
In <Target_Identification>/<Internal_Reference>
|
<type>
In <Investigation_Area>
|
In <Observation_Area> (or <Context_Area>)/<Target_Identification>
|
|
Note: Do not use Centaur as the only value of <type> for any target in data labels submitted to SBN.. |
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>
Note: PDS has gutted the type list below. If you are preparing data for submission to SBN, please use values from the following list, and note that validation will produce error messages as those values are no longer included in IM schemas starting with version 1E00. If you are producing data for any other node, please consult the current Information Model Specification or Data Dictionary for valid values. |
|
In <Product_Context>/<Facility>
|
In <Product_Context>/<Instrument>
Note: <type> in the Instrument context product has been deprecated since IM release 1.12.0.0 (the 1C00 schema files) and replaced by the <Type_List_Area> subclass. Please contact your PDS Node for assistance with this if you find yourself faced with the prospect of creating an Instrument context object. |
In <Product_Context>/<Instrument_Host>
|
In <Product_Context>/<Investigation>
|
In <Product_Context>/<Target>
|
|
<wavelength_range>
In <Primary_Result_Summary>/<Science_Facets>
|
|