#include <FieldParameters.h>

Inheritance diagram for core::FieldParameters:

Collaboration diagram for core::FieldParameters:

Public Member Functions
	FieldParameters ()

void	print () final

void	setGradientShading (const bool enabled)

bool	getGradientShading () const

void	setGradientOffset (const double value)

double	getGradientOffset () const

void	setSamplingRate (const double value)

double	getSamplingRate () const

void	setDistance (const double value)

double	getDistance () const

void	setCutoff (const double value)

double	getCutoff () const

void	setEpsilon (const double value)

double	getEpsilon () const

void	setAccumulationSteps (const uint64_t value)

uint64_t	getAccumulationSteps () const

void	setUseOctree (const bool value)

bool	getUseOctree () const

Public Member Functions inherited from core::AbstractParameters
	AbstractParameters (const std::string &name)

virtual	~AbstractParameters ()=default

po::options_description &	parameters ()

Public Member Functions inherited from core::BaseObject
	BaseObject ()=default

virtual	~BaseObject ()=default

	BaseObject (const BaseObject &)

BaseObject &	operator= (const BaseObject &rhs)

bool	isModified () const

void	resetModified ()

void	markModified (const bool triggerCallback=true)

void	onModified (const ModifiedCallback &callback)

void	clearModifiedCallback ()

Protected Member Functions
void	parse (const po::variables_map &vm) final

Protected Member Functions inherited from core::BaseObject
template<typename T >
void	_updateValue (T &member, const T &newValue, const bool triggerCallback=true)

template<class T >
bool	_isEqual (const T &a, const T &b, typename std::enable_if< std::is_floating_point< T >::value >::type *=0)

template<class T >
bool	_isEqual (const T &a, const T &b, typename std::enable_if<!std::is_floating_point< T >::value >::type *=0)

Protected Attributes
Vector3ui	_dimensions

Vector3d	_elementSpacing

Vector3d	_offset

bool	_gradientShading {false}

double	_gradientOffset {0.001}

double	_samplingRate {0.125}

double	_distance {1.f}

double	_cutoff {1500.f}

double	_epsilon {1e-6}

uint64_t	_randomAccumulation {0}

bool	_useOctree {true}

Protected Attributes inherited from core::AbstractParameters
std::string	_name

po::options_description	_parameters

Additional Inherited Members
Public Types inherited from core::BaseObject
using	ModifiedCallback = std::function< void(const BaseObject &)>

Static Protected Member Functions inherited from core::AbstractParameters
static std::string	asString (const bool flag)

Detailed Description

Definition at line 31 of file FieldParameters.h.

Constructor & Destructor Documentation

◆ FieldParameters()

core::FieldParameters::FieldParameters ( )

Definition at line 35 of file FieldParameters.cpp.

Member Function Documentation

◆ getAccumulationSteps()

uint64_t core::FieldParameters::getAccumulationSteps ( ) const

inline

Definition at line 58 of file FieldParameters.h.

◆ getCutoff()

double core::FieldParameters::getCutoff ( ) const

inline

Definition at line 52 of file FieldParameters.h.

◆ getDistance()

double core::FieldParameters::getDistance ( ) const

inline

Definition at line 49 of file FieldParameters.h.

◆ getEpsilon()

double core::FieldParameters::getEpsilon ( ) const

inline

Definition at line 55 of file FieldParameters.h.

◆ getGradientOffset()

double core::FieldParameters::getGradientOffset ( ) const

inline

Definition at line 43 of file FieldParameters.h.

◆ getGradientShading()

bool core::FieldParameters::getGradientShading ( ) const

inline

Definition at line 40 of file FieldParameters.h.

◆ getSamplingRate()

double core::FieldParameters::getSamplingRate ( ) const

inline

Definition at line 46 of file FieldParameters.h.

◆ getUseOctree()

bool core::FieldParameters::getUseOctree ( ) const

inline

Definition at line 61 of file FieldParameters.h.

◆ parse()

void core::FieldParameters::parse ( const po::variables_map & )

finalprotectedvirtual

Parses parameters managed by the class

Parameters

vm	the variables map of all arguments passed by the user

Reimplemented from core::AbstractParameters.

Definition at line 53 of file FieldParameters.cpp.

◆ print()

void core::FieldParameters::print ( )

finalvirtual

Displays values of registered parameters

Reimplemented from core::AbstractParameters.

Definition at line 70 of file FieldParameters.cpp.

◆ setAccumulationSteps()

void core::FieldParameters::setAccumulationSteps ( const uint64_t value )

inline

Definition at line 57 of file FieldParameters.h.

◆ setCutoff()

void core::FieldParameters::setCutoff ( const double value )

inline

Definition at line 51 of file FieldParameters.h.

◆ setDistance()

void core::FieldParameters::setDistance ( const double value )

inline

Definition at line 48 of file FieldParameters.h.

◆ setEpsilon()

void core::FieldParameters::setEpsilon ( const double value )

inline

Definition at line 54 of file FieldParameters.h.

◆ setGradientOffset()

void core::FieldParameters::setGradientOffset ( const double value )

inline

Definition at line 42 of file FieldParameters.h.

◆ setGradientShading()

void core::FieldParameters::setGradientShading ( const bool enabled )

inline

Definition at line 39 of file FieldParameters.h.

◆ setSamplingRate()

void core::FieldParameters::setSamplingRate ( const double value )

inline

Definition at line 45 of file FieldParameters.h.

◆ setUseOctree()

void core::FieldParameters::setUseOctree ( const bool value )

inline

Definition at line 60 of file FieldParameters.h.

Member Data Documentation

◆ _cutoff

double core::FieldParameters::_cutoff {1500.f}

protected

Definition at line 74 of file FieldParameters.h.

◆ _dimensions

Vector3ui core::FieldParameters::_dimensions

protected

Definition at line 66 of file FieldParameters.h.

◆ _distance

double core::FieldParameters::_distance {1.f}

protected

Definition at line 73 of file FieldParameters.h.

◆ _elementSpacing

Vector3d core::FieldParameters::_elementSpacing

protected

Definition at line 67 of file FieldParameters.h.

◆ _epsilon

double core::FieldParameters::_epsilon {1e-6}

protected

Definition at line 75 of file FieldParameters.h.

◆ _gradientOffset

double core::FieldParameters::_gradientOffset {0.001}

protected

Definition at line 71 of file FieldParameters.h.

◆ _gradientShading

bool core::FieldParameters::_gradientShading {false}

protected

Definition at line 70 of file FieldParameters.h.

◆ _offset

Vector3d core::FieldParameters::_offset

protected

Definition at line 68 of file FieldParameters.h.

◆ _randomAccumulation

uint64_t core::FieldParameters::_randomAccumulation {0}

protected

Definition at line 76 of file FieldParameters.h.

◆ _samplingRate

double core::FieldParameters::_samplingRate {0.125}

protected

Definition at line 72 of file FieldParameters.h.

◆ _useOctree

bool core::FieldParameters::_useOctree {true}

protected

Definition at line 77 of file FieldParameters.h.

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

platform/core/parameters/FieldParameters.h
platform/core/parameters/FieldParameters.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FieldParameters()

Member Function Documentation

◆ getAccumulationSteps()

◆ getCutoff()

◆ getDistance()

◆ getEpsilon()

◆ getGradientOffset()

◆ getGradientShading()

◆ getSamplingRate()

◆ getUseOctree()

◆ parse()

◆ print()

◆ setAccumulationSteps()

◆ setCutoff()

◆ setDistance()

◆ setEpsilon()

◆ setGradientOffset()

◆ setGradientShading()

◆ setSamplingRate()

◆ setUseOctree()

Member Data Documentation

◆ _cutoff

◆ _dimensions

◆ _distance

◆ _elementSpacing

◆ _epsilon

◆ _gradientOffset

◆ _gradientShading

◆ _offset

◆ _randomAccumulation

◆ _samplingRate

◆ _useOctree