DGtal  0.9.3beta
Public Types | Public Member Functions | Data Fields
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)
 
SignalDataoperator= (const SignalData &other)
 
const Valuedefaut () const
 

Data Fields

Valuedata
 
unsigned int size
 
int zero
 
bool periodic
 

Detailed Description

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

Represents the signal data.

Template Parameters
TValuethe type chosen for each sample (generally float or double).

Definition at line 58 of file Signal.h.

Member Typedef Documentation

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

Definition at line 59 of file Signal.h.

Constructor & Destructor Documentation

template<typename TValue >
DGtal::SignalData< TValue >::SignalData ( )

Constructor. The object is not valid.

See also
init.
template<typename TValue >
DGtal::SignalData< TValue >::SignalData ( unsigned int  s,
int  z = 0,
bool  p = false,
const Value def = Value(0) 
)

Constructor.

Parameters
sthe number of data in the signal.
zthe index of the zero-th element.
p'true' if the signal is periodic.
defthe default value.
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
tthe array containing initial data.
sizethe size of the signal.
zthe index of the zero-th element.
p'true' if the signal is periodic.
defthe default value.
template<typename TValue >
DGtal::SignalData< TValue >::~SignalData ( )

Destructor.

template<typename TValue >
DGtal::SignalData< TValue >::SignalData ( const SignalData< TValue > &  other)

Copy constructor.

Parameters
otherthe data to clone.

Member Function Documentation

template<typename TValue >
const Value& DGtal::SignalData< TValue >::defaut ( ) const

Default value.

Returns
the default value.
template<typename TValue >
void DGtal::SignalData< TValue >::init ( unsigned int  s,
int  z = 0,
bool  p = false,
const Value def = Value(0) 
)

Initializer.

Parameters
sthe number of data in the signal.
zthe index of the zero-th element.
p'true' if the signal is periodic.
defthe default value.
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
tthe array containing initial data.
sizethe size of the signal.
zthe index of the zero-th element.
p'true' if the signal is periodic.
defthe default value.
template<typename TValue >
SignalData& DGtal::SignalData< TValue >::operator= ( const SignalData< TValue > &  other)

Assignment.

Parameters
otherthe data to clone.
Returns
'this'.

Field Documentation

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

a dyn. array on Value s.

Definition at line 62 of file Signal.h.

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.

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

the size of the array data.

Definition at line 64 of file Signal.h.

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: