Skip to content
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.

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

[DOC] doc string determine_local_basis is missing #81

Closed
maximedieudonne opened this issue Dec 6, 2021 · 1 comment · Fixed by #84
Closed

[DOC] doc string determine_local_basis is missing #81

maximedieudonne opened this issue Dec 6, 2021 · 1 comment · Fixed by #84
Assignees

Comments

@maximedieudonne
Copy link
Contributor

maximedieudonne commented Dec 6, 2021

hello,
I would like to use the determine_local_basis function in curvature.py. but i'm confused about the inputs and the outputs format.
For example how should I reshape my input "normal" . How to define the proj_matrix and which tolerance should i use ?

I understand that this function is used in the function fit_curvature but i dont understand how to initiate my imputs arguments

thanks for your help,

@maximedieudonne maximedieudonne changed the title [DOC] doc string determine_local_basis are missing [DOC] doc string determine_local_basis is missing Dec 6, 2021
@JulienLefevreMars
Copy link
Collaborator

Hello @MaximeDdnn ,

The function is confusing indeed: I propose to add some comments to clarify. Briefly:

  • the normal vector should be 3 x1
  • the proj_matrix is obtained through the curvature_fit function. There is no tolerance but the if in determine_local_basis_function is there to avoid a projection to a null vector if the normal equal [[1],[0],[0]]

@alexpron alexpron linked a pull request Dec 6, 2021 that will close this issue
@JulienLefevreMars JulienLefevreMars linked a pull request Dec 6, 2021 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants