WideAngleCameraSensor Class Reference

Camera sensor with variable mapping function. More...

#include <sensors/sensors.hh>

Inherits CameraSensor.

Public Member Functions

 WideAngleCameraSensor ()
 Constructor. More...
 
virtual ~WideAngleCameraSensor ()
 Destructor. More...
 
rendering::CameraPtr Camera () const
 Returns a pointer to the rendering::Camera. More...
 
SensorCategory Category () const
 Get the category of the sensor. More...
 
event::ConnectionPtr ConnectUpdated (std::function< void()> _subscriber)
 Connect a signal that is triggered when the sensor is updated. More...
 
void DisconnectUpdated (event::ConnectionPtr &_c) GAZEBO_DEPRECATED(8.0)
 Disconnect from a the updated signal. More...
 
void FillMsg (msgs::Sensor &_msg)
 fills a msgs::Sensor message. More...
 
uint32_t Id () const
 Get the sensor's ID. More...
 
const unsigned char * ImageData () const
 Gets the raw image data from the sensor. More...
 
unsigned int ImageHeight () const
 Gets the height of the image in pixels. More...
 
unsigned int ImageWidth () const
 Gets the width of the image in pixels. More...
 
void Init () override
 Initialize the camera. More...
 
virtual bool IsActive () const
 Returns true if sensor generation is active. More...
 
common::Time LastMeasurementTime () const
 Return last measurement time. More...
 
common::Time LastUpdateTime () const
 Return last update time. More...
 
void Load (const std::string &_worldName) override
 Load the sensor with default parameters. More...
 
virtual void Load (const std::string &_worldName, sdf::ElementPtr _sdf)
 Load the sensor with SDF parameters. More...
 
std::string Name () const
 Get name. More...
 
NoisePtr Noise (const SensorNoiseType _type) const
 Get the sensor's noise model for a specified noise type. More...
 
uint32_t ParentId () const
 Get the sensor's parent's ID. More...
 
std::string ParentName () const
 Returns the name of the sensor parent. More...
 
virtual ignition::math::Pose3d Pose () const
 Get the current pose. More...
 
void ResetLastUpdateTime ()
 Reset the lastUpdateTime to zero. More...
 
bool SaveFrame (const std::string &_filename)
 Saves the image to the disk. More...
 
std::string ScopedName () const
 Get fully scoped name of the sensor. More...
 
virtual void SetActive (const bool _value)
 Set whether the sensor is active or not. More...
 
void SetParent (const std::string &_name, const uint32_t _id)
 Set the sensor's parent. More...
 
virtual void SetPose (const ignition::math::Pose3d &_pose)
 Set the current pose. More...
 
void SetUpdateRate (const double _hz)
 Set the update rate of the sensor. More...
 
virtual std::string Topic () const
 Gets the topic name of the sensor. More...
 
std::string TopicIgn () const
 Gets the ignition topic name of the sensor. More...
 
std::string Type () const
 Get sensor type. More...
 
void Update (const bool _force)
 Update the sensor. More...
 
double UpdateRate () const
 Get the update rate of the sensor. More...
 
bool Visualize () const
 Return true if user requests the sensor to be visualized via tag: <visualize>true</visualize> in SDF. More...
 
std::string WorldName () const
 Returns the name of the world the sensor is in. More...
 

Protected Member Functions

void Fini () override
 Finalize the camera. More...
 
bool NeedsUpdate ()
 Return true if the sensor needs to be updated. More...
 
void OnCtrlMessage (ConstCameraLensPtr &_msg)
 Handle incoming control message. More...
 
virtual void Render ()
 Handle the render event. More...
 
bool Rendered () const
 Get the value of the rendered flag. More...
 
void SetRendered (const bool _value)
 Set the value of the rendered flag. More...
 
bool UpdateImpl (const bool _force) override
 This gets overwritten by derived sensor types. More...
 

Protected Attributes

bool active
 True if sensor generation is active. More...
 
rendering::CameraPtr camera
 Pointer to the camera. More...
 
std::vector< event::ConnectionPtrconnections
 All event connections. More...
 
transport::PublisherPtr imagePub
 Publisher of image messages. More...
 
ignition::transport::Node::Publisher imagePubIgn
 Publisher of image messages. More...
 
common::Time lastMeasurementTime
 Stores last time that a sensor measurement was generated; this value must be updated within each sensor's UpdateImpl. More...
 
common::Time lastUpdateTime
 Time of the last update. More...
 
transport::NodePtr node
 Node for communication. More...
 
ignition::transport::Node nodeIgn
 Ignition transport node. More...
 
std::map< SensorNoiseType, NoisePtrnoises
 Noise added to sensor data. More...
 
uint32_t parentId
 The sensor's parent ID. More...
 
std::string parentName
 Name of the parent. More...
 
std::vector< SensorPluginPtrplugins
 All the plugins for the sensor. More...
 
ignition::math::Pose3d pose
 Pose of the sensor. More...
 
gazebo::rendering::ScenePtr scene
 Pointer to the Scene. More...
 
sdf::ElementPtr sdf
 Pointer the the SDF element for the sensor. More...
 
common::Time updatePeriod
 Desired time between updates, set indirectly by Sensor::SetUpdateRate. More...
 
gazebo::physics::WorldPtr world
 Pointer to the world. More...
 

Detailed Description

Camera sensor with variable mapping function.

This sensor is used for simulating cameras with wide-angle lens

Constructor & Destructor Documentation

Constructor.

virtual ~WideAngleCameraSensor ( )
virtual

Destructor.

Member Function Documentation

rendering::CameraPtr Camera ( ) const
inherited

Returns a pointer to the rendering::Camera.

Returns
The Pointer to the camera sensor.
SensorCategory Category ( ) const
inherited

Get the category of the sensor.

Returns
The category of the sensor.
See also
SensorCategory
event::ConnectionPtr ConnectUpdated ( std::function< void()>  _subscriber)
inherited

Connect a signal that is triggered when the sensor is updated.

Parameters
[in]_subscriberCallback that receives the signal.
Returns
A pointer to the connection. This must be kept in scope.
See also
Sensor::DisconnectUpdated
void DisconnectUpdated ( event::ConnectionPtr _c)
inherited

Disconnect from a the updated signal.

Parameters
[in]_cThe connection to disconnect
See also
Sensor::ConnectUpdated
Deprecated:
Use event::~Connection to disconnect
void FillMsg ( msgs::Sensor &  _msg)
inherited

fills a msgs::Sensor message.

Parameters
[out]_msgMessage to fill.
void Fini ( )
overrideprotectedvirtual

Finalize the camera.

Reimplemented from CameraSensor.

uint32_t Id ( ) const
inherited

Get the sensor's ID.

Returns
The sensor's ID.
const unsigned char* ImageData ( ) const
inherited

Gets the raw image data from the sensor.

Returns
The pointer to the image data array.
unsigned int ImageHeight ( ) const
inherited

Gets the height of the image in pixels.

Returns
The image height in pixels.
unsigned int ImageWidth ( ) const
inherited

Gets the width of the image in pixels.

Returns
The image width in pixels.
Deprecated:
See ImageWidth()
void Init ( )
overridevirtual

Initialize the camera.

Reimplemented from CameraSensor.

virtual bool IsActive ( ) const
virtualinherited

Returns true if sensor generation is active.

Returns
True if active, false if not.

Reimplemented from Sensor.

common::Time LastMeasurementTime ( ) const
inherited

Return last measurement time.

Returns
Time of last measurement.
Deprecated:
See LastMeasurementTime() function.
common::Time LastUpdateTime ( ) const
inherited

Return last update time.

Returns
Time of last update.
void Load ( const std::string &  _worldName)
overridevirtual

Load the sensor with default parameters.

Parameters
[in]_worldNameName of world to load from

Reimplemented from CameraSensor.

virtual void Load ( const std::string &  _worldName,
sdf::ElementPtr  _sdf 
)
virtualinherited

Load the sensor with SDF parameters.

Parameters
[in]_sdfSDF Sensor parameters
[in]_worldNameName of world to load from

Reimplemented from Sensor.

std::string Name ( ) const
inherited

Get name.

Returns
Name of sensor.
bool NeedsUpdate ( )
protectedinherited

Return true if the sensor needs to be updated.

Returns
True when sensor should be updated.
NoisePtr Noise ( const SensorNoiseType  _type) const
inherited

Get the sensor's noise model for a specified noise type.

Parameters
[in]_typeIndex of the noise type. Refer to SensorNoiseType enumeration for possible indices
Returns
The sensor's noise model for the given noise type
void OnCtrlMessage ( ConstCameraLensPtr &  _msg)
protected

Handle incoming control message.

Parameters
[in]_msgMessage received from topic
uint32_t ParentId ( ) const
inherited

Get the sensor's parent's ID.

Returns
The sensor's parent's ID.
std::string ParentName ( ) const
inherited

Returns the name of the sensor parent.

The parent name is set by Sensor::SetParent.

Returns
Name of Parent.
virtual ignition::math::Pose3d Pose ( ) const
virtualinherited

Get the current pose.

Returns
Current pose of the sensor.
See also
SetPose()
virtual void Render ( )
protectedvirtualinherited

Handle the render event.

bool Rendered ( ) const
protectedinherited

Get the value of the rendered flag.

void ResetLastUpdateTime ( )
inherited

Reset the lastUpdateTime to zero.

bool SaveFrame ( const std::string &  _filename)
inherited

Saves the image to the disk.

Parameters
[in]_filenameThe name of the file to be saved.
Returns
True if successful, false if unsuccessful.
std::string ScopedName ( ) const
inherited

Get fully scoped name of the sensor.

Returns
world_name::model_name::link_name::sensor_name.
virtual void SetActive ( const bool  _value)
virtualinherited

Set whether the sensor is active or not.

Parameters
[in]_valueTrue if active, false if not.
void SetParent ( const std::string &  _name,
const uint32_t  _id 
)
inherited

Set the sensor's parent.

Parameters
[in]_nameThe sensor's parent's name.
[in]_idThe sensor's parent's ID.
virtual void SetPose ( const ignition::math::Pose3d &  _pose)
virtualinherited

Set the current pose.

Parameters
[in]_poseNew pose of the sensor.
See also
Pose()
void SetRendered ( const bool  _value)
protectedinherited

Set the value of the rendered flag.

Parameters
[in]_valueNew rendered value.
void SetUpdateRate ( const double  _hz)
inherited

Set the update rate of the sensor.

Parameters
[in]_hzupdate rate of sensor.
virtual std::string Topic ( ) const
virtualinherited

Gets the topic name of the sensor.

Returns
Topic name

Reimplemented from Sensor.

std::string TopicIgn ( ) const
inherited

Gets the ignition topic name of the sensor.

Returns
Ignition topic name
std::string Type ( ) const
inherited

Get sensor type.

Returns
Type of sensor.
void Update ( const bool  _force)
inherited

Update the sensor.

Parameters
[in]_forceTrue to force update, false otherwise.
bool UpdateImpl ( const bool  )
overrideprotectedvirtual

This gets overwritten by derived sensor types.

This function is called during Sensor::Update. And in turn, Sensor::Update is called by SensorManager::Update

Parameters
[in]_forceTrue if update is forced, false if not
Returns
True if the sensor was updated.

Reimplemented from CameraSensor.

double UpdateRate ( ) const
inherited

Get the update rate of the sensor.

Returns
_hz update rate of sensor. Returns 0 if unthrottled.
bool Visualize ( ) const
inherited

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

Returns
True if visualized, false if not.
std::string WorldName ( ) const
inherited

Returns the name of the world the sensor is in.

Returns
Name of the world.

Member Data Documentation

bool active
protectedinherited

True if sensor generation is active.

rendering::CameraPtr camera
protectedinherited

Pointer to the camera.

std::vector<event::ConnectionPtr> connections
protectedinherited

All event connections.

transport::PublisherPtr imagePub
protectedinherited

Publisher of image messages.

ignition::transport::Node::Publisher imagePubIgn
protectedinherited

Publisher of image messages.

common::Time lastMeasurementTime
protectedinherited

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

common::Time lastUpdateTime
protectedinherited

Time of the last update.

transport::NodePtr node
protectedinherited

Node for communication.

ignition::transport::Node nodeIgn
protectedinherited

Ignition transport node.

std::map<SensorNoiseType, NoisePtr> noises
protectedinherited

Noise added to sensor data.

uint32_t parentId
protectedinherited

The sensor's parent ID.

std::string parentName
protectedinherited

Name of the parent.

std::vector<SensorPluginPtr> plugins
protectedinherited

All the plugins for the sensor.

ignition::math::Pose3d pose
protectedinherited

Pose of the sensor.

gazebo::rendering::ScenePtr scene
protectedinherited

Pointer to the Scene.

sdf::ElementPtr sdf
protectedinherited

Pointer the the SDF element for the sensor.

common::Time updatePeriod
protectedinherited

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

gazebo::physics::WorldPtr world
protectedinherited

Pointer to the world.


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