【译】PCL官网教程翻译(11)：添加自定义PointT类型 - Adding your own custom PointT type

最新推荐文章于 2022-07-20 18:44:02 发布

tjwyj

最新推荐文章于 2022-07-20 18:44:02 发布

阅读量1.2k

点赞数 2

分类专栏： PCL官网教程翻译文章标签： PCL 官网教程翻译 3D 计算机视觉

原文链接：https://pcl.readthedocs.io/projects/tutorials/en/latest/adding_custom_ptype.html#adding-custom-ptype

版权

PCL官网教程翻译专栏收录该内容

25 篇文章 54 订阅

订阅专栏

英文原网页查看。
修订：20201115

添加自定义PointT类型

本文档不仅解释了如何添加自己的PointT point类型，还解释了PCL中模板化的点类型是什么、它们为什么存在以及如它们如何呈现。如果您已经熟悉这些信息，请跳到文档的最后一部分。

目录

添加自定义PointT类型
为什么是PointT类型
PCL中有哪些PointT类型?
点类型如何公开?
如何添加一个新的PointT类型
范例

注意
当前文档仅对PCL 0.x和 1.x有效。在撰写本文时，PCL 2.x中会有一些变化。

PCL提供了各种预定义的点类型，从XYZ数据的SSE对齐结构到更复杂的n维直方图表示，如PFH(点特征直方图)。这些类型应该足以支持PCL中实现的所有算法和方法。然而，在某些情况下，用户希望定义新类型。本文档描述了定义您自己的自定义PointT类型以及确保您的项目能够成功编译和运行所涉及的步骤。

为什么是PointT类型

PCL的PointT类型可以追溯到它作为ROS一个开发库的时候。当时的共识是，点云是一个复杂的n-D结构，需要能够表示不同类型的信息。但是，用户应该知道并理解需要传递哪些类型的信息，以便使代码更容易调试、考虑优化等等。
一个例子是对XYZ数据进行简单的操作。对于支持SSE的处理器，最有效的方法是将3维数据存储为浮点数，然后使用额外的浮点数填充:

struct PointXYZ
{
  float x;
  float y;
  float z;
  float padding;
};

但是，作为一个例子，如果用户希望在嵌入式平台上编译PCL，添加额外的填充可能会浪费内存。因此，可以使用没有最后一个浮点数的更简单的PointXYZ结构。
此外，如果您的应用程序需要一个PointXYZRGBNormal，其中包含XYZ 3D数据、RGBA信息(颜色)和每个点估计的表面法向量，那么用上述所有内容定义一个结构是很简单的。由于PCL中的所有算法都应该是模板化的，所以除了结构定义之外，不需要进行其他更改。

PCL中有哪些PointT类型?

为了涵盖我们能想到的所有可能的情况，我们在PCL中定义了很多的点类型。以下可能只是一个片段，请参见point_types.hpp获取完整列表。
这个列表很重要，因为在定义您自己的自定义类型之前，您需要理解为什么以现在的方式创建现有类型。此外，您想要的类型可能已经为您定义好了。

PointXYZ - 成员: float x, y, z;
这是最常用的数据类型之一，因为它只表示3D xyz信息。3个float数据填充了一个额外的float，用于SSE对齐。用户可以通过points[i].data[0]或points[i].x用于访问x坐标值。

union
{
  float data[4];
  struct
  {
    float x;
    float y;
    float z;
  };
};

PointXYZI - 成员: float x, y, z, intensity;
简单的XYZ +强度点类型。在理想的情况下，这4个成员将创建一个单一的结构，sse对齐。然而，由于大多数点操作要么将data[4]设置为0或为1(用于转换)，因此我们不能将强度设置为相同结构的成员，因为它的内容将被覆盖。例如，两点之间的点积将其第4个分量设为0，否则点积就没有意义，等等。
因此，对于sse对齐，我们用3个额外的浮动填充强度。在存储方面效率低下，但在内存对齐方面很好。

union
{
  float data[4];
  struct
  {
    float x;
    float y;
    float z;
  };
};
union
{
  struct
  {
    float intensity;
  };
  float data_c[4];
};

PointXYZRGBA - 成员: float x, y, z; uint32_t rgba;
与PointXYZI类似，除了rgba包含成无符号32位的rgba信息。由于有了union声明，还可以按名称单独访问颜色通道。

注意
嵌套的union声明提供了另一种方法来查看RGBA数据，即一个精确的浮点数。这是由于历史原因而出现的，不应该在新代码中使用。

union
{
  float data[4];
  struct
  {
    float x;
    float y;
    float z;
  };
};
union
{
  union
  {
    struct
    {
      uint8_t b;
      uint8_t g;
      uint8_t r;
      uint8_t a;
    };
    float rgb;
  };
  uint32_t rgba;
};

PointXYZRGB - float x, y, z; uint32_t rgba;
与PointXYZRGBA一样。
PointXY - float x, y;
简单的2D x-y点结构。

struct
{
  float x;
  float y;
};

InterestPoint - float x, y, z, strength;
与PointXYZI类似，只是强度包含了对关键点强度的度量。

union
{
  float data[4];
  struct
  {
    float x;
    float y;
    float z;
  };
};
union
{
  struct
  {
    float strength;
  };
  float data_c[4];
};

Normal - float normal[3], curvature;
另一个最常用的数据类型,Normal结构代表了表面上一个给定的点法向,和曲率值(可以通过求解表面的特征值得到-、更多信息参考NormalEstimation类)。
由于在PCL中对表面法线的操作非常常见，我们用第四个分量填充了这三个分量，以便实现sse对齐和计算效率。用户可以通过points[i].data_n[0]或points[i].normal[0]或points[i].normal_x访问法向量的第一个坐标量。同样，曲率不能存储在相同的结构中，因为它会被对正常数据的操作覆盖。

union
{
  float data_n[4];
  float normal[3];
  struct
  {
    float normal_x;
    float normal_y;
    float normal_z;
  };
}
union
{
  struct
  {
    float curvature;
  };
  float data_c[4];
};

PointNormal - float x, y, z; float normal[3], curvature;
一个点结构，包含XYZ数据，连同表面法线和曲率。

union
{
  float data[4];
  struct
  {
    float x;
    float y;
    float z;
  };
};
union
{
  float data_n[4];
  float normal[3];
  struct
  {
    float normal_x;
    float normal_y;
    float normal_z;
  };
};
union
{
  struct
  {
    float curvature;
  };
  float data_c[4];
};

PointXYZRGBNormal - float x, y, z, normal[3], curvature; uint32_t rgba;
一个点结构，包含XYZ数据，RGBA颜色，连同表面法线和曲率。

注意
除了名称之外，这个point类型还包含alpha颜色通道。

union
{
  float data[4];
  struct
  {
    float x;
    float y;
    float z;
  };
};
union
{
  float data_n[4];
  float normal[3];
  struct
  {
    float normal_x;
    float normal_y;
    float normal_z;
  };
}
union
{
  struct
  {
    union
    {
      union
      {
        struct
        {
          uint8_t b;
          uint8_t g;
          uint8_t r;
          uint8_t a;
        };
        float rgb;
      };
      uint32_t rgba;
    };
    float curvature;
  };
  float data_c[4];
};

PointXYZINormal - float x, y, z, intensity, normal[3], curvature;
一种点结构，包含XYZ数据、强度值、表面法线和曲率。

union
{
  float data[4];
  struct
  {
    float x;
    float y;
    float z;
  };
};
union
{
  float data_n[4];
  float normal[3];
  struct
  {
    float normal_x;
    float normal_y;
    float normal_z;
  };
}
union
{
  struct
  {
    float intensity;
    float curvature;
  };
  float data_c[4];
};

PointWithRange - float x, y, z (union with float point[4]), range;
与PointXYZI类似，range包含了从采集点到物体点的距离量。

union
{
  float data[4];
  struct
  {
    float x;
    float y;
    float z;
  };
};
union
{
  struct
  {
    float range;
  };
  float data_c[4];
};

PointWithViewpoint - float x, y, z, vp_x, vp_y, vp_z;
与PointXYZI类似，还包括将获取视点包含为一个3D点的vp_x、vp_y和vp_z。

union
{
  float data[4];
  struct
  {
    float x;
    float y;
    float z;
  };
};
union
{
  struct
  {
    float vp_x;
    float vp_y;
    float vp_z;
  };
  float data_c[4];
};

MomentInvariants - float j1, j2, j3;
简单的点类型，包含表面上3个力矩不变量。有关更多信息，请参见MomentInvariantsEstimation。

struct
{
  float j1, j2, j3;
};

PrincipalRadiiRSD - float r_min, r_max;
简单的点类型，包含表面上的2个RSD半径。有关更多信息，请参见RSDEstimation。

struct
{
  float r_min, r_max;
};

Boundary - uint8_t boundary_point;
简单点类型，保存了是否位于表面边界信息。有关更多信息，请参见BoundaryEstimation。

struct
{
  uint8_t boundary_point;
};

PrincipalCurvatures - float principal_curvature[3], pc1, pc2;
简单点型，包含给定点的主曲率。有关更多信息，请参见PrincipalCurvaturesEstimation。

struct
{
  union
  {
    float principal_curvature[3];
    struct
    {
      float principal_curvature_x;
      float principal_curvature_y;
      float principal_curvature_z;
    };
  };
  float pc1;
  float pc2;
};

PFHSignature125 - float pfh[125];
保存给定点的PFH(点特征直方图)的简单点类型。有关更多信息，请参见PFHEstimation。

struct
{
  float histogram[125];
};

FPFHSignature33 - float fpfh[33];
简单点类型，包含给定点的FPFH(快速点特征直方图)。有关更多信息，请参见FPFHEstimation。

struct
{
  float histogram[33];
};

VFHSignature308 - float vfh[308];
持有给定点的VFH(视点特征直方图)的简单点类型。有关更多信息，请参见VFHEstimation。

struct
{
  float histogram[308];
};

Narf36 - float x, y, z, roll, pitch, yaw; float descriptor[36];
包含给定点的NARF(通常对齐半径特性)的简单点类型。有关更多信息，请参见NARFEstimation。

struct
{
  float x, y, z, roll, pitch, yaw;
  float descriptor[36];
};

BorderDescription - int x, y; BorderTraits traits;
简单点类型，包含给定点的边界类型。有关更多信息，请参见BorderEstimation。

struct
{
  int x, y;
  BorderTraits traits;
};

IntensityGradient - float gradient[3];
简单点类型，包含给定点的强度梯度。有关更多信息，请参见IntensityGradientEstimation。

struct
{
  union
  {
    float gradient[3];
    struct
    {
      float gradient_x;
      float gradient_y;
      float gradient_z;
    };
  };
};

Histogram - float histogram[N];
通用n-D直方图占位符。

template <int N>
struct Histogram
{
  float histogram[N];
};

PointWithScale - float x, y, z, scale;
与PointXYZI类似，还包含考虑几何操作中某一点的scale(例如，计算最近邻的球体半径、窗口大小等)。

struct
{
  union
  {
    float data[4];
    struct
    {
      float x;
      float y;
      float z;
    };
  };
  float scale;
};

PointSurfel - float x, y, z, normal[3], rgba, radius, confidence, curvature;
包含XYZ数据、曲面法线、RGB信息、比例尺、置信度和曲面曲率的复杂点类型。

union
{
  float data[4];
  struct
  {
    float x;
    float y;
    float z;
  };
};
union
{
  float data_n[4];
  float normal[3];
  struct
  {
    float normal_x;
    float normal_y;
    float normal_z;
  };
};
union
{
  struct
  {
    uint32_t rgba;
    float radius;
    float confidence;
    float curvature;
  };
  float data_c[4];
};

点类型如何公开?

由于PCL较大，而且是一个模板库，在一个源文件中包含许多PCL算法会减慢编译过程。在编写本文档时，大多数c++编译器还没有进行适当的优化来处理大量模板文件，特别是在涉及到优化(-O2或-O3)时。
为了加快包含和链接PCL的用户代码的速度，我们使用显式模板实例化，包括所有可能的组合，其中所有算法都可以使用PCL中已经定义的点类型来调用。这意味着一旦将PCL编译为库，任何用户代码都不需要编译模板代码，从而加快了编译时间。这个技巧涉及到将模板实现与转发声明类和方法的头文件分离，并在链接时解析。下面是一个编写的例子:

// foo.h

#ifndef PCL_FOO_
#define PCL_FOO_

template <typename PointT>
class Foo
{
  public:
    void
    compute (const pcl::PointCloud<PointT> &input,
             pcl::PointCloud<PointT> &output);
}

#endif // PCL_FOO_

上面定义的头文件通常包含在所有用户代码中。正如我们所看到的，我们正在定义方法和类，但是我们还没有实现任何东西。

// impl/foo.hpp

#ifndef PCL_IMPL_FOO_
#define PCL_IMPL_FOO_

#include "foo.h"

template <typename PointT> void
Foo::compute (const pcl::PointCloud<PointT> &input,
              pcl::PointCloud<PointT> &output)
{
  output = input;
}

#endif // PCL_IMPL_FOO_

上面定义了Foo::compute方法的实际模板实现。这通常应该对用户代码隐藏。

// foo.cpp

#include "pcl/point_types.h"
#include "pcl/impl/instantiate.hpp"
#include "foo.h"
#include "impl/foo.hpp"

// Instantiations of specific point types
PCL_INSTANTIATE(Foo, PCL_XYZ_POINT_TYPES));

最后，上面展示了在PCL中显式实例化的方法。宏PCL_INSTANTIATE只遍历给定的类型列表，并为每个类型创建显式实例化。从pcl/include/pcl/impl/instantiate.hpp:

// PCL_INSTANTIATE: call to instantiate template TEMPLATE for all
// POINT_TYPES

#define PCL_INSTANTIATE_IMPL(r, TEMPLATE, POINT_TYPE) \
  BOOST_PP_CAT(PCL_INSTANTIATE_, TEMPLATE)(POINT_TYPE)

#define PCL_INSTANTIATE(TEMPLATE, POINT_TYPES)        \
  BOOST_PP_SEQ_FOR_EACH(PCL_INSTANTIATE_IMPL, TEMPLATE, POINT_TYPES);

其中PCL_XYZ_POINT_TYPES为(来自pcl/include/pcl/impl/point_types.hpp):

// Define all point types that include XYZ data
#define PCL_XYZ_POINT_TYPES   \
  (pcl::PointXYZ)             \
  (pcl::PointXYZI)            \
  (pcl::PointXYZRGBA)         \
  (pcl::PointXYZRGB)          \
  (pcl::InterestPoint)        \
  (pcl::PointNormal)          \
  (pcl::PointXYZRGBNormal)    \
  (pcl::PointXYZINormal)      \
  (pcl::PointWithRange)       \
  (pcl::PointWithViewpoint)   \
  (pcl::PointWithScale)

基本上，如果您只想显式地为pcl::PointXYZ实例化Foo，您不需要使用宏，就像下面这样简单:

// foo.cpp

#include "pcl/point_types.h"
#include "pcl/impl/instantiate.hpp"
#include "foo.h"
#include "impl/foo.hpp"

template class Foo<pcl::PointXYZ>;

注意
有关显式实例化的更多信息，请参见David Vandervoorde和Nicolai M. Josuttis编写的c++ Templates - The Complete Guide。

如何添加一个新的PointT类型

要添加新的point类型，首先必须定义它。例如:

struct MyPointType
{
  float test;
};

然后，您需要对新点类型MyPointType添加PCL中特定类/算法的模板头实现。例如，假设您想使用pcl::PassThrough。你所要做的就是:

#define PCL_NO_PRECOMPILE
#include <pcl/filters/passthrough.h>
#include <pcl/filters/impl/passthrough.hpp>

// 剩余的代码在次填充

如果您的代码是库的一部分，其他人使用它，那么尝试为您的MyPointType类型和您公开的任何类(从PCL外部的PCL)使用显式实例化也是有意义的。

注意
从PCL-1.7开始，您需要定义PCL_NO_PRECOMPILE，然后才能包含任何PCL头文件来包含模板化算法。

范例

下面的代码片段示例创建了一个包含XYZ数据(填充了SSE)的新点类型，以及测试例程。

#define PCL_NO_PRECOMPILE
#include <pcl/pcl_macros.h>
#include <pcl/point_types.h>
#include <pcl/point_cloud.h>
#include <pcl/io/pcd_io.h>

struct MyPointType
{
  PCL_ADD_POINT4D;                  // preferred way of adding a XYZ+padding
  float test;
  PCL_MAKE_ALIGNED_OPERATOR_NEW     // make sure our new allocators are aligned
} EIGEN_ALIGN16;                    // enforce SSE padding for correct memory alignment

POINT_CLOUD_REGISTER_POINT_STRUCT (MyPointType,           // here we assume a XYZ + "test" (as fields)
                                   (float, x, x)
                                   (float, y, y)
                                   (float, z, z)
                                   (float, test, test)
)


int
main (int argc, char** argv)
{
  pcl::PointCloud<MyPointType> cloud;
  cloud.points.resize (2);
  cloud.width = 2;
  cloud.height = 1;

  cloud.points[0].test = 1;
  cloud.points[1].test = 2;
  cloud.points[0].x = cloud.points[0].y = cloud.points[0].z = 0;
  cloud.points[1].x = cloud.points[1].y = cloud.points[1].z = 3;

  pcl::io::savePCDFile ("test.pcd", cloud);
}

tjwyj

关注

2
点赞
踩
5

收藏

觉得还不错? 一键收藏
0
评论
【译】PCL官网教程翻译(11)：添加自定义PointT类型 - Adding your own custom PointT type

英文原网页查看。添加自定义PointT类型本文档不仅解释了如何添加自己的PointT point类型，还解释了PCL中模板化的点类型是什么、它们为什么存在以及如它们如何表述。如果您已经熟悉这些信息，请跳到文档的最后一部分。目录添加自定义PointT类型为什么是PointT类型PCL中有哪些PointT类型?点类型如何公开?如何添加一个新的PointT类型范例注意当前...
复制链接

扫一扫