Jetson Linux API Reference

32.7.1 Release
Argus::ISourceSettings Class Referenceabstract

Detailed Description

Interface to the source settings (provided by IRequest::getSourceSettings()).

Definition at line 50 of file Settings.h.

Inheritance diagram for Argus::ISourceSettings:
Collaboration diagram for Argus::ISourceSettings:

Public Member Functions

virtual Status setExposureTimeRange (const Range< uint64_t > &exposureTimeRange)=0
 Sets the exposure time range of the source, in nanoseconds. More...
 
virtual Range< uint64_t > getExposureTimeRange () const =0
 Returns the exposure time range of the source, in nanoseconds. More...
 
virtual Status setFocusPosition (int32_t position)=0
 Sets the focus position, in focuser units. More...
 
virtual int32_t getFocusPosition () const =0
 Returns the focus position, in focuser units. More...
 
virtual Status setAperturePosition (int32_t position)=0
 Sets the aperture position. More...
 
virtual int32_t getAperturePosition () const =0
 Returns the aperture position. More...
 
virtual Status setApertureMotorSpeed (float speed)=0
 Sets the aperture motor speed in motor steps/second. More...
 
virtual float getApertureMotorSpeed () const =0
 Returns the aperture motor speed in motor steps/second. More...
 
virtual Status setApertureFNumber (float fnumber)=0
 Sets the aperture f-number. More...
 
virtual float getApertureFNumber () const =0
 Returns the aperture f-number. More...
 
virtual Status setFrameDurationRange (const Range< uint64_t > &frameDurationRange)=0
 Sets the frame duration range, in nanoseconds. More...
 
virtual Range< uint64_t > getFrameDurationRange () const =0
 Returns the frame duration range, in nanoseconds. More...
 
virtual Status setGainRange (const Range< float > &gainRange)=0
 Sets the gain range for the sensor. More...
 
virtual Range< float > getGainRange () const =0
 Returns the gain range. More...
 
virtual Status setSensorMode (SensorMode *mode)=0
 Sets the sensor mode. More...
 
virtual SensorModegetSensorMode () const =0
 Returns the sensor mode. More...
 
virtual Status setOpticalBlack (const BayerTuple< float > &opticalBlackLevels)=0
 Sets the user-specified optical black levels. More...
 
virtual BayerTuple< float > getOpticalBlack () const =0
 Returns user-specified opticalBlack level per bayer phase. More...
 
virtual Status setOpticalBlackEnable (bool enable)=0
 Sets whether or not user-provided optical black levels are used. More...
 
virtual bool getOpticalBlackEnable () const =0
 Returns whether user-specified optical black levels are enabled. More...
 

Static Public Member Functions

static const InterfaceIDid ()
 

Protected Member Functions

 ~ISourceSettings ()
 

Constructor & Destructor Documentation

◆ ~ISourceSettings()

Argus::ISourceSettings::~ISourceSettings ( )
inlineprotected

Definition at line 217 of file Settings.h.

Member Function Documentation

◆ getApertureFNumber()

virtual float Argus::ISourceSettings::getApertureFNumber ( ) const
pure virtual

Returns the aperture f-number.

◆ getApertureMotorSpeed()

virtual float Argus::ISourceSettings::getApertureMotorSpeed ( ) const
pure virtual

Returns the aperture motor speed in motor steps/second.

◆ getAperturePosition()

virtual int32_t Argus::ISourceSettings::getAperturePosition ( ) const
pure virtual

Returns the aperture position.

◆ getExposureTimeRange()

virtual Range<uint64_t> Argus::ISourceSettings::getExposureTimeRange ( ) const
pure virtual

Returns the exposure time range of the source, in nanoseconds.

◆ getFocusPosition()

virtual int32_t Argus::ISourceSettings::getFocusPosition ( ) const
pure virtual

Returns the focus position, in focuser units.

◆ getFrameDurationRange()

virtual Range<uint64_t> Argus::ISourceSettings::getFrameDurationRange ( ) const
pure virtual

Returns the frame duration range, in nanoseconds.

◆ getGainRange()

virtual Range<float> Argus::ISourceSettings::getGainRange ( ) const
pure virtual

Returns the gain range.

◆ getOpticalBlack()

virtual BayerTuple<float> Argus::ISourceSettings::getOpticalBlack ( ) const
pure virtual

Returns user-specified opticalBlack level per bayer phase.

Returns
opticalBlackLevels

◆ getOpticalBlackEnable()

virtual bool Argus::ISourceSettings::getOpticalBlackEnable ( ) const
pure virtual

Returns whether user-specified optical black levels are enabled.

If false, the Argus implementation will choose the optical black values.

See also
setOpticalBlackEnable()
Returns
enable

◆ getSensorMode()

virtual SensorMode* Argus::ISourceSettings::getSensorMode ( ) const
pure virtual

Returns the sensor mode.

◆ id()

static const InterfaceID& Argus::ISourceSettings::id ( )
inlinestatic

Definition at line 53 of file Settings.h.

◆ setApertureFNumber()

virtual Status Argus::ISourceSettings::setApertureFNumber ( float  fnumber)
pure virtual

Sets the aperture f-number.

If the f-number is not valid, error will be returned.

Parameters
[in]fnumberThe new f-number.
Returns
success/status of the call.

◆ setApertureMotorSpeed()

virtual Status Argus::ISourceSettings::setApertureMotorSpeed ( float  speed)
pure virtual

Sets the aperture motor speed in motor steps/second.

If the speed is set outside of the speed limits, the speed will be clamped.

Parameters
[in]speedThe new speed.
See also
ICameraProperties::getApertureMotorSpeedRange()
Returns
success/status of the call.

◆ setAperturePosition()

virtual Status Argus::ISourceSettings::setAperturePosition ( int32_t  position)
pure virtual

Sets the aperture position.

If the position is not valid, error will be returned.

Parameters
[in]positionThe new aperture position.
See also
ICameraProperties::getAperturePositionRange()
Returns
success/status of the call.

◆ setExposureTimeRange()

virtual Status Argus::ISourceSettings::setExposureTimeRange ( const Range< uint64_t > &  exposureTimeRange)
pure virtual

Sets the exposure time range of the source, in nanoseconds.

If the exposure range is outside of the available range, the capture's exposure time will be as close as possible to the exposure range specified.

Parameters
[in]exposureTimeRangeExposure time range, in nanoseconds.
See also
ISensorMode::getExposureTimeRange()
Returns
success/status of the call.

◆ setFocusPosition()

virtual Status Argus::ISourceSettings::setFocusPosition ( int32_t  position)
pure virtual

Sets the focus position, in focuser units.

If the position is set outside of the focuser limits, the position will be clamped.

Parameters
[in]positionThe new focus position, in focuser units.
See also
ICameraProperties::getFocusPositionRange()
Returns
success/status of the call.

◆ setFrameDurationRange()

virtual Status Argus::ISourceSettings::setFrameDurationRange ( const Range< uint64_t > &  frameDurationRange)
pure virtual

Sets the frame duration range, in nanoseconds.

If frame range is out of bounds of the current sensor mode, the capture's frame duration will be as close as possible to the range specified.

Parameters
[in]frameDurationRangeFrame duration range, in nanoseconds
See also
ISensorMode::getFrameDurationRange()
Returns
success/status of the call.

◆ setGainRange()

virtual Status Argus::ISourceSettings::setGainRange ( const Range< float > &  gainRange)
pure virtual

Sets the gain range for the sensor.

The range has to be within the max and min reported in the CameraProperties Otherwise the range will be clipped.

Parameters
[in]gainRangescalar gain range
See also
ISensorMode::getAnalogGainRange()
Returns
success/status of the call.

◆ setOpticalBlack()

virtual Status Argus::ISourceSettings::setOpticalBlack ( const BayerTuple< float > &  opticalBlackLevels)
pure virtual

Sets the user-specified optical black levels.

These values will be ignored unless getOpticalBlackEnable() == true Values are floating point in the range [0,1) normalized based on sensor bit depth.

Parameters
[in]opticalBlackLevelsopticalBlack levels in range [0,1) per bayer phase
Returns
success/status of the call.

◆ setOpticalBlackEnable()

virtual Status Argus::ISourceSettings::setOpticalBlackEnable ( bool  enable)
pure virtual

Sets whether or not user-provided optical black levels are used.

Parameters
[in]enableIf true, Argus will use the user-specified optical black levels.
See also
setOpticalBlack() If false, the Argus implementation will choose the optical black values.
Returns
success/status of the call.

◆ setSensorMode()

virtual Status Argus::ISourceSettings::setSensorMode ( SensorMode mode)
pure virtual

Sets the sensor mode.

Note that changing sensor mode from one capture to the next may result in multiple sensor frames being dropped between the two captures.

Parameters
[in]modeDesired sensor mode for the capture.
See also
ICameraProperties::getAllSensorModes()
Returns
success/status of the call.

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