Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.generalrobotics.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Camera

Inherits from: Sensor Abstract base class for camera sensors. Extends the base Sensor class with camera-specific functionality including intrinsic parameter management and image capture. Attributes: settings (CameraSettings): Camera configuration and parameters

​
init

Camera.__init__() -> None
Initialize camera with default settings.
​
Returns
​
returns
None

​
getImage

Camera.getImage() -> Image
Return the image from camera. Captures and returns the current image from the camera sensor.
​
Returns
​
Image
Image
The captured image with metadata
​
Raises
​
NotImplementedError
Must be implemented by subclasses

​
getData

Camera.getData() -> Image
Get the image from the camera. Implements the Sensor interface by delegating to getImage().
​
Returns
​
Image
Image
The captured image from the camera

​
getCameraIntrinsics

Camera.getCameraIntrinsics() -> Optional[tuple[float, float, float, float]]
Get the intrinsic parameters for the camera. Retrieves the camera’s intrinsic calibration parameters used for image projection and rectification.
​
Returns
​
returns
Optional[tuple[float, float, float, float]]

​
setCameraIntrinsics

Camera.setCameraIntrinsics(fx: float, fy: float, cx: float, cy: float) -> None
Set the intrinsic parameters for the camera. Configures the camera’s intrinsic calibration parameters for accurate image projection and rectification.
​
Arguments
​
fx (float)
float
required
Focal length in x direction (pixels)
​
fy (float)
float
required
Focal length in y direction (pixels)
​
cx (float)
float
required
Principal point x coordinate (pixels)
​
cy (float)
float
required
Principal point y coordinate (pixels)
​
Returns
​
returns
None

​
getCameraSettings

Camera.getCameraSettings() -> CameraSettings
Get the camera settings.
​
Returns
​
CameraSettings
CameraSettings
Current camera configuration and parameters

​
setCameraSettings

Camera.setCameraSettings(settings: CameraSettings) -> None
Set the camera settings.
​
Arguments
​
settings (CameraSettings)
CameraSettings
required
New camera configuration to apply
​
Returns
​
returns
None