CameraCMOSSensor.h

Go to the documentation of this file.

/*
Copyright 2007-2026. Algoryx Simulation AB.
 
All AGX source code, intellectual property, documentation, sample code,
tutorials, scene files and technical white papers, are copyrighted, proprietary
and confidential material of Algoryx Simulation AB. You may not download, read,
store, distribute, publish, copy or otherwise disseminate, use or expose this
material unless having a written signed agreement with Algoryx Simulation AB, or having been
advised so by Algoryx Simulation AB for a time limited evaluation, or having purchased a
valid commercial license from Algoryx Simulation AB.
 
Algoryx Simulation AB disclaims all responsibilities for loss or damage caused
from using this software, unless otherwise stated in written agreements with
Algoryx Simulation AB.
*/
#pragma once
#include <agxSensor/CameraBackend.h>
#include <agxSensor/CameraPhotodetector.h>
#include <agxSensor/LazyTrigger.h>
 
#include <optional>
 
namespace agxSensor
{
  using OptionalExposureCompensation = std::optional<agx::Real>;
  using OptionalDynamicRange = std::optional<agx::Real>;
 
  struct CameraCMOSSensorManualExposureFlag
  {
  };
 
  AGX_DECLARE_POINTER_TYPES(CameraCMOSSensor);
 
  class AGXSENSOR_EXPORT CameraCMOSSensor : public CameraPhotodetector
  {
    public:
      CameraCMOSSensor(
        const agx::Vec2& size = agx::Vec2(2728.8e-6, 1549.8e-6), const agx::Vec2i& resolution = agx::Vec2i(1920, 1080),
        agx::Real iso = 100, agx::Real shutterSpeed = 5.6e-3, agx::Real dynamicRange = 11.3);
 
      CameraCMOSSensor(
        CameraCMOSSensorManualExposureFlag, const agx::Vec2& size = agx::Vec2(2728.8e-6, 1549.8e-6),
        const agx::Vec2i& resolution = agx::Vec2i(1920, 1080), agx::Real iso = 100, agx::Real shutterSpeed = 5.6e-3,
        agx::Real exposureCompensation = 0.0);
 
      void setSize(const agx::Vec2& size);
 
      agx::Vec2 getSize() const;
 
      void setResolution(const agx::Vec2i& resolution);
 
      agx::Vec2i getResolution() const;
 
      void setISO(agx::Real iso);
 
      agx::Real getISO() const;
 
      void setShutterSpeed(agx::Real shutterSpeed);
 
      agx::Real getShutterSpeed() const;
 
      void setAutoExposure(agx::Real dynamicRange);
 
      void setManualExposureCompensation(agx::Real exposureCompensation);
 
      bool hasAutoExposureEnabled() const;
 
      OptionalExposureCompensation getExposureCompensation() const;
 
      OptionalDynamicRange getDynamicRange() const;
 
      virtual agx::Vec2 getExtents() const override;
 
      DOXYGEN_START_INTERNAL_BLOCK()
 
    public:
      virtual void synchronizeParameters(Camera* camera, const CameraBackend& backend) override;
      virtual void resetSynchronizationState() override;
 
      AGXSTREAM_DECLARE_SERIALIZABLE(agxSensor::CameraCMOSSensor);
 
      DOXYGEN_END_INTERNAL_BLOCK()
 
    private:
      CameraCMOSSensorParameters m_parameters;
      LazyTrigger m_dirty;
  };
}