Classes

EST_Wave()

default constructor

EST_Wave()

copy constructor

EST_Wave()

Construct from memory supplied by caller

~EST_Wave()

Destructor

a()

return amplitude of sample i from channel channel. By default the 0th channel is selected. This function can be used for assignment.

operator)()

return amplitude of sample i from channel channel. By default the 0th channel is selected.

operator)()

return amplitude of sample i from channel 0

a_safe()

Version of a() that returns zero if index is out of array bounds. This is particularly useful in signal processing when you want to have windows going off the end of the waveform.

t()

return the time position in seconds of the ith sample

num_samples()

return the number of samples in the waveform

num_channels()

return the number of channels in the waveform

sample_rate()

return the sampling rate (frequency)

set_sample_rate()

Set sampling rate to n

length()

return the size of the waveform, i.e. the number of samples.

end()

return the time position of the last sample.

have_left_context()

Can we look N samples to the left?

sample_type()

returns the file format of the file from which the waveform was read. If the waveform has not been read from a file, this is set to the default type

name()

A string indentifying the waveform, commonly used to store the filename

set_name()

Sets name.

resize()

resize the waveform

resample()

Resample waveform to rate

rescale()

multiply all samples by a factor gain. This checks for overflows and puts them to the maximum positive or negative value as appropriate.

clear()

clear waveform and set size to 0.

load()

Load a file into the waveform. The load routine attempts to automatically determine which file type is being loaded. A portion of the waveform can be loaded by setting offset to the sample position from the beginning and to the number of required samples after this.

load_file()

Load a file of type filetype into the waveform. This can be used to load unheadered files, in which case the fields sample_rate, sample_type, bo and nc are used to specify the sample rate, type, byte order and number of channels. A portion of the waveform can be loaded by setting offset to the sample position from the beginning and to the number of required samples after this.

save()

Save waveform to a file called filename of file format EST_filetype

save()

Save waveform to a already openend file with file pointer *FP

operator = ()

Assignment operator

operator +=()

Add to existing wave in serial. Waveforms must have the same number of channels.

operator |=()

Add wave in parallel, i.e. make wave a become new channels in existing waveform.

operator << ()

print waveform

EST_Track()

Default constructor

EST_Track()

Copy constructor

EST_Track()

resizing constructor

EST_Track()

resizing constructor

~EST_Track()

default destructor

resize()

resize the track to have {\tt num_frames} and {\tt num_channels}. if {\tt preserve} is set to 1, any existing values in the track are kept, up to the limits imposed by the new number of frames and channels. If the new track size is bigger, new positions are filled with 0

resize()

resize the track to have {\tt num_frames} and {\tt num_channels}. if {\tt preserve} is set to 1, any existing values in the track are kept, up to the limits imposed by the new number of frames and channels. If the new track size is bigger, new positions are filled with 0

resize_aux()

resize the track's auxiliary channels

set_num_channels()

Change the number of channels while keeping the number of frames the same. if {\tt preserve} is set to 1, any existing values in the track are kept, up to the limits imposed by the new number of frames and channels. If the new track size is bigger, new positions are filled with 0

set_num_frames()

Change the number of frames while keeping the number of channels the same. if {\tt preserve} is set to 1, any existing values in the track are kept, up to the limits imposed by the new number of frames and channels. If the new track size is bigger, new positions are filled with 0

set_channel_name()

set the name of the channel.

set_aux_channel_name()

set the name of the auxiliary channel.

copy_setup()

copy everything but data

name()

name of track - redundant use access to features

set_name()

set name of track - redundant use access to features

frame()

make {\tt fv} a window to frame {\tt n} in the track

channel()

make {\tt fv} a window to channel {\tt n} in the track

channel()

make {\tt fv} a window to the named channel in the track

sub_track()

make {\tt st} refer to a portion of the track. No values are copied - an internal pointer in st is set to the specified portion of the the track. After this, st behaves like a normal track. Its first channel is the same as start_channel and its first frame is the same as start_frame. Any values written into st will changes values in the main track. st cannot be resized.

Parameters
start_frame	first frame at which sub-track starts
nframes	number of frames to be included in total
start_channel	first channel at which sub-track starts
nframes	number of channels to be included in total

sub_track()

make {\tt st} refer to a portion of the track. No values are copied - an internal pointer in st is set to the specified portion of the the track. After this, st behaves like a normal track. Its first channel is the same as start_channel and its first frame is the same as start_frame. Any values written into st will changes values in the main track. st cannot be resized.

Parameters
start_frame	first frame at which sub-track starts
nframes	number of frames to be included in total
start_channel_name	name of channel at which sub-track starts
end_channel_name	name of channel at which sub-track stops

sub_track()

make {\tt st} refer to a portion of the track. No values are copied - an internal pointer in st is set to the specified portion of the the track. After this, st behaves like a normal track. Its first channel is the same as start_channel and its first frame is the same as start_frame. Any values written into st will changes values in the main track. st cannot be resized.

Parameters
start_frame	first frame at which sub-track starts
nframes	number of frames to be included in total
start_channel_name	name of channel at which sub-track starts
end_channel_name	name of channel at which sub-track stops

sub_track()

make {\tt st} refer to a portion of the track. (const version) No values are copied - an internal pointer in st is set to the specified portion of the the track. After this, st behaves like a normal track. Its first channel is the same as start_channel and its first frame is the same as start_frame. Any values written into st will changes values in the main track. st cannot be resized.

Parameters
start_frame	first frame at which sub-track starts
nframes	number of frames to be included in total
start_channel	first channel at which sub-track starts
nframes	number of channels to be included in total

copy_sub_track()

Copy contiguous portion of track into {\tt st}. Unilike the normal sub_track functions, this makes a completely new track. values written into this will not affect the main track and it can be resized.

Parameters
start_frame	first frame at which sub-track starts
nframes	number of frames to be included in total
start_channel	first channel at which sub-track starts
nframes	number of channels to be included in total

copy_channel_out()

copy channel {\tt n} into pre-allocated buffer buf

copy_frame_out()

copy frame {\tt n} into pre-allocated buffer buf

copy_channel_in()

copy buf into pre-allocated channel n of track

copy_channel_in()

copy channel buf into pre-allocated channel n of track

copy_frame_in()

copy buf into frame n of track

copy_frame_in()

copy t into frame n of track

copy_frame_in()

copy from into frame n of track

channel_position()

Return the position of channel {\tt name} if it exists, otherwise return -1

channel_position()

Return the position of channel {\tt name} if it exists, otherwise return -1

has_channel()

Returns true if the track has a channel named {\tt name}, otherwise false

has_channel()

Returns true if the track has a channel named {\tt name}, otherwise false

a()

return amplitude of frame i, channel c

a_no_check()

return amplitude of frame i, channel c with no bounds checking

a()

return amplitude of point i, in the channel named name plus offset. If you have a track with say channels called F0 and voicing, you can access the 45th frame's F0 as t.a(45, "F0"); If there are 20 cepstral coefficients for each frame, the 5th can be accessed as t.a(45, "cepstrum", 5);

a()

return amplitude of time t, channel c. This can be used for reading or writing to this point. By default the nearest frame to this time is used. If {\tt interp} is set to {\tt it_linear}, linear interpolaion is performed between the two amplitudes of the two frames either side of the time point to give an estimation of what the amplitude would have been at time {\tt t}. If {\tt interp} is set to {\tt it_linear_nz}, interpolation is as above, unless the time requested is off the end of a portion of track in which case the nearest amplitude is returned.

operator) ()

return amplitude of frame i, channel c

operator) ()

return amplitude of frame i, channel 0

operator) ()

return amplitude of frame nearest time t, channel c

operator) ()

return amplitude of frame nearest time t, channel 0

t()

return time position of frame i

ms_t()

return time of framet i in milli-seconds.

fill_time()

set frame times to regular intervals of time {\tt t}

fill_time()

fill times with times of other track

fill()

fill all amplitudes with value {\tt v}

sample()

resample track at this frame shift, specified in seconds. This can be used to change a variable frame spaced track into a fixed frame track, or to change the spacing of an existing evenly spaced track.

change_type()

REDO

shift()

return an estimation of the frame spacing in seconds. This returns -1 if the track is not a fixed shift track

start()

return time of first value in track

end()

return time of last value in track

load()

Load a file called {\tt name} into the track. The load function attempts to automatically determine which file type is being loaded from the file's header. If no header is found, the function assumes the file is ascii data, with a fixed frame shift, arranged with rows representing frames and columns channels. In this case, the frame shift must be specified as an argument to this function

load()

Load character data from an already opened tokenstream {\tt ts} into the track. The load function attempts to automatically determine which file type is being loaded from the file's header. If no header is found, the function assumes the file is ascii data, with a fixed frame shift, arranged with rows representing frames and columns channels. In this case, the frame shift must be specified as an argument to this function

load()

Load a file called {\tt name} of format {\tt type} into the track. If no header is found, the function assumes the file is ascii data, with a fixed frame shift, arranged with rows representing frames and columns channels. In this case, the frame shift must be specified as an argument to this function

save()

Save the track to a file {\tt name} of format {\tt type}

save()

Save the track to a already opened file pointer{\tt FP} and write a file of format {\tt type}

empty()

returns true if no values are set in the frame

set_break()

set frame i to be a break

set_value()

set frame i to be a value

val()

return true if frame i is a value

track_break()

return true if frame i is a break

prev_non_break()

starting at frame i, return the frame index of the first value frame before i. If frame i is a value, return i

next_non_break()

starting at frame i, return the frame index of the first value frame after i. If frame i is a value, return i

index()

return the frame index nearest time t

index_below()

return the frame index before time t

num_frames()

return number of frames in track

length()

return number of frames in track

num_channels()

return number of channels in track

num_aux_channels()

return number of auxiliary channels in track

rm_excess_breaks()

If the contour has multiple break values between sections containing values, reduce the break sections so that each has a single break only

equal_space()

return true if track has equal (i.e. fixed) frame spacing */

single_break()

return true if track has only single breaks between value sections