From 0e051496904358fa8539f3d50054a6ac3b89b9aa Mon Sep 17 00:00:00 2001 From: Austin Sanders Date: Tue, 3 Sep 2024 12:13:10 -0600 Subject: [PATCH] Updated docstrings --- ale/drivers/lo_drivers.py | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/ale/drivers/lo_drivers.py b/ale/drivers/lo_drivers.py index c82f4b594..f2ccbaaeb 100644 --- a/ale/drivers/lo_drivers.py +++ b/ale/drivers/lo_drivers.py @@ -249,8 +249,7 @@ def instrument_id(self): def ikid(self): """ Returns the Naif ID code for the instrument - Expects the instrument_id to be defined. This must be a string containing - the short name of the instrument. + Expects the spacecraft name to be defined. Returns ------- @@ -287,8 +286,7 @@ def sensor_name(self): def ephemeris_start_time(self): """ Returns the ephemeris time of the image. - Expects spacecraft_id to be defined. This should be the integer - Naif ID code for the spacecraft. + Expects the utc_start_time for the image to be defined. Returns ------- @@ -302,8 +300,8 @@ def ephemeris_start_time(self): def ephemeris_stop_time(self): """ Returns the ephemeris time of the image. - Expects spacecraft_id to be defined. This should be the integer - Naif ID code for the spacecraft. + This matches the ephemeris start time of the image, so it expects + ephemeris_start_time to be defined. Returns ------- @@ -346,7 +344,7 @@ def detector_center_sample(self): @property def focal2pixel_samples(self): """ - The transformation from focal plan coordinates to detector samples. + The transformation from focal plane coordinates to detector samples. To transform the coordinate (x,y) to detector samples do the following: samples = focal2pixel_samples[0] + x * focal2pixel_samples[1] + y * focal2pixel_samples[2] @@ -361,7 +359,7 @@ def focal2pixel_samples(self): @property def focal2pixel_lines(self): """ - The transformation from focal plan coordinates to detector lines. + The transformation from focal plane coordinates to detector lines. To transform the coordinate (x,y) to detector lines do the following: lines = focal2pixel_lines[0] + x * focal2pixel_lines[1] + y * focal2pixel_lines[2]