Difference between revisions of "Filling Out Context Object Classes"

From The SBN Wiki
Jump to navigation Jump to search
(Creation - Safety Save)
(Creation - Safety Save)
Line 14: Line 14:
 
''REQUIRED''
 
''REQUIRED''
  
−
The name of the agency.  Use the full name, and if there's a popular acronym include it in parentheses following the name.
+
This ''must'' be identical to either the value of the ''<title>'' or one of the ''<alternate_title>" attributes listed in the ''Identification_Area''.
  
−
 
+
{| class="wikitable" style="background-color: thistle"
−
The name in the ''Identification_Area'' is the name of the PDS4 product.  This is the name of the agency.  They may be similar, but functionally they are different things.
+
| '''''Note:''''' ''This seems odd and pointless to me.  If you agree, let me know in writing so I can toss it back to the development team with some documentation.
 +
|}
  
  
Line 24: Line 25:
  
 
''REQUIRED''
 
''REQUIRED''
−
 
  
 
This is for a brief description of the agency named.
 
This is for a brief description of the agency named.
−
 
−
 
−
 
  
 
== <Facility> ==
 
== <Facility> ==
−
 
  
 
This class is used for facilities like a terrestrial labs and observatories.
 
This class is used for facilities like a terrestrial labs and observatories.
−
 
  
 
=== <name> ===
 
=== <name> ===
Line 41: Line 36:
 
''OPTIONAL''
 
''OPTIONAL''
  
−
The name of the facility.  Use the full name, and if there's a popular acronym include it in parentheses following the name.
+
 
 +
This ''must'' be identical to either the value of the ''<title>'' or one of the ''<alternate_title>" attributes listed in the ''Identification_Area''.
  
 
{| class="wikitable" style="background-color: thistle"
 
{| class="wikitable" style="background-color: thistle"
−
| '''''Note:''''' ''This attribute is currently optional, but should be required, logically.  It will be required for all ''Facility'' objects created by SBN data preparers.''
+
| '''''Note:''''' ''This seems odd and pointless to me.  If you agree, let me know in writing so I can toss it back to the development team with some documentation.
 
|}
 
|}
  
 
=== <type> ===
 
=== <type> ===
−
 
  
 
''OPTIONAL''
 
''OPTIONAL''
Line 57: Line 52:
 
| '''''Note:''''' ''This attribute is currently optional, but should be required, logically.  It will be required for all ''Facility'' objects created by SBN data preparers.''
 
| '''''Note:''''' ''This attribute is currently optional, but should be required, logically.  It will be required for all ''Facility'' objects created by SBN data preparers.''
 
|}
 
|}
−
 
  
 
=== <address> ===
 
=== <address> ===
Line 86: Line 80:
 
''OPTIONAL''
 
''OPTIONAL''
  
−
The name of the instrument.  Use the full name, and if there's a popular acronym include it in parentheses following the name.
+
 
 +
This ''must'' be identical to either the value of the ''<title>'' or one of the ''<alternate_title>" attributes listed in the ''Identification_Area''.
  
 
{| class="wikitable" style="background-color: thistle"
 
{| class="wikitable" style="background-color: thistle"
−
| '''''Note:''''' ''This attribute is currently optional, but should be required, logically.  It will be required for all ''Instrument'' objects created by SBN data preparers.''
+
| '''''Note:''''' ''This seems odd and pointless to me.  If you agree, let me know in writing so I can toss it back to the development team with some documentation.
 
|}
 
|}
  
Line 129: Line 124:
 
This class is for describing the hardware an ''Instrument'' is physically mounted on/to.
 
This class is for describing the hardware an ''Instrument'' is physically mounted on/to.
  
−
=== <> ===
+
=== <name> ===
  
 
''OPTIONAL''
 
''OPTIONAL''
  
  
−
The name of the instrument host.  Use the full name, and if there's a popular acronym include it in parentheses following the name.
+
This ''must'' be identical to either the value of the ''<title>'' or one of the ''<alternate_title>" attributes listed in the ''Identification_Area''.
  
 
{| class="wikitable" style="background-color: thistle"
 
{| class="wikitable" style="background-color: thistle"
−
| '''''Note:''''' ''This attribute is currently optional, but should be required, logically.  It will be required for all ''Instrument_Host'' objects created by SBN data preparers.''
+
| '''''Note:''''' ''This seems odd and pointless to me.  If you agree, let me know in writing so I can toss it back to the development team with some documentation.
 
|}
 
|}
−
 
  
 
=== <version_id> ===
 
=== <version_id> ===
−
 
  
 
''OPTIONAL''
 
''OPTIONAL''
Line 151: Line 144:
  
 
=== <type> ===
 
=== <type> ===
−
 
  
 
''REQUIRED''
 
''REQUIRED''
−
 
  
 
This must be one of the standard values '''Earth_Based''', '''Rover''' or '''Spacecraft'''.
 
This must be one of the standard values '''Earth_Based''', '''Rover''' or '''Spacecraft'''.
−
 
−
 
  
 
{| class="wikitable" style="background-color: thistle"
 
{| class="wikitable" style="background-color: thistle"
Line 191: Line 180:
 
''OPTIONAL''
 
''OPTIONAL''
  
−
The name of the investigation.  Use the full name, and if there's a popular acronym or nickname include it in parentheses following the name.
+
 
 +
This ''must'' be identical to either the value of the ''<title>'' or one of the ''<alternate_title>" attributes listed in the ''Identification_Area''.
  
 
{| class="wikitable" style="background-color: thistle"
 
{| class="wikitable" style="background-color: thistle"
−
| '''''Note:''''' ''This attribute is currently optional, but should be required, logically.  It will be required for all ''Investigation'' objects created by SBN data preparers.''
+
| '''''Note:''''' ''This seems odd and pointless to me.  If you agree, let me know in writing so I can toss it back to the development team with some documentation.
 
|}
 
|}
  
Line 245: Line 235:
 
== <Target> ==
 
== <Target> ==
  
 +
Use this class when it is useful to define a target context object for an observational target.  It provides a permanent hub for linking to additional description and information (via the ''Reference_List'', primarily).
 +
 +
''Target'' products should be created when such a hub is wanted/needed.  For example, if the target is a piece of hardware, like a calibration lamp, with specific characteristics that can be/are described by associated document products in the archive (or published references outside the archive), and ''Target'' product can link the target name to those references.
 +
 +
=== <name> ===
 +
 +
 +
''OPTIONAL''
 +
 +
This ''must'' be identical to either the value of the ''<title>'' or one of the ''<alternate_title>" attributes listed in the ''Identification_Area''.
 +
 +
{| class="wikitable" style="background-color: thistle"
 +
| '''''Note:''''' ''This seems odd and pointless to me.  If you agree, let me know in writing so I can toss it back to the development team with some documentation.
 +
|}
 +
 +
 +
=== <type> ===
 +
 +
 +
''OPTIONAL''
 +
This must be one of the standard values from the list in the [[Standard_Values_Quick_Reference#In_.3CProduct_Context.3E.2F.3CTarget.3E|Standard Values Quick Reference]].  If more than one of these types applies to the ''Target'', you may repeat the ''<type>'' attribute.
 +
=== <description> ===
 +
''REQUIRED''
 +
This free-format text field must contain a description of the target itself.
  
  
 
== <Telescope> ==
 
== <Telescope> ==
 +
 +
This class is designed for identifying and providing key details about permanently-mounted terrestrial telescopes.
 +
 +
{| class="wikitable" style="background-color: thistle"
 +
| '''''Note:''''' ''This context object should be useable for mobile telescopes as well, but isn't in its current form.  The only other option would be the ''<Other>'' class, which is unsatisfyingly vague.  For the time being, the best option for mobile scope is probably to user this class and ignore the validation errors.''
 +
|}
 +
 +
=== <name*gt; ===
 +
 +
 +
''OPTIONAL''
 +
 +
This ''must'' be identical to either the value of the ''<title>'' or one of the ''<alternate_title>" attributes listed in the ''Identification_Area''.
 +
 +
{| class="wikitable" style="background-color: thistle"
 +
| '''''Note:''''' ''This seems odd and pointless to me.  If you agree, let me know in writing so I can toss it back to the development team with some documentation.
 +
|}
 +
=== <aperture> ===
 +
''REQUIRED''
 +
This attribute holds the diameter of the telescope aperture.  You must specify a unit of length for this value. For example:<pre>    <aperture unit="m">1.3</aperture></pre>
 +
=== &lt;longitude&gt; ===
 +
''REQUIRED''
 +
This should be the east longitude of the telescope mounting.  The value is a single floating-point value, and you will need to specify units for the value.  For example:<pre>  <longitude unit="degree">123.4567</longitude></pre>
 +
{| class="wikitable" style="background-color: thistle"| '''''Note:''''' ''The current definition of ''longitude'' is not sufficiently specific.  It does not indicate the direction of measurement or the range of values.  It is also allowed to have angular units other than degrees.''|}
 +
=== &lt;latitude&gt; ===
 +
''REQUIRED''
 +
This should be the north latitude of the telescope mounting.  The value is a single floating-point value, and you will need to specify units for the value.  For example:<pre>  <longitude unit="degree">-12.34567</longitude></pre>
 +
{| class="wikitable" style="background-color: thistle"| '''''Note:''''' ''The current definition of ''latitude'' is not sufficiently specific.  It  allows angular units other than degrees.''|}
 +
=== &lt;altitude&gt; ===
 +
''REQUIRED''
 +
This is the altitude of the telescope above sea level.  You will have to specify units for this value:<pre>    <altitude unit="m">14000</altitude></pre>
 +
=== &lt;coordinate_source&gt; ===
 +
''REQUIRED''
 +
This must be one of the values in the [[Standard_Values_Quick_Reference#.3Ccoordinate_source.3E|Standard Value Quick Reference]].  If you have a value that doesn't fit, let me know.  Use ''Unknown'' for mobile telescopes for the time being.
 +
=== &lt;description&gt; ===
 +
''OPTIONAL''
 +
This is for a free-format text description of the telescope.

Revision as of 23:31, 24 January 2013

Following are the context object classes and their attributes. Only one instance of one of these may appear in any context product. Only the context objects that a data preparer is likely to use are listed. There are some additional objects used for PDS system maintenance. Your PDS consultant will advise you directly in the unlikely event you need to create context products for these,

For additional explanation, see the PDS4 Standard Reference, or contact your PDS node consultant.

Note that in the PDS4 master schema, all classes have capitalized names; attributes never do.


<Agency>

This is used to provide basic information about an agency, like NASA or ESA.

<name>

REQUIRED

This must be identical to either the value of the <title> or one of the <alternate_title>" attributes listed in the Identification_Area.

Note: This seems odd and pointless to me. If you agree, let me know in writing so I can toss it back to the development team with some documentation.


<description>

REQUIRED

This is for a brief description of the agency named.

<Facility>

This class is used for facilities like a terrestrial labs and observatories.

<name>

OPTIONAL


This must be identical to either the value of the <title> or one of the <alternate_title>" attributes listed in the Identification_Area.

Note: This seems odd and pointless to me. If you agree, let me know in writing so I can toss it back to the development team with some documentation.

<type>

OPTIONAL

This must be one of the two standard values Laboratory or Observatory. If you need a different value, contact your PDS consultant.

Note: This attribute is currently optional, but should be required, logically. It will be required for all Facility objects created by SBN data preparers.

<address>

OPTIONAL

This is a text field to hold the address (mailing address, street address or both) of the facility.

<country>

OPTIONAL

This attribute is for the name of the country. It's not clear why this is here. If you use it, I suggest you use it for the full name of the country, with the intention of using it for searching out ground-based observatories and related data by country of origin.

<description>

OPTIONAL

This is a place for free-format text to provide additional relevant details about the facility.


<Instrument>

Use this for anything that can be reasonably considered to be an instrument, in the "taking data" sense.

<name>

OPTIONAL


This must be identical to either the value of the <title> or one of the <alternate_title>" attributes listed in the Identification_Area.

Note: This seems odd and pointless to me. If you agree, let me know in writing so I can toss it back to the development team with some documentation.

<version_id>

OPTIONAL

Note: The version of the Instrument product is in the Identification_Area. This version_id should never be used in SBN Instrument context products.

<type>

REQUIRED

This must be one of the standard values listed in the Standard Values Quick Reference. If the instrument you're describing corresponds to more than one of these values, you may repeat the <type> attribute.

<description>

REQUIRED

Free-format text description of the instrument.

<naif_instrument_id>

OPTIONAL

If the instrument being described has a NAIF identification code, type it in here.

<serial_number>

OPTIONAL

If the instrument has a known serial number, this is the place for it.


<Instrument_Host>

This class is for describing the hardware an Instrument is physically mounted on/to.

<name>

OPTIONAL


This must be identical to either the value of the <title> or one of the <alternate_title>" attributes listed in the Identification_Area.

Note: This seems odd and pointless to me. If you agree, let me know in writing so I can toss it back to the development team with some documentation.

<version_id>

OPTIONAL

Note: The version of the Instrument_Host product is in the Identification_Area. This version_id should never be used in SBN Instrument_Host context products.

<type>

REQUIRED

This must be one of the standard values Earth_Based, Rover or Spacecraft.

Note: These values don't make sense in many cases, or when compared to each other. Fudge it for now; hopefully this will be fixed before the version 1.0 release.

<description>

REQUIRED

This is a free-format text description of the instrument host.

<naif_host_id>

OPTIONAL

If the host has a NAIF identification code, this is the place to put it.

<serial_number>

OPTIONAL

If the host has a known serial number, it can be recorded here for posterity,


<Investigation>

This class is for describing a mission, a coordinated observing campaign, or some other large-scale, organized effort to collect data.

<name>

OPTIONAL


This must be identical to either the value of the <title> or one of the <alternate_title>" attributes listed in the Identification_Area.

Note: This seems odd and pointless to me. If you agree, let me know in writing so I can toss it back to the development team with some documentation.

<type>

REQUIRED

This must be one of the four standard values: Individual_Investigation, Mission, Observing_Campaign, Other_Investigation.

<description>

REQUIRED

This is a free-format text description of the investigation.

<start_date>

REQUIRED

The date of the start of the investigation, in ISO 8601 format.

If this is, for some reason, not available, you can use the nilreason attribute, like this: 

    <start_date nil_reason="missing"/>

<stop_date>

REQUIRED

The date of the end of the investigation, in ISO 8601 format.

If this is not available for some reason (most often that the investigation isn't over yet), you can use the nilreason attribute, like this: 

    <stop_date nil_reason="anticipated"/>


<Other>

Use this context class only if no other class is reasonably applicable.

<description>

REQUIRED

This free-form text should provide whatever key details about the context object are relevant to the archive. Best to be explicit about this if you're using the Other context object.


<Target>

Use this class when it is useful to define a target context object for an observational target. It provides a permanent hub for linking to additional description and information (via the Reference_List, primarily).

Target products should be created when such a hub is wanted/needed. For example, if the target is a piece of hardware, like a calibration lamp, with specific characteristics that can be/are described by associated document products in the archive (or published references outside the archive), and Target product can link the target name to those references.

<name>

OPTIONAL

This must be identical to either the value of the <title> or one of the <alternate_title>" attributes listed in the Identification_Area.

Note: This seems odd and pointless to me. If you agree, let me know in writing so I can toss it back to the development team with some documentation.


<type>

OPTIONAL This must be one of the standard values from the list in the Standard Values Quick Reference. If more than one of these types applies to the Target, you may repeat the <type> attribute.

<description>

REQUIRED This free-format text field must contain a description of the target itself.


<Telescope>

This class is designed for identifying and providing key details about permanently-mounted terrestrial telescopes.

Note: This context object should be useable for mobile telescopes as well, but isn't in its current form. The only other option would be the <Other> class, which is unsatisfyingly vague. For the time being, the best option for mobile scope is probably to user this class and ignore the validation errors.

<name*gt;

OPTIONAL

This must be identical to either the value of the <title> or one of the <alternate_title>" attributes listed in the Identification_Area.

Note: This seems odd and pointless to me. If you agree, let me know in writing so I can toss it back to the development team with some documentation.

<aperture>

REQUIRED

This attribute holds the diameter of the telescope aperture. You must specify a unit of length for this value. For example:

    <aperture unit="m">1.3</aperture>

<longitude>

REQUIRED

This should be the east longitude of the telescope mounting. The value is a single floating-point value, and you will need to specify units for the value. For example:

  <longitude unit="degree">123.4567</longitude>

<latitude>

REQUIRED

This should be the north latitude of the telescope mounting. The value is a single floating-point value, and you will need to specify units for the value. For example:
  <longitude unit="degree">-12.34567</longitude>

<altitude>

REQUIRED

This is the altitude of the telescope above sea level. You will have to specify units for this value:
    <altitude unit="m">14000</altitude>

<coordinate_source>

REQUIRED This must be one of the values in the Standard Value Quick Reference. If you have a value that doesn't fit, let me know. Use Unknown for mobile telescopes for the time being.

<description>

OPTIONAL This is for a free-format text description of the telescope.

Retrieved from "http://sbnwiki.astro.umd.edu/wiki/index.php?title=Filling_Out_Context_Object_Classes&oldid=639"