Skip to content

Class vl::ICamera#

ClassList > vl > ICamera

Public Functions#

Type Name
virtual StreamId addStream (const std::shared_ptr< IFrameObserver > & frameObserver, const ImageSettings & imageSettings=ImageSettings()) = 0
virtual AutoExposureMode autoExposureMode () const = 0
virtual std::vector< AutoExposureMode > autoExposureModesAvailable () const = 0
virtual bool awbLock () const = 0
virtual vl::AwbMode awbMode () const = 0
virtual BinningMode binningMode (void) const = 0
Returns the active binning mode.
virtual float deviceTemperature (void) const
Read device temperature if available.
virtual float exposure () const = 0
virtual hs::types::Range< float > exposureLimits () const = 0
Returns the exposure limits of the device in [micro sec].
virtual hs::types::Range< float > exposureRange () const = 0
Returns the current auto exposure range in [micro sec].
virtual FlashOutputMode flashOutputMode () const = 0
virtual std::vector< FlashOutputMode > flashOutputModesAvailable () = 0
virtual float gain () const = 0
virtual hs::types::Range< float > gainLimits () const = 0
Returns the gain limits of the device in [decibel].
virtual hs::types::Range< float > gainRange () const = 0
Returns the current auto gain range in [decibel].
virtual Frame grabImage (const ImageSettings & imageSettings=ImageSettings()) = 0
virtual void grabImage (const std::shared_ptr< IFrameObserver > & frameObserver, const ImageSettings & imageSettings=ImageSettings()) = 0
virtual bool hasBinning (void) const = 0
Check if binning is available.
virtual bool hasDeviceTemperature (void) const
Check if device temperature reading is available.
virtual bool hasProperty (const std::string & name) = 0
virtual const hs::PropertyBase & property (const std::string & name) const = 0
virtual hs::PropertyBase & property (const std::string & name) = 0
virtual void removeStream (StreamId) = 0
virtual bool running () const = 0
virtual void setAutoExposureMode (AutoExposureMode mode) = 0
virtual void setAwbLock (bool lock) = 0
virtual void setAwbMode (vl::AwbMode mode) = 0
virtual void setBinningMode (BinningMode const mode) = 0
Set the binning mode.
virtual void setExposure (float exposure) = 0
virtual void setExposureRange (const hs::types::Range< float > & range) = 0
Set the auto exposure range in [micro sec].
virtual void setFlashOutputMode (FlashOutputMode mode) = 0
virtual void setGain (float gain) = 0
virtual void setGainRange (const hs::types::Range< float > & range) = 0
Set the auto gain range in [decibel].
virtual void setTriggerMode (TriggerMode mode) = 0
virtual void softReset (void) const
Soft-reset device if available.
virtual CameraStatus start () = 0
virtual void stop () = 0
virtual void trigger () = 0
virtual TriggerMode triggerMode () const = 0
virtual std::vector< TriggerMode > triggerModesAvailable () = 0
virtual ~ICamera () = default

Public Functions Documentation#

function addStream#

virtual StreamId vl::ICamera::addStream (
    const std::shared_ptr< IFrameObserver > & frameObserver,
    const ImageSettings & imageSettings=ImageSettings ()
) = 0

function autoExposureMode#

virtual AutoExposureMode vl::ICamera::autoExposureMode () const = 0

function autoExposureModesAvailable#

virtual std::vector< AutoExposureMode > vl::ICamera::autoExposureModesAvailable () const = 0

function awbLock#

virtual bool vl::ICamera::awbLock () const = 0

function awbMode#

virtual vl::AwbMode vl::ICamera::awbMode () const = 0

function binningMode#

Returns the active binning mode. 

virtual BinningMode vl::ICamera::binningMode (
    void
) const = 0

Returns:

BinningMode currently active

function deviceTemperature#

Read device temperature if available. 

inline virtual float vl::ICamera::deviceTemperature (
    void
) const

Returns:

Temperature in degC

function exposure#

virtual float vl::ICamera::exposure () const = 0

function exposureLimits#

Returns the exposure limits of the device in [micro sec]. 

virtual hs::types::Range< float > vl::ICamera::exposureLimits () const = 0

Returns:

Range in [us] or -1.f if not connected.

function exposureRange#

Returns the current auto exposure range in [micro sec]. 

virtual hs::types::Range< float > vl::ICamera::exposureRange () const = 0

Returns:

Range in [us] or -1.f if not connected.

function flashOutputMode#

virtual FlashOutputMode vl::ICamera::flashOutputMode () const = 0

function flashOutputModesAvailable#

virtual std::vector< FlashOutputMode > vl::ICamera::flashOutputModesAvailable () = 0

function gain#

virtual float vl::ICamera::gain () const = 0

function gainLimits#

Returns the gain limits of the device in [decibel]. 

virtual hs::types::Range< float > vl::ICamera::gainLimits () const = 0

Returns:

Range in [db] or -1.f if not connected.

function gainRange#

Returns the current auto gain range in [decibel]. 

virtual hs::types::Range< float > vl::ICamera::gainRange () const = 0

Returns:

Range in [db] or -1.f if not connected.

function grabImage [1/2]#

virtual Frame vl::ICamera::grabImage (
    const ImageSettings & imageSettings=ImageSettings ()
) = 0

function grabImage [2/2]#

virtual void vl::ICamera::grabImage (
    const std::shared_ptr< IFrameObserver > & frameObserver,
    const ImageSettings & imageSettings=ImageSettings ()
) = 0

function hasBinning#

Check if binning is available. 

virtual bool vl::ICamera::hasBinning (
    void
) const = 0

Returns:

true if binning can be used

function hasDeviceTemperature#

Check if device temperature reading is available. 

inline virtual bool vl::ICamera::hasDeviceTemperature (
    void
) const

Returns:

true if device temperature can be read

function hasProperty#

virtual bool vl::ICamera::hasProperty (
    const std::string & name
) = 0

function property [1/2]#

virtual const hs::PropertyBase & vl::ICamera::property (
    const std::string & name
) const = 0

function property [2/2]#

virtual hs::PropertyBase & vl::ICamera::property (
    const std::string & name
) = 0

function removeStream#

virtual void vl::ICamera::removeStream (
    StreamId
) = 0

function running#

virtual bool vl::ICamera::running () const = 0

function setAutoExposureMode#

virtual void vl::ICamera::setAutoExposureMode (
    AutoExposureMode mode
) = 0

function setAwbLock#

virtual void vl::ICamera::setAwbLock (
    bool lock
) = 0

function setAwbMode#

virtual void vl::ICamera::setAwbMode (
    vl::AwbMode mode
) = 0

function setBinningMode#

Set the binning mode. 

virtual void vl::ICamera::setBinningMode (
    BinningMode const mode
) = 0

Parameters:

  • BinningMode to set (0, 2x2, 4x4)

function setExposure#

virtual void vl::ICamera::setExposure (
    float exposure
) = 0

function setExposureRange#

Set the auto exposure range in [micro sec]. 

virtual void vl::ICamera::setExposureRange (
    const hs::types::Range< float > & range
) = 0

Parameters:

  • range in [us]

function setFlashOutputMode#

virtual void vl::ICamera::setFlashOutputMode (
    FlashOutputMode mode
) = 0

function setGain#

virtual void vl::ICamera::setGain (
    float gain
) = 0

function setGainRange#

Set the auto gain range in [decibel]. 

virtual void vl::ICamera::setGainRange (
    const hs::types::Range< float > & range
) = 0

Parameters:

  • range in [db]

function setTriggerMode#

virtual void vl::ICamera::setTriggerMode (
    TriggerMode mode
) = 0

function softReset#

Soft-reset device if available. 

inline virtual void vl::ICamera::softReset (
    void
) const

function start#

virtual CameraStatus vl::ICamera::start () = 0

function stop#

virtual void vl::ICamera::stop () = 0

function trigger#

virtual void vl::ICamera::trigger () = 0

function triggerMode#

virtual TriggerMode vl::ICamera::triggerMode () const = 0

function triggerModesAvailable#

virtual std::vector< TriggerMode > vl::ICamera::triggerModesAvailable () = 0

function ~ICamera#

virtual vl::ICamera::~ICamera () = default

The documentation for this class was generated from the following file docs/libvl/build/1.2.5/doxygen/source/vl/camera.h