Zivid C++ API 2.8.1+dd4dffea-1
Defining the Future of 3D Machine Vision
Classes | Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion Class Reference

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
 Correction More...
 
class  Removal
 Removal More...
 

Public Types

using Descendants = 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 >
 

Public Member Functions

 ContrastDistortion ()
 Default constructor More...
 
template<typename... Args>
 ContrastDistortion (Args &&...args)
 Constructor taking variadic number of arguments More...
 
template<typename... Args>
void set (Args &&...args)
 Set multiple arguments More...
 
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) More...
 
const Correctioncorrection () const
 Get Correction More...
 
Correctioncorrection ()
 Get Correction More...
 
ContrastDistortionset (const Correction &value)
 Set Correction More...
 
ContrastDistortionset (const Correction::Enabled &value)
 Set Correction::Enabled More...
 
ContrastDistortionset (const Correction::Strength &value)
 Set Correction::Strength More...
 
const Removalremoval () const
 Get Removal More...
 
Removalremoval ()
 Get Removal More...
 
ContrastDistortionset (const Removal &value)
 Set Removal More...
 
ContrastDistortionset (const Removal::Enabled &value)
 Set Removal::Enabled More...
 
ContrastDistortionset (const Removal::Threshold &value)
 Set Removal::Threshold More...
 
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::Correctionget () 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::Enabledget () 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::Strengthget () 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::Removalget () 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::Enabledget () 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::Thresholdget () const
 
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Correctionget () const
 
template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Removalget () 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 More...
 
template<typename F >
void forEach (const F &f)
 Run the given function on each direct member with the value of the member as parameter More...
 
bool operator== (const ContrastDistortion &other) const
 Equality operator More...
 
bool operator!= (const ContrastDistortion &other) const
 Inequality operator More...
 
std::string toString () const
 Get the value as string More...
 

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group
 The type of this node More...
 
static constexpr const char * path { "Processing/Filters/Experimental/ContrastDistortion" }
 The full path for this value More...
 
static constexpr const char * name { "ContrastDistortion" }
 The name of this value More...
 
static constexpr const char * description
 The description for this value More...
 

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 More...
 

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

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

Member Function Documentation

◆ copyWith()

template<typename... Args>
ContrastDistortion Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::copyWith ( Args &&...  args) const
inline

◆ correction() [1/2]

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

◆ correction() [2/2]

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

◆ 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() [2/7]

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

◆ set() [3/7]

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

◆ set() [4/7]

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

◆ 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() [7/7]

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

◆ toString()

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

Get the value as string

Friends And Related Function 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: