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

How to Present 4D Representations to the User? #69

Open
kalebphipps opened this issue May 24, 2024 · 0 comments
Open

How to Present 4D Representations to the User? #69

kalebphipps opened this issue May 24, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation maintenance Improve code readability and robustness. question Further information is requested

Comments

@kalebphipps
Copy link
Member

Is your feature request related to a problem? Please describe.
ARTIST uses a 4D representation for points and vectors. However, this representation may not be intuitive to a user, which could lead to confusion when creating configurations.

Describe the solution you'd like
We should discuss the best way to deal with this - I see three possible options at the moment:

  1. Provide clear documentation and examples stating the 4D convention (already on the way) and assume the user is smart enough to follow these instructions.
  2. Provide clear documentation and examples and include checks within the ScenearioGenerator and ARTIST to ensure that the provided tensors have the appropriate shape and that the last entry is always a 0 for directions and 1 for points.
  3. Hide the 4D representation within the code, allow the user to provide 3D tensors as input and automatically adjust them within the code.

Once we have made a decision we should update this issue with the proposed solution and implement it!

@kalebphipps kalebphipps added documentation Improvements or additions to documentation question Further information is requested maintenance Improve code readability and robustness. labels May 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation maintenance Improve code readability and robustness. question Further information is requested
Projects
None yet
Development

No branches or pull requests

5 participants