CTL::IdentityModel Class Reference

The IdentityModel class represents the identity function. More...

#include <datamodels1d.h>

Inheritance diagram for CTL::IdentityModel:

Collaboration diagram for CTL::IdentityModel:

Public Types
enum	{ Type = 53 }
Public Types inherited from CTL::AbstractDataModel
enum	{ Type = 0 }
Public Types inherited from CTL::SerializationInterface
enum	{ Type = -1, UserType = 65536 }

Public Member Functions
int	type () const override
float	valueAt (float position) const override
	Always returns the input value (i.e. position). More...
float	binIntegral (float position, float binWidth) const override
	Returns the integral over model values in the interval [position - 0.5 * binWidth, position + 0.5 * binWidth]. More...
AbstractIntegrableDataModel *	clone () const override
Public Member Functions inherited from CTL::AbstractIntegrableDataModel
float	meanValue (float position, float binWidth) const
Public Member Functions inherited from CTL::AbstractDataModel
virtual QVariant	parameter () const
virtual void	setParameter (const QVariant &parameter)
void	fromVariant (const QVariant &variant) override
QVariant	toVariant () const override
bool	isIntegrable () const
void	setName (const QString &name)
const QString &	name () const
Public Member Functions inherited from CTL::SerializationInterface
virtual	~SerializationInterface ()=default

Friends
template<class >
struct	SerializationHelper::RegisterWithSerializationHelper

Additional Inherited Members
Protected Member Functions inherited from CTL::AbstractIntegrableDataModel
	AbstractIntegrableDataModel (const AbstractIntegrableDataModel &)=default
	AbstractIntegrableDataModel (AbstractIntegrableDataModel &&)=default
AbstractIntegrableDataModel &	operator= (const AbstractIntegrableDataModel &)=default
AbstractIntegrableDataModel &	operator= (AbstractIntegrableDataModel &&)=default
Protected Member Functions inherited from CTL::AbstractDataModel
	AbstractDataModel (const AbstractDataModel &)=default
	AbstractDataModel (AbstractDataModel &&)=default
AbstractDataModel &	operator= (const AbstractDataModel &)=default
AbstractDataModel &	operator= (AbstractDataModel &&)=default
Protected Member Functions inherited from CTL::SerializationInterface
	SerializationInterface ()=default
	SerializationInterface (const SerializationInterface &)=default
	SerializationInterface (SerializationInterface &&)=default
SerializationInterface &	operator= (const SerializationInterface &)=default
SerializationInterface &	operator= (SerializationInterface &&)=default
Related Functions inherited from CTL::AbstractDataModel
	DataModelPtr
	Template alias name for CopyableUniquePtr<ModelType> to a suitable ModelType.
	AbstractDataModelPtr
	Alias name for DataModelPtr<AbstractDataModel>. More...
std::unique_ptr< ModelType >	makeDataModel (ConstructorArguments &&... arguments)
using DataModelPtr	CopyableUniquePtr
	Alias name for CopyableUniquePtr<ModelType> to a suitable ModelType.

Detailed Description

The IdentityModel class represents the identity function.

This model always returns the input unchanged (identity).

Member Function Documentation

binIntegral()

float CTL::IdentityModel::binIntegral ( float  position, float  binWidth  ) const

overridevirtual

Returns the integral over model values in the interval [position - 0.5 * binWidth, position + 0.5 * binWidth].

Returns \( \frac{b^2-a^2}{2}\), with the abbreviations:

\( \begin{align*} a &= position - 0.5\cdot binWidth \\ b &= position + 0.5\cdot binWidth. \end{align*} \)

Implements CTL::AbstractIntegrableDataModel.

clone()

AbstractIntegrableDataModel * CTL::IdentityModel::clone ( ) const

overridevirtual

Creates a copy of this instance and returns a base class pointer to the new object.

Implements CTL::AbstractIntegrableDataModel.

type()

int CTL::IdentityModel::type ( ) const

inlineoverridevirtual

Returns the type id of this instance.

Reimplemented from CTL::AbstractDataModel.

valueAt()

float CTL::IdentityModel::valueAt ( float  position ) const

overridevirtual

Always returns the input value (i.e. position).

This represents the identity function \( f(x) = x \).

Implements CTL::AbstractDataModel.

---

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

• modules/src/models/datamodels1d.h
• modules/src/models/datamodels1d.cpp