From cb9ab2a555c4786fd4064f9ea3171e56358361ce Mon Sep 17 00:00:00 2001
From: acpaquette <acpaquette@usgs.gov>
Date: Fri, 8 Mar 2024 13:02:47 -0700
Subject: [PATCH] Detail Supported Instruments (#478)
* Initial changes and additions to specify validated cameras
* Addressed PR feedback
* Missed a couple acronyms in LRO rst file
* Fixed title underline in LRO
---
docs/source/sensors/Apollo.rst | 2 ++
docs/source/sensors/Cassini.rst | 6 ++--
docs/source/sensors/Chandrayaan.rst | 5 +++
docs/source/sensors/Clementine.rst | 11 +++++++
docs/source/sensors/Clipper.rst | 2 ++
docs/source/sensors/Dawn.rst | 6 ++--
docs/source/sensors/Galileo.rst | 6 ++--
docs/source/sensors/Hayabusa.rst | 12 +++----
docs/source/sensors/Hayabusa2.rst | 9 +++++
.../source/sensors/{Selene.rst => Kaguya.rst} | 12 +++----
docs/source/sensors/LunarOrbiter.rst | 2 ++
.../sensors/LunarReconnaissanceOrbiter.rst | 20 +++++------
docs/source/sensors/Mariner10.rst | 2 ++
docs/source/sensors/MarsExpress.rst | 8 ++---
docs/source/sensors/MarsGlobalSurveyor.rst | 5 +++
.../sensors/MarsReconnaissanceOrbiter.rst | 18 ++++++++--
docs/source/sensors/MarsScienceLaboritory.rst | 5 +++
docs/source/sensors/Messenger.rst | 4 +--
docs/source/sensors/Near.rst | 2 ++
docs/source/sensors/NewHorizons.rst | 6 ++--
docs/source/sensors/Odyssey.rst | 12 +++----
docs/source/sensors/OsirisRex.rst | 8 +++++
docs/source/sensors/Rosetta.rst | 2 ++
docs/source/sensors/TraceGasOrbiter.rst | 6 ++--
docs/source/sensors/Voyager.rst | 4 +--
docs/source/sensors/index.rst | 33 ++++++++++++++++---
26 files changed, 147 insertions(+), 61 deletions(-)
create mode 100644 docs/source/sensors/Apollo.rst
create mode 100644 docs/source/sensors/Chandrayaan.rst
create mode 100644 docs/source/sensors/Clementine.rst
create mode 100644 docs/source/sensors/Clipper.rst
create mode 100644 docs/source/sensors/Hayabusa2.rst
rename docs/source/sensors/{Selene.rst => Kaguya.rst} (83%)
create mode 100644 docs/source/sensors/LunarOrbiter.rst
create mode 100644 docs/source/sensors/Mariner10.rst
create mode 100644 docs/source/sensors/MarsGlobalSurveyor.rst
create mode 100644 docs/source/sensors/MarsScienceLaboritory.rst
create mode 100644 docs/source/sensors/Near.rst
create mode 100644 docs/source/sensors/OsirisRex.rst
create mode 100644 docs/source/sensors/Rosetta.rst
diff --git a/docs/source/sensors/Apollo.rst b/docs/source/sensors/Apollo.rst
new file mode 100644
index 0000000..cef1fc5
--- /dev/null
+++ b/docs/source/sensors/Apollo.rst
@@ -0,0 +1,2 @@
+Apollo Metric
+=============
\ No newline at end of file
diff --git a/docs/source/sensors/Cassini.rst b/docs/source/sensors/Cassini.rst
index a8f586c..ce7acc7 100644
--- a/docs/source/sensors/Cassini.rst
+++ b/docs/source/sensors/Cassini.rst
@@ -1,6 +1,6 @@
-Cassini ISS
-===========
-The Cassini Imaging Subsystem comprises two instruments -- a narrow angle camera
+Cassini Imaging Subsystem
+=========================
+The Cassini Imaging Subsystem (ISS) comprises two instruments -- a narrow angle camera
and a wide angle camera. The narrow angle camera contains 24 filters, and the
wide angle camera contains 18 filters.
diff --git a/docs/source/sensors/Chandrayaan.rst b/docs/source/sensors/Chandrayaan.rst
new file mode 100644
index 0000000..d72a70b
--- /dev/null
+++ b/docs/source/sensors/Chandrayaan.rst
@@ -0,0 +1,5 @@
+Chandrayaan1 Moon Mineralogy Mapper
+===================================
+
+Chandrayaan1 Forerunner
+=======================
\ No newline at end of file
diff --git a/docs/source/sensors/Clementine.rst b/docs/source/sensors/Clementine.rst
new file mode 100644
index 0000000..6f8084c
--- /dev/null
+++ b/docs/source/sensors/Clementine.rst
@@ -0,0 +1,11 @@
+Clementine Ultraviolet/Visible
+==============================
+
+Clementine Near-Infrared
+========================
+
+Clementine High-Resolution
+==========================
+
+Clementine Long-Wave Infrared
+=============================
\ No newline at end of file
diff --git a/docs/source/sensors/Clipper.rst b/docs/source/sensors/Clipper.rst
new file mode 100644
index 0000000..17507df
--- /dev/null
+++ b/docs/source/sensors/Clipper.rst
@@ -0,0 +1,2 @@
+Clipper Europa Imaging System
+=============================
\ No newline at end of file
diff --git a/docs/source/sensors/Dawn.rst b/docs/source/sensors/Dawn.rst
index 51cde4b..4332a51 100644
--- a/docs/source/sensors/Dawn.rst
+++ b/docs/source/sensors/Dawn.rst
@@ -1,6 +1,6 @@
-Dawn FC
-=======
-The Dawn Framing Camera is a frame camera with a resolution of up to 25 meters
+Dawn Framing Camera
+===================
+The Dawn Framing Camera (FC) is a frame camera with a resolution of up to 25 meters
per pixel. This instrument contains a clear filter and 7 band-pass filters.
Processing Dawn FC Images
diff --git a/docs/source/sensors/Galileo.rst b/docs/source/sensors/Galileo.rst
index 9de137c..9e92c26 100644
--- a/docs/source/sensors/Galileo.rst
+++ b/docs/source/sensors/Galileo.rst
@@ -1,6 +1,6 @@
-Galileo SSI
-===========
-The Galileo Solid State Imager is a modified form of the Voyager Narrow Angle
+Galileo Solid State Imager
+==========================
+The Galileo Solid State Imager (SSI) is a modified form of the Voyager Narrow Angle
Camera. Galileo SSI has 8 band filters and is capable of capturing imagery with
a spatial resolution up to 1 kilometer per pixel.
diff --git a/docs/source/sensors/Hayabusa.rst b/docs/source/sensors/Hayabusa.rst
index d6d8d4b..bd92ad2 100644
--- a/docs/source/sensors/Hayabusa.rst
+++ b/docs/source/sensors/Hayabusa.rst
@@ -1,9 +1,5 @@
-Hayabusa ONC
-============
-The Hayabusa Optical Navigation Camera is suite of three instruments (two wide
-angle and one telescopic imager), and is primarily used for navigation. The
-wide angle cameras employ clear filters, and the telescopic imager uses 7
-color filters and one clear filter.
+Hayabusa Asteroid Multi-band Imaging Camera
+===========================================
-Processing Hayabusa ONC Images
-------------------------------
+Hayabusa Near Infrared Spectrometer
+===================================
diff --git a/docs/source/sensors/Hayabusa2.rst b/docs/source/sensors/Hayabusa2.rst
new file mode 100644
index 0000000..2bd36c7
--- /dev/null
+++ b/docs/source/sensors/Hayabusa2.rst
@@ -0,0 +1,9 @@
+Hayabusa2 Optical Navigation Camera
+===================================
+The Hayabusa2 Optical Navigation (ONC) Camera is suite of three instruments (two wide
+angle and one telescopic imager), and is primarily used for navigation. The
+wide angle cameras employ clear filters, and the telescopic imager uses 7
+color filters and one clear filter.
+
+Processing Hayabusa2 ONC Images
+-------------------------------
\ No newline at end of file
diff --git a/docs/source/sensors/Selene.rst b/docs/source/sensors/Kaguya.rst
similarity index 83%
rename from docs/source/sensors/Selene.rst
rename to docs/source/sensors/Kaguya.rst
index 64de671..3fa2f95 100644
--- a/docs/source/sensors/Selene.rst
+++ b/docs/source/sensors/Kaguya.rst
@@ -1,6 +1,6 @@
-Kaguya TC
-=========
-The Kaguya Terrain Camera is a dual-band, stereo, linescan camera with a spatial
+Kaguya Terrain Camera
+=====================
+The Kaguya Terrain Camera (TC) is a dual-band, stereo, linescan camera with a spatial
resolution of 20 meters per pixel. This set of sensors uses two telescopic
imaging instruments, one pointed forward, and one pointed backward. Together,
these instruments provide data necessary to create stereoscopic imagery.
@@ -37,9 +37,9 @@ Begin by generating an ISD as described in the section on :ref:`isd_generation`.
isd = csmapi.Isd(alelabel)
camera = plugin.constructModelFromISD(isd, model)
-Kaguya MI
-=========
-The Kaguya Multiband Imagery platform comprises two different instruments -- a
+Kaguya Multiband Imagery platform
+=================================
+The Kaguya Multiband Imagery (MI) platform comprises two different instruments -- a
visible light sensor (VIS) and a near infrared sensor (NIR). The visible light
sensor has a spatial resolution of 20 meters per pixel, and collects 5 bands of
data via a bandpass filter. The near infrared sensor is responsible for
diff --git a/docs/source/sensors/LunarOrbiter.rst b/docs/source/sensors/LunarOrbiter.rst
new file mode 100644
index 0000000..0ff2577
--- /dev/null
+++ b/docs/source/sensors/LunarOrbiter.rst
@@ -0,0 +1,2 @@
+LunarOrbiter High Camera
+========================
\ No newline at end of file
diff --git a/docs/source/sensors/LunarReconnaissanceOrbiter.rst b/docs/source/sensors/LunarReconnaissanceOrbiter.rst
index 168e9df..3048da7 100644
--- a/docs/source/sensors/LunarReconnaissanceOrbiter.rst
+++ b/docs/source/sensors/LunarReconnaissanceOrbiter.rst
@@ -1,25 +1,25 @@
-MiniRF
-======
-MiniRF is the Lunar Reconnaissance Orbiter's Miniature Radio Frequency instrument.
-This instrument features two wavelength bands, and has a resolution of 30 meters
+Lunar Reconnaissance Orbiter Miniature Radio-Frequency
+======================================================
+Lunar Reconnaissance Orbiter (LRO) Miniature Radio Frequency (MiniRF) instrument
+features two wavelength bands, and has a resolution of 30 meters
per pixel.
Processing MiniRF Images
------------------------
-LRO NAC
-=======
-LRO NAC is the Lunar Reconnaissance Orbiter's Narrow Angle Camera. It is a
+Lunar Reconnaissance Orbiter Narrow Angle Camera
+================================================
+Lunar Reconnaissance Orbiter (LRO) Narrow Angle Camera (NAC) is a
panchromatic linescan imager with a resolution of .5 meters per pixel over a 5km
swath.
Processing LRO NAC Images
-------------------------
-LRO WAC
-=======
-LRO WAC is the Lunar Reconnaissance Orbiter's Wide Angle Camera. This is a
+Lunar Reconnaissance Orbiter Wide Angle Camera
+==============================================
+Lunar Reconnaissance Orbiter (LRO) Wide Angle Camera (WAC) is a
pushframe camera with a resolution of 100 meters per pixel over a 65km swath.
This instrument captures data in 7 bands.
diff --git a/docs/source/sensors/Mariner10.rst b/docs/source/sensors/Mariner10.rst
new file mode 100644
index 0000000..5a38540
--- /dev/null
+++ b/docs/source/sensors/Mariner10.rst
@@ -0,0 +1,2 @@
+Mariner10
+=========
\ No newline at end of file
diff --git a/docs/source/sensors/MarsExpress.rst b/docs/source/sensors/MarsExpress.rst
index 96e037f..a7ff650 100644
--- a/docs/source/sensors/MarsExpress.rst
+++ b/docs/source/sensors/MarsExpress.rst
@@ -1,8 +1,8 @@
-MEX HRSC
-========
-* HRSC has 9 different filters. Each has it's own instrument id, as well as
+Mars Express High Resolution Stereo Camera
+==========================================
+* High Resolution Stereo Camera (HRSC) has 9 different filters. Each has it's own instrument id, as well as
the main/"HEAD" camera composing those filters. There is also another
- "SRC" channel, making-up a total of 11 distinct sensors. It is very
+ "Super-Resolution Channel" (SRC) channel, making-up a total of 11 distinct sensors. It is very
important to understand which code is needed when/where.
* HRSC is a variable rate line scanner, and so does not maintain one exposure
diff --git a/docs/source/sensors/MarsGlobalSurveyor.rst b/docs/source/sensors/MarsGlobalSurveyor.rst
new file mode 100644
index 0000000..1e24e3e
--- /dev/null
+++ b/docs/source/sensors/MarsGlobalSurveyor.rst
@@ -0,0 +1,5 @@
+MarsGlobalSurveyor Mars Orbiter Camera Wide Angle Camera
+========================================================
+
+MarsGlobalSurveyor Mars Orbiter Camera Narrow Angle Camera
+==========================================================
\ No newline at end of file
diff --git a/docs/source/sensors/MarsReconnaissanceOrbiter.rst b/docs/source/sensors/MarsReconnaissanceOrbiter.rst
index 41b3509..1198d92 100644
--- a/docs/source/sensors/MarsReconnaissanceOrbiter.rst
+++ b/docs/source/sensors/MarsReconnaissanceOrbiter.rst
@@ -1,9 +1,21 @@
-MRO CTX
-=======
-The Mars Reconnaissance Orbiter Context Camera (CTX) is a high resolution linescan
+Mars Reconnaissance Orbiter Context Camera
+==========================================
+The Mars Reconnaissance Orbiter (MRO) Context Camera (CTX) is a high resolution linescan
imager that is capable of capturing grayscale images with a resolution of up to
6 meters per pixel.
Processing MRO CTX Images
-------------------------
+
+Mars Reconnaissance Orbiter High Resolution Imaging Science Experiment
+======================================================================
+
+Processing MRO HiRISE Images
+----------------------------
+
+Mars Reconnaissance Orbiter Mars Color Imager
+=============================================
+
+Processing MRO Marci Images
+---------------------------
diff --git a/docs/source/sensors/MarsScienceLaboritory.rst b/docs/source/sensors/MarsScienceLaboritory.rst
new file mode 100644
index 0000000..eef2c02
--- /dev/null
+++ b/docs/source/sensors/MarsScienceLaboritory.rst
@@ -0,0 +1,5 @@
+Mars Science Laboritory Mast Camera
+===================================
+
+Mars Science Laboritory Navigation Camera
+=========================================
\ No newline at end of file
diff --git a/docs/source/sensors/Messenger.rst b/docs/source/sensors/Messenger.rst
index a59f668..8664845 100644
--- a/docs/source/sensors/Messenger.rst
+++ b/docs/source/sensors/Messenger.rst
@@ -1,5 +1,5 @@
-Messenger MDIS
-==============
+Messenger Dual Imaging System
+=============================
The Messenger Mercury Dual Imaging System (MDIS) is a suite of two framing
cameras-- a wide angle camera (WAC) and a narrow angle camera (NAC). The wide
angle camera captures multispectral information, and the narrow angle camera
diff --git a/docs/source/sensors/Near.rst b/docs/source/sensors/Near.rst
new file mode 100644
index 0000000..96ec036
--- /dev/null
+++ b/docs/source/sensors/Near.rst
@@ -0,0 +1,2 @@
+Near MultiSpectral Imager
+=========================
\ No newline at end of file
diff --git a/docs/source/sensors/NewHorizons.rst b/docs/source/sensors/NewHorizons.rst
index 2a44343..6146845 100644
--- a/docs/source/sensors/NewHorizons.rst
+++ b/docs/source/sensors/NewHorizons.rst
@@ -1,6 +1,6 @@
-New Horizons LORRI
-==================
-New Horizons Long Range Reconnaissance Imager is a fixed, narrow angle frame
+New Horizons Long Range Reconnaissance Imager
+=============================================
+New Horizons Long Range Reconnaissance Imager (LORRI) is a fixed, narrow angle frame
camera with a field of view of .29 degrees. LORRI is a panchromatic imaging
system, and it offers a maximum spatial resolution of roughly 33 meters per
pixel.
diff --git a/docs/source/sensors/Odyssey.rst b/docs/source/sensors/Odyssey.rst
index cf74fd3..22ecbcb 100644
--- a/docs/source/sensors/Odyssey.rst
+++ b/docs/source/sensors/Odyssey.rst
@@ -1,6 +1,6 @@
-Odyssey THEMIS IR
-=================
-The Thermal Emission Imaging System Infrared sensor is a linescan camera
+Odyssey Thermal Emission Imaging System Infrared
+================================================
+The Thermal Emission Imaging System (THEMIS) Infrared sensor (IR) is a linescan camera
responsible for capturing 10 infrared bands at a spatial resolution of 100
meters per pixel.
@@ -8,9 +8,9 @@ meters per pixel.
Processing THEMIS IR Images
---------------------------
-Odyssey THEMIS VIS
-==================
-The Thermal Emission Imaging System Visible sensor is a push frame camera
+Odyssey Thermal Emission Imaging System Visible
+===============================================
+The Thermal Emission Imaging System (THEMIS) Visible sensor (VIS) is a push frame camera
responsible for capturing 5 color bands at a spatial resolution of 18 meters
per pixel.
diff --git a/docs/source/sensors/OsirisRex.rst b/docs/source/sensors/OsirisRex.rst
new file mode 100644
index 0000000..b731107
--- /dev/null
+++ b/docs/source/sensors/OsirisRex.rst
@@ -0,0 +1,8 @@
+OsirisRex SamCam
+================
+
+OsirisRex PolyCam
+=================
+
+OsirisRex NavCam
+================
\ No newline at end of file
diff --git a/docs/source/sensors/Rosetta.rst b/docs/source/sensors/Rosetta.rst
new file mode 100644
index 0000000..e8aa2ea
--- /dev/null
+++ b/docs/source/sensors/Rosetta.rst
@@ -0,0 +1,2 @@
+Rosetta Visible and Infrared Thermal Imaging Spectrometer
+=========================================================
\ No newline at end of file
diff --git a/docs/source/sensors/TraceGasOrbiter.rst b/docs/source/sensors/TraceGasOrbiter.rst
index 147fb5b..9922f3e 100644
--- a/docs/source/sensors/TraceGasOrbiter.rst
+++ b/docs/source/sensors/TraceGasOrbiter.rst
@@ -1,6 +1,6 @@
-TGO CaSSIS
-==========
-The Trace Gas Orbiter's Color and Stereo Surface Imaging System is a 4 filter
+TGO Color and Stereo Surface Imaging System
+===========================================
+The Trace Gas Orbiter's Color and Stereo Surface Imaging System (CaSSIS) is a 4 filter
frame camera capable of capturing data at a resolution of 4.6 meters per pixel.
The camera is mounted on a rotating mechanism, and it is able to capture stereo
imagery in a single pass.
diff --git a/docs/source/sensors/Voyager.rst b/docs/source/sensors/Voyager.rst
index 3407df3..e5359fe 100644
--- a/docs/source/sensors/Voyager.rst
+++ b/docs/source/sensors/Voyager.rst
@@ -1,5 +1,5 @@
-Voyager
-=======
+Voyager Wide/Narrow Angle Camera
+================================
The voyager imaging system is a set of two instruments -- a wide angle camera
(WAC) and a narrow angle camera (NAC). The wide angle camera contains 8 filters
and has a field of view of 3.2 degrees. The narrow angle camera also contains 8
diff --git a/docs/source/sensors/index.rst b/docs/source/sensors/index.rst
index 5355a13..600d81d 100644
--- a/docs/source/sensors/index.rst
+++ b/docs/source/sensors/index.rst
@@ -4,17 +4,40 @@ Cameras that can be used with USGSCSM
.. toctree::
Cassini
- Dawn
- Galileo
- Hayabusa
- Juno
LunarReconnaissanceOrbiter
MarsExpress
MarsReconnaissanceOrbiter
Messenger
+ Kaguya
+
+##############################################
+Available Cameras that have not been evaluated
+##############################################
+
+If there is a camera on this list that you would like to be verified for use
+please make an issue_ and we will get to the evaluation in a timely manner
+
+.. toctree::
+ Apollo
+ Chandrayaan
+ Clementine
+ Clipper
+ Dawn
+ Galileo
+ Hayabusa
+ Hayabusa2
+ Juno
+ LunarOrbiter
+ Mariner10
+ MarsGlobalSurveyor
+ Near
+ MarsScienceLaboritory
NewHorizons
Odyssey
- Selene
+ OsirisRex
+ Rosetta
TraceGasOrbiter
Viking
Voyager
+
+.. _issue: https://github.com/USGS-Astrogeology/usgscsm/issues?state=open
\ No newline at end of file
--
GitLab