CopperSpice API  1.7.2
QCameraImageProcessing Class Reference

Provides an interface for image processing related camera settings. More...

Inheritance diagram for QCameraImageProcessing:
QObject

Public Types

enum  ColorFilter
 
enum  WhiteBalanceMode
 

Public Methods

ColorFilter colorFilter () const
 
qreal contrast () const
 
qreal denoisingLevel () const
 
bool isAvailable () const
 
bool isColorFilterSupported (ColorFilter filter) const
 
bool isWhiteBalanceModeSupported (WhiteBalanceMode mode) const
 
qreal manualWhiteBalance () const
 
qreal saturation () const
 
void setColorFilter (ColorFilter filter)
 
void setContrast (qreal value)
 
void setDenoisingLevel (qreal value)
 
void setManualWhiteBalance (qreal colorTemperature)
 
void setSaturation (qreal value)
 
void setSharpeningLevel (qreal value)
 
void setWhiteBalanceMode (WhiteBalanceMode mode)
 
qreal sharpeningLevel () const
 
WhiteBalanceMode whiteBalanceMode () const
 
- Public Methods inherited from QObject
 QObject (QObject *parent=nullptr)
 
 ~QObject ()
 
bool blockSignals (bool block)
 
const QList< QObject * > & children () const
 
bool connect (const QObject *sender, const QString &signalMethod, const QString &location, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
bool connect (const QObject *sender, const QString &signalMethod, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
bool disconnect (const QObject *receiver, const QString &slotMethod=QString ()) const
 
bool disconnect (const QString &signalMethod, const QString &location, const QObject *receiver=nullptr, const QString &slotMethod=QString ()) const
 
bool disconnect (const QString &signalMethod=QString (), const QObject *receiver=nullptr, const QString &slotMethod=QString ()) const
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QStringdynamicPropertyNames () const
 
virtual bool event (QEvent *event)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
template<typename T >
findChild (const QString &childName=QString ()) const
 
template<class T >
QList< T > findChildren (const QRegularExpression &regExp, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 
template<class T >
QList< T > findChildren (const QString &objName=QString (), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 
bool inherits (const QString &className) const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const
 
bool isWindowType () const
 
void killTimer (int id)
 
const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const
 
QObject * parent () const
 
template<class T = QVariant>
property (const QString &name) const
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const QString &name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 
QThreadthread () const
 

Friends

class QCamera
 

Additional Inherited Members

- Public Signals inherited from QObject
void destroyed (QObject *obj=nullptr)
 
void objectNameChanged (const QString &objectName)
 
- Public Slots inherited from QObject
void deleteLater ()
 
- Static Public Methods inherited from QObject
static bool connect (const QObject *sender, const QMetaMethod &signalMethod, const QObject *receiver, const QMetaMethod &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool connect (const QObject *sender, const QString &signalMethod, const QObject *receiver, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection, const QString &location=QString ())
 
static bool connect (const QObject *sender, const QString &signalMethod, const QString &location, const QObject *receiver, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class SlotClass , class... SlotArgs, class SlotReturn >
static bool connect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, SlotReturn (SlotClass::*slotMethod)(SlotArgs...), Qt::ConnectionType type=Qt::AutoConnection)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class T >
static bool connect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, T slotLambda, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool disconnect (const QObject *sender, const QMetaMethod &signalMethod, const QObject *receiver, const QMetaMethod &slotMethod)
 
static bool disconnect (const QObject *sender, const QString &signalMethod, const QObject *receiver, const QString &slotMethod)
 
static bool disconnect (const QObject *sender, const QString &signalMethod, const QString &location, const QObject *receiver, const QString &slotMethod)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class SlotClass , class... SlotArgs, class SlotReturn >
static bool disconnect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, SlotReturn (SlotClass::*slotMethod)(SlotArgs...))
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver >
static bool disconnect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, std::nullptr_t slotMethod=nullptr)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class T >
static bool disconnect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, T slotMethod)
 
static QMetaObjectstaticMetaObject ()
 
static QString tr (const char *text, const char *comment=nullptr, std::optional< int > numArg=std::optional< int >())
 
- Protected Methods inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signalMethod) const
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signalMethod) const
 
bool isSignalConnected (const QMetaMethod &signalMethod) const
 
int receivers (const QString &signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

The QCameraImageProcessing class provides an interface for image processing related camera settings. After capturing the data for a camera frame, the camera hardware and software performs various image processing tasks to produce a final image. This includes compensating for ambient light color, reducing noise, as well as making some other adjustments to the image.

You can retrieve this class from an instance of a QCamera object. For example, you can set the white balance (or color temperature) used for processing images.

camera = new QCamera;
QCameraImageProcessing *imageProcessing = camera->imageProcessing();
if (imageProcessing->isAvailable()) {
imageProcessing->setWhiteBalanceMode(QCameraImageProcessing::WhiteBalanceFluorescent);
}

Or adjust the amount of de-noising performed. In some cases changing these settings may result in a longer delay before an image is ready.

imageProcessing->setDenoisingLevel(-0.3); // reduce the amount of de-noising applied
See also
QCameraImageProcessingControl

Member Enumeration Documentation

Contains values for filtering camera colors.

Constant Value Description
QCameraImageProcessing::ColorFilterNone 0 No filter is applied to images.
QCameraImageProcessing::ColorFilterGrayscale 1 A grayscale filter.
QCameraImageProcessing::ColorFilterNegative 2 A negative filter.
QCameraImageProcessing::ColorFilterSolarize 3 A solarize filter.
QCameraImageProcessing::ColorFilterSepia 4 A sepia filter.
QCameraImageProcessing::ColorFilterPosterize 5 A posterize filter.
QCameraImageProcessing::ColorFilterWhiteboard 6 A whiteboard filter.
QCameraImageProcessing::ColorFilterBlackboard 7 A blackboard filter.
QCameraImageProcessing::ColorFilterAqua 8 An aqua filter.
QCameraImageProcessing::ColorFilterVendor 1000 The base value for vendor defined filters.

Contains values for the white balance mode.

Constant Value Description
QCameraImageProcessing::WhiteBalanceAuto 0 Auto white balance mode.
QCameraImageProcessing::WhiteBalanceManual 1 Manual white balance. In this mode the white balance should be set with setManualWhiteBalance()
QCameraImageProcessing::WhiteBalanceSunlight 2 Sunlight white balance mode.
QCameraImageProcessing::WhiteBalanceCloudy 3 Cloudy white balance mode.
QCameraImageProcessing::WhiteBalanceShade 4 Shade white balance mode.
QCameraImageProcessing::WhiteBalanceTungsten 5 Tungsten (incandescent) white balance mode.
QCameraImageProcessing::WhiteBalanceFluorescent 6 Fluorescent white balance mode.
QCameraImageProcessing::WhiteBalanceFlash 7 Flash white balance mode.
QCameraImageProcessing::WhiteBalanceSunset 8 Sunset white balance mode.
QCameraImageProcessing::WhiteBalanceVendor 1000 Base value for vendor defined white balance modes.

Method Documentation

ColorFilter QCameraImageProcessing::colorFilter ( ) const

Returns the color filter which will be applied to image data captured by the camera.

See also
setColorFilter()
qreal QCameraImageProcessing::contrast ( ) const

Returns the contrast adjustment setting.

See also
setContrast()
qreal QCameraImageProcessing::denoisingLevel ( ) const

Returns the de-noising adjustment level.

See also
setDenoisingLevel()
bool QCameraImageProcessing::isAvailable ( ) const

Returns true if image processing related settings are supported by this camera.

bool QCameraImageProcessing::isColorFilterSupported ( ColorFilter  filter) const

Returns true if a color filter is supported.

Returns true if a color filter is supported.

bool QCameraImageProcessing::isWhiteBalanceModeSupported ( WhiteBalanceMode  mode) const

Returns true if the white balance mode is supported.

Returns true if the white balance mode is supported.

qreal QCameraImageProcessing::manualWhiteBalance ( ) const

Returns the current color temperature if the current white balance mode is WhiteBalanceManual. For other modes the return value is undefined.

See also
setManualWhiteBalance()
qreal QCameraImageProcessing::saturation ( ) const

Returns the saturation adjustment value.

See also
setSaturation()
void QCameraImageProcessing::setColorFilter ( ColorFilter  filter)

Sets the color filter which will be applied to image data captured by the camera.

See also
colorFilter()

Sets the color filter which will be applied to image data captured by the camera.

See also
colorFilter()
void QCameraImageProcessing::setContrast ( qreal  value)

Set the contrast adjustment to value. Valid contrast adjustment values range between -1.0 and 1.0, with a default of 0.

See also
contrast()

Set the contrast adjustment to value.

Valid contrast adjustment values range between -1.0 and 1.0, with a default of 0.

See also
contrast()
void QCameraImageProcessing::setDenoisingLevel ( qreal  level)

Sets the de-noising adjustment level. Valid sharpening values range between -1.0 and 1.0, with a default of 0.

If the parameter value is set to 0, the amount of de-noising applied is selected by camera and depends on camera capabilities and settings. Changing value in -1.0..1.0 range adjusts the amount of de-noising applied within the supported range.

See also
denoisingLevel()

Sets the de-noising adjustment level. Valid sharpening values range between -1.0 and 1.0, with a default of 0.

If the parameter value is set to 0, the amount of de-noising applied is selected by camera and depends on camera capabilities and settings. Changing value in -1.0..1.0 range adjusts the amount of de-noising applied within the supported range.

See also
denoisingLevel()
void QCameraImageProcessing::setManualWhiteBalance ( qreal  colorTemperature)

Sets manual white balance to colorTemperature. This is used when whiteBalanceMode() is set to WhiteBalanceManual. The units are Kelvin.

See also
manualWhiteBalance()

Sets manual white balance to colorTemperature. This is used when whiteBalanceMode() is set to WhiteBalanceManual. The units are Kelvin.

See also
manualWhiteBalance()
void QCameraImageProcessing::setSaturation ( qreal  value)

Sets the saturation adjustment value to value. Valid saturation values range between -1.0 and 1.0, with a default of 0.

See also
saturation()

Sets the saturation adjustment value to value. Valid saturation values range between -1.0 and 1.0, with a default of 0.

See also
saturation()
void QCameraImageProcessing::setSharpeningLevel ( qreal  level)

Sets the sharpening adjustment level. Valid sharpening values range between -1.0 and 1.0, with a default of 0.

See also
sharpeningLevel()

Sets the sharpening adjustment level. Valid sharpening values range between -1.0 and 1.0, with a default of 0.

See also
sharpeningLevel()
void QCameraImageProcessing::setWhiteBalanceMode ( WhiteBalanceMode  mode)

Sets the white balance to mode.

See also
whiteBalanceMode()

Sets the white balance to mode.

See also
whiteBalanceMode()
qreal QCameraImageProcessing::sharpeningLevel ( ) const

Returns the sharpening adjustment level.

See also
setSharpeningLevel()
WhiteBalanceMode QCameraImageProcessing::whiteBalanceMode ( ) const

Returns the white balance mode being used.

See also
setWhiteBalanceMode()