Difference between revisions of "SBN Discipline Dictionary"

From The SBN Wiki
Jump to navigation Jump to search
m
 
(One intermediate revision by one other user not shown)
Line 5: Line 5:
 
I'll be building the dictionary schema - the file we'll use to validate labels - by hand until a real dictionary tool exists.  The first part of this page lists classes and attributes already in the dictionary.  I'll need formal definitions for these, so please fill them in if you can.
 
I'll be building the dictionary schema - the file we'll use to validate labels - by hand until a real dictionary tool exists.  The first part of this page lists classes and attributes already in the dictionary.  I'll need formal definitions for these, so please fill them in if you can.
  
−
The second part of this page is for requesting new additions to the dictionary.  You must provide a name for the attribute, a data type, a definition, and any constraints necessary for validation (extrema, for example).  Attributes should be collected into classes of related concepts where that makes sense.  Classes can be added at the end of the attribute list.  Follow the form of the [[#Current Attributes]] section when adding new entries.
+
The second part of this page, [[#New Classes and Attributes|New Classes and Attributes]] is for requesting additions and modifications to the current classes and attributes (except for new definitions, which can and should be edited in place in the '''Current Classes''' section).
−
 
 
 
----
 
----
  
Line 177: Line 176:
 
:Unit Type: Angle<br />
 
:Unit Type: Angle<br />
 
:Definition:
 
:Definition:
 +
 +
-----
 +
-----
 +
=== New Classes and Attributes ===
 +
 +
Create (or modify) classes here to contain new (or existing) attributes.  If you want to change one of the existing classes listed above under [[#Current Classes|CurrentClasses]], make a new entry for it under this heading and describe the changes to be made.
 +
 +
Here's an example you can cut-and-paster for editing:
 +
 +
==== ClassName ====
 +
Explain what the class is meant to contain - what sort of information is gathered in the class.  Then indicate what is in the class, or what changes should be made, as a bulleted list:
 +
* newAttribute1 - give a definition, units, data type, etc.  Prose is fine.
 +
* newAttribute2 - definitions, etc.
 +
* add oldAttribute1 - as attribute already defined above to include in this class
 +
* remove oldAttribute2 - an attribute that should be removed from the existing class

Latest revision as of 20:14, 29 January 2013

Small Bodies Discipline Dictionary

This dictionary should contain classes and attributes specific to small bodies research. It should not contain things that are better defined in the context of the mission or things that should be in some other discipline-specific dictionary - the the exception of geometry. We will be incorporating geometric parameters into our mock-up dictionary until it becomes clear how geometry should be handled across the PDS.

I'll be building the dictionary schema - the file we'll use to validate labels - by hand until a real dictionary tool exists. The first part of this page lists classes and attributes already in the dictionary. I'll need formal definitions for these, so please fill them in if you can.

The second part of this page, New Classes and Attributes is for requesting additions and modifications to the current classes and attributes (except for new definitions, which can and should be edited in place in the Current Classes section).

Current Classes

Attributes should be grouped into classes. Classes are named using camel case with the first letter capitalized. Attributes are considered required unless otherwise indicated.

JulianDates

Julian date equivalents of observation times

Filter

Simple filter description

GroundbasedParameters

General ground-based observing parameters

Geometry

Catch-all geometry class - though perhaps this should be divided into ground-based and spacecraft classes?

Current Attributes

Please do edit any and all of these definitions as warranted.

startJulianDate
Type: Double-precision float
Definition: Full Julian date of the start point of an observation.
stopJulianDate
Type: Double-precision float
Definition: Full Julian date of the end point of an observation.
midJulianDate
Type: Double-precision float
Definition: Full Julian date of the mid-point of an observation.
filterName
Type: String
Definition:
centerWavelength
Type: Float
Unit Type: Length
Definition: Center wavelength of the filter bandpass
airmass
Type: Double-precision float
Unit Type: airmass
Minimum: 1.00
Definition:
rightAscension
Type: Double-precision float
Unit Type: degrees
Minimum: 0.00
Maximum: 360.00
Definition: Right ascension, in degrees
declination
Type: Double-precision float
Unit Type: degrees
Minimum: -90.00
Maximun: 90.00
Definition: Declination, in degrees
exposureTime
Type: Float
Unit Type: Time
Minimum: 0.00
Definition:
pixelFOV
Type: Float
Unit Type: Angle
Minimum: 0.00
Definition:
timeFromClosestApproach
Type: Double-precision float
Unit Type: Time
Definition:
geometryNote
Type: String, white space preserved
Definition: A place for comments specific to the attributes in the geometry class
SPICEFileNames
Type: String, white-space delimited file names
Definition: A list of SPICE kernels used for calculating the associated geometry
targetSpacecraftPosition
Type: 3-vector of double-precision floats
Unit Type: Distance - fixed to km
Definition: Distance measured from the center of mass of the target to the center of mass of the spacecraft
targetSpacecraftVelocity
Type: 3-vector of double-precision floats
Unit Type: Distance - fixed to km/s
Definition:
targetCenterDistance
Type: double-precision float
Unit Type: Length
:Definition:
spacecraftHeliocentricDistance
Type: double-precision float
Unit Type: Length
Definition:
spacecraftSunPosition
Type: 3-vector of double-precision floats
Unit Type: Distance - fixed to km
Definition:
spacecraftHeliocentricVelocity
Unit Type: Distance - fixed to km/s
Definition:
targetHeliocentricDistance
Type: double-precision float
Unit Type: Length
Definition:
targetSunPosition
Type: 3-vector of double-precision floats
Unit Type: Distance - fixed to km
Definition:
targetHeliocentricVelocity
Type: 3-vector of double-precision floats
Unit Type: Distance - fixed to km/s
Definition:
spacecraftGeocentricDistance
Type: double-precision float
Unit Type: Length
Definition:
spacecraftEarthPosition
Type: 3-vector of double-precision floats
Unit Type: Distance - fixed to km
Definition:
targetGeocentricDistance
Type: double-precision float
Unit Type: Length
Definition:
earthTargetPosition
Type: 3-vector of double-precision floats
Unit Type: Length
Definition:
earthTargetVelocity
Type: 3-vector of double-precision floats
Unit Type: Velocity
Definition:
phaseAngle
Type: Double-precision float
Unit Type: Angle
Definition:
celestialNorthClockAngle
Type: Double-precision float
Unit Type: Angle
Definition:
solarNorthPoleClockAngle
Type: Double-precision float
Unit Type: Angle
Definition:

New Classes and Attributes

Create (or modify) classes here to contain new (or existing) attributes. If you want to change one of the existing classes listed above under CurrentClasses, make a new entry for it under this heading and describe the changes to be made.

Here's an example you can cut-and-paster for editing:

ClassName

Explain what the class is meant to contain - what sort of information is gathered in the class. Then indicate what is in the class, or what changes should be made, as a bulleted list:

  • newAttribute1 - give a definition, units, data type, etc. Prose is fine.
  • newAttribute2 - definitions, etc.
  • add oldAttribute1 - as attribute already defined above to include in this class
  • remove oldAttribute2 - an attribute that should be removed from the existing class
Retrieved from "http://sbnwiki.astro.umd.edu/wiki/index.php?title=SBN_Discipline_Dictionary&oldid=687"