Interface to the source settings (provided by IRequest::getSourceSettings()).
Definition at line 50 of file Settings.h.
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 SensorMode * | getSensorMode () 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 InterfaceID & | id () |
Protected Member Functions | |
~ISourceSettings () | |
|
inlineprotected |
Definition at line 217 of file Settings.h.
|
pure virtual |
Returns the aperture f-number.
|
pure virtual |
Returns the aperture motor speed in motor steps/second.
|
pure virtual |
Returns the aperture position.
|
pure virtual |
Returns the exposure time range of the source, in nanoseconds.
|
pure virtual |
Returns the focus position, in focuser units.
|
pure virtual |
Returns the frame duration range, in nanoseconds.
|
pure virtual |
Returns the gain range.
|
pure virtual |
Returns user-specified opticalBlack level per bayer phase.
|
pure virtual |
Returns whether user-specified optical black levels are enabled.
If false, the Argus implementation will choose the optical black values.
|
pure virtual |
Returns the sensor mode.
|
inlinestatic |
Definition at line 53 of file Settings.h.
|
pure virtual |
Sets the aperture f-number.
If the f-number is not valid, error will be returned.
[in] | fnumber | The new f-number. |
|
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.
[in] | speed | The new speed. |
|
pure virtual |
Sets the aperture position.
If the position is not valid, error will be returned.
[in] | position | The new aperture position. |
|
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.
[in] | exposureTimeRange | Exposure time range, in nanoseconds. |
|
pure virtual |
Sets the focus position, in focuser units.
If the position is set outside of the focuser limits, the position will be clamped.
[in] | position | The new focus position, in focuser units. |
|
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.
[in] | frameDurationRange | Frame duration range, in nanoseconds |
|
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.
[in] | gainRange | scalar gain range |
|
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.
[in] | opticalBlackLevels | opticalBlack levels in range [0,1) per bayer phase |
|
pure virtual |
Sets whether or not user-provided optical black levels are used.
[in] | enable | If true , Argus will use the user-specified optical black levels. |
false
, the Argus implementation will choose the optical black values.
|
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.
[in] | mode | Desired sensor mode for the capture. |