The base infrared/thermal camera class. More...

#include <camera.h>

Inheritance diagram for flyby::IRCamera:

[legend]

Collaboration diagram for flyby::IRCamera:

[legend]

Public Member Functions
	IRCamera ()
	Default constructor.

	IRCamera (const std::string &name)
	Name constructor.

IRPalette	get_color_palette () override
	Gets the active color palette of the IR camera.

void	set_color_palette (IRPalette palette) override
	Sets the active color palette of the IR camera.

std::vector< IRPalette >	get_color_palette_options () override
	Gets the active color palette of the IR camera.

Public Member Functions inherited from flyby::Camera
	Camera ()
	The default constructor.

	Camera (const std::string &name)
	The name constructor.

void	take_picture () override
	Take a picture on the camera.

void	start_video_recording () override
	Start recording a video on the camera.

void	stop_video_recording () override
	Stop recording a video on the camera.

void	set_optical_zoom_level (int level) override
	Sets the optical zoom on the camera.

unsigned int	get_optical_zoom_level () override
	Gets the optical zoom on the camera.

std::vector< unsigned int >	get_optical_zoom_range () override
	Gets the optical zoom range on the camera.

ZoomType	get_optical_zoom_type () override
	Gets the optical zoom type on the camera.

void	set_digital_zoom_level (int level) override
	Sets the digital zoom on the camera.

unsigned int	get_digital_zoom_level () override
	Gets the digital zoom on the camera.

std::vector< unsigned int >	get_digital_zoom_range () override
	Gets the digital zoom range on the camera.

unsigned int	get_iso_level () override
	Gets the ISO level on the camera.

std::vector< unsigned int >	get_iso_range () override
	Gets the ISO range on the camera.

void	set_iso_level (unsigned int level) override
	Sets the ISO level on the camera.

unsigned int	get_shutter_speed () override
	Gets the shutter speed on the camera.

std::vector< unsigned int >	get_shutter_speed_range () override
	Gets the shutter speed range on the camera.

void	set_shutter_speed (unsigned int speed) override
	Sets the shutter speed on the camera.

ExposureProgramMode	get_exposure_program_mode () override
	Gets the exposure program mode.

void	set_exposure_program_mode (ExposureProgramMode mode) override
	Sets the exposure program mode.

float	get_aperture () override
	Gets the aperture.

std::vector< float >	get_aperture_range () override
	Gets the possible aperture values.

void	set_aperture (float aperture) override
	Sets the aperture.

std::string	get_white_balance () override
	Gets the white balance.

std::vector< std::string >	get_white_balance_options () override
	Gets the white balance options.

void	set_white_balance (std::string wb) override
	Sets the white balance.

FocusMode	get_focus_mode () override
	Gets the focus mode.

void	set_focus_mode (FocusMode mode) override
	Sets the focus mode.

unsigned int	get_focus_position () override
	Gets the focus position.

std::vector< unsigned int >	get_focus_position_range () override
	Gets the focus position range.

void	set_focus_position (unsigned int position) override
	Sets the focus position.

bool	get_zoom () const final
	Does the camera support zoom.

bool	get_gimbal () const final
	Is the camera mounted on a gimbal.

bool	get_picture () const final
	Does the camera support pictures.

bool	get_video () const final
	Does the camera support videos.

CameraType	get_type () const final
	Get the type of camera.

bool	is_recording () const final
	Get the recording status of the camera.

Additional Inherited Members
Protected Attributes inherited from flyby::Camera
CameraType	m_type
	The camera type.

bool	m_picture { false }
	Can the camera take pictures.

bool	m_video { false }
	Can the camera take videos.

bool	m_zoom { false }
	Can the camera zoom.

bool	m_gimbal { false }
	Is the camera mounted on a controllable gimbal.

bool	m_is_recording { false }
	Is the camera currently recording.

Detailed Description

The base infrared/thermal camera class.

This class is should be extended by implementing functionality that is present. For example, an IR camera that has multiple color palettes should override the set_color_palette function.

Member Function Documentation

◆ get_color_palette()

IRPalette flyby::IRCamera::get_color_palette ( )

inlineoverride

Gets the active color palette of the IR camera.

Should be overridden if a camera should implement this capability.

Returns: The currently used palette.

◆ get_color_palette_options()

std::vector< IRPalette > flyby::IRCamera::get_color_palette_options ( )

inlineoverride

Gets the active color palette of the IR camera.

Should be overridden if a camera should implement this capability.

Returns: A vector of palette options available.

◆ set_color_palette()

void flyby::IRCamera::set_color_palette ( IRPalette palette )

inlineoverride

Sets the active color palette of the IR camera.

Should be overridden if a camera should implement this capability.

Parameters

palette - The infrared palette to use.

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

include/flyby/payload/component/camera.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_color_palette()

◆ get_color_palette_options()

◆ set_color_palette()