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

Environment structure: Object grouping and coordinate systems unclear #313

Open
LudwigFriedmann opened this issue Jan 21, 2025 · 5 comments
Assignees
Labels
isType:Bug An issue that contains contradictions or errors in the standard.
Milestone

Comments

@LudwigFriedmann
Copy link
Collaborator

LudwigFriedmann commented Jan 21, 2025

Describe the bug
Texts and illustrations in documentation chapter 7.3.4 Environment Structure, more precisely

  • Grp_Terrain
  • Grp_Environment_Objects
  • Grp_Buildings
  • Grp_Vegetation
  • Grp_Road_Network
  • Grp_Sidewalks
  • Grp_Road_Marks
  • Grp_Road_Objects
  • Grp_Signals

are potentially misleading.

Text and iluustrations read as the corresponding group nodes describe single objects.
The illustrations even show individual coordinate systems.
However, this is not the case. The group nodes share their origin with Grp_Root, i.e. the reference coordinate system.
We have to decide here whether we are talking about individual objects or overarching groups here.
In the former case, we may have to define coordinate systems.

To Reproduce
Steps to reproduce the behavior:

  1. See Documentation 7.3.4 Environment Structure

Expected behavior
We have to decide here whether we are talking about individual objects or overarching groups.
In the former case, we would have to define coordinate systems.
In the second case, we have to adapt the texts and illustrations and state that the objects share the coordinate frame of Grp_Root.

Screenshots

System Information (please complete the following information):

Additional context

@LudwigFriedmann LudwigFriedmann added the isType:Bug An issue that contains contradictions or errors in the standard. label Jan 21, 2025
@LudwigFriedmann LudwigFriedmann added this to the v1.0.0 milestone Jan 21, 2025
@LudwigFriedmann LudwigFriedmann changed the title Environment structure: Object grouping unclear Environment structure: Object grouping and coordinate systems unclear Jan 21, 2025
@ClemensLinnhoff
Copy link
Collaborator

You are right. The Grp Nodes don't have transforms. The images show individual objects within this group that may have their own coordinates. We need to clarify this in the text.

@lyndyRott
Copy link
Collaborator

In the original description of the environment objects, a class item was described as a multitude of objects of the same type (or simply plural). This was changed by the linguistic review:
see commit 6a56d53 from November 27th

transformations (T) were removed before this on Nov 22nd

I assume that this is the ambiguity you are referring to?

Maybe someone can make the choice and adjust the description and possibly the transformations if needed, after deciding on a strategy, as I am not familiar with the details.

@LudwigFriedmann
Copy link
Collaborator Author

All right, then we're clearly committed to the group/layer based approach.
I can clarify this with 1-2 sentences per paragraph and will create a corresponding PR.

Before we update the images (i.e. remove the coordinate systems), I'd like to discuss whether an introductory illustration featuring an overlay of all layers would be useful?

@ClemensLinnhoff
Copy link
Collaborator

ClemensLinnhoff commented Jan 22, 2025

Before we update the images (i.e. remove the coordinate systems),

I don't know if we should remove the individual coordinate frames, as they show that each object in that group can have its own coordinate system. But I also see, that it might be confusing. What do you think about having these coordinate frames in a different color? Or just a lighter shade of blue?

whether an introductory illustration featuring an overlay of all layers would be useful?

Yes, I think this might be useful. We have that for the bones in the human class and it gives quite a good overview.

@LudwigFriedmann
Copy link
Collaborator Author

I think bounding boxes, such as those in illustration for 7.3.4.3.4 Grp_Environment_Objects, would be better.
In my opinion, this would be sufficient to illustrate that we might be dealing with individual objects.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
isType:Bug An issue that contains contradictions or errors in the standard.
Projects
None yet
Development

No branches or pull requests

7 participants