parselmouth.Harmonicity
=======================



.. currentmodule:: parselmouth

.. autoclass:: Harmonicity
   :show-inheritance:
   :members:
   :inherited-members:
   :undoc-members:
   :special-members:
   :exclude-members: __weakref__, __doc__, __module__, __dict__, __members__, __getstate__, __setstate__, __annotations__

   
   
   .. rubric:: Methods

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

   
   
   .. rubric:: Attributes

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