Skip to content

Commit

Permalink
Merge branch 'quickfix_calibration_docs' into 'main'
Browse files Browse the repository at this point in the history
Add documentation about calibration models and parameters

Closes #326, #285, and #280

See merge request syntron/support/csr/ifm3d/ifm3d!389
  • Loading branch information
lola-masson committed Sep 18, 2024
2 parents e743030 + 1b8ea04 commit 7c43871
Showing 1 changed file with 14 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,20 @@ namespace ifm3d
};
using ExtrinsicOpticToUser = struct ExtrinsicOpticToUser;

/** @ingroup Deserialize */
/** @ingroup Deserialize
*
* @brief
*
* @param model_id The model id identifies which model is used.
* 0: Bouguet (unprojection, intrinsic), 1: Bouguet
* (projection, inverse intrinsic) 2: Fish eye (unprojection, intrinsic),
* 3: Fish eye (projection, inverse intrinsic)
* @param model_parameters The parameters of the model.
* For the Bouguet model: fx, fy, mx, my, alpha,
* k1, k2, k3, k4, k5, For the fish eye model: fx, fy, mx, my, alpha, k1,
* k2, k3, k4, theta*_max or theta_max
*/

struct Calibration
{
using Ptr = std::shared_ptr<struct Calibration>;
Expand Down

0 comments on commit 7c43871

Please sign in to comment.