Instrument Models¶
Supported Instruments¶
- MER
- Pancam
- MSL
- Mastcam
- Cassini
- Imaging Science Subsystem (ISS)
get_wavelength¶
Get the wavelength from an image’s label
-
instrument_models.get_wavelength.
get_wavelength
(label, unit)[source]¶ Get the filter wavelength from the label of an image
See Supported Instruments for full list of supported missions and instruments. If the instrument is not supported,
get_wavelength()
will returnnan
.Parameters: - label (
pvl.PVLModule
) – Image’s label - unit (
str
[nm
]) – The wavelength unit. Best practice forunit
to exist inpdsspect.pdsspect_image_set.ImageStamp.accepted_units
Returns: wavelength – The filter wavelenth from the image rounded to 3 decimal places.
If image does not have a wavelength or the instrument is not supported, wavelength with be
nan
Return type: See also
instrument_models.mastcam.Mastcam.get_wavelength()
- Get Mastcam wavelength
instrument_models.pancam.Pancam.get_wavelength()
- Get Pancam wavelength
instrument_models.cassini_iss.CassiniISS.get_wavelength()
- Get Cassini ISS wavelength
- label (
-
instrument_models.get_wavelength.
is_pancam
(label)[source]¶ Determine if label is for a Pancam image
Parameters: label ( pvl.PVLModule
) – Image’s labelReturns: is_pancam – True
if label is from a Pancam image,False
otherwiseReturn type: bool
instrument¶
Provide base class for all instrument models
-
class
instrument_models.instrument.
InstrumentBase
(label)[source]¶ Abstract Base Class for all instrument models
Parameters: label ( pvl.PVLModule
) – Image’s label-
label
¶ pvl.PVLModule
– Image’s label
-
get_wavelength
(unit, *args, **kwargs)[source]¶ Abstract method to get the image’s wavelength
Parameters: unit ( str
[nm
]) – The wavelength unit. Best practice forunit
to exist inpdsspect.pdsspect_image_set.ImageStamp.accepted_units
Returns: wavelength – The image’s filter wavelength Return type: float
-
mastcam¶
-
class
instrument_models.mastcam.
Mastcam
(label)[source]¶ Bases:
instrument_models.instrument.InstrumentBase
Model to get the filter wavelength of a Mastcam image
See Mastcam Multispectral Imaging on the Mars Science Laboratory Rover: Wavelength Coverage and Imaging Strategies at the Gale Crater Field Site for more details on Mastcam’s filter wavelengths
-
get_wavelength
(unit='nm')[source]¶ Get the wavelength from mastcam image
Parameters: unit ( str
[nm
]) – The wavelength unit. Best practice forunit
to exist inpdsspect.pdsspect_image_set.ImageStamp.accepted_units
Returns: wavelength – Filter wavelength of the mastcam image Return type: float
-
pancam¶
-
class
instrument_models.pancam.
Pancam
(label)[source]¶ Bases:
instrument_models.instrument.InstrumentBase
Model to get the filter wavelength of a Patcam image
See Pancam for more details on Pancam’s filter wavelengths.
-
camera
¶ bool
– Images camera. Should either beleft_filters
orright_filters
-
get_wavelength
(unit='nm')[source]¶ Get the filter wavelength from the image
Parameters: unit ( str
[nm
]) – The wavelength unit. Best practice forunit
to exist inpdsspect.pdsspect_image_set.ImageStamp.accepted_units
Returns: wavelength – The image’s filter wavelength Return type: float
-
cassini_iss¶
-
class
instrument_models.cassini_iss.
CassiniISS
(label)[source]¶ Bases:
instrument_models.instrument.InstrumentBase
Model to get the filter wavelength from Cassini ISS image
See Cassini Imaging Science Subsystem (ISS) Data User’s Guide (Page 149) for table of filter name and corresponding wavelengths. We use the effective wavelength rather than the center wavelength.wavelength
-
NA_filters
¶ dict
– Dictionary of the ISS Narrow Angle Camera filter names and wavelengthsKey is the two filternames and the value is the wavelength in nm
-
WA_filters
¶ dict
– Dictionary of the ISS Wide Angle Camera filter names and wavelengthsKey is the two filternames and the value is the wavelength in nm
-
filter_name
¶ str
– The image’s filter names joined by a comma and spaceFor example, in the label the filtername appears as
("CL1","UV3")
and sofilter_name
returns'CL1, UV3'
-