mess_drivers — MDIS Driver Classes

The ale.drivers.mess_drivers module

Added in version 0.1.0.

class ale.drivers.mess_drivers.MessengerMdisIsisLabelIsisSpiceDriver(file, num_ephem=909, num_quats=909, props={})

Bases: Framer, IsisLabel, IsisSpice, Driver

property fikid

Naif ID code used in calculating focal length Expects filter_number to be defined. This should be an integer containing the filter number from the pds3 label. Expects ikid to be defined. This should be the integer Naid ID code for the instrument.

Returns

: int

Naif ID code used in calculating focal length

property instrument_id

Returns an instrument id for unquely identifying the instrument, but often also used to be piped into Spice Kernels to acquire IKIDs. Therefore they the same ID the Spice expects in bods2c calls. Expects instrument_id to be defined in the Pds3Label mixin. This should be a string of the form MDIS-WAC or MDIS-NAC.

Returns

: str

instrument id

property spacecraft_name

Spacecraft name used in various SPICE calls to acquire ephemeris data. Messenger MDIS img PDS3 labels do not the have a SPACECRAFT_NAME keyword, so we override it here to find INSTRUMENT_HOST_NAME in the label.

Returns

: str

Spacecraft name

class ale.drivers.mess_drivers.MessengerMdisIsisLabelNaifSpiceDriver(file, num_ephem=909, num_quats=909, props={})

Bases: IsisLabel, NaifSpice, Framer, Driver

Driver for reading MDIS ISIS3 Labels. These are Labels that have been ingested into ISIS from PDS EDR images. Any SPCIE data attached by the spiceinit application will be ignored.

property detector_center_line

Returns center detector line acquired from Spice Kernels Expects ikid to be defined. This should be the integer Naid ID code for the instrument.

We subtract 0.5 from the ISIS center line because ISIS detector coordinates are 0.5 based.

Returns

: float

detector center line

property detector_center_sample

Returns center detector sample acquired from Spice Kernels Expects ikid to be defined. This should be the integer Naid ID code for the instrument.

We subtract 0.5 from the ISIS center sample because ISIS detector coordinates are 0.5 based.

Returns

: float

detector center sample

property ephemeris_start_time

Returns the ephemeris_start_time of the image. Expects spacecraft_clock_start_count to be defined. This should be a float containing the start clock count of the spacecraft. Expects spacecraft_id to be defined. This should be the integer Naif ID code for the spacecraft.

Returns

: float

ephemeris start time of the image.

property fikid

Naif ID code used in calculating focal length Expects filter_number to be defined. This should be an integer containing the filter number from the pds3 label. Expects ikid to be defined. This should be the integer Naid ID code for the instrument.

Returns

: int

Naif ID code used in calculating focal length

property focal_length

Computes Focal Length from Kernels

MDIS has tempature dependant focal lengh and coefficients need to be acquired from IK Spice kernels (coeff describe focal length as a function of tempature). Focal plane temps are acquired from a PDS3 label.

Returns

: double

focal length in meters

property instrument_id

Returns an instrument id for unquely identifying the instrument, but often also used to be piped into Spice Kernels to acquire IKIDs. Therefore they the same ID the Spice expects in bods2c calls. Expects instrument_id to be defined in the Pds3Label mixin. This should be a string of the form MDIS-WAC or MDIS-NAC.

Returns

: str

instrument id

property pixel_size

Overriden because the MESSENGER IK uses PIXEL_PITCH and the units are already millimeters

Returns

: float pixel size

property platform_name

Returns the name of the platform containing the sensor. This is usually the spacecraft name.

Messenger MDIS ISIS labels use upper camel case so this converts it to all upper case.

Returns

: str

Spacecraft name

property sampling_factor

Returns the summing factor from the PDS3 label. For example a return value of 2 indicates that 2 lines and 2 samples (4 pixels) were summed and divided by 4 to produce the output pixel value.

NOTE: This is overwritten for the messenger driver as the value is stored in “MESS:PIXELBIN”

Returns

: int

Number of samples and lines combined from the original data to produce a single pixel in this image

property sensor_model_version

Returns

: int

ISIS sensor model version

property usgscsm_distortion_model

Returns a dictionary containing the distortion model. Expects odtx and odty are defined. These should be the optical distortion x and y coefficients respectively.

Returns

: dict

radial distortion model

class ale.drivers.mess_drivers.MessengerMdisPds3NaifSpiceDriver(file, num_ephem=909, num_quats=909, props={})

Bases: Framer, Pds3Label, NaifSpice, Driver

Driver for reading MDIS PDS3 labels. Requires a Spice mixin to acquire addtional ephemeris and instrument data located exclusively in spice kernels.

property detector_center_line

Returns center detector line acquired from Spice Kernels. Expects ikid to be defined. This should be the integer Naid ID code for the instrument.

NOTE: This value is defined in an ISIS iak as 512.5, but we subtract 0.5 from the ISIS center sample because ISIS detector coordinates are 0.5 based.

Returns

: float

center detector line

property detector_center_sample

Returns center detector sample acquired from Spice Kernels. Expects ikid to be defined. This should be the integer Naid ID code for the instrument.

NOTE: This value is defined in an ISIS iak as 512.5, but we subtract 0.5 from the ISIS center sample because ISIS detector coordinates are 0.5 based.

Returns

: float

center detector sample

property fikid

Naif ID code used in calculating focal length Expects filter_number to be defined. This should be an integer containing the filter number from the pds3 label. Expects ikid to be defined. This should be the integer Naid ID code for the instrument.

Returns

: int

Naif ID code used in calculating focal length

property focal_length

Computes Focal Length from Kernels

MDIS has tempature dependant focal lengh and coefficients need to be acquired from IK Spice kernels (coeff describe focal length as a function of tempature). Focal plane temps are acquired from a PDS3 label.

Returns

: double

focal length in meters

property instrument_id

Returns an instrument id for unquely identifying the instrument, but often also used to be piped into Spice Kernels to acquire IKIDs. Therefore they the same ID the Spice expects in bods2c calls. Expects instrument_id to be defined in the Pds3Label mixin. This should be a string of the form MDIS-WAC or MDIS-NAC.

Returns

: str

instrument id

property pixel_size

Overriden because the MESSENGER IK uses PIXEL_PITCH and the units are already millimeters

Returns

: float pixel size

property sampling_factor

Returns the summing factor from the PDS3 label. For example a return value of 2 indicates that 2 lines and 2 samples (4 pixels) were summed and divided by 4 to produce the output pixel value.

NOTE: This is overwritten for the messenger driver as the value is stored in “MESS:PIXELBIN”

Returns

: int

Number of samples and lines combined from the original data to produce a single pixel in this image

property sensor_model_version

Returns

: int

ISIS sensor model version

property spacecraft_name

Spacecraft name used in various SPICE calls to acquire ephemeris data. Messenger MDIS img PDS3 labels do not the have a SPACECRAFT_NAME keyword, so we override it here to find INSTRUMENT_HOST_NAME in the label.

Returns

: str

Spacecraft name

property usgscsm_distortion_model

Returns a dictionary containing the distortion model. Expects odtx and odty are defined. These should be the optical distortion x and y coefficients respectively.

Returns

: dict

radial distortion model