M_Camera::IService Class Reference

Public Member Functions
virtual	~IService ()
virtual void	ConfigOperationMode (M_Common::OperationModeType const &Mode)
virtual void	ConfigAutoFocus (M_Camera::AutoFocusKind::Type State)
virtual void	ConfigFocusLevel (M_Common::PercentType Level)
virtual void	CmdSetFocusByStep (int32_t Steps)
virtual void	ConfigDigitalZoom (bool Enable)
virtual void	ConfigZoomLevel (M_Common::PercentType Level)
virtual void	CmdSetZoomByStep (int32_t Steps)
virtual void	ConfigPredefinedZoomFov (uint16_t PredefinedLevel)
virtual void	CmdSetPredefinedZoomFovByStep (int32_t Steps)
virtual void	ConfigAutoBrightness (bool Enable)
virtual void	ConfigBrightnessLevel (M_Common::PercentType Level)
virtual void	CmdSetBrightnessByStep (int32_t Steps)
virtual void	ConfigAutoContrast (bool Enable)
virtual void	ConfigContrastLevel (M_Common::PercentType Level)
virtual void	CmdSetContrastByStep (int32_t Steps)
virtual void	ConfigHdrMode (int32_t Mode)
virtual void	ConfigPolarity (M_Camera::PolarityHotColor::Type HotIs)
virtual void	ConfigEconomyMode (bool Enable)
virtual void	ConfigCooler (bool Enable)
virtual void	ConfigAutoGain (bool Enable)
virtual void	ConfigGainLevel (M_Common::PercentType Level)
virtual void	CmdSetGainByStep (int32_t Steps)
virtual void	ConfigExposureTime (uint16_t ShutterSpeedPerSec)
virtual void	ConfigAutoExposure (bool Enable)
virtual void	ConfigAperture (M_Common::ProportionalType Aperture)
virtual void	CmdSetRegionOfInterest (M_Common::PixelRegionType const &Rectangle)
virtual void	CmdClearRegionOfInterest ()
	Clear the currently set Region of Interest. More...
virtual void	ConfigExternalTriggerMode (bool Enable)
virtual void	ConfigGrabbing (bool Enable)
virtual void	CmdCalibrateNuc (bool IsCalibrating)
virtual void	ConfigAutoCalibrateNuc (bool IsActive)
virtual void	ConfigAlphaBlendingLevel (M_Common::PercentType Level)
virtual void	CmdSetFalseColour (bool Enable, std::string const &Name)
virtual void	ConfigInfraredDynamicMode (bool Enable)
virtual void	ConfigSelectCameraPreset (std::string const &Name)
virtual void	CmdStartFocusEngine (M_Camera::ScaleDirection::Type Direction)
virtual void	CmdStopFocusEngine ()
	Stop focus engine. More...
virtual void	CmdStartZoomEngine (M_Camera::ScaleDirection::Type Direction)
virtual void	CmdStopZoomEngine ()
	Stop zoom engine (FoV motor). More...
virtual void	CmdFreezeImage ()
	Freeze current camera image. More...

Detailed Description

Camera Service interface. Contains operations that a client can command the Camera Service to perform.

Constructor & Destructor Documentation

~IService()

M_Camera::IService::~IService ( )

virtual

Member Function Documentation

CmdCalibrateNuc()

void M_Camera::IService::CmdCalibrateNuc ( bool  IsCalibrating )

virtual

Calibrate the non-uniformity compensation (NUC) coefficients for an IR camera.

Parameters

IsCalibrating

Indicates whether NUC calibration should be started (true) or aborted (false).

CmdClearRegionOfInterest()

void M_Camera::IService::CmdClearRegionOfInterest ( )

virtual

Clear the currently set Region of Interest.

CmdFreezeImage()

void M_Camera::IService::CmdFreezeImage ( )

virtual

Freeze current camera image.

CmdSetBrightnessByStep()

void M_Camera::IService::CmdSetBrightnessByStep ( int32_t  Steps )

virtual

Increase or decrease brightness by the given number of steps (of a predefined size).

Parameters

Steps

The number of steps to increase (positive numbers) or decrease (negative numbers).

CmdSetContrastByStep()

void M_Camera::IService::CmdSetContrastByStep ( int32_t  Steps )

virtual

Increase or decrease contrast by the given number of steps (of a predefined size).

Parameters

Steps

The number of steps to increase (positive numbers) or decrease (negative numbers).

CmdSetFalseColour()

void M_Camera::IService::CmdSetFalseColour ( bool  Enable, std::string const &  Name  )

virtual

Enable or disable false colour processing with the specified algorithm.

Parameters

Enable	Enable or disable (True = Enable, False = Disable)
Name	Algorithm name.

CmdSetFocusByStep()

void M_Camera::IService::CmdSetFocusByStep ( int32_t  Steps )

virtual

Increase or decrease focus by the given number of steps (of a predefined size). Note: A small focus indicates that a near object is focused, a large focus indicates that a distant object is focused.

Parameters

Steps

The number of steps to increase (positive numbers) or decrease (negative numbers).

CmdSetGainByStep()

void M_Camera::IService::CmdSetGainByStep ( int32_t  Steps )

virtual

Increase or decrease gain by the given number of steps (of a predefined size).

Parameters

Steps

The number of steps to increase (positive numbers) or decrease (negative numbers).

CmdSetPredefinedZoomFovByStep()

void M_Camera::IService::CmdSetPredefinedZoomFovByStep ( int32_t  Steps )

virtual

Increase or decrease field of view by the given number of steps (of a predefined size).

Parameters

Steps

The number of steps to increase (positive numbers) or decrease (negative numbers).

CmdSetRegionOfInterest()

void M_Camera::IService::CmdSetRegionOfInterest ( M_Common::PixelRegionType const &  Rectangle )

virtual

Set the Region of Interest as a cropped part of the Video.

Parameters

Rectangle

Rectangle defining the Region of Interest.

CmdSetZoomByStep()

void M_Camera::IService::CmdSetZoomByStep ( int32_t  Steps )

virtual

Increase or decrease zoom by the given number of steps (of a predefined size).

Parameters

Steps

The number of steps to increase (positive numbers) or decrease (negative numbers).

CmdStartFocusEngine()

void M_Camera::IService::CmdStartFocusEngine ( M_Camera::ScaleDirection::Type  Direction )

virtual

Start engine to increase or decrease focus.

Parameters

Direction

Increase or decrease.

CmdStartZoomEngine()

void M_Camera::IService::CmdStartZoomEngine ( M_Camera::ScaleDirection::Type  Direction )

virtual

Start engine to increase or decrease zoom (FoV motor).

Parameters

Direction

Increase or decrease.

CmdStopFocusEngine()

void M_Camera::IService::CmdStopFocusEngine ( )

virtual

Stop focus engine.

CmdStopZoomEngine()

void M_Camera::IService::CmdStopZoomEngine ( )

virtual

Stop zoom engine (FoV motor).

ConfigAlphaBlendingLevel()

void M_Camera::IService::ConfigAlphaBlendingLevel ( M_Common::PercentType  Level )

virtual

Set alpha blending level. Can be used to combine two images together for cameras which support this.

Parameters

Level

Level in percent.

ConfigAperture()

void M_Camera::IService::ConfigAperture ( M_Common::ProportionalType  Aperture )

virtual

Set lens aperture.

Parameters

Aperture

Aperture [-].

ConfigAutoBrightness()

void M_Camera::IService::ConfigAutoBrightness ( bool  Enable )

virtual

Enable or disable auto brightness.

Parameters

Enable

Enable or disable (True = Enable, False = Disable)

ConfigAutoCalibrateNuc()

void M_Camera::IService::ConfigAutoCalibrateNuc ( bool  IsActive )

virtual

Activate/deactivate the automatic non-uniformity compensation (NUC) coefficients for an IR camera.

Parameters

IsActive

Indicates whether automatic NUC calibration should be active (true) or inactive (false).

ConfigAutoContrast()

void M_Camera::IService::ConfigAutoContrast ( bool  Enable )

virtual

Enable or disable auto contrast.

Parameters

Enable

Enable or disable (True = Enable, False = Disable)

ConfigAutoExposure()

void M_Camera::IService::ConfigAutoExposure ( bool  Enable )

virtual

Enable or disable auto exposure.

Parameters

Enable

Enable or disable (True = Enable, False = Disable)

ConfigAutoFocus()

void M_Camera::IService::ConfigAutoFocus ( M_Camera::AutoFocusKind::Type  State )

virtual

Enable or disable auto focus.

Parameters

State

Auto-focus state.

ConfigAutoGain()

void M_Camera::IService::ConfigAutoGain ( bool  Enable )

virtual

Enable or disable auto gain.

Parameters

Enable

Enable or disable (True = Enable, False = Disable)

ConfigBrightnessLevel()

void M_Camera::IService::ConfigBrightnessLevel ( M_Common::PercentType  Level )

virtual

Set brightness level.

Parameters

Level

Level in percent.

ConfigContrastLevel()

void M_Camera::IService::ConfigContrastLevel ( M_Common::PercentType  Level )

virtual

Set contrast level.

Parameters

Level

Level in percent.

ConfigCooler()

void M_Camera::IService::ConfigCooler ( bool  Enable )

virtual

Enable or disable cooler for IR-Camera.

Parameters

Enable

Enable or disable (True = Enable, False = Disable)

ConfigDigitalZoom()

void M_Camera::IService::ConfigDigitalZoom ( bool  Enable )

virtual

Enable or disable 2x digital zoom.

Parameters

Enable

Enable or disable (True = Enable, False = Disable)

ConfigEconomyMode()

void M_Camera::IService::ConfigEconomyMode ( bool  Enable )

virtual

Set economy or normal mode for IR-Camera.

Parameters

Enable

Operating mode (True = Economy, False = Normal)

ConfigExposureTime()

void M_Camera::IService::ConfigExposureTime ( uint16_t  ShutterSpeedPerSec )

virtual

Exposure time (e.g. shutter speed) in fractions of a second.

Parameters

ShutterSpeedPerSec

Exposure time (e.g. shutter speed) fractions of a second. Examples: A value of 1 = One second A value of 2 = Half a second A value of 3 = Third of a second A value of 75 = 1/75 of a second A value of 10000 = 1/10000 of a second

Note: As reference the NGVA currently supports the following values: 1, 2, 3, 6, 12, 25, 50, 75, 100, 120, 150, 215, 300, 425, 600, 1000, 1250, 1750, 2500, 3500, 6000, 10000

ConfigExternalTriggerMode()

void M_Camera::IService::ConfigExternalTriggerMode ( bool  Enable )

virtual

Set external (true) or internal (false) trigger mode.

Parameters

Enable

Enable or disable (True = Enable, False = Disable)

ConfigFocusLevel()

void M_Camera::IService::ConfigFocusLevel ( M_Common::PercentType  Level )

virtual

Set focus level.

Parameters

Level

Level in percent. An absolute value between 0 and 100 where 0 represents the minimum zoom value (MinZoomFovDegrees) and 100 represents the maximum zoom value (MaxZoomFovDegrees) as defined by the reported settings. Note: 100 is the narrowest Field of View, 0 is the widest Field of View.

ConfigGainLevel()

void M_Camera::IService::ConfigGainLevel ( M_Common::PercentType  Level )

virtual

Set gain level.

Parameters

Level

Level in percent.

ConfigGrabbing()

void M_Camera::IService::ConfigGrabbing ( bool  Enable )

virtual

Start/enable (true) or stop/disable (false) image frame grabbing.

Parameters

Enable

Start/stop grabbing image frame grabbing. True = Start False = Stop

ConfigHdrMode()

void M_Camera::IService::ConfigHdrMode ( int32_t  Mode )

virtual

Set high dynamic range mode.

Parameters

Mode	HDR sub-mode.

ConfigInfraredDynamicMode()

void M_Camera::IService::ConfigInfraredDynamicMode ( bool  Enable )

virtual

Enable or disable infrared dynamic mode.

Parameters

Enable

Enable or disable (True = Enable, False = Disable)

ConfigOperationMode()

void M_Camera::IService::ConfigOperationMode ( M_Common::OperationModeType const &  Mode )

virtual

Set the camera operation mode.

Parameters

Mode	Mode to set.

ConfigPolarity()

void M_Camera::IService::ConfigPolarity ( M_Camera::PolarityHotColor::Type  HotIs )

virtual

Set polarity for IR-Camera.

Parameters

HotIs

Polarity (Hot-is-White, Hot-is-Black, Hot-is-Red)

ConfigPredefinedZoomFov()

void M_Camera::IService::ConfigPredefinedZoomFov ( uint16_t  PredefinedLevel )

virtual

Set Field of View (Zoom) to a predefined level.

Parameters

PredefinedLevel

Predefined FoV levels.

ConfigSelectCameraPreset()

void M_Camera::IService::ConfigSelectCameraPreset ( std::string const &  Name )

virtual

Select a preset with predefined Camera configuration values. Note: Selecting a preset will overwrite any current values that have been set on the camera with the values which belong to the specified preset.

Parameters

Name	Name pf preset.

ConfigZoomLevel()

void M_Camera::IService::ConfigZoomLevel ( M_Common::PercentType  Level )

virtual

Set zoom level.

Parameters

Level

Level in percent.