Skip to content

DOC: se3_log_map does not highlight that eps and cos_bound are unused #1943

Open
@tvercaut

Description

@tvercaut

Reading through the documentation for se3_log_map, I was under the impression that eps and cos_bound were important for numerical stability:

eps: A threshold for clipping the squared norm of the rotation logarithm
to avoid division by zero in the singular case.
cos_bound: Clamps the cosine of the rotation angle to
[-1 + cos_bound, 3 - cos_bound] to avoid non-finite outputs.
The non-finite outputs can be caused by passing small rotation angles
to the `acos` function in `so3_rotation_angle` of `so3_log_map`.

However, following #1609 and 292acc7 it appeared that eps and cos_bound are only retained for backwards compatibility in so3_log_map (Note the o instead of e). This is made clear in the corresponding documentation:

eps: (unused, for backward compatibility)
cos_bound: (unused, for backward compatibility)

Now, given that se3_log_map calls so3_log_map,

log_rotation = so3_log_map(R, eps=eps, cos_bound=cos_bound)

I believe the deprecation of eps and cos_bound should also be highlighted in teh documentation of se3_log_map.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions