Time tracing class. More...

#include <signals.h>

Collaboration diagram for opencarp::sig::time_trace:

Public Member Functions
	time_trace ()
	use defaults only, 1000 ms duration, 10 us sampling interval, no real time offset More...

	time_trace (sReal _dt)
	prescribe dt only, default duration is 1000. ms More...

	time_trace (sReal _duration, sReal _dt)
	prescribe duration and sampling, use default real time offset More...

	time_trace (sReal _duration, sReal _dt, sReal _rtOff, std::string _label)

	time_trace (sReal _duration, sReal _dt, sReal _rtOff)

	time_trace (sReal _duration, sReal _dt, sReal _rtOff, std::string _label, std::string _t_unit, std::string _f_unit)
	full constructor, prescribe all members More...

time_trace &	operator= (const time_trace &in)

	time_trace (const time_trace &a)
	copy constructor with setting of constant signal value More...

	time_trace (const time_trace &a, sReal val)
	copy constructor with setting of constant signal value More...

std::string	format_file_header (const time_trace_ffmt ffmt_spec)
	IO format file header from format specifciation and given time trace. More...

void	operator*= (const time_trace &a)
	overloaded operators More...

void	operator*= (const sReal s)

void	operator+= (const sReal a)

void	operator+= (const time_trace &a)

void	operator<<= (int delta)

void	operator>>= (int delta)

void	set_labels (std::string _label)

void	set_labels (std::string _label, std::string _t_unit, std::string _f_unit)

void	setUnits (std::string _t_unit, std::string _f_unit)

void	resize (int numSamples)

sReal	duration ()

size_t	len () const
	< length of trace in samples More...

sReal	rta ()

sReal	zta ()

SF::vector< sReal > &	diff ()

SF::vector< sReal > &	gradient ()

int	read_trace (const std::string fname)
	determine duration of a signal stored in file More...

int	read_trace (const std::string fname, bool unitize)
	read traces from file More...

int	write_trace ()
	write traces to file More...

int	write_trace (const std::string fname)
	write traces to file More...

int	write_trace (const std::string fname, time_trace_ffmt ffmt_spec)
	write traces to file More...

size_t	timeShift (sReal t_shift)

void	unitize ()
	scale signal to unity strength More...

bool	IsEquDistSampling ()
	check whether time trace is sampled with constant sampling interval More...

sReal	fval_t (sReal _t)
	retrieve value of a function at a given time t More...

void	resample (time_trace &trc)

void	resample (time_trace &trc, IpMeth_t meth)

void	interp1 (time_trace &trc, IpMeth_t meth)
	interpolate a time trace More...

Public Attributes
std::string	label
	descriptive label of signal More...

std::string	t_unit
	unit of time axis More...

std::string	f_unit
	unit of signal More...

SF::vector< sReal >	f
	store function values of trace More...

SF::vector< sReal >	t
	time axis More...

sReal	dt
	temporal discretization of trace, if regularly sampled More...

sReal	rtOff
	real time offset of time axis More...

bool	fade
	signal fades to zero after end or remains at final amplitude More...

Detailed Description

Time tracing class.

signals to define stimulus pulses or other time-dependent parameters such as inhomogeneous boundary conditions

Definition at line 142 of file signals.h.

Constructor & Destructor Documentation

◆ time_trace() [1/8]

opencarp::sig::time_trace::time_trace ( )

inline

use defaults only, 1000 ms duration, 10 us sampling interval, no real time offset

Definition at line 156 of file signals.h.

◆ time_trace() [2/8]

opencarp::sig::time_trace::time_trace ( sReal _dt )

inline

prescribe dt only, default duration is 1000. ms

Definition at line 160 of file signals.h.

◆ time_trace() [3/8]

opencarp::sig::time_trace::time_trace	(	sReal	_duration,
		sReal	_dt
	)

inline

prescribe duration and sampling, use default real time offset

Definition at line 164 of file signals.h.

◆ time_trace() [4/8]

opencarp::sig::time_trace::time_trace	(	sReal	_duration,
		sReal	_dt,
		sReal	_rtOff,
		std::string	_label
	)

inline

Definition at line 167 of file signals.h.

◆ time_trace() [5/8]

opencarp::sig::time_trace::time_trace	(	sReal	_duration,
		sReal	_dt,
		sReal	_rtOff
	)

inline

Definition at line 172 of file signals.h.

◆ time_trace() [6/8]

opencarp::sig::time_trace::time_trace	(	sReal	_duration,
		sReal	_dt,
		sReal	_rtOff,
		std::string	_label,
		std::string	_t_unit,
		std::string	_f_unit
	)

inline

full constructor, prescribe all members

Definition at line 176 of file signals.h.

◆ time_trace() [7/8]

opencarp::sig::time_trace::time_trace ( const time_trace & a )

inline

copy constructor with setting of constant signal value

Definition at line 209 of file signals.h.

◆ time_trace() [8/8]

opencarp::sig::time_trace::time_trace	(	const time_trace &	a,
		sReal	val
	)

inline

copy constructor with setting of constant signal value

Definition at line 215 of file signals.h.

Member Function Documentation

◆ diff()

SF::vector<sReal>& opencarp::sig::time_trace::diff ( )

inline

build difference between samples of a signal

Parameters

p	signal for which we compute difference
diff	flag, either we diff or undiff

Note: We assume that the signal is zero before sample 0

Definition at line 296 of file signals.h.

◆ duration()

sReal opencarp::sig::time_trace::duration ( )

inline

Definition at line 257 of file signals.h.

Here is the caller graph for this function:

◆ format_file_header()

std::string opencarp::sig::time_trace::format_file_header ( const time_trace_ffmt ffmt_spec )

inline

IO format file header from format specifciation and given time trace.

build header string for trace file from format specification

Definition at line 567 of file signals.h.

Here is the caller graph for this function:

◆ fval_t()

sReal opencarp::sig::time_trace::fval_t ( sReal _t )

inline

retrieve value of a function at a given time t

Definition at line 417 of file signals.h.

Here is the caller graph for this function:

◆ gradient()

SF::vector<sReal>& opencarp::sig::time_trace::gradient ( )

inline

build difference between samples of a signal

Parameters

p	signal for which we compute difference
diff	flag, either we diff or undiff

Note: We assume that the signal is zero before sample 0

Definition at line 314 of file signals.h.

◆ interp1()

void opencarp::sig::time_trace::interp1	(	time_trace &	trc,
		IpMeth_t	meth
	)

inline

interpolate a time trace

Interpolate function given by vectors x and y at grid xi to obtain yi where the discrete step size of xi is constant. Further, it is assumed that step size in xi is constant as well.

Parameters

trc	time trace to store resampled signal
meth	interpolation method, either LINEAR or NEAREST

Definition at line 456 of file signals.h.

Here is the caller graph for this function:

◆ IsEquDistSampling()

bool opencarp::sig::time_trace::IsEquDistSampling ( )

inline

check whether time trace is sampled with constant sampling interval

check whether the sampling of a trace is regular

Returns: true if equidistant, false otherwise

Definition at line 399 of file signals.h.

◆ len()

size_t opencarp::sig::time_trace::len ( ) const

inline

< length of trace in samples

Definition at line 263 of file signals.h.

Here is the caller graph for this function:

◆ operator*=() [1/2]

void opencarp::sig::time_trace::operator*= ( const sReal s )

inline

Definition at line 508 of file signals.h.

◆ operator*=() [2/2]

void opencarp::sig::time_trace::operator*= ( const time_trace & a )

inline

overloaded operators

Definition at line 499 of file signals.h.

◆ operator+=() [1/2]

void opencarp::sig::time_trace::operator+= ( const sReal a )

◆ operator+=() [2/2]

void opencarp::sig::time_trace::operator+= ( const time_trace & a )

inline

Definition at line 519 of file signals.h.

◆ operator<<=()

void opencarp::sig::time_trace::operator<<= ( int delta )

inline

Definition at line 527 of file signals.h.

◆ operator=()

time_trace& opencarp::sig::time_trace::operator= ( const time_trace & in )

inline

Definition at line 194 of file signals.h.

◆ operator>>=()

void opencarp::sig::time_trace::operator>>= ( int delta )

inline

Definition at line 546 of file signals.h.

◆ read_trace() [1/2]

int opencarp::sig::time_trace::read_trace ( const std::string fname )

inline

determine duration of a signal stored in file

read traces from file

Parameters

fname name of input file

Returns: 0, if read successful -1, file could not be opened -2, number of samples does not match header

Definition at line 623 of file signals.h.

Here is the caller graph for this function:

◆ read_trace() [2/2]

int opencarp::sig::time_trace::read_trace	(	const std::string	fname,
		bool	_unitize
	)

inline

read traces from file

Parameters

fname	name of input file
unitize	scale signal to unity strength

Definition at line 683 of file signals.h.

◆ resample() [1/2]

void opencarp::sig::time_trace::resample ( time_trace & trc )

inline

Definition at line 434 of file signals.h.

Here is the caller graph for this function:

◆ resample() [2/2]

void opencarp::sig::time_trace::resample	(	time_trace &	trc,
		IpMeth_t	meth
	)

inline

Definition at line 440 of file signals.h.

◆ resize()

void opencarp::sig::time_trace::resize ( int numSamples )

inline

Definition at line 251 of file signals.h.

Here is the caller graph for this function:

◆ rta()

sReal opencarp::sig::time_trace::rta ( )

inline

Definition at line 268 of file signals.h.

◆ set_labels() [1/2]

void opencarp::sig::time_trace::set_labels ( std::string _label )

inline

Definition at line 234 of file signals.h.

Here is the caller graph for this function:

◆ set_labels() [2/2]

void opencarp::sig::time_trace::set_labels	(	std::string	_label,
		std::string	_t_unit,
		std::string	_f_unit
	)

inline

Definition at line 239 of file signals.h.

◆ setUnits()

void opencarp::sig::time_trace::setUnits	(	std::string	_t_unit,
		std::string	_f_unit
	)

inline

Definition at line 245 of file signals.h.

Here is the caller graph for this function:

◆ timeShift()

size_t opencarp::sig::time_trace::timeShift ( sReal t_shift )

inline

Definition at line 350 of file signals.h.

◆ unitize()

void opencarp::sig::time_trace::unitize ( )

inline

scale signal to unity strength

Definition at line 362 of file signals.h.

Here is the caller graph for this function:

◆ write_trace() [1/3]

int opencarp::sig::time_trace::write_trace ( )

inline

write traces to file

Parameters

fname name of file for output

Returns: 0, if write successful -1, otherwise

Definition at line 701 of file signals.h.

Here is the caller graph for this function:

◆ write_trace() [2/3]

int opencarp::sig::time_trace::write_trace ( const std::string fname )

inline

write traces to file

Parameters

fname	name of file for output
ffmt_spec	file format specification

Returns: 0, if write successful -1, otherwise

Definition at line 716 of file signals.h.

◆ write_trace() [3/3]

int opencarp::sig::time_trace::write_trace	(	const std::string	fname,
		time_trace_ffmt	ffmt_spec
	)

inline

write traces to file

Parameters

fname	name of file for output
ffmt_spec	file format specification

Returns: 0, if write successful -1, otherwise

Definition at line 733 of file signals.h.

◆ zta()

sReal opencarp::sig::time_trace::zta ( )

inline

Definition at line 278 of file signals.h.

Member Data Documentation

◆ dt

sReal opencarp::sig::time_trace::dt

temporal discretization of trace, if regularly sampled

Definition at line 149 of file signals.h.

◆ f

SF::vector<sReal> opencarp::sig::time_trace::f

store function values of trace

Definition at line 147 of file signals.h.

◆ f_unit

std::string opencarp::sig::time_trace::f_unit

unit of signal

Definition at line 146 of file signals.h.

◆ fade

bool opencarp::sig::time_trace::fade

signal fades to zero after end or remains at final amplitude

Definition at line 151 of file signals.h.

◆ label

std::string opencarp::sig::time_trace::label

descriptive label of signal

Definition at line 144 of file signals.h.

◆ rtOff

sReal opencarp::sig::time_trace::rtOff

real time offset of time axis

Definition at line 150 of file signals.h.

◆ t

SF::vector<sReal> opencarp::sig::time_trace::t

time axis

Definition at line 148 of file signals.h.

◆ t_unit

std::string opencarp::sig::time_trace::t_unit

unit of time axis

Definition at line 145 of file signals.h.

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

numerics/signals.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ time_trace() [1/8]

◆ time_trace() [2/8]

◆ time_trace() [3/8]

◆ time_trace() [4/8]

◆ time_trace() [5/8]

◆ time_trace() [6/8]

◆ time_trace() [7/8]

◆ time_trace() [8/8]

Member Function Documentation

◆ diff()

◆ duration()

◆ format_file_header()

◆ fval_t()

◆ gradient()

◆ interp1()

◆ IsEquDistSampling()

◆ len()

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator<<=()

◆ operator=()

◆ operator>>=()

◆ read_trace() [1/2]

◆ read_trace() [2/2]

◆ resample() [1/2]

◆ resample() [2/2]

◆ resize()

◆ rta()

◆ set_labels() [1/2]

◆ set_labels() [2/2]

◆ setUnits()

◆ timeShift()

◆ unitize()

◆ write_trace() [1/3]

◆ write_trace() [2/3]

◆ write_trace() [3/3]

◆ zta()

Member Data Documentation

◆ dt

◆ f

◆ f_unit

◆ fade

◆ label

◆ rtOff

◆ t

◆ t_unit