VowelClassCollection

VowelClassCollection(track_list=EMPTY_LIST)

A class for an entire vowel system.

Intended Usage

It is a subclass of defaultdict, so it can be keyed by vowel class label.

vowel_measurements = [VowelMeasurement(t) for t in fasttrack_tracks]
vowel_system = VowelClassCollection(vowel_measurements)

Name	Type	Description	Default
track_list	list[VowelMeasurement]	A list of `VowelMeasurement`s.	`EMPTY_LIST`

Name	Type	Description
winners	list[OneTrack]	All winner tracks from the entire vowel system.
vowel_measurements	list[VowelMeasurement]	All `VowelMeasurement` objects within this vowel system
textgrid	AlignedTextGrid	The `AlignedTextGrid` associated with this vowel system.
winner_expanded_formants	`NDArray`[`Shape`[20, `FormantN`], `Float`]	A cached property that returns the expanded formants for the winners.
winner_param	`NDArray`[`Shape`[`Param`, `Formant`, `N`], `Float`]	An array of all parameters from all winners across the vowel system.
winner_maxformant	`NDArray`[`Shape`[1, `N`], `Float`]	An array of the maximum formants of all winners across the vowel system
winner_param_mean	`NDArray`[`Shape`[1, `FormantParam`], `Float`]	The mean of all DCT parameters across all formants for the winners in this vowel system.
winner_param_cov	`NDArray`[`Shape`[`FormantParam`, `FormantParam`], `Float`]	The covariance of all parameters across all formants for the winners in this vowel system
winner_param_icov	`NDArray`[`Shape`[`FormantParam`, `FormantParam`], `Float`]	The inverse of `winner_param_cov`.
winner_maxformant_mean	float	The mean maximum formant across all winners in this vowel system.
winner_maxformant_cov	`NDArray`[`Shape`[1, 1], `Float`]	The covariance of the maximum formant across all winners in this vowel system.
winner_maxformant_icov	`NDArray`[`Shape`[1, 1], `Float`]	The inverse of `winner_maxformant_cov`

Name	Description
edge_intercept	Return the intercept for a line with the given slope
to_param_df	Return DataFrame of formant DCT parameters.
to_point_df	Return a DataFrame of point measurements
to_tracks_df	Return a DataFrame of the formant tracks

VowelClassCollection.edge_intercept(slope=-1.5)

Return the intercept for a line with the given slope such that it will intersect with x=y above the center of the vowel space

Name	Type	Description	Default
slope	float	The slope of the line. Defaults to -1.5	`-1.5`

Name	Type	Description
float	np.ndarray	The intercept

VowelClassCollection.to_param_df(output='log_param')

Return DataFrame of formant DCT parameters.

Name	Type	Description
	`pl`.`DataFrame`	A DataFrame of formant DCT parameters

VowelClassCollection.to_point_df()

Return a DataFrame of point measurements

Name	Type	Description
	`pl`.`DataFrame`	A DataFrame of vowel point measures.

VowelClassCollection.to_tracks_df()

Return a DataFrame of the formant tracks

Name	Type	Description
	`pl`.`DataFrame`	A dataframe with formant track data.