triana.types

Interface Signal

All Known Implementing Classes:

ComplexSampleSet, SampleSet, TimeFrequency

public interface Signal

Signal is an interface that can be implemented by any Triana data types that include data that has been acquired from a time-based data stream. It provides methods for setting and returning the sampling frequency and other appropriate information.

See Also:

GraphType, Arithmetic, Spectrum, ComplexSpectrum, ComplexSampleSet, Document

Method Summary

Methods

Modifier and Type	Method and Description
double	getAcquisitionTime() Returns the acquisition time as a double giving the number of seconds since the reference time, which should be the same reference time as for the method setAcquisitionTime.
double	getSamplingRate() Returns the sampling frequency of the data.
void	setAcquisitionTime(double t) Sets the acquisition time to the given value, in seconds.
void	setSamplingRate(double r) Sets the sampling rate of the signal in samples per second (Hz).

Method Detail

getSamplingRate

double getSamplingRate()

Returns the sampling frequency of the data. If the data are irregularly sampled it should return 0. The sampling frequency in measured in samples per second (Hz).

Returns:

double The sampling frequency in Hz

setSamplingRate

void setSamplingRate(double r)

Sets the sampling rate of the signal in samples per second (Hz).

Parameters:

r - The sampling rate in Hz

getAcquisitionTime

double getAcquisitionTime()

Returns the acquisition time as a double giving the number of seconds since the reference time, which should be the same reference time as for the method setAcquisitionTime. The time is interpreted as the moment of acquisition of the first sample in the data set.

Returns:

double The time of acquisition in seconds since the reference time

setAcquisitionTime

void setAcquisitionTime(double t)

Sets the acquisition time to the given value, in seconds. This time should be added to the description StringVector in a way that allows it to be distinguished from the date set by Triana when a data object is first created. The acquisition time is generally earlier than the time when the data enters a Triana analysis system. The argument t should be the number of seconds since the reference zero of time, which is a choice made by the programmer. The time should refer to the moment of acquisition of the first sample of the data set.

Parameters:

t - The time of acquisition in seconds since the reference time