Skip to content

Commit

Permalink
Improve docs
Browse files Browse the repository at this point in the history
Co-authored-by: Tom Aldcroft <[email protected]>
  • Loading branch information
jeanconn and taldcroft authored Oct 24, 2023
1 parent a9218d2 commit 01930d5
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions chandra_aca/drift.py
Original file line number Diff line number Diff line change
Expand Up @@ -167,8 +167,14 @@ def calc(self, times, t_ccd):

def get_fid_offset(time, t_ccd):
"""
Compute the fid light offset values for the provided inputs.
The y_offset and z_offset values in this function were calibrated against the
Compute the fid light offset values for a given ``time`` and ``t_ccd``.
The apparent fid light positions change in accordance with the ACA alignment drift as a function
of time and temperature. This is captured in the ACA aimpoint drift model. This function uses that
model to provide the offsets in y-angle and z-angle (arcsec) to apply additively to the nominal
fid positions.
The y_offset and z_offset values in this function were calibrated using the
2022-11 aimpoint drift model and the FEB07 fid characteristics.
See https://github.com/sot/fid_drift_mon/blob/master/fid_offset_coeff.ipynb
"""
Expand Down

0 comments on commit 01930d5

Please sign in to comment.