GpuLidarSensor Class Reference

GpuLidar Sensor Class. More...

#include <GpuLidarSensor.hh>

Public Member Functions
	GpuLidarSensor ()
	constructor More...
virtual	~GpuLidarSensor ()
	destructor More...
virtual gz::common::ConnectionPtr	ConnectNewLidarFrame (std::function< void(const float *_scan, unsigned int _width, unsigned int _heighti, unsigned int _channels, const std::string &)> _subscriber) override
	Connect function pointer to internal GpuRays callback. More...
virtual bool	CreateLidar () override
	Create Lidar sensor. More...
gz::rendering::GpuRaysPtr	GpuRays () const
	Get Gpu Rays object used in the sensor. More...
bool	HasConnections () const
	Check if there are any subscribers. More...
gz::math::Angle	HFOV () const
	Get the horizontal field of view of the laser sensor. More...
virtual bool	Init () override
	Initialize values in the sensor. More...
bool	IsHorizontal () const
	Gets if sensor is horizontal. More...
virtual bool	Load (const sdf::Sensor &_sdf) override
	Load the sensor based on data from an sdf::Sensor object. More...
virtual bool	Load (sdf::ElementPtr _sdf) override
	Load sensor sata from SDF. More...
double	RayCountRatio () const
	Return the ratio of horizontal ray count to vertical ray count. More...
void	RemoveGpuRays (gz::rendering::ScenePtr _scene)
	Remove sensor from scene. More...
void	SetScene (gz::rendering::ScenePtr _scene) override
	Makes possible to change sensor scene. More...
virtual bool	Update (const std::chrono::steady_clock::duration &_now) override
	Force the sensor to generate data. More...
gz::math::Angle	VFOV () const
	Get the vertical field-of-view. More...
Public Member Functions inherited from Lidar
	Lidar ()
	constructor More...
virtual	~Lidar ()
	destructor More...
gz::math::Angle	AngleMax () const
	Get the maximum angle. More...
gz::math::Angle	AngleMin () const
	Get the minimum angle. More...
double	AngleResolution () const
	Get radians between each range. More...
void	ApplyNoise ()
	Apply noise to the laser buffer, if noise has been configured. This should be called before PublishLidarScan if you want the scan data to contain noise. More...
int	Fiducial (const unsigned int _index) const
	Get detected fiducial value for a ray. Warning: If you are accessing all the ray data in a loop it's possible that the Ray will update in the middle of your access loop. This means some data will come from one scan, and some from another scan. You can solve this problem by using SetActive(false) <your accessor loop> SetActive(true). More...
bool	HasConnections () const
	Check if there are any subscribers for sensor data. More...
double	HorzFOV () const
	Get the horizontal field of view of the laser sensor. More...
virtual bool	IsActive () const
bool	IsHorizontal () const
	Gets if sensor is horizontal. More...
virtual bool	PublishLidarScan (const std::chrono::steady_clock::duration &_now)
	Publish LaserScan message. More...
double	Range (const int _index) const
	Get detected range for a ray. Warning: If you are accessing all the ray data in a loop it's possible that the Ray will update in the middle of your access loop. This means some data will come from one scan, and some from another scan. You can solve this problem by using SetActive(false) <your accessor loop> SetActive(true). More...
unsigned int	RangeCount () const
	Get the range count. More...
double	RangeCountRatio () const
	Return the ratio of horizontal range count to vertical range count. More...
double	RangeMax () const
	Get the maximum range. More...
double	RangeMin () const
	Get the minimum range. More...
double	RangeResolution () const
	Get the range resolution If RangeResolution is 1, the number of simulated rays is equal to the number of returned range readings. If it's less than 1, fewer simulated rays than actual returned range readings are used, the results are interpolated from two nearest neighbors, and vice versa. More...
void	Ranges (std::vector< double > &_ranges) const
	Get all the ranges. More...
unsigned int	RayCount () const
	Get the ray count. More...
double	RayCountRatio () const
	Return the ratio of horizontal ray count to vertical ray count. More...
double	Retro (const int _index) const
	Get detected retro (intensity) value for a ray. Warning: If you are accessing all the ray data in a loop it's possible that the Ray will update in the middle of your access loop. This means some data will come from one scan, and some from another scan. You can solve this problem by using SetActive(false) <your accessor loop> SetActive(true). More...
void	SetAngleMax (const double _angle)
	Set the scan maximum angle. More...
void	SetAngleMin (const double _angle)
	Set the scan minimum angle. More...
void	SetParent (const std::string &_parent) override
	Initialize values in the sensor. More...
void	SetVerticalAngleMax (const double _angle)
	Set the vertical scan line top angle. More...
void	SetVerticalAngleMin (const double _angle)
	Set the vertical scan bottom angle. More...
double	VertFOV () const
	Get the vertical field-of-view. More...
gz::math::Angle	VerticalAngleMax () const
	Get the vertical scan line top angle. More...
gz::math::Angle	VerticalAngleMin () const
	Get the vertical scan bottom angle. More...
double	VerticalAngleResolution () const
	Get the vertical angle in radians between each range. More...
unsigned int	VerticalRangeCount () const
	Get the vertical scan line count. More...
unsigned int	VerticalRayCount () const
	Get the vertical scan line count. More...
uint32_t	VisibilityMask () const
	Get the visibility mask. More...
Public Member Functions inherited from RenderingSensor
virtual	~RenderingSensor ()
	destructor More...
bool	ManualSceneUpdate () const
	Get whether the scene graph is updated manually. Defaults to false. More...
void	Render ()
	Render update. This performs the actual render operation. More...
rendering::ScenePtr	Scene () const
	Get the rendering scene. More...
void	SetManualSceneUpdate (bool _manual)
	Set whether to update the scene graph manually. If set to true, it is expected that rendering::Scene::PreRender is called manually before calling Render() More...
virtual void	SetScene (rendering::ScenePtr _scene)
	Set the rendering scene. More...
Public Member Functions inherited from Sensor
virtual	~Sensor ()
	destructor More...
void	AddSequence (gz::msgs::Header *_msg, const std::string &_seqKey="default")
	Add a sequence number to an gz::msgs::Header. This function can be called by a sensor that wants to add a sequence number to a sensor message in order to have improved accountability for generated sensor data. More...
bool	EnableMetrics () const
	Get flag state for enabling performance metrics publication. More...
std::string	FrameId () const
	FrameId. More...
SensorId	Id () const
	Get the sensor's ID. More...
bool	IsActive () const
	Get whether the sensor is enabled or not. More...
std::string	Name () const
	Get name. More...
std::chrono::steady_clock::duration	NextDataUpdateTime () const
	Return the next time the sensor will generate data. More...
std::string	Parent () const
	Get parent link of the sensor. More...
gz::math::Pose3d	Pose () const
	Get the current pose. More...
void	PublishMetrics (const std::chrono::duration< double > &_now)
	Publishes information about the performance of the sensor. This method is called by Update(). More...
sdf::ElementPtr	SDF () const
	Get the SDF used to load this sensor. More...
void	SetActive (bool _active)
	Enable or disable the sensor. Disabled sensors will not generate or publish data unless Update is called with the '_force' argument set to true. More...
void	SetEnableMetrics (bool _enableMetrics)
	Set flag to enable publishing performance metrics. More...
void	SetFrameId (const std::string &_frameId)
	Set Frame ID of the sensor. More...
void	SetPose (const gz::math::Pose3d &_pose)
	Update the pose of the sensor. More...
bool	SetTopic (const std::string &_topic)
	Set topic where sensor data is published. More...
void	SetUpdateRate (const double _hz)
	Set the update rate of the sensor. An update rate of zero means that the sensor is updated every cycle. It's zero by default. \detail Negative rates become zero. More...
std::string	Topic () const
	Get topic where sensor data is published. More...
bool	Update (const std::chrono::steady_clock::duration &_now, const bool _force)
	Update the sensor. More...
double	UpdateRate () const
	Get the update rate of the sensor. More...

Additional Inherited Members
Public Attributes inherited from Lidar
bool	initialized = false
	true if Load() has been called and was successful More...
float *	laserBuffer = nullptr
	Raw buffer of laser data. More...
std::mutex	lidarMutex
	Just a mutex for thread safety. More...
Protected Member Functions inherited from Lidar
virtual void	Fini ()
	Finalize the ray. More...
Protected Member Functions inherited from RenderingSensor
	RenderingSensor ()
	constructor More...
void	AddSensor (rendering::SensorPtr _sensor)
	Add a rendering::Sensor. Its render updates will be handled by this base class. More...
Protected Member Functions inherited from Sensor
	Sensor ()
	constructor More...

Detailed Description

GpuLidar Sensor Class.

This class creates laser scans using the GPU. It's measures the range from the origin of the center to points on the visual geometry in the scene.

It offers both an ignition-transport interface and a direct C++ API to access the image data. The API works by setting a callback to be called with image data.

Constructor & Destructor Documentation

GpuLidarSensor()

GpuLidarSensor

(

)

constructor

~GpuLidarSensor()

virtual ~GpuLidarSensor ( )

virtual

destructor

Member Function Documentation

ConnectNewLidarFrame()

virtual gz::common::ConnectionPtr ConnectNewLidarFrame ( std::function< void(const float *_scan, unsigned int _width, unsigned int _heighti, unsigned int _channels, const std::string &)>  _subscriber )

overridevirtual

Connect function pointer to internal GpuRays callback.

Returns

gz::common::Connection pointer

Reimplemented from Lidar.

CreateLidar()

virtual bool CreateLidar ( )

overridevirtual

Create Lidar sensor.

Reimplemented from Lidar.

GpuRays()

gz::rendering::GpuRaysPtr GpuRays

(

)

const

Get Gpu Rays object used in the sensor.

Returns

Pointer to gz::rendering::GpuRays

HasConnections()

bool HasConnections

(

)

const

Check if there are any subscribers.

Returns

True if there are subscribers, false otherwise

Todo:

(iche033) Make this function virtual on Garden

HFOV()

gz::math::Angle HFOV

(

)

const

Get the horizontal field of view of the laser sensor.

Returns

The horizontal field of view of the laser sensor.

Init()

virtual bool Init ( )

overridevirtual

Initialize values in the sensor.

Returns

True on success

Reimplemented from Lidar.

IsHorizontal()

bool IsHorizontal

(

)

const

Gets if sensor is horizontal.

Returns

True if horizontal, false if not

Load() [1/2]

virtual bool Load ( const sdf::Sensor &  _sdf )

overridevirtual

Load the sensor based on data from an sdf::Sensor object.

Parameters

[in]

_sdf

SDF Sensor parameters.

Returns

true if loading was successful

Reimplemented from Lidar.

Load() [2/2]

virtual bool Load ( sdf::ElementPtr  _sdf )

overridevirtual

Load sensor sata from SDF.

Parameters

[in]

_sdf

SDF used

Returns

True on success

Reimplemented from Lidar.

RayCountRatio()

double RayCountRatio

(

)

const

Return the ratio of horizontal ray count to vertical ray count.

A ray count is the number of simulated rays. Whereas a range count is the total number of data points returned. When range count != ray count, then values are interpolated between rays.

RemoveGpuRays()

void RemoveGpuRays

(

gz::rendering::ScenePtr

_scene

)

Remove sensor from scene.

Parameters

[in]

_scene

used with the sensor

SetScene()

void SetScene ( gz::rendering::ScenePtr  _scene )

override

Makes possible to change sensor scene.

Parameters

[in]

_scene

used with the sensor

Update()

virtual bool Update ( const std::chrono::steady_clock::duration &  _now )

overridevirtual

Force the sensor to generate data.

Parameters

[in]

_now

The current time

Returns

true if the update was successfull

Reimplemented from Lidar.

VFOV()

gz::math::Angle VFOV

(

)

const

Get the vertical field-of-view.

Returns

Vertical field of view.

---

The documentation for this class was generated from the following file:

• gz/sensors/GpuLidarSensor.hh