DGtal::SignalData< TValue > Struct Template Reference

#include <DGtal/math/Signal.h>

Public Types
typedef TValue	Value

Public Member Functions
	SignalData ()
void	init (unsigned int s, int z=0, bool p=false, const Value &def=Value(0))
void	init (const Value *t, unsigned int size, int z=0, bool p=false, const Value &def=Value(0))
	SignalData (unsigned int s, int z=0, bool p=false, const Value &def=Value(0))
	SignalData (const Value *t, unsigned int size, int z=0, bool p=false, const Value &def=Value(0))
	~SignalData ()
	SignalData (const SignalData &other)
SignalData &	operator= (const SignalData &other)
const Value &	defaut () const

Data Fields
Value *	data
	a dyn. array on Value s. More...
unsigned int	size
	the size of the array data. More...
int	zero
	the true index of the zero abscissa. More...
bool	periodic

Detailed Description

template<typename TValue>
struct DGtal::SignalData< TValue >

Represents the signal data.

Template Parameters

TValue

the type chosen for each sample (generally float or double).

Definition at line 58 of file Signal.h.

Member Typedef Documentation

Value

template<typename TValue >

typedef TValue DGtal::SignalData< TValue >::Value

Definition at line 59 of file Signal.h.

Constructor & Destructor Documentation

SignalData() [1/4]

template<typename TValue >

DGtal::SignalData< TValue >::SignalData

(

)

Constructor. The object is not valid.

See also

init.

SignalData() [2/4]

template<typename TValue >

DGtal::SignalData< TValue >::SignalData	(	unsigned int	s,
		int	z = 0,
		bool	p = false,
		const Value &	def = Value(0)
	)

Constructor.

Parameters

s	the number of data in the signal.
z	the index of the zero-th element.
p	'true' if the signal is periodic.
def	the default value.

SignalData() [3/4]

template<typename TValue >

DGtal::SignalData< TValue >::SignalData	(	const Value *	t,
		unsigned int	size,
		int	z = 0,
		bool	p = false,
		const Value &	def = Value(0)
	)

Constructor.

Parameters

t	the array containing initial data.
size	the size of the signal.
z	the index of the zero-th element.
p	'true' if the signal is periodic.
def	the default value.

~SignalData()

template<typename TValue >

DGtal::SignalData< TValue >::~SignalData

(

)

Destructor.

SignalData() [4/4]

template<typename TValue >

DGtal::SignalData< TValue >::SignalData

(

const SignalData< TValue > &

other

)

Copy constructor.

Parameters

other

the data to clone.

Member Function Documentation

defaut()

template<typename TValue >

const Value& DGtal::SignalData< TValue >::defaut

(

)

const

Default value.

Returns

the default value.

init() [1/2]

template<typename TValue >

void DGtal::SignalData< TValue >::init	(	const Value *	t,
		unsigned int	size,
		int	z = 0,
		bool	p = false,
		const Value &	def = Value(0)
	)

Initializer.

Parameters

t	the array containing initial data.
size	the size of the signal.
z	the index of the zero-th element.
p	'true' if the signal is periodic.
def	the default value.

init() [2/2]

template<typename TValue >

void DGtal::SignalData< TValue >::init	(	unsigned int	s,
		int	z = 0,
		bool	p = false,
		const Value &	def = Value(0)
	)

Initializer.

Parameters

s	the number of data in the signal.
z	the index of the zero-th element.
p	'true' if the signal is periodic.
def	the default value.

operator=()

template<typename TValue >

SignalData& DGtal::SignalData< TValue >::operator=

(

const SignalData< TValue > &

other

)

Assignment.

Parameters

other

the data to clone.

Returns

'this'.

Field Documentation

data

template<typename TValue >

Value* DGtal::SignalData< TValue >::data

a dyn. array on Value s.

Definition at line 62 of file Signal.h.

periodic

template<typename TValue >

bool DGtal::SignalData< TValue >::periodic

when 'true', the signal is periodic, otherwise infinite (with default value outside).

Definition at line 69 of file Signal.h.

size

template<typename TValue >

unsigned int DGtal::SignalData< TValue >::size

the size of the array data.

Definition at line 64 of file Signal.h.

zero

template<typename TValue >

int DGtal::SignalData< TValue >::zero

the true index of the zero abscissa.

Definition at line 66 of file Signal.h.

---

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

• Signal.h