Skip to content

Properly escape ccd_offset docstring to avoid syntax warning #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MJWeberg merged 1 commit into from
Aug 26, 2025
Merged

Properly escape ccd_offset docstring to avoid syntax warning #121

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions eispac/instr/ccd_offset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,16 @@

@u.quantity_input
def ccd_offset(wavelength:u.Angstrom) ->u.pixel:
"""Calculate the spatial offset of a line relative to He II 256 Å
r"""
Calculate the spatial offset of a line relative to He II 256 Å

Spatial offset of the specified wavelength relative
to He II 256 Å. If you see a feature in the He II 256 image at
coordinate :math:`Y`, then the corrected coordinate
:math:`Y^{\prime}` for any other wavelength :math:`\lambda` is,

.. math::

Y^{\prime} = Y - o(\lambda),

where :math:`o(\lambda)` is the CCD offset.
Expand All @@ -36,7 +38,7 @@ def ccd_offset(wavelength:u.Angstrom) ->u.pixel:
from Fe VIII 185.21 Å and Si VII 275.35 Å

.. note:: This routine is a (nearly) verbatim translation of the IDL version of
eis_ccd_offset written by Peter Young. The above documentation has
``eis_ccd_offset`` written by Peter Young. The above documentation has
been adapted from that routine.

Parameters
Expand All @@ -47,8 +49,8 @@ def ccd_offset(wavelength:u.Angstrom) ->u.pixel:
Returns
-------
offset : `~numpy.ndarray`
The spatial offset between the specified wavelength and He II 256.32.
The value represents how many pixels above He II 256.32 the specified
The spatial offset between the specified wavelength and He II 256.32 Å.
The value represents how many pixels above He II 256.32 Å the specified
wavelength sits on the EIS detectors.

References
Expand All @@ -68,7 +70,7 @@ def ccd_offset(wavelength:u.Angstrom) ->u.pixel:
wavelength = np.atleast_1d(wavelength)
# Calculate the offset for all lines in the shortwave band
short_long_base_offset = 18.5 * u.pixel
offset_fe_8 = wavelength-185.21*u.Angstrom
offset_fe_8 = wavelength - 185.21*u.Angstrom
offset_si_7_he_2 = 275.35*u.Angstrom - 256.32*u.Angstrom
offset = grating_tilt*offset_fe_8 + short_long_base_offset + grating_tilt*offset_si_7_he_2
# Find and calculate the offset for all lines in the longwave band
Expand Down
Loading