Skip to content

Commit

Permalink
Detail Supported Instruments (#478)
Browse files Browse the repository at this point in the history
* Initial changes and additions to specify validated cameras

* Addressed PR feedback

* Missed a couple acronyms in LRO rst file

* Fixed title underline in LRO
  • Loading branch information
acpaquette authored Mar 8, 2024
1 parent 48c55c4 commit cb9ab2a
Show file tree
Hide file tree
Showing 26 changed files with 147 additions and 61 deletions.
2 changes: 2 additions & 0 deletions docs/source/sensors/Apollo.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Apollo Metric
=============
6 changes: 3 additions & 3 deletions docs/source/sensors/Cassini.rst
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
5 changes: 5 additions & 0 deletions docs/source/sensors/Chandrayaan.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Chandrayaan1 Moon Mineralogy Mapper
===================================

Chandrayaan1 Forerunner
=======================
11 changes: 11 additions & 0 deletions docs/source/sensors/Clementine.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Clementine Ultraviolet/Visible
==============================

Clementine Near-Infrared
========================

Clementine High-Resolution
==========================

Clementine Long-Wave Infrared
=============================
2 changes: 2 additions & 0 deletions docs/source/sensors/Clipper.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Clipper Europa Imaging System
=============================
6 changes: 3 additions & 3 deletions docs/source/sensors/Dawn.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/source/sensors/Galileo.rst
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
12 changes: 4 additions & 8 deletions docs/source/sensors/Hayabusa.rst
Original file line number Diff line number Diff line change
@@ -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
===================================
9 changes: 9 additions & 0 deletions docs/source/sensors/Hayabusa2.rst
Original file line number Diff line number Diff line change
@@ -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
-------------------------------
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/source/sensors/LunarOrbiter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
LunarOrbiter High Camera
========================
20 changes: 10 additions & 10 deletions docs/source/sensors/LunarReconnaissanceOrbiter.rst
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 2 additions & 0 deletions docs/source/sensors/Mariner10.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Mariner10
=========
8 changes: 4 additions & 4 deletions docs/source/sensors/MarsExpress.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down
5 changes: 5 additions & 0 deletions docs/source/sensors/MarsGlobalSurveyor.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
MarsGlobalSurveyor Mars Orbiter Camera Wide Angle Camera
========================================================

MarsGlobalSurveyor Mars Orbiter Camera Narrow Angle Camera
==========================================================
18 changes: 15 additions & 3 deletions docs/source/sensors/MarsReconnaissanceOrbiter.rst
Original file line number Diff line number Diff line change
@@ -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
---------------------------
5 changes: 5 additions & 0 deletions docs/source/sensors/MarsScienceLaboritory.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Mars Science Laboritory Mast Camera
===================================

Mars Science Laboritory Navigation Camera
=========================================
4 changes: 2 additions & 2 deletions docs/source/sensors/Messenger.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/source/sensors/Near.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Near MultiSpectral Imager
=========================
6 changes: 3 additions & 3 deletions docs/source/sensors/NewHorizons.rst
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
12 changes: 6 additions & 6 deletions docs/source/sensors/Odyssey.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
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.


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.

Expand Down
8 changes: 8 additions & 0 deletions docs/source/sensors/OsirisRex.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
OsirisRex SamCam
================

OsirisRex PolyCam
=================

OsirisRex NavCam
================
2 changes: 2 additions & 0 deletions docs/source/sensors/Rosetta.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Rosetta Visible and Infrared Thermal Imaging Spectrometer
=========================================================
6 changes: 3 additions & 3 deletions docs/source/sensors/TraceGasOrbiter.rst
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/sensors/Voyager.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down
33 changes: 28 additions & 5 deletions docs/source/sensors/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit cb9ab2a

Please sign in to comment.