search

zauberzeug / rosys

An all-Python robot system based on web technologies. The purpose is similar to ROS, but it's based on NiceGUI and easier to use for mobile robotics.
https://rosys.io
MIT License
70 stars 10 forks source link

Improve documentation for `calibration.project_to_image` #170

Closed rodja closed 2 weeks ago

rodja commented 1 month ago

I noticed that the docstring was not up-to-date after adding frame-feature #153.

NiklasNeugebauer commented 2 weeks ago

I agree with @falkoschindler. I added this before we added frames to points with the idea of making projection easier from various frames.

Two signatures sounds like the best solution.

falkoschindler commented 2 weeks ago

I reworked the signatures and docstrings once again. Now there's a red test...

falkoschindler commented 2 weeks ago

There's probably a misconception about the frame parameter. Earlier I wrote

So frame probably indicates the frame of the input point.

Now I think the pytest shows that this is not the case. frame seems indeed to be a kind of target frame, in which we want the resulting points or coordinates. But does that makes sense? Who needs this feature? And how to fix the implementation?