Skip to content

Commit

Permalink
Updated docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
AustinSanders committed Sep 3, 2024
1 parent 59a9f25 commit 0e05149
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions ale/drivers/lo_drivers.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------
Expand Down Expand Up @@ -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
-------
Expand All @@ -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
-------
Expand Down Expand Up @@ -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]
Expand All @@ -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]
Expand Down

0 comments on commit 0e05149

Please sign in to comment.