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.

Sign up for GitHub

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

Jump to bottom

[Bug] Affine transform: parameter names changed compared to the prototype #196

Open
2 tasks
haesleinhuepf opened this issue Jun 19, 2024 · 3 comments · May be fixed by #197
Open
2 tasks

[Bug] Affine transform: parameter names changed compared to the prototype #196

haesleinhuepf opened this issue Jun 19, 2024 · 3 comments · May be fixed by #197
Labels
bug Something isn't working

Comments

@haesleinhuepf
Copy link
Member

Pre-requist tasks

Describe the bug
A clear and concise description of what the bug is. What were you trying to do and what happened.

When updating this notebook to use pyclesperanto without prototype, I receive error messages, because parameter names changed.

transform -> transform_matrix
linear_interpolation -> interpolate

To Reproduce
Steps to reproduce the behavior, ideally a notebook ready to run, with test data, at minima a code snippet.

Expected behavior
A clear and concise description of what you expected to happen. Mainly if the issues is not a crash but a bad behaviour of a filter or operation.

I would attempt to avoid backwards compatibility breaking changes. It's otherwise harder to update code.

Screenshots
If applicable, add screenshots to help explain your problem. Expected results, vs actuall results. Or the output error message if any.

Configuration details:

  • OS: [e.g. MacOS 14, Windows 11, Linux Ubuntu 22.03]
  • Device: [e.g. NVIDIA RTX 4090, Intel Iris Graphics, etc.]
  • Device type: [e.g. Integrated GPU, dedicated GPU, CPU, HPC server]

Additional context
Add any other context about the problem here.
@haesleinhuepf haesleinhuepf added the bug Something isn't working label Jun 19, 2024
@haesleinhuepf
Copy link
Member Author

Also the transform_matrix parameter does not accept numpy arrays. It expects a list.

@haesleinhuepf haesleinhuepf linked a pull request Jun 19, 2024 that will close this issue
Open
@StRigaud
Copy link
Member

StRigaud commented Jun 19, 2024 •
edited
Loading

transform -> transform_matrix
linear_interpolation -> interpolate

I prefer my parameter name:
transform_matrix -> specify we expect the transform matrix, not a AffineTransform3D or AffineTransform object like in the prototype
interpolate -> currently a bool, can easily be changed for a string if one day we add other type of interpolation (I doubt but we dont know), and its shorter to type.

I will make a deprecated message and a compatibility patch

Also the transform_matrix parameter does not accept numpy arrays. It expects a list.

Not sure I can change that for now, I do not have access at Numpy API on the C++ side.

StRigaud added a commit that referenced this issue Jun 20, 2024
@StRigaud
add deprecated function, fixes #196
c80c6ad
@StRigaud
Copy link
Member

StRigaud commented Jul 9, 2024

documentation was updated here and a deprecated function will be introduced with #197

@StRigaud StRigaud linked a pull request Jul 9, 2024 that will close this issue
WIP: benchmarking affine transforms #197
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

WIP: benchmarking affine transforms clEsperanto/pyclesperanto
2 participants
@StRigaud @haesleinhuepf