Information about a monocular camera sensor. More...
#include <Camera.hh>
Public Member Functions | |
Camera () | |
Constructor. More... | |
Camera (const Camera &_camera) | |
Copy constructor. More... | |
Camera (Camera &&_camera) noexcept | |
Move constructor. More... | |
virtual | ~Camera () |
Destructor. More... | |
const ignition::math::Vector2d & | DistortionCenter () const |
Get the distortion center or principal point. More... | |
double | DistortionK1 () const |
Get the radial distortion coefficient k1. More... | |
double | DistortionK2 () const |
Get the radial distortion coefficient k2. More... | |
double | DistortionK3 () const |
Get the radial distortion coefficient k3. More... | |
double | DistortionP1 () const |
Get the tangential distortion coefficient p1. More... | |
double | DistortionP2 () const |
Get the tangential distortion coefficient p2. More... | |
sdf::ElementPtr | Element () const |
Get a pointer to the SDF element that was used during load. More... | |
double | FarClip () const |
Get the far clip distance. More... | |
ignition::math::Angle | HorizontalFov () const |
Get the horizontal field of view in radians. More... | |
uint32_t | ImageHeight () const |
Get the image height in pixels. More... | |
const Noise & | ImageNoise () const |
Get the image noise values. More... | |
uint32_t | ImageWidth () const |
Get the image width in pixels. More... | |
double | LensC1 () const |
Get lens custom function linear scaling constant. More... | |
double | LensC2 () const |
Get lens custom function angular scaling constant. More... | |
double | LensC3 () const |
Get lens custom function angle offset constant. More... | |
ignition::math::Angle | LensCutoffAngle () const |
Get lens cutoff angle. More... | |
int | LensEnvironmentTextureSize () const |
Get environment texture size. More... | |
double | LensFocalLength () const |
Get lens custom function focal length. More... | |
const std::string & | LensFunction () const |
Get lens custom function. More... | |
double | LensIntrinsicsCx () const |
Get the lens X principal point in pixels. More... | |
double | LensIntrinsicsCy () const |
Get the lens Y principal point in pixels. More... | |
double | LensIntrinsicsFx () const |
Get the lens X focal length in pixels. More... | |
double | LensIntrinsicsFy () const |
Get the lens Y focal length in pixels. More... | |
double | LensIntrinsicsSkew () const |
Get the lens XY axis skew. More... | |
bool | LensScaleToHfov () const |
Get lens scale to horizontal field of field. More... | |
std::string | LensType () const |
Get the lens type. More... | |
Errors | Load (ElementPtr _sdf) |
Load the camera sensor based on an element pointer. More... | |
std::string | Name () const |
Get the name of the camera. More... | |
double | NearClip () const |
Get the near clip distance. More... | |
bool | operator!= (const Camera &_alt) const |
Return true this Camera object does not contain the same values as the passed in parameter. More... | |
Camera & | operator= (const Camera &_camera) |
Assignment operator. More... | |
Camera & | operator= (Camera &&_camera) noexcept |
Move assignment operator. More... | |
bool | operator== (const Camera &_alt) const |
Return true if both Camera objects contain the same values. More... | |
PixelFormatType | PixelFormat () const |
Get the pixel format. More... | |
std::string | PixelFormatStr () const |
Get the pixel format as a string. More... | |
const ignition::math::Pose3d & | Pose () const SDF_DEPRECATED(9.0) |
Get the pose of the camer. More... | |
const std::string & | PoseFrame () const SDF_DEPRECATED(9.0) |
Get the name of the coordinate frame in which this camera's pose is expressed. More... | |
const std::string & | PoseRelativeTo () const |
Get the name of the coordinate frame relative to which this object's pose is expressed. More... | |
const ignition::math::Pose3d & | RawPose () const |
Get the pose of the camer. More... | |
bool | SaveFrames () const |
Get whether frames should be saved. More... | |
const std::string & | SaveFramesPath () const |
Get the path in which to save frames. More... | |
void | SetDistortionCenter (const ignition::math::Vector2d &_center) const |
Set the distortion center or principal point. More... | |
void | SetDistortionK1 (double _k1) |
Set the radial distortion coefficient k1. More... | |
void | SetDistortionK2 (double _k2) |
Set the radial distortion coefficient k2. More... | |
void | SetDistortionK3 (double _k3) |
Set the radial distortion coefficient k3. More... | |
void | SetDistortionP1 (double _p1) |
Set the tangential distortion coefficient p1. More... | |
void | SetDistortionP2 (double _p2) |
Set the tangential distortion coefficient p2. More... | |
void | SetFarClip (double _far) |
Set the far clip distance. More... | |
void | SetHorizontalFov (const ignition::math::Angle &_hfov) |
Set the horizontal field of view in radians. More... | |
void | SetImageHeight (uint32_t _height) |
Set the image height in pixels. More... | |
void | SetImageNoise (const Noise &_noise) |
Set the noise values related to the image. More... | |
void | SetImageWidth (uint32_t _width) |
Set the image width in pixels. More... | |
void | SetLensC1 (double _c1) |
Set lens custom function linear scaling constant. More... | |
void | SetLensC2 (double _c2) |
Set lens custom function angular scaling constant. More... | |
void | SetLensC3 (double _c3) |
Set lens custom function angle offset constant. More... | |
void | SetLensCutoffAngle (const ignition::math::Angle &_angle) |
Set lens cutoff angle. More... | |
void | SetLensEnvironmentTextureSize (int _size) |
Set environment texture size. More... | |
void | SetLensFocalLength (double _f) |
Set lens custom function focal length. More... | |
void | SetLensFunction (const std::string &_fun) |
Set lens custom function. More... | |
void | SetLensIntrinsicsCx (double _cx) |
Set the lens X principal point in pixels. More... | |
void | SetLensIntrinsicsCy (double _cy) |
Set the lens Y principal point in pixels. More... | |
void | SetLensIntrinsicsFx (double _fx) |
Set the lens X focal length in pixels. More... | |
void | SetLensIntrinsicsFy (double _fy) |
Set the lens Y focal length in pixels. More... | |
void | SetLensIntrinsicsSkew (double _s) |
Set the lens XY axis skew. More... | |
void | SetLensScaleToHfov (bool _scale) |
Set lens scale to horizontal field of field. More... | |
void | SetLensType (const std::string &_type) |
Set the lens type. More... | |
void | SetName (const std::string &_name) |
Set the name of the camera. More... | |
void | SetNearClip (double _near) |
Set the near clip distance. More... | |
void | SetPixelFormat (PixelFormatType _format) |
Set the pixel format type. More... | |
void | SetPixelFormatStr (const std::string &_fmt) |
Set the pixel format from a string. More... | |
void | SetPose (const ignition::math::Pose3d &_pose) SDF_DEPRECATED(9.0) |
Set the pose of the camera. More... | |
void | SetPoseFrame (const std::string &_frame) SDF_DEPRECATED(9.0) |
Set the name of the coordinate frame in which this camera's pose is expressed. More... | |
void | SetPoseRelativeTo (const std::string &_frame) |
Set the name of the coordinate frame relative to which this object's pose is expressed. More... | |
void | SetRawPose (const ignition::math::Pose3d &_pose) |
Set the pose of the camera. More... | |
void | SetSaveFrames (bool _save) |
Set whether frames should be saved. More... | |
void | SetSaveFramesPath (const std::string &_path) |
Set the path in which to save frames. More... | |
Static Public Member Functions | |
static PixelFormatType | ConvertPixelFormat (const std::string &_format) |
Convert a string to a PixelFormatType. More... | |
static std::string | ConvertPixelFormat (PixelFormatType _type) |
Convert a PixelFormatType to a string. More... | |
Information about a monocular camera sensor.
sdf::v9::Camera::Camera | ( | ) |
Constructor.
sdf::v9::Camera::Camera | ( | const Camera & | _camera | ) |
Copy constructor.
[in] | _camera | Camera to copy. |
|
noexcept |
Move constructor.
[in] | _camera | Camera to move. |
|
virtual |
Destructor.
|
static |
Convert a string to a PixelFormatType.
[in] | _format | String equivalent of a pixel format type to convert. |
|
static |
Convert a PixelFormatType to a string.
[in] | _type | Pixel format type to convert. |
const ignition::math::Vector2d& sdf::v9::Camera::DistortionCenter | ( | ) | const |
Get the distortion center or principal point.
double sdf::v9::Camera::DistortionK1 | ( | ) | const |
Get the radial distortion coefficient k1.
double sdf::v9::Camera::DistortionK2 | ( | ) | const |
Get the radial distortion coefficient k2.
double sdf::v9::Camera::DistortionK3 | ( | ) | const |
Get the radial distortion coefficient k3.
double sdf::v9::Camera::DistortionP1 | ( | ) | const |
Get the tangential distortion coefficient p1.
double sdf::v9::Camera::DistortionP2 | ( | ) | const |
Get the tangential distortion coefficient p2.
sdf::ElementPtr sdf::v9::Camera::Element | ( | ) | const |
double sdf::v9::Camera::FarClip | ( | ) | const |
Get the far clip distance.
ignition::math::Angle sdf::v9::Camera::HorizontalFov | ( | ) | const |
Get the horizontal field of view in radians.
uint32_t sdf::v9::Camera::ImageHeight | ( | ) | const |
Get the image height in pixels.
const Noise& sdf::v9::Camera::ImageNoise | ( | ) | const |
Get the image noise values.
uint32_t sdf::v9::Camera::ImageWidth | ( | ) | const |
Get the image width in pixels.
double sdf::v9::Camera::LensC1 | ( | ) | const |
Get lens custom function linear scaling constant.
double sdf::v9::Camera::LensC2 | ( | ) | const |
Get lens custom function angular scaling constant.
double sdf::v9::Camera::LensC3 | ( | ) | const |
Get lens custom function angle offset constant.
ignition::math::Angle sdf::v9::Camera::LensCutoffAngle | ( | ) | const |
Get lens cutoff angle.
Everything outside of the specified angle will be hidden.
int sdf::v9::Camera::LensEnvironmentTextureSize | ( | ) | const |
Get environment texture size.
This is the resolution of the environment cube map used to draw the world.
double sdf::v9::Camera::LensFocalLength | ( | ) | const |
Get lens custom function focal length.
const std::string& sdf::v9::Camera::LensFunction | ( | ) | const |
Get lens custom function.
Possible values are 'sin', 'tan', and 'id'.
double sdf::v9::Camera::LensIntrinsicsCx | ( | ) | const |
Get the lens X principal point in pixels.
double sdf::v9::Camera::LensIntrinsicsCy | ( | ) | const |
Get the lens Y principal point in pixels.
double sdf::v9::Camera::LensIntrinsicsFx | ( | ) | const |
Get the lens X focal length in pixels.
double sdf::v9::Camera::LensIntrinsicsFy | ( | ) | const |
Get the lens Y focal length in pixels.
double sdf::v9::Camera::LensIntrinsicsSkew | ( | ) | const |
Get the lens XY axis skew.
bool sdf::v9::Camera::LensScaleToHfov | ( | ) | const |
Get lens scale to horizontal field of field.
std::string sdf::v9::Camera::LensType | ( | ) | const |
Get the lens type.
This is the type of the lens mapping. Supported values are gnomonical, stereographic, equidistant, equisolid_angle, orthographic, custom. For gnomonical (perspective) projection, it is recommended to specify a horizontal_fov of less than or equal to 90 degrees
Errors sdf::v9::Camera::Load | ( | ElementPtr | _sdf | ) |
std::string sdf::v9::Camera::Name | ( | ) | const |
Get the name of the camera.
double sdf::v9::Camera::NearClip | ( | ) | const |
Get the near clip distance.
bool sdf::v9::Camera::operator!= | ( | const Camera & | _alt | ) | const |
Return true this Camera object does not contain the same values as the passed in parameter.
Assignment operator.
[in] | _camera | The camera to set values from. |
Move assignment operator.
[in] | _camera | The camera to set values from. |
bool sdf::v9::Camera::operator== | ( | const Camera & | _alt | ) | const |
Return true if both Camera objects contain the same values.
PixelFormatType sdf::v9::Camera::PixelFormat | ( | ) | const |
Get the pixel format.
This value is set from the <format> element that is the child of <image>.
std::string sdf::v9::Camera::PixelFormatStr | ( | ) | const |
Get the pixel format as a string.
const ignition::math::Pose3d& sdf::v9::Camera::Pose | ( | ) | const |
Get the pose of the camer.
This is the pose of the camera as specified in SDF (<camera> <pose> ... </pose></camera>).
const std::string& sdf::v9::Camera::PoseFrame | ( | ) | const |
Get the name of the coordinate frame in which this camera's pose is expressed.
A empty value indicates that the frame is the parent link.
const std::string& sdf::v9::Camera::PoseRelativeTo | ( | ) | const |
Get the name of the coordinate frame relative to which this object's pose is expressed.
An empty value indicates that the frame is relative to the parent link.
const ignition::math::Pose3d& sdf::v9::Camera::RawPose | ( | ) | const |
Get the pose of the camer.
This is the pose of the camera as specified in SDF (<camera> <pose> ... </pose></camera>).
bool sdf::v9::Camera::SaveFrames | ( | ) | const |
Get whether frames should be saved.
const std::string& sdf::v9::Camera::SaveFramesPath | ( | ) | const |
Get the path in which to save frames.
void sdf::v9::Camera::SetDistortionCenter | ( | const ignition::math::Vector2d & | _center | ) | const |
Set the distortion center or principal point.
[in] | _center | Distortion center or principal point. |
void sdf::v9::Camera::SetDistortionK1 | ( | double | _k1 | ) |
Set the radial distortion coefficient k1.
[in] | _k1 | The k1 radial distortion. |
void sdf::v9::Camera::SetDistortionK2 | ( | double | _k2 | ) |
Set the radial distortion coefficient k2.
[in] | _k2 | The k2 radial distortion. |
void sdf::v9::Camera::SetDistortionK3 | ( | double | _k3 | ) |
Set the radial distortion coefficient k3.
[in] | _k3 | The k3 radial distortion. |
void sdf::v9::Camera::SetDistortionP1 | ( | double | _p1 | ) |
Set the tangential distortion coefficient p1.
[in] | _p1 | The p1 tangential distortion. |
void sdf::v9::Camera::SetDistortionP2 | ( | double | _p2 | ) |
Set the tangential distortion coefficient p2.
void sdf::v9::Camera::SetFarClip | ( | double | _far | ) |
Set the far clip distance.
[in] | _far | The far clip distance. |
void sdf::v9::Camera::SetHorizontalFov | ( | const ignition::math::Angle & | _hfov | ) |
Set the horizontal field of view in radians.
[in] | _hfov | The horizontal field of view in radians. |
void sdf::v9::Camera::SetImageHeight | ( | uint32_t | _height | ) |
Set the image height in pixels.
[in] | _height | The image height in pixels. |
void sdf::v9::Camera::SetImageNoise | ( | const Noise & | _noise | ) |
Set the noise values related to the image.
[in] | _noise | Noise values for the image. |
void sdf::v9::Camera::SetImageWidth | ( | uint32_t | _width | ) |
Set the image width in pixels.
[in] | _width | The image width in pixels. |
void sdf::v9::Camera::SetLensC1 | ( | double | _c1 | ) |
Set lens custom function linear scaling constant.
[in] | _c1 | The lens custom function linear scaling constant. |
void sdf::v9::Camera::SetLensC2 | ( | double | _c2 | ) |
Set lens custom function angular scaling constant.
[in] | _c2 | The lens custom function angular scaling constant. |
void sdf::v9::Camera::SetLensC3 | ( | double | _c3 | ) |
Set lens custom function angle offset constant.
[in] | _c3 | The lens custom function angle offset constant. |
void sdf::v9::Camera::SetLensCutoffAngle | ( | const ignition::math::Angle & | _angle | ) |
Set lens cutoff angle.
Everything outside of the specified angle will be hidden.
[in] | _angle | The lens cutoff angle. |
void sdf::v9::Camera::SetLensEnvironmentTextureSize | ( | int | _size | ) |
Set environment texture size.
This is the resolution of the environment cube map used to draw the world.
[in] | _size | The lens environment texture size. |
void sdf::v9::Camera::SetLensFocalLength | ( | double | _f | ) |
Set lens custom function focal length.
[in] | _f | The lens custom function focal length. |
void sdf::v9::Camera::SetLensFunction | ( | const std::string & | _fun | ) |
Set lens custom function.
[in] | _fun | The lens custom function. Possible values are 'sin', 'tan', and 'id'. |
void sdf::v9::Camera::SetLensIntrinsicsCx | ( | double | _cx | ) |
Set the lens X principal point in pixels.
[in] | _cx | The lens X principal point in pixels. |
void sdf::v9::Camera::SetLensIntrinsicsCy | ( | double | _cy | ) |
Set the lens Y principal point in pixels.
[in] | _cy | The lens Y principal point in pixels. |
void sdf::v9::Camera::SetLensIntrinsicsFx | ( | double | _fx | ) |
Set the lens X focal length in pixels.
[in] | _fx | The lens X focal length in pixels. |
void sdf::v9::Camera::SetLensIntrinsicsFy | ( | double | _fy | ) |
Set the lens Y focal length in pixels.
[in] | _fy | The lens Y focal length in pixels. |
void sdf::v9::Camera::SetLensIntrinsicsSkew | ( | double | _s | ) |
Set the lens XY axis skew.
[in] | _s | The lens XY axis skew. |
void sdf::v9::Camera::SetLensScaleToHfov | ( | bool | _scale | ) |
Set lens scale to horizontal field of field.
[in] | _scale | True if the image should be scaled to fit horizontal FOV, otherwise it will be shown according to projection type parameters. |
void sdf::v9::Camera::SetLensType | ( | const std::string & | _type | ) |
Set the lens type.
Supported values are gnomonical, stereographic, equidistant, equisolid_angle, orthographic, custom.
[in] | _type | The lens type. |
void sdf::v9::Camera::SetName | ( | const std::string & | _name | ) |
Set the name of the camera.
[in] | _name | Name of the sensor. |
void sdf::v9::Camera::SetNearClip | ( | double | _near | ) |
Set the near clip distance.
[in] | _near | The near clip distance. |
void sdf::v9::Camera::SetPixelFormat | ( | PixelFormatType | _format | ) |
Set the pixel format type.
[in] | _format | The image format. |
void sdf::v9::Camera::SetPixelFormatStr | ( | const std::string & | _fmt | ) |
Set the pixel format from a string.
[in] | _fmt | The pixel format string. |
void sdf::v9::Camera::SetPose | ( | const ignition::math::Pose3d & | _pose | ) |
Set the pose of the camera.
[in] | _pose | The new camera pose. |
void sdf::v9::Camera::SetPoseFrame | ( | const std::string & | _frame | ) |
Set the name of the coordinate frame in which this camera's pose is expressed.
A empty value indicates that the frame is the parent link.
[in] | _frame | The name of the pose frame. |
void sdf::v9::Camera::SetPoseRelativeTo | ( | const std::string & | _frame | ) |
Set the name of the coordinate frame relative to which this object's pose is expressed.
An empty value indicates that the frame is relative to the parent link.
[in] | _frame | The name of the pose relative-to frame. |
void sdf::v9::Camera::SetRawPose | ( | const ignition::math::Pose3d & | _pose | ) |
Set the pose of the camera.
[in] | _pose | The new camera pose. |
void sdf::v9::Camera::SetSaveFrames | ( | bool | _save | ) |
Set whether frames should be saved.
[in] | _save | True if image frames should be saved. |
void sdf::v9::Camera::SetSaveFramesPath | ( | const std::string & | _path | ) |
Set the path in which to save frames.
[in] | _path | Path to save frames. |