diff --git a/src/HFS_API.cpp b/src/HFS_API.cpp index d909691f9a933ab299c86e78e6e459903c10768e..2e6a965a48eae4e349037632a03236ee8e880df6 100644 --- a/src/HFS_API.cpp +++ b/src/HFS_API.cpp @@ -981,6 +981,7 @@ double transform_opt[3]; * dimensions. * * @param vec: input vector + * @param trf_x, trf_y: postion of FBT inside of FBA * @param[out] output: output vector * * @return 0 on success, 1 if the result is outside of the FOV @@ -1074,6 +1075,7 @@ double res[2]; * coordinates are set * * @param quaternion: quaternion for trandformation (in J2000 to SC) + * @param trf_x, trf_y: postion of FBT inside of FBA * * @return 0 on success */ @@ -1174,7 +1176,7 @@ int FGS :: generate_centroid(hfs_parameters update, centroid_packet *cent_packet /** * @brief Function for updating the output centroid packet with the latest centroid measurement - * + * @param update: hfs parameter update * @param[out] cent_packet: centroid packet struct that is visible to the Simulink model */ diff --git a/src/HFS_API.hpp b/src/HFS_API.hpp index f728eb71e584909ebd4338b81f0befb22bdebcd6..dc3a4bea8c3d21abca5e899bb79e663ecee8c119 100644 --- a/src/HFS_API.hpp +++ b/src/HFS_API.hpp @@ -72,15 +72,18 @@ struct hfs_state * * @param position_quat: quaternion for the attitude of the spacecraft * @param ang_rate: angular rate of the spacecraft in sc reference frame [arcsec/s] - * @param time: current simulation time; - * @param sync_flag: synchronisation flag for HFS + * @param time: current simulation time; * @param channel: chosen channel for FGS * @param save: flag for saving the current state of the HFS * @param reset: flag for reseting the HFS * @param set_invalid: flag for setting the validity flag to false - * @param validation_signal: Target Signal used for validation and identification + * @param set_error: Set validity index of the centroid + * @param validation_signal: Target Signal used for validation and identification * @param set_error: Error code that will be set in the centroid, at 0, the HFS will use the code given by the validation * @param mode: operational mode of the FGS 0: Standby, 1: Acquisition, 2: Tracking + * @param add_shift_x/add_shift_y: additive shift of the centroid in centipx + * @param mult_shift_x/mult_shift_y: multiplicative shift of the centroid + * @param target_pos_x/target_pos_y: Position of the FBT inside of the FBA with respect to the center * @note Operational modes are integers as Simulink doesn't support c */ typedef struct{ @@ -97,7 +100,6 @@ typedef struct{ * * @param x,y: Position measurement in mas * @param time: time tag of the measurement - * @param last_sync: time tag of the last sync pulse * @param validity_flag: Flag for the validity of the measurement * @param validity_index: quality index of the measurement (-1 to 1 or error code) * @param magnitude: signal of the measured star in ADU