Corrects artifacts that appear when imaging scenes with large texture gradients or high contrast. These artifacts are caused by blurring in the lens. The filter works best when aperture values are chosen such that the camera has quite good focus. The filter also supports removing the points that experience a large correction. More...

#include <Zivid/Settings.h>

Classes
class	Correction
	Contrast distortion correction filter. More...

class	Removal
	Contrast distortion removal filter. More...

Public Types
using	Descendants

Public Member Functions
	ContrastDistortion ()
	Default constructor.

template<typename... Args>
	ContrastDistortion (Args &&...args)
	Constructor taking variadic number of arguments.

template<typename... Args>
void	set (Args &&...args)
	Set multiple arguments.

template<typename... Args>
ContrastDistortion	copyWith (Args &&...args) const
	Returns a copy of this object with the given argument(s) set to the new value(s)

const Correction &	correction () const
	Get Correction.

Correction &	correction ()
	Get Correction.

ContrastDistortion &	set (const Correction &value)
	Set Correction.

ContrastDistortion &	set (const Correction::Enabled &value)
	Set Correction::Enabled.

ContrastDistortion &	set (const Correction::Strength &value)
	Set Correction::Strength.

const Removal &	removal () const
	Get Removal.

Removal &	removal ()
	Get Removal.

ContrastDistortion &	set (const Removal &value)
	Set Removal.

ContrastDistortion &	set (const Removal::Enabled &value)
	Set Removal::Enabled.

ContrastDistortion &	set (const Removal::Threshold &value)
	Set Removal::Threshold.

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Removal &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold &	get () const

template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction &	get () const

template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Removal &	get () const

template<typename F >
void	forEach (const F &f) const
	Run the given function on each direct member with the value of the member as parameter.

template<typename F >
void	forEach (const F &f)
	Run the given function on each direct member with the value of the member as parameter.

bool	operator== (const ContrastDistortion &other) const
	Equality operator.

bool	operator!= (const ContrastDistortion &other) const
	Inequality operator.

std::string	toString () const
	Get the value as string.

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::group
	The type of this node.

static constexpr const char *	path { "Processing/Filters/Experimental/ContrastDistortion" }
	The full path for this value.

static constexpr const char *	name { "ContrastDistortion" }
	The name of this value.

static constexpr const char *	description
	The description for this value.

Friends
struct	DataModel::Detail::Befriend< ContrastDistortion >

std::ostream &	operator<< (std::ostream &stream, const ContrastDistortion &value)
	Operator to send the value as string to a stream.

Detailed Description

Corrects artifacts that appear when imaging scenes with large texture gradients or high contrast. These artifacts are caused by blurring in the lens. The filter works best when aperture values are chosen such that the camera has quite good focus. The filter also supports removing the points that experience a large correction.

Member Typedef Documentation

◆ Descendants

using Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Descendants

Initial value:

 std::tuple<
                            Settings::Processing::Filters::Experimental::ContrastDistortion::Correction,
                            Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled,
                            Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength,
                            Settings::Processing::Filters::Experimental::ContrastDistortion::Removal,
                            Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled,
                            Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold>

Constructor & Destructor Documentation

◆ ContrastDistortion() [1/2]

Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::ContrastDistortion ( )

Default constructor.

◆ ContrastDistortion() [2/2]

template<typename... Args>

Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::ContrastDistortion ( Args &&... args )

inlineexplicit

Constructor taking variadic number of arguments.

One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing ContrastDistortion then invoking set(args).

The provided arguments must be descendants of ContrastDistortion. These types can be provided:

Member Function Documentation

◆ copyWith()

template<typename... Args>

ContrastDistortion Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::copyWith ( Args &&... args ) const

inline

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this ContrastDistortion object, then invokes set(args) on the copy, and finally returns the copy. This method does not modify the original object.

The provided arguments must be descendants of ContrastDistortion. These types can be provided:

◆ correction() [1/2]

Correction & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::correction ( )

inline

Get Correction.

◆ correction() [2/2]

const Correction & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::correction ( ) const

inline

Get Correction.

◆ forEach() [1/2]

template<typename F >

void Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::forEach ( const F & f )

inline

Run the given function on each direct member with the value of the member as parameter.

◆ forEach() [2/2]

template<typename F >

void Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::forEach ( const F & f ) const

inline

Run the given function on each direct member with the value of the member as parameter.

◆ get() [1/8]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction >::value, int >::type = 0>

const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::get ( ) const

inline

◆ get() [2/8]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled >::value, int >::type = 0>

const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::get ( ) const

inline

◆ get() [3/8]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength >::value, int >::type = 0>

const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::get ( ) const

inline

◆ get() [4/8]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal >::value, int >::type = 0>

const Settings::Processing::Filters::Experimental::ContrastDistortion::Removal & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::get ( ) const

inline

◆ get() [5/8]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled >::value, int >::type = 0>

const Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::get ( ) const

inline

◆ get() [6/8]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold >::value, int >::type = 0>

const Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::get ( ) const

inline

◆ get() [7/8]

template<size_t i, typename std::enable_if< i==0, int >::type = 0>

const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::get ( ) const

inline

◆ get() [8/8]

template<size_t i, typename std::enable_if< i==1, int >::type = 0>

const Settings::Processing::Filters::Experimental::ContrastDistortion::Removal & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::get ( ) const

inline

◆ operator!=()

bool Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::operator!= ( const ContrastDistortion & other ) const

Inequality operator.

◆ operator==()

bool Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::operator== ( const ContrastDistortion & other ) const

Equality operator.

◆ removal() [1/2]

Removal & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::removal ( )

inline

Get Removal.

◆ removal() [2/2]

const Removal & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::removal ( ) const

inline

Get Removal.

◆ set() [1/7]

template<typename... Args>

void Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::set ( Args &&... args )

inline

Set multiple arguments.

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of ContrastDistortion. These types can be provided:

◆ set() [2/7]

ContrastDistortion & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::set ( const Correction & value )

inline

Set Correction.

◆ set() [3/7]

ContrastDistortion & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::set ( const Correction::Enabled & value )

inline

Set Correction::Enabled.

◆ set() [4/7]

ContrastDistortion & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::set ( const Correction::Strength & value )

inline

Set Correction::Strength.

◆ set() [5/7]

ContrastDistortion & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::set ( const Removal & value )

inline

Set Removal.

◆ set() [6/7]

ContrastDistortion & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::set ( const Removal::Enabled & value )

inline

Set Removal::Enabled.

◆ set() [7/7]

ContrastDistortion & Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::set ( const Removal::Threshold & value )

inline

Set Removal::Threshold.

◆ toString()

std::string Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::toString ( ) const

Get the value as string.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< ContrastDistortion >

friend struct DataModel::Detail::Befriend< ContrastDistortion >

friend

◆ operator<<

std::ostream & operator<<	(	std::ostream &	stream,
		const ContrastDistortion &	value )

friend

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

constexpr const char* Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::description

staticconstexpr

Initial value:

{
                            R"description(Corrects artifacts that appear when imaging scenes with large texture gradients
or high contrast. These artifacts are caused by blurring in the lens. The filter
works best when aperture values are chosen such that the camera has quite good focus.
The filter also supports removing the points that experience a large correction.
)description"
                        }

The description for this value.

◆ name

constexpr const char* Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::name { "ContrastDistortion" }

staticconstexpr

The name of this value.

◆ nodeType

constexpr DataModel::NodeType Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::nodeType = DataModel::NodeType::group

staticconstexpr

The type of this node.

◆ path

constexpr const char* Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::path { "Processing/Filters/Experimental/ContrastDistortion" }

staticconstexpr

The full path for this value.

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

Zivid/Settings.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ ContrastDistortion() [1/2]

◆ ContrastDistortion() [2/2]

Member Function Documentation

◆ copyWith()

◆ correction() [1/2]

◆ correction() [2/2]

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ get() [1/8]

◆ get() [2/8]

◆ get() [3/8]

◆ get() [4/8]

◆ get() [5/8]

◆ get() [6/8]

◆ get() [7/8]

◆ get() [8/8]

◆ operator!=()

◆ operator==()

◆ removal() [1/2]

◆ removal() [2/2]

◆ set() [1/7]

◆ set() [2/7]

◆ set() [3/7]

◆ set() [4/7]

◆ set() [5/7]

◆ set() [6/7]

◆ set() [7/7]

◆ toString()

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< ContrastDistortion >

◆ operator<<

Member Data Documentation

◆ description

◆ name

◆ nodeType

◆ path