Skip to content

Commit

Permalink
Merge pull request #1 from pds-data-dictionaries/rev-250109
Browse files Browse the repository at this point in the history
Initial ingest version 1.0.0.0
  • Loading branch information
jennifergward authored Jan 15, 2025
2 parents 22d0dd8 + ed99f97 commit 3d9b6d0
Show file tree
Hide file tree
Showing 34 changed files with 1,942 additions and 1,038 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Changelog

## 1.0.0.0
- 6/15/2020 GEO/EAG Initial version of the LCROSS mission dictionary for PDS3 to PDS4 migration.

- 11/20/2024 GEO/JGW Minor updates for dictionary release.
74 changes: 10 additions & 64 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,67 +1,21 @@
<!--
README.md template
In this template, values delimited by braces (e.g., "{value}") should be
replaced by the appropriate values for your namespace. The braces
should then be removed. Example values are provided as comments for
potentially mysterious cases.
-->

# {dictionary name} ({prefix:}) {"Discipline" or "Local"} Dictionary
<!-- EXAMPLES
Spectral (sp:) Discipline Dictionary
DART Mission (dart:) Local Dictionary
-->

The {dictionary name} dictionary provides classes and attributes for
{brief functional description}

### Steward
{steward name} ({steward GitHub handle}), {steward node}
<!-- EXAMPLE
Anne Raugh (@acraugh), Small Bodies Node (SBN)
-->
# LCROSS Mission Dictionary

# Documentation

<!-- The following assumes the complete documentation set exists. If it
does not, edit the sentence and link accordingly. -->
The User's Guide and detailed documentation for using this dictionary in
label design and processing
are located at https://pds-data-dictionaries.github.io/{repo id}.
<!-- EXAMPLE
are located at https://pds-data-dictionaries.github.io/ldd-template.
-->

# Latest Release
The LCROSS Mission Dictionary (lcross) contains classes, attributes and rules specific to the LCROSS mission and its instruments.

<!-- Note that the Dictionaries Page link below won't look right on the
rendered page until you replace the braces and content with the
dictionary prefix.
Steward: Jennifer Ward, [PDS Geosciences Node](https://pds-geosciences.wustl.edu/)

EXAMPLE

[PDS Data Dictionaries Page](https://pds.nasa.gov/datastandards/dictionaries/#sp)
The GitHub link will exist once there is an official first release of
the dictionary (typically part of a system build) for the namespace. The
link is the same for all LDD repos and all builds.
# Documentation

The change log file is usually in the root directory of the repo, but
path information relative to root can be included if needed.
See this dictionary's online documentation at https://pds-data-dictionaries.github.io/ldd-lcross for a User Guide and Detailed Documentation (TBD).

EXAMPLES
# Latest Release

* Review the [Change Log] (ChangeLog.md)
* Review the [Change Log] (src/CHANGELOG.md)
-->
* Download dictionary files from the [PDS Data Dictionaries Page](https://pds.nasa.gov/datastandards/dictionaries/#{dictionary prefix})
* On [GitHub](../../releases/latest)
* Review the [Change log]({change log file name})
* [LCROSS](https://pds.nasa.gov/datastandards/dictionaries/#lcross)
* [GitHub](../../releases/latest)
* [Change log](CHANGELOG.md)

# About This Repository
<!-- The top-level directory structure and names must not change, but if
you have more to say about any of these directories, edit away! -->
In this repo you will find...
* **[src](src)/** - The directory containing the managed *IngestLDD* file
that defines this namespace. This is where changes to the namespace
Expand All @@ -87,12 +41,10 @@ The `gh-pages` branch is auto-generated and used to run the documentation site.
# Contributing to this Dictionary

## Suggest a Feature or Report a Bug
<!-- replace "repo id" below with the "ldd-xxx" string from the
GitHub repo URL.-->

There is a common place to request enhancements and report problems for
any PDS-curated dictionary - the [PDS4 Issue Repo](https://github.com/pds-data-dictionaries/PDS4-LDD-Issue-Repo/issues/new/choose).
Search for the \[{repo id}\] update request block and click the green
Search for the \[ldd-lcross\] update request block and click the green
"Get Started" button.

## Contribute Code or documentation
Expand All @@ -108,12 +60,6 @@ for documentation and tutorials describing the procedures
required to reserve a namespace,
establish a new repo, and build your dictionary.

<!-- NOTE
PDS needs a better suggestion than the following, but I'm hesitant
to point to my wiki and I don't see the information clearly
identified elsewhere...
-->
If you need help creating your *IngestLDD* file, contact the [Dictionary Stewards Group](https://pds-data-dictionaries.github.io/teams/pds-dd-stewards.html). Documentation is in preparation.

# For Dictionary Stewards
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
"Sort Key","Type","Name","Version","Name Space Id","Description","Steward","Value Type","Minimum Cardinality","Maximum Cardinality","Minimum Value","Maximum Value","Minimum Characters","Maximum Characters","Unit of Measure Type","Specified Unit Id","Attribute Concept","Conceptual Domain"
"lcross:MIR_Instrument_State:1 ","Class","MIR_Instrument_State","1.0.0.0","lcross","Class with attributes specific to the MIR instrument on LCROSS.","geo","","","","","","","","","","",""
"lcross:MIR_Instrument_State:2 lcross:instrument_gain_state:1 ","Attribute","instrument_gain_state","n/a","lcross","The instrument_gain_state specifies the instrument gain state, either High or Low. ","geo","ASCII_Short_String_Collapsed","0","1","Unbounded","Unbounded","1","255","Units_of_None","none","TBD_classConcept","SHORT_STRING"
"lcross:MIR_Instrument_State:2 lcross:instrument_gain_state:2 Value:High","Value","High","","","High"
"lcross:MIR_Instrument_State:2 lcross:instrument_gain_state:2 Value:Low","Value","Low","","","Low"
"lcross:MIR_Instrument_State:2 lcross:missing_packet_flag:1 ","Attribute","missing_packet_flag","n/a","lcross","The missing_packet_flag indicates whether the image is missing data. A missing packet appears as a horizontal bar 8 pixels high of zero data. ","geo","ASCII_Short_String_Collapsed","0","1","Unbounded","Unbounded","1","255","Units_of_None","none","TBD_classConcept","SHORT_STRING"
"lcross:MIR_Instrument_State:2 lcross:missing_packet_flag:2 Value:No","Value","No","","","No packets were missed."
"lcross:MIR_Instrument_State:2 lcross:missing_packet_flag:2 Value:Yes","Value","Yes","","","Packets are missing."
"lcross:MIR_Instrument_State:2 lcross:calibration_valid:1 ","Attribute","calibration_valid","n/a","lcross","The response of the mid-IR cameras exhibited a startup transient. The calibration is valid only after this transient had settled. This attribute indicates whether the image was taken before or after this point. Values are Yes or No. ","geo","ASCII_Short_String_Collapsed","0","1","Unbounded","Unbounded","1","255","Units_of_None","none","TBD_classConcept","SHORT_STRING"
"lcross:MIR_Instrument_State:2 lcross:calibration_valid:2 Value:No","Value","No","","","Calibration is not valid."
"lcross:MIR_Instrument_State:2 lcross:calibration_valid:2 Value:Yes","Value","Yes","","","Calibration is valid."
"lcross:NIR_Instrument_State:1 ","Class","NIR_Instrument_State","1.0.0.0","lcross","Class with attributes specific to the NIR instrument on LCROSS.","geo","","","","","","","","","","",""
"lcross:NIR_Instrument_State:2 lcross:enhancement_mode:1 ","Attribute","enhancement_mode","n/a","lcross","This attribute indicates whether onboard image stretching was enabled or disabled. Values are On or Off. ","geo","ASCII_Short_String_Collapsed","0","1","Unbounded","Unbounded","1","255","Units_of_None","none","TBD_classConcept","SHORT_STRING"
"lcross:NIR_Instrument_State:2 lcross:enhancement_mode:2 Value:Off","Value","Off","","","Onboard image enhancement was disabled."
"lcross:NIR_Instrument_State:2 lcross:enhancement_mode:2 Value:On","Value","On","","","Onboard image enhancement was enabled."
"lcross:NIR_Instrument_State:2 lcross:operating_setting_value:1 ","Attribute","operating_setting_value","n/a","lcross","The operating setting value determines the integration time and gain. Values range from 0 to 15. ","geo","ASCII_Integer","0","1","0","15","Unbounded","Unbounded","Units_of_None","none","TBD_classConcept","INTEGER"
"lcross:NIR_Instrument_State:2 lcross:integration_time:1 ","Attribute","integration_time","n/a","lcross","The integration time in msec. ","geo","ASCII_Integer","0","1","0","9223372036854775807","Unbounded","Unbounded","Units_of_Time","none","TBD_classConcept","INTEGER"
"lcross:NIR_Instrument_State:2 lcross:gain_value:1 ","Attribute","gain_value","n/a","lcross","The focal plane sensitivity in electrons per count. Value is approximate and inferred from the operating setting value and factory definitions. ","geo","ASCII_Integer","0","1","0","9223372036854775807","Unbounded","Unbounded","Units_of_None","none","TBD_classConcept","INTEGER"
"lcross:NSP_Instrument_State:1 ","Class","NSP_Instrument_State","1.0.0.0","lcross","Class with attributes specific to the NSP instrument on LCROSS.","geo","","","","","","","","","","",""
"lcross:NSP_Instrument_State:2 lcross:saturation_flag:1 ","Attribute","saturation_flag","n/a","lcross","Indicates whether a spectra is saturated based on a mechanical test. ","geo","ASCII_Short_String_Collapsed","0","1","Unbounded","Unbounded","1","255","Units_of_None","none","TBD_classConcept","SHORT_STRING"
"lcross:NSP_Instrument_State:2 lcross:saturation_flag:2 Value:No","Value","No","","","No saturation."
"lcross:NSP_Instrument_State:2 lcross:saturation_flag:2 Value:Yes","Value","Yes","","","Saturation noted."
"lcross:NSP_Instrument_State:2 lcross:boresight_to_sun_angle:1 ","Attribute","boresight_to_sun_angle","n/a","lcross","Angle between the instrument boresight vector and the spacecraft to sun vector in degrees. ","geo","ASCII_Real","0","1","-1.7976931348623157e308","1.7976931348623157e308","Unbounded","Unbounded","Units_of_Angle","none","TBD_classConcept","REAL"
"lcross:VSP_Instrument_State:1 ","Class","VSP_Instrument_State","1.0.0.0","lcross","Class with attributes specific to the VSP instrument on LCROSS.","geo","","","","","","","","","","",""
"lcross:VSP_Instrument_State:2 lcross:saturation_flag:1 ","Attribute","saturation_flag","n/a","lcross","Indicates whether a spectra is saturated based on a mechanical test. ","geo","ASCII_Short_String_Collapsed","0","1","Unbounded","Unbounded","1","255","Units_of_None","none","TBD_classConcept","SHORT_STRING"
"lcross:VSP_Instrument_State:2 lcross:saturation_flag:2 Value:No","Value","No","","","No saturation."
"lcross:VSP_Instrument_State:2 lcross:saturation_flag:2 Value:Yes","Value","Yes","","","Saturation noted."
"lcross:VSP_Instrument_State:2 lcross:exposure_duration:1 ","Attribute","exposure_duration","n/a","lcross","The time interval between the opening and closing of an instrument aperture. ","geo","ASCII_Real","0","1","-1.7976931348623157e308","1.7976931348623157e308","Unbounded","Unbounded","Units_of_None","none","TBD_classConcept","REAL"
"lcross:VSP_Instrument_State:2 lcross:tec_setpoint:1 ","Attribute","tec_setpoint","n/a","lcross","The setpoint temperature of the VSP thermo-electric cooler. ","geo","ASCII_Real","0","1","-1.7976931348623157e308","1.7976931348623157e308","Unbounded","Unbounded","Units_of_Temperature","none","TBD_classConcept","REAL"
"lcross:VSP_Instrument_State:2 lcross:tec_temperature:1 ","Attribute","tec_temperature","n/a","lcross","The measurement temperature of the VSP thermo-electric cooler. ","geo","ASCII_Real","0","1","-1.7976931348623157e308","1.7976931348623157e308","Unbounded","Unbounded","Units_of_Temperature","none","TBD_classConcept","REAL"
"lcross:VSP_Instrument_State:2 lcross:packet_timestamp:1 ","Attribute","packet_timestamp","n/a","lcross","A 32-bit unsigned integer representing time from the epoch Jan 1, 1980 in milliseconds. This counter resets every approximately 50 days. ","geo","ASCII_Integer","0","1","-9223372036854775808","9223372036854775807","Unbounded","Unbounded","Units_of_None","none","TBD_classConcept","INTEGER"
"lcross:VSP_Instrument_State:2 lcross:vsp_bracket_number:1 ","Attribute","vsp_bracket_number","n/a","lcross","When in bracket mode, the VSP captures three spectra in quick succession. The bracket number indicates which of the three spectra are captured.. ","geo","ASCII_Integer","0","1","-9223372036854775808","9223372036854775807","Unbounded","Unbounded","Units_of_None","none","TBD_classConcept","INTEGER"
"lcross:Mission_Parameters:1 ","Class","Mission_Parameters","1.0.0.0","lcross","Container class for mission level attributes (i.e., common across all or most instruments) and instrument specific classes.","geo","","","","","","","","","","",""
"lcross:Mission_Parameters:2 lcross:product_type:1 ","Attribute","product_type","n/a","lcross"," The product_type attributes identifies the type or category of a product within a data set. ","geo","ASCII_Short_String_Collapsed","0","1","Unbounded","Unbounded","1","255","Units_of_None","none","TBD_classConcept","SHORT_STRING"
"lcross:Mission_Parameters:2 lcross:product_type:2 Value:Calibrated Data","Value","Calibrated Data","","","Calibrated data from an instrument."
"lcross:Mission_Parameters:2 lcross:product_type:2 Value:Calibrated Image","Value","Calibrated Image","","","A radiometrically calibrated product."
"lcross:Mission_Parameters:2 lcross:product_type:2 Value:Calibrated Spectrum","Value","Calibrated Spectrum","","","A radiometrically calibrated spectrum."
"lcross:Mission_Parameters:2 lcross:product_type:2 Value:Raw Data","Value","Raw Data","","","Raw output from an instrument, usually in DN."
"lcross:Mission_Parameters:2 lcross:product_type:2 Value:Raw Image","Value","Raw Image","","","A raw product."
"lcross:Mission_Parameters:2 lcross:product_type:2 Value:Raw Spectrum","Value","Raw Spectrum","","","A raw spectrum product."
"lcross:Mission_Parameters:2 lcross:producer_institution_name:1 ","Attribute","producer_institution_name","n/a","lcross"," The producer_institution_name element identifies a university, research center, NASA center or other institution associated with the production of a data set. ","geo","ASCII_Short_String_Collapsed","0","1","Unbounded","Unbounded","1","255","Units_of_None","none","TBD_classConcept","SHORT_STRING"
"lcross:Mission_Parameters:2 lcross:mission_phase_name:1 ","Attribute","mission_phase_name","n/a","lcross"," The mission_phase_name element provides the commonly-used identifier of a mission phase. ","geo","ASCII_Short_String_Collapsed","0","1","Unbounded","Unbounded","1","255","Units_of_None","none","TBD_classConcept","SHORT_STRING"
"lcross:Mission_Parameters:2 lcross:mission_phase_name:2 Value:Earthlook1","Value","Earthlook1","","","Earthlook1"
"lcross:Mission_Parameters:2 lcross:mission_phase_name:2 Value:Earthlook2","Value","Earthlook2","","","Earthlook2"
"lcross:Mission_Parameters:2 lcross:mission_phase_name:2 Value:Impact","Value","Impact","","","Impact"
"lcross:Mission_Parameters:2 lcross:mission_phase_name:2 Value:Mirlook","Value","Mirlook","","","Mirlook"
"lcross:Mission_Parameters:2 lcross:mission_phase_name:2 Value:Preimpact","Value","Preimpact","","","Preimpact"
"lcross:Mission_Parameters:2 lcross:mission_phase_name:2 Value:Quicklook","Value","Quicklook","","","Quicklook"
"lcross:Mission_Parameters:2 lcross:mission_phase_name:2 Value:Separation","Value","Separation","","","Separation"
"lcross:Mission_Parameters:2 lcross:mission_phase_name:2 Value:Starfield","Value","Starfield","","","Starfield"
"lcross:Mission_Parameters:2 lcross:mission_phase_name:2 Value:Swingby","Value","Swingby","","","Swingby"
"lcross:Mission_Parameters:2 lcross:spacecraft_clock_start_count:1 ","Attribute","spacecraft_clock_start_count","n/a","lcross","The spacecraft_clock_start_count attribute provides the value of the spacecraft clock at the beginning of a time period of interest. ","geo","ASCII_Short_String_Collapsed","0","1","Unbounded","Unbounded","1","255","Units_of_None","none","TBD_classConcept","SHORT_STRING"
"lcross:Mission_Parameters:2 lcross:spacecraft_clock_stop_count:1 ","Attribute","spacecraft_clock_stop_count","n/a","lcross","The spacecraft_clock_stop_count attribute provides the value of the spacecraft clock at the end of a time period of interest. ","geo","ASCII_Short_String_Collapsed","0","1","Unbounded","Unbounded","1","255","Units_of_None","none","TBD_classConcept","SHORT_STRING"
"lcross:Mission_Parameters:2 lcross:intercept_point_latitude:1 ","Attribute","intercept_point_latitude","n/a","lcross","The intercept_point_latitude attribute is the latitude of a point on the surface of a body.","geo","ASCII_Real","0","1","-90.0","90.0","Unbounded","Unbounded","Units_of_Angle","none","TBD_classConcept","REAL"
"lcross:Mission_Parameters:2 lcross:intercept_point_longitude:1 ","Attribute","intercept_point_longitude","n/a","lcross","The intercept_point_longitude attribute is the longitude of a point on the surface of a body.","geo","ASCII_Real","0","1","0.0","360.0","Unbounded","Unbounded","Units_of_Angle","none","TBD_classConcept","REAL"
"lcross:Mission_Parameters:2 lcross:instrument_temperature:1 ","Attribute","instrument_temperature","n/a","lcross","The instrument_temperature attribute provides the temperature, in degrees Celsius of an instrument or some part of an instrument.","geo","ASCII_Real","0","1","-1.7976931348623157e308","1.7976931348623157e308","Unbounded","Unbounded","Units_of_Temperature","none","TBD_classConcept","REAL"
"lcross:Mission_Parameters:2 lcross:instrument_temperature_count:1 ","Attribute","instrument_temperature_count","n/a","lcross","The instrument_temperature_count attribute provides the temperature of an instrument in raw counts or DN values. ","geo","ASCII_Integer","0","1","-9223372036854775808","9223372036854775807","Unbounded","Unbounded","Units_of_None","none","TBD_classConcept","INTEGER"
"lcross:LCROSS_Parameters:1 ","Class","LCROSS_Parameters","1.0.0.0","lcross","Top level container class.","geo","","","","","","","","","","",""
Loading

0 comments on commit 3d9b6d0

Please sign in to comment.