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

incorrect info given in the doc: writing pcd #2484

Closed
csukuangfj opened this issue Sep 27, 2018 · 3 comments
Closed

incorrect info given in the doc: writing pcd #2484

csukuangfj opened this issue Sep 27, 2018 · 3 comments

Comments

@csukuangfj
Copy link
Contributor

Your Environment

  • PCL Version: the master branch

Context

The doc http://pointclouds.org/documentation/tutorials/writing_pcd.php#writing-pcd
gives the structure of the type

// \brief A point structure representing Euclidean xyz coordinates.
struct PointXYZ
{
  float x;
  float y;
  float z;
};

which is incorrect.

Expected Behavior

It should give the correct memory layout, otherwise it is confusing for beginners.

@taketwo
Copy link
Member

taketwo commented Oct 7, 2018

This is indeed not correct, however I'm not sure if a beginner needs to know about extra padding and union tricks. I would propose to remove the snippet and just say:

The type of each point is set to pcl::PointXYZ, which is a structure that has x, y, and z fields.

@SergioRAgostinho?

@csukuangfj
Copy link
Contributor Author

I agree. No info is better than bad info.

@SergioRAgostinho
Copy link
Member

Ok by me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants