parselmouth.Harmonicity

parselmouth.Harmonicity#

class parselmouth.Harmonicity#

Bases: TimeFrameSampled, Vector

Methods

`__init__`
`add`
`as_array`
`at_xy`
`copy`
`divide`
`formula`
`frame_number_to_time`
`get_column_distance`
`get_end_time`
`get_frame_number_from_time`
`get_highest_x`
`get_highest_y`
`get_lowest_x`
`get_lowest_y`
`get_maximum`
`get_minimum`
`get_number_of_columns`
`get_number_of_frames`
`get_number_of_rows`
`get_row_distance`
`get_start_time`
`get_sum`
`get_time_from_frame_number`
`get_time_step`
`get_total_duration`
`get_value`
`get_value_at_xy`
`get_value_in_cell`
`get_x_of_column`
`get_y_of_row`
`info`
`multiply`
`read`	Read a file into a `parselmouth.Data` object.
`save`
`save_as_binary_file`
`save_as_headerless_spreadsheet_file`
`save_as_matrix_text_file`
`save_as_short_text_file`
`save_as_text_file`
`scale`
`scale_peak`
`scale_times_by`
`scale_times_to`
`scale_x_by`
`scale_x_to`
`set_value`
`shift_times_by`
`shift_times_to`
`shift_x_by`
`shift_x_to`
`subtract`
`subtract_mean`
`t_bins`
`t_grid`
`time_to_frame_number`
`ts`
`x_bins`
`x_grid`
`xs`
`y_bins`
`y_grid`
`ys`

Attributes

`centre_time`
`class_name`
`dt`
`duration`
`dx`
`dy`
`end_time`
`full_name`
`n_columns`
`n_frames`
`n_rows`
`name`
`nt`
`nx`
`ny`
`start_time`
`t1`
`time_range`
`time_step`
`tmax`
`tmin`
`total_duration`
`trange`
`values`
`x1`
`xmax`
`xmin`
`xrange`
`y1`
`ymax`
`ymin`
`yrange`

class FileFormat#

Bases: pybind11_object

__eq__(self: object, other: object) → bool#

__hash__(self: object) → int#

__index__(self: parselmouth.Data.FileFormat) → int#

__init__(self: parselmouth.Data.FileFormat, value: int) → None#
__init__(self: parselmouth.Data.FileFormat, arg0: str) → None

__int__(self: parselmouth.Data.FileFormat) → int#

__ne__(self: object, other: object) → bool#

__new__(**kwargs)#

__repr__(self: object) → str#

__str__()#: name(self: handle) -> str

BINARY = <FileFormat.BINARY: 2>#

SHORT_TEXT = <FileFormat.SHORT_TEXT: 1>#

TEXT = <FileFormat.TEXT: 0>#

property name#

property value#

__add__(self: parselmouth.Vector, number: float) → parselmouth.Vector#

__buffer__(flags, /)#: Return a buffer object that exposes the underlying memory of the object.

__copy__(self: parselmouth.Data) → parselmouth.Data#

__deepcopy__(self: parselmouth.Data, memo: dict) → parselmouth.Data#

__eq__(self: parselmouth.Data, other: parselmouth.Data) → bool#

__iadd__(self: parselmouth.Vector, number: float) → parselmouth.Vector#

__imul__(self: parselmouth.Vector, factor: float) → parselmouth.Vector#

__init__(*args, **kwargs)#

__isub__(self: parselmouth.Vector, number: float) → parselmouth.Vector#

__itruediv__(self: parselmouth.Vector, factor: float) → parselmouth.Vector#

__len__(self: parselmouth.Sampled) → int#

__mul__(self: parselmouth.Vector, factor: float) → parselmouth.Vector#

__ne__(self: parselmouth.Data, other: parselmouth.Data) → bool#

__new__(**kwargs)#

__radd__(self: parselmouth.Vector, number: float) → parselmouth.Vector#

__release_buffer__(buffer, /)#: Release the buffer object that exposes the underlying memory of the object.

__rmul__(self: parselmouth.Vector, factor: float) → parselmouth.Vector#

__str__(self: parselmouth.Thing) → str#

__sub__(self: parselmouth.Vector, number: float) → parselmouth.Vector#

__truediv__(self: parselmouth.Vector, factor: float) → parselmouth.Vector#

add(self: parselmouth.Vector, number: float) → None#

as_array(self: parselmouth.Matrix) → numpy.ndarray[numpy.float64]#

at_xy(self: parselmouth.Matrix, x: float, y: float) → float#

copy(self: parselmouth.Data) → parselmouth.Data#

divide(self: parselmouth.Vector, factor: float) → None#

formula(self: parselmouth.Matrix, formula: str, from_x: float | None = None, to_x: float | None = None, from_y: float | None = None, to_y: float | None = None) → None#
formula(self: parselmouth.Matrix, formula: str, x_range: Tuple[float | None, float | None] = (None, None), y_range: Tuple[float | None, float | None] = (None, None)) → None

frame_number_to_time(self: parselmouth.Sampled, frame_number: Positive[int]) → float#

get_column_distance(self: parselmouth.Matrix) → float#

get_end_time(self: parselmouth.Function) → float#

get_frame_number_from_time(self: parselmouth.Sampled, time: float) → float#

get_highest_x(self: parselmouth.Matrix) → float#

get_highest_y(self: parselmouth.Matrix) → float#

get_lowest_x(self: parselmouth.Matrix) → float#

get_lowest_y(self: parselmouth.Matrix) → float#

get_maximum(self: parselmouth.Matrix) → float#

get_minimum(self: parselmouth.Matrix) → float#

get_number_of_columns(self: parselmouth.Matrix) → int#

get_number_of_frames(self: parselmouth.Sampled) → int#

get_number_of_rows(self: parselmouth.Matrix) → int#

get_row_distance(self: parselmouth.Matrix) → float#

get_start_time(self: parselmouth.Function) → float#

get_sum(self: parselmouth.Matrix) → float#

get_time_from_frame_number(self: parselmouth.Sampled, frame_number: Positive[int]) → float#

get_time_step(self: parselmouth.Sampled) → float#

get_total_duration(self: parselmouth.Function) → float#

get_value(self: parselmouth.Harmonicity, time: float, interpolation: parselmouth.ValueInterpolation = <ValueInterpolation.CUBIC: 2>) → float#

get_value_at_xy(self: parselmouth.Matrix, x: float, y: float) → float#

get_value_in_cell(self: parselmouth.Matrix, row_number: Positive[int], column_number: Positive[int]) → float#

get_x_of_column(self: parselmouth.Matrix, column_number: Positive[int]) → float#

get_y_of_row(self: parselmouth.Matrix, row_number: Positive[int]) → float#

info(self: parselmouth.Thing) → str#

multiply(self: parselmouth.Vector, factor: float) → None#

static read(file_path: str) → parselmouth.Data#

Read a file into a parselmouth.Data object.

Parameters:: file_path (str) – The path of the file on disk to read.
Returns:: The Praat Data object that was read.
Return type:: parselmouth.Data

parselmouth.Harmonicity

Contents

parselmouth.Harmonicity#