drake::perception::pc_flags Namespace Reference

Detailed Description

Point cloud flags.

Classes
class	DescriptorType
	Describes an descriptor field with a name and the descriptor's size. More...
class	Fields
	Allows combination of BaseField and DescriptorType for a PointCloud. More...

Typedefs
typedef int	BaseFieldT

Enumerations
enum	BaseField : int {   kNone = 0 , kInherit = 1 << 0 , kXYZs = 1 << 1 , kNormals = 1 << 2 ,   kRGBs = 1 << 3 }
	Indicates the data the point cloud stores. More...

Functions
constexpr DescriptorType	kDescriptorNone (0, "kDescriptorNone")
	No descriptor.
constexpr DescriptorType	kDescriptorCurvature (1, "kDescriptorCurvature")
	Curvature.
constexpr DescriptorType	kDescriptorFPFH (33, "kDescriptorFPFH")
	Point-feature-histogram.
std::string	to_string (const Fields &fields)
	Provides a human-readable description of fields.
std::ostream &	operator<< (std::ostream &os, const Fields &rhs)
	Provides human-readable output.
Fields	operator| (const BaseFieldT &lhs, const DescriptorType &rhs)
	Makes operator| compatible for BaseField + DescriptorType.
Fields	operator| (const DescriptorType &lhs, const Fields &rhs)
	Makes operator| compatible for DescriptorType + Fields (DescriptorType or BaseFields).

Typedef Documentation

BaseFieldT

typedef int BaseFieldT

Enumeration Type Documentation

BaseField

enum BaseField : int

Indicates the data the point cloud stores.

Enumerator
kNone
kInherit	Inherit other fields. May imply an intersection of all compatible descriptors.
kXYZs	XYZ point in Cartesian space.
kNormals	Normals.
kRGBs	RGB colors.

Function Documentation

kDescriptorCurvature()

DescriptorType kDescriptorCurvature ( 1 , "kDescriptorCurvature"  )

constexpr

Curvature.

kDescriptorFPFH()

DescriptorType kDescriptorFPFH ( 33 , "kDescriptorFPFH"  )

constexpr

Point-feature-histogram.

kDescriptorNone()

DescriptorType kDescriptorNone ( 0 , "kDescriptorNone"  )

constexpr

No descriptor.

operator<<()

std::ostream & operator<<	(	std::ostream &	os,
		const Fields &	rhs )

Provides human-readable output.

(Deprecated.)

Deprecated

Use fmt functions instead (e.g., fmt::format(), fmt::to_string(), fmt::print()). Refer to GitHub issue #17742 for more information.
This will be removed from Drake on or after 2026-06-01.

operator|() [1/2]

Fields operator|	(	const BaseFieldT &	lhs,
		const DescriptorType &	rhs )

Makes operator| compatible for BaseField + DescriptorType.

See also

Fields::operator|= for preconditions.

operator|() [2/2]

Fields operator|	(	const DescriptorType &	lhs,
		const Fields &	rhs )

Makes operator| compatible for DescriptorType + Fields (DescriptorType or BaseFields).

See also

Fields::operator|= for preconditions.

to_string()

std::string to_string

(

const Fields &

fields

)

Provides a human-readable description of fields.