Implementation of the resampled 2D-function. More...

#include <CSampledFunction2d.h>

Inheritance diagram for imath::CSampledFunction2d:

Collaboration diagram for imath::CSampledFunction2d:

Public Member Functions
	CSampledFunction2d ()

	CSampledFunction2d (const CSampledFunction2d &function2d)

	CSampledFunction2d (const imath::ISampledFunction2d &function2d)

	CSampledFunction2d (const istd::CIndex2d &size, double defaultValue=0)

void	Reset ()

bool	CreateGrid2d (const istd::CIndex2d &size, double defaultValue=0)

istd::CIndex2d	GetGridSize2d () const

double	GetSampleValue (const istd::CIndex2d &index) const

void	SetSampleValue (const istd::CIndex2d &index, double value)

virtual bool	CreateFunction (double *dataPtr, const ArgumentType &sizes)
	Create function from input data.

virtual int	GetTotalSamplesCount () const
	Get number of samples stored in this container.

virtual int	GetGridSize (int dimensionIndex) const
	Get number of samples for specified dimension.

virtual istd::CRange	GetLogicalRange (int dimensionIndex) const
	Get logical grid position range for specified dimension.

virtual istd::CRange	GetResultValueRange (int dimensionIndex, int resultDimension=-1) const
	Get range of result value for the given axis.

virtual bool	GetValueAt (const ArgumentType &argument, ResultType &result) const

virtual ResultType	GetValueAt (const ArgumentType &argument) const

Public Member Functions inherited from imath::TISampledFunction< ArgumentDimensions, ResultDimensions >
virtual int	GetArgumentDimensionality () const
	Get the number of argument components.

virtual int	GetResultDimensionality () const
	Get the number of result components.

Public Member Functions inherited from imath::TIMathFunction< istd::TIndex< ArgumentDimensions >, TVector< ResultDimensions > >
virtual bool	GetValueAt (const istd::TIndex< ArgumentDimensions > &argument, TVector< ResultDimensions > &result) const=0
	Get function value for specified argument value.

virtual TVector< ResultDimensions >	GetValueAt (const istd::TIndex< ArgumentDimensions > &argument) const=0
	Get function value for specified argument value.

Public Member Functions inherited from istd::IChangeable
virtual int	GetSupportedOperations () const
	Get set of flags for supported operations.

virtual bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
	Copy this object from another one.

virtual bool	IsEqual (const IChangeable &object) const
	Compare this object with another object.

virtual std::unique_ptr< IChangeable >	CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
	Make a copy of this object.

virtual bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
	Reset data to its default state.

virtual QMutex *	GetChangesLock () const
	Get mutex beeing locked during changes, if available.

virtual void	BeginChanges (const ChangeSet &changeSet)
	Starts the change transaction.

virtual void	EndChanges (const ChangeSet &changeSet)
	Ends the change transaction.

virtual void	BeginChangeGroup (const ChangeSet &changeSet)
	Starts group of changes.

virtual void	EndChangeGroup (const ChangeSet &changeSet)
	Ends group of changes.

Additional Inherited Members
Public Types inherited from imath::TISampledFunction< ArgumentDimensions, ResultDimensions >
typedef imath::TIMathFunction< istd::TIndex< ArgumentDimensions >, imath::TVector< ResultDimensions > >	BaseClass

typedef BaseClass::ArgumentType	ArgumentType

Public Types inherited from imath::TIMathFunction< istd::TIndex< ArgumentDimensions >, TVector< ResultDimensions > >
typedef istd::TIndex< ArgumentDimensions >	ArgumentType

typedef TVector< ResultDimensions >	ResultType

Public Types inherited from istd::IChangeable
enum	ChangeFlags { CF_ICF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING , CF_DELEGATED , CF_NO_UNDO }
	Data model change notification flags. More...

enum	SupportedOperations { SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 , SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4 , SO_CHANGE_LOCK = 1 << 5 }
	Flags for supported operations. More...

enum	CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
	Control how relationship betweeen objects are interpreted. More...

Static Public Member Functions inherited from istd::IChangeable
static const ChangeSet &	GetNoChanges ()
	Get empty set of changes.

static const ChangeSet &	GetAnyChange ()
	Get anonymous change set.

static const ChangeSet &	GetAllChanges ()
	Get anonymous change set.

static const ChangeSet &	GetDelegatedChanges ()
	Get delegated change set.

Protected Member Functions inherited from istd::IChangeable
virtual void	OnBeginChanges ()
	Callback function for begin change event.

virtual void	OnEndChanges (const ChangeSet &changeSet)
	Callback function for end change event.

Detailed Description

Implementation of the resampled 2D-function.

Definition at line 23 of file CSampledFunction2d.h.

Constructor & Destructor Documentation

◆ CSampledFunction2d() [1/4]

imath::CSampledFunction2d::CSampledFunction2d ( )

◆ CSampledFunction2d() [2/4]

imath::CSampledFunction2d::CSampledFunction2d ( const CSampledFunction2d & function2d )

◆ CSampledFunction2d() [3/4]

imath::CSampledFunction2d::CSampledFunction2d ( const imath::ISampledFunction2d & function2d )

explicit

◆ CSampledFunction2d() [4/4]

imath::CSampledFunction2d::CSampledFunction2d	(	const istd::CIndex2d &	size,
		double	defaultValue = 0 )

explicit

Member Function Documentation

◆ CreateFunction()

virtual bool imath::CSampledFunction2d::CreateFunction	(	double *	dataPtr,
		const ArgumentType &	sizes )

virtual

Create function from input data.

Implements imath::TISampledFunction< ArgumentDimensions, ResultDimensions >.

◆ CreateGrid2d()

bool imath::CSampledFunction2d::CreateGrid2d	(	const istd::CIndex2d &	size,
		double	defaultValue = 0 )

◆ GetGridSize()

virtual int imath::CSampledFunction2d::GetGridSize ( int dimensionIndex ) const

virtual

Get number of samples for specified dimension.

Implements imath::TISampledFunction< ArgumentDimensions, ResultDimensions >.

◆ GetGridSize2d()

istd::CIndex2d imath::CSampledFunction2d::GetGridSize2d ( ) const

inline

Definition at line 57 of file CSampledFunction2d.h.

References istd::TArray< Element, Dimensions >::GetSizes().

◆ GetLogicalRange()

virtual istd::CRange imath::CSampledFunction2d::GetLogicalRange ( int dimensionIndex ) const

virtual

Get logical grid position range for specified dimension.

Logical position describes

Implements imath::TISampledFunction< ArgumentDimensions, ResultDimensions >.

◆ GetResultValueRange()

virtual istd::CRange imath::CSampledFunction2d::GetResultValueRange	(	int	dimensionIndex,
		int	resultDimension = -1 ) const

virtual

Get range of result value for the given axis.

Optionally some result dimension can be also specified.

Parameters

dimensionIndex	index of argument dimension.
resultDimension	optional index of result dimension, it can be negative if all dimensions are meaned.

Returns: range of possible values, or invalid range if it is unknown.

Implements imath::TISampledFunction< ArgumentDimensions, ResultDimensions >.

◆ GetSampleValue()

double imath::CSampledFunction2d::GetSampleValue ( const istd::CIndex2d & index ) const

inline

Definition at line 63 of file CSampledFunction2d.h.

References istd::TArray< Element, Dimensions >::GetAt(), istd::TArray< Element, Dimensions >::GetSizes(), and istd::TIndex< Dimensions >::IsInside().

◆ GetTotalSamplesCount()

virtual int imath::CSampledFunction2d::GetTotalSamplesCount ( ) const

virtual

Get number of samples stored in this container.

Implements imath::TISampledFunction< ArgumentDimensions, ResultDimensions >.

◆ GetValueAt() [1/2]

virtual ResultType imath::CSampledFunction2d::GetValueAt ( const ArgumentType & argument ) const

virtual

◆ GetValueAt() [2/2]

virtual bool imath::CSampledFunction2d::GetValueAt	(	const ArgumentType &	argument,
		ResultType &	result ) const

virtual

◆ Reset()

void imath::CSampledFunction2d::Reset ( )

◆ SetSampleValue()

void imath::CSampledFunction2d::SetSampleValue	(	const istd::CIndex2d &	index,
		double	value )

inline

Definition at line 71 of file CSampledFunction2d.h.

References istd::TArray< Element, Dimensions >::GetSizes(), istd::TIndex< Dimensions >::IsInside(), and istd::TArray< Element, Dimensions >::SetAt().

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

imath/CSampledFunction2d.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CSampledFunction2d() [1/4]

◆ CSampledFunction2d() [2/4]

◆ CSampledFunction2d() [3/4]

◆ CSampledFunction2d() [4/4]

Member Function Documentation

◆ CreateFunction()

◆ CreateGrid2d()

◆ GetGridSize()

◆ GetGridSize2d()

◆ GetLogicalRange()

◆ GetResultValueRange()

◆ GetSampleValue()

◆ GetTotalSamplesCount()

◆ GetValueAt() [1/2]

◆ GetValueAt() [2/2]

◆ Reset()

◆ SetSampleValue()