Basic camera sensor. More...

#include <sensors/sensors.hh>

Inheritance diagram for gazebo::sensors::CameraSensor:

Public Member Functions
	CameraSensor ()
	Constructor.

virtual	~CameraSensor ()
	Destructor.

rendering::CameraPtr	GetCamera () const
	Returns a pointer to the rendering::Camera.

const unsigned char *	GetImageData ()
	Gets the raw image data from the sensor.

unsigned int	GetImageHeight () const
	Gets the height of the image in pixels.

unsigned int	GetImageWidth () const
	Gets the width of the image in pixels.

virtual std::string	GetTopic () const
	Gets the topic name of the sensor.

virtual void	Init ()
	Initialize the camera.

virtual bool	IsActive ()
	Returns true if sensor generation is active.

virtual void	Load (const std::string &_worldName, sdf::ElementPtr _sdf)
	Load the sensor with SDF parameters.

virtual void	Load (const std::string &_worldName)
	Load the sensor with default parameters.

bool	SaveFrame (const std::string &_filename)
	Saves the image to the disk.

virtual void	SetParent (const std::string &_name)
	Set the parent of the sensor.

Public Member Functions inherited from gazebo::sensors::Sensor
	Sensor ()
	Constructor.

virtual	~Sensor ()
	Destructor.

template<typename T >
event::ConnectionPtr	ConnectUpdated (T _subscriber)
	Connect a signal that is triggered when the sensor is updated.

void	DisconnectUpdated (event::ConnectionPtr &_c)
	Disconnect from a the updated signal.

void	FillMsg (msgs::Sensor &_msg)
	fills a msgs::Sensor message.

common::Time	GetLastMeasurementTime ()
	Return last measurement time.

common::Time	GetLastUpdateTime ()
	Return last update time.

std::string	GetName () const
	Get name.

std::string	GetParentName () const
	Returns the name of the sensor parent.

virtual math::Pose	GetPose () const
	Get the current pose.

std::string	GetScopedName () const
	Get fully scoped name of the sensor.

std::string	GetType () const
	Get sensor type.

double	GetUpdateRate ()
	Get the update rate of the sensor.

bool	GetVisualize () const
	Return true if user requests the sensor to be visualized via tag: <visualize>true</visualize> in SDF.

std::string	GetWorldName () const
	Returns the name of the world the sensor is in.

virtual void	SetActive (bool _value)
	Set whether the sensor is active or not.

void	SetUpdateRate (double _hz)
	Set the update rate of the sensor.

void	Update (bool _force)
	Update the sensor.

Protected Member Functions
virtual void	Fini ()
	Finalize the camera.

virtual void	UpdateImpl (bool _force)
	Update the sensor information.

Additional Inherited Members
Protected Attributes inherited from gazebo::sensors::Sensor
bool	active
	True if sensor generation is active.

std::vector< event::ConnectionPtr >	connections
	All event connections.

common::Time	lastMeasurementTime
	Stores last time that a sensor measurement was generated; this value must be updated within each sensor's UpdateImpl.

common::Time	lastUpdateTime
	Time of the last update.

transport::NodePtr	node
	Node for communication.

std::string	parentName
	Name of the parent.

std::vector< SensorPluginPtr >	plugins
	All the plugins for the sensor.

math::Pose	pose
	Pose of the sensor.

transport::SubscriberPtr	poseSub
	Subscribe to pose updates.

sdf::ElementPtr	sdf
	Pointer the the SDF element for the sensor.

common::Time	updatePeriod
	Desired time between updates, set indirectly by Sensor::SetUpdateRate.

gazebo::physics::WorldPtr	world
	Pointer to the world.

Detailed Description

Basic camera sensor.

This sensor is used for simulating standard monocular cameras

Constructor & Destructor Documentation

gazebo::sensors::CameraSensor::CameraSensor ( )

Constructor.

virtual gazebo::sensors::CameraSensor::~CameraSensor ( )

virtual

Destructor.

Member Function Documentation

virtual void gazebo::sensors::CameraSensor::Fini ( )

protectedvirtual

Finalize the camera.

Reimplemented from gazebo::sensors::Sensor.

rendering::CameraPtr gazebo::sensors::CameraSensor::GetCamera ( ) const

inline

Returns a pointer to the rendering::Camera.

Returns: The Pointer to the camera sensor.

const unsigned char* gazebo::sensors::CameraSensor::GetImageData ( )

Gets the raw image data from the sensor.

Returns: The pointer to the image data array.

unsigned int gazebo::sensors::CameraSensor::GetImageHeight ( ) const

Gets the height of the image in pixels.

Returns: The image height in pixels.

unsigned int gazebo::sensors::CameraSensor::GetImageWidth ( ) const

Gets the width of the image in pixels.

Returns: The image width in pixels.

virtual std::string gazebo::sensors::CameraSensor::GetTopic ( ) const

virtual

Gets the topic name of the sensor.

Returns: Topic name

Todo:: to be implemented

Reimplemented from gazebo::sensors::Sensor.

virtual void gazebo::sensors::CameraSensor::Init ( )

virtual

Initialize the camera.

Reimplemented from gazebo::sensors::Sensor.

virtual bool gazebo::sensors::CameraSensor::IsActive ( )

virtual

Returns true if sensor generation is active.

Returns: True if active, false if not.

Reimplemented from gazebo::sensors::Sensor.

virtual void gazebo::sensors::CameraSensor::Load	(	const std::string &	_worldName,
		sdf::ElementPtr	_sdf
	)

virtual

Load the sensor with SDF parameters.

Parameters

[in]	_sdf	SDF Sensor parameters
[in]	_worldName	Name of world to load from

Reimplemented from gazebo::sensors::Sensor.

virtual void gazebo::sensors::CameraSensor::Load ( const std::string & _worldName )

virtual

Load the sensor with default parameters.

Parameters

[in] _worldName Name of world to load from

Reimplemented from gazebo::sensors::Sensor.

bool gazebo::sensors::CameraSensor::SaveFrame ( const std::string & _filename )

Saves the image to the disk.

Parameters

[in] _filename The name of the file to be saved.

Returns: True if successful, false if unsuccessful.

virtual void gazebo::sensors::CameraSensor::SetParent ( const std::string & _name )

virtual

Set the parent of the sensor.

Parameters

_name The name of the parent

Reimplemented from gazebo::sensors::Sensor.

virtual void gazebo::sensors::CameraSensor::UpdateImpl ( bool _force )

protectedvirtual

Update the sensor information.

Parameters

[in] _force True if update is forced, false if not

Reimplemented from gazebo::sensors::Sensor.

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

CameraSensor.hh

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation