Interface for a resampled function with a regular grid design. More...

#include <TISampledFunction.h>

Inheritance diagram for imath::TISampledFunction< ArgumentDimensions, ResultDimensions >:

Public Types
typedef imath::TIMathFunction< istd::TIndex< ArgumentDimensions >, imath::TVector< ResultDimensions > >	BaseClass

typedef BaseClass::ArgumentType	ArgumentType

typedef BaseClass::ResultType	ResultType

typedef istd::TIndex< ArgumentDimensions >	SampleIndex

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_ACF_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 }
	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...

typedef QMultiMap< QByteArray, QVariant >	ChangeInfoMap

Public Member Functions
virtual bool	CreateFunction (double *dataPtr, const ArgumentType &sizes)=0
	Create function from input data.

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

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

virtual double	GetSampleAt (const SampleIndex &index) const =0
	Get sample value at the given index.

virtual istd::CRange	GetLogicalRange (int dimensionIndex) const =0
	Get logical range for the specified dimension.

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

virtual std::vector< double >	GetSamples () const =0
	Get all samples as a vector.

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::IPolymorphic
virtual	~IPolymorphic ()

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 istd::TUniqueInterfacePtr< istd::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 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
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

template<int ArgumentDimensions, int ResultDimensions>
class imath::TISampledFunction< ArgumentDimensions, ResultDimensions >

Interface for a resampled function with a regular grid design.

Definition at line 24 of file TISampledFunction.h.

Member Typedef Documentation

◆ ArgumentType

template<int ArgumentDimensions, int ResultDimensions>

typedef BaseClass::ArgumentType imath::TISampledFunction< ArgumentDimensions, ResultDimensions >::ArgumentType

Definition at line 34 of file TISampledFunction.h.

◆ BaseClass

template<int ArgumentDimensions, int ResultDimensions>

typedef imath::TIMathFunction< istd::TIndex<ArgumentDimensions>, imath::TVector<ResultDimensions> > imath::TISampledFunction< ArgumentDimensions, ResultDimensions >::BaseClass

Definition at line 33 of file TISampledFunction.h.

◆ ResultType

template<int ArgumentDimensions, int ResultDimensions>

typedef BaseClass::ResultType imath::TISampledFunction< ArgumentDimensions, ResultDimensions >::ResultType

Definition at line 35 of file TISampledFunction.h.

◆ SampleIndex

template<int ArgumentDimensions, int ResultDimensions>

typedef istd::TIndex<ArgumentDimensions> imath::TISampledFunction< ArgumentDimensions, ResultDimensions >::SampleIndex

Definition at line 36 of file TISampledFunction.h.

Member Function Documentation

◆ CreateFunction()

template<int ArgumentDimensions, int ResultDimensions>

virtual bool imath::TISampledFunction< ArgumentDimensions, ResultDimensions >::CreateFunction	(	double *	dataPtr,
		const ArgumentType &	sizes
	)

pure virtual

Create function from input data.

Implemented in imath::CSampledFunction, and imath::CSampledFunction2d.

◆ GetArgumentDimensionality()

template<int ArgumentDimensions, int ResultDimensions>

int imath::TISampledFunction< ArgumentDimensions, ResultDimensions >::GetArgumentDimensionality ( ) const

inlinevirtual

Get the number of argument components.

Definition at line 92 of file TISampledFunction.h.

◆ GetGridSize()

template<int ArgumentDimensions, int ResultDimensions>

virtual int imath::TISampledFunction< ArgumentDimensions, ResultDimensions >::GetGridSize ( int dimensionIndex ) const

pure virtual

Get number of samples for specified dimension.

Implemented in imath::CSampledFunction, and imath::CSampledFunction2d.

◆ GetLogicalRange()

template<int ArgumentDimensions, int ResultDimensions>

virtual istd::CRange imath::TISampledFunction< ArgumentDimensions, ResultDimensions >::GetLogicalRange ( int dimensionIndex ) const

pure virtual

Get logical range for the specified dimension.

Logical range defines boundaries of the function domain in the given dimension.

Implemented in imath::CSampledFunction, and imath::CSampledFunction2d.

◆ GetResultDimensionality()

template<int ArgumentDimensions, int ResultDimensions>

int imath::TISampledFunction< ArgumentDimensions, ResultDimensions >::GetResultDimensionality ( ) const

inlinevirtual

Get the number of result components.

Definition at line 99 of file TISampledFunction.h.

◆ GetResultValueRange()

template<int ArgumentDimensions, int ResultDimensions>

virtual istd::CRange imath::TISampledFunction< ArgumentDimensions, ResultDimensions >::GetResultValueRange	(	int	dimensionIndex,
		int	resultDimension = `-1`
	)		const

pure virtual

Get the range (boundary) of possible result values 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.

Implemented in imath::CSampledFunction, and imath::CSampledFunction2d.

◆ GetSampleAt()

template<int ArgumentDimensions, int ResultDimensions>

virtual double imath::TISampledFunction< ArgumentDimensions, ResultDimensions >::GetSampleAt ( const SampleIndex & index ) const

pure virtual

Get sample value at the given index.

Implemented in imath::CSampledFunction, and imath::CSampledFunction2d.

◆ GetSamples()

template<int ArgumentDimensions, int ResultDimensions>

virtual std::vector< double > imath::TISampledFunction< ArgumentDimensions, ResultDimensions >::GetSamples ( ) const

pure virtual

Get all samples as a vector.

Returns: vector containing all sample values

Implemented in imath::CSampledFunction, and imath::CSampledFunction2d.

◆ GetTotalSamplesCount()

template<int ArgumentDimensions, int ResultDimensions>

virtual int imath::TISampledFunction< ArgumentDimensions, ResultDimensions >::GetTotalSamplesCount ( ) const

pure virtual

Get number of samples stored in this container.

Implemented in imath::CSampledFunction, and imath::CSampledFunction2d.

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

Acf/Include/imath/TISampledFunction.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ArgumentType

◆ BaseClass

◆ ResultType

◆ SampleIndex

Member Function Documentation

◆ CreateFunction()

◆ GetArgumentDimensionality()

◆ GetGridSize()

◆ GetLogicalRange()

◆ GetResultDimensionality()

◆ GetResultValueRange()

◆ GetSampleAt()

◆ GetSamples()

◆ GetTotalSamplesCount()