lro_drivers — LRO Driver Classes¶
The ale.drivers.lro_drivers module
Added in version 0.1.0.
- class ale.drivers.lro_drivers.LroLrocIsisLabelNaifSpiceDriver(file, num_ephem=909, num_quats=909, props={})¶
Bases:
LineScanner,NaifSpice,IsisLabel,Driver- property additional_preroll¶
Returns the addition preroll defined in an IAK.
Returns¶
- : float
Returns the additionl preroll.
- property additive_line_error¶
Returns the additive line error defined in an IAK.
Returns¶
- : float
Returns the additive line error.
- property constant_time_offset¶
Returns the constant time offset defined in an IAK.
Returns¶
- : float
Returns the constant time offset.
- property detector_center_sample¶
The center of the CCD in detector pixels ISIS uses 0.5 based CCD samples, so we need to convert to 0 based.
Returns¶
- float :
The center sample of the CCD
- property ephemeris_start_time¶
The starting ephemeris time for LRO is computed by taking the LRO:SPACECRAFT_CLOCK_PREROLL_COUNT, as defined in the label, and adding offsets that were taken from an IAK.
Returns¶
- : double
Starting ephemeris time of the image
- property exposure_duration¶
Takes the exposure_duration defined in a parent class and adds offsets taken from an IAK.
- : float
Returns the exposure duration in seconds.
- property focal2pixel_lines¶
Expects ikid to be defined. This must be the integer Naif id code of the instrument. For LROC NAC this is flipped depending on the spacecraft direction.
Returns¶
- : list<double>
focal plane to detector lines
- property instrument_id¶
The short text name for the instrument
Returns an instrument id uniquely identifying the instrument. Used to acquire instrument codes from Spice Lib bods2c routine.
Returns¶
- str
The short text name for the instrument
- property light_time_correction¶
Returns the type of light time correciton and abberation correction to use in NAIF calls.
LROC is specifically set to not use light time correction because it is so close to the surface of the moon that light time correction to the center of the body is incorrect.
Returns¶
- : str
The light time and abberation correction string for use in NAIF calls. See https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/req/abcorr.html for the different options available.
- property multiplicative_line_error¶
Returns the multiplicative line error defined in an IAK.
Returns¶
- : float
Returns the multiplicative line error.
- property odtk¶
The coefficients for the distortion model
Returns¶
- : list
Radial distortion coefficients. There is only one coefficient for LROC NAC l/r
- property sampling_factor¶
Returns the summing factor from the PDS3 label that is defined by the CROSSTRACK_SUMMING. 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.
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 ISIS instrument sensor model version number
Returns¶
- : int
ISIS sensor model version
- property spacecraft_direction¶
Returns the x axis of the first velocity vector relative to the spacecraft. This indicates of the craft is moving forwards or backwards.
From LROC Frame Kernel: lro_frames_2014049_v01.tf “+X axis is in the direction of the velocity vector half the year. The other half of the year, the +X axis is opposite the velocity vector”
Hence we rotate the first velocity vector into the sensor reference frame, but the X component of that vector is inverted compared to the spacecraft so a +X indicates backwards and -X indicates forwards
The returned velocity is also slightly off from the spacecraft velocity due to the sensor being attached to the craft with wax.
Returns¶
- directiondouble
X value of the first velocity relative to the sensor
- class ale.drivers.lro_drivers.LroLrocPds3LabelNaifSpiceDriver(file, num_ephem=909, num_quats=909, props={})¶
Bases:
LineScanner,NaifSpice,Pds3Label,DriverDriver for reading LROC NACL, NACR (not WAC, it is a push frame) labels. Requires a Spice mixin to acquire addtional ephemeris and instrument data located exclusively in SPICE kernels, A PDS3 label, and the LineScanner and Driver bases.
- property additional_preroll¶
Returns the addition preroll defined in an IAK.
Returns¶
- : float
Returns the additionl preroll.
- property additive_line_error¶
Returns the additive line error defined in an IAK.
Returns¶
- : float
Returns the additive line error.
- property constant_time_offset¶
Returns the constant time offset defined in an IAK.
Returns¶
- : float
Returns the constant time offset.
- property detector_center_sample¶
The center of the CCD in detector pixels ISIS uses 0.5 based CCD samples, so we need to convert to 0 based.
Returns¶
- float :
The center sample of the CCD
- property ephemeris_start_time¶
The starting ephemeris time for LRO is computed by taking the LRO:SPACECRAFT_CLOCK_PREROLL_COUNT, as defined in the label, and adding offsets that were taken from an IAK.
Returns¶
- : double
Starting ephemeris time of the image
- property exposure_duration¶
Takes the exposure_duration defined in a parent class and adds offsets taken from an IAK.
Returns¶
- : float
Returns the exposure duration in seconds.
- property focal2pixel_lines¶
Expects ikid to be defined. This must be the integer Naif id code of the instrument. For LROC NAC this is flipped depending on the spacecraft direction.
Returns¶
- : list<double>
focal plane to detector lines
- property instrument_id¶
The short text name for the instrument
Returns an instrument id uniquely identifying the instrument. Used to acquire instrument codes from Spice Lib bods2c routine.
Returns¶
- str
The short text name for the instrument
- property light_time_correction¶
Returns the type of light time correciton and abberation correction to use in NAIF calls.
LROC is specifically set to not use light time correction because it is so close to the surface of the moon that light time correction to the center of the body is incorrect.
Returns¶
- : str
The light time and abberation correction string for use in NAIF calls. See https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/req/abcorr.html for the different options available.
- property multiplicative_line_error¶
Returns the multiplicative line error defined in an IAK.
Returns¶
- : float
Returns the multiplicative line error.
- property odtk¶
The coefficients for the distortion model
Returns¶
- : list
Radial distortion coefficients. There is only one coefficient for LROC NAC l/r
- property sampling_factor¶
Returns the summing factor from the PDS3 label that is defined by the CROSSTRACK_SUMMING. 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.
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 ISIS instrument sensor model version number
Returns¶
- : int
ISIS sensor model version
- property spacecraft_direction¶
Returns the x axis of the first velocity vector relative to the spacecraft. This indicates of the craft is moving forwards or backwards.
From LROC Frame Kernel: lro_frames_2014049_v01.tf “+X axis is in the direction of the velocity vector half the year. The other half of the year, the +X axis is opposite the velocity vector”
Hence we rotate the first velocity vector into the sensor reference frame, but the X component of that vector is inverted compared to the spacecraft so a +X indicates backwards and -X indicates forwards
The returned velocity is also slightly off from the spacecraft velocity due to the sensor being attached to the craft with wax.
Returns¶
- directiondouble
X value of the first velocity relative to the sensor
- class ale.drivers.lro_drivers.LroMiniRfIsisLabelNaifSpiceDriver(file, num_ephem=909, num_quats=909, props={})¶
Bases:
Radar,NaifSpice,IsisLabel,Driver- property ephemeris_start_time¶
Returns the start and stop ephemeris times for the image.
Returns¶
- : float
start time
- property ephemeris_stop_time¶
Returns the stop ephemeris times for the image.
Returns¶
- : float
stop time
- property instrument_id¶
The short text name for the instrument
Returns an instrument id uniquely identifying the instrument. Used to acquire instrument codes from Spice Lib bods2c routine.
Returns¶
- str
The short text name for the instrument
- property line_exposure_duration¶
Line exposure duration in seconds. The sum of the burst and the delay for the return.
Returns¶
- : double
scaled pixel width
- property range_conversion_coefficients¶
Range conversion coefficients
Returns¶
- : List
range conversion coefficients