handwriting_features.data.containers package

Submodules

handwriting_features.data.containers.sample module

class handwriting_features.data.containers.sample.HandwritingSampleWrapper(sample)[source]

Bases: object

Class implementing the handwriting sample wrapper

axes = ('x', 'y', 'xy')
compute_acceleration(axis='xy', in_air=False)[source]

Computes the acceleration.

Parameters

  • axis (str, optional) – axis to compute the acceleration from, defaults to “xy”

  • in_air (bool, optional) – in-air flag, defaults to False

Returns

acceleration

Return type

numpy.ndarray or numpy.NaN

compute_azimuth(in_air=False)[source]

Computes the azimuth.

Parameters

in_air (bool, optional) – in-air flag, defaults to False

Returns

azimuth

Return type

numpy.ndarray or numpy.NaN

compute_jerk(axis='xy', in_air=False)[source]

Computes the jerk.

Parameters

  • axis (str, optional) – axis to compute the jerk from, defaults to “xy”

  • in_air (bool, optional) – in-air flag, defaults to False

Returns

jerk

Return type

numpy.ndarray or numpy.NaN

compute_pressure()[source]

Computes the pressure.

Returns

tilt

Return type

numpy.ndarray or numpy.NaN

compute_tilt(in_air=False)[source]

Computes the tilt.

Parameters

in_air (bool, optional) – in-air flag, defaults to False

Returns

tilt

Return type

numpy.ndarray or numpy.NaN

compute_velocity(axis='xy', in_air=False)[source]

Computes the velocity.

Parameters

  • axis (str, optional) – axis to compute the velocity from, defaults to “xy”

  • in_air (bool, optional) – in-air flag, defaults to False

Returns

velocity

Return type

numpy.ndarray or numpy.NaN

classmethod from_json(path, labels=None)[source]

Initializes HandwritingSampleWrapper object from a JSON file.

Parameters

  • path (str) – path to a JSON file

  • labels (list, optional) – labels for the data values

Returns

HandwritingSampleWrapper object

Return type

HandwritingSampleWrapper

classmethod from_list(values, labels=None)[source]

Initializes HandwritingSampleWrapper object from a list.

Parameters

  • values (list) – data values

  • labels (list, optional) – labels for the data values

Returns

HandwritingSampleWrapper object

Return type

HandwritingSampleWrapper

classmethod from_numpy_array(values, labels=None)[source]

Initializes HandwritingSampleWrapper object from a numpy array.

Parameters

  • values (numpy.ndarray) – data values

  • labels (list, optional) – labels for the data values

Returns

HandwritingSampleWrapper object

Return type

HandwritingSampleWrapper

classmethod from_pandas_dataframe(values, labels=None)[source]

Initializes HandwritingSampleWrapper object from a pandas DataFrame.

Parameters

  • values (pandas.DataFrame) – data values

  • labels (list, optional) – labels for the data values

Returns

HandwritingSampleWrapper object

Return type

HandwritingSampleWrapper

classmethod from_svc(path, labels=None)[source]

Initializes HandwritingSampleWrapper object from an SVC file.

Parameters

  • path (str) – path to an SVC file

  • labels (list, optional) – labels for the data values

Returns

HandwritingSampleWrapper object

Return type

HandwritingSampleWrapper

property in_air_data
property in_air_strokes
property on_surface_data
property on_surface_strokes
property sample_azimuth
property sample_pen_status
property sample_pressure
property sample_tilt
property sample_time
property sample_x
property sample_y
surfaces = ('on_surface', 'in_air')
classmethod validate_axis(axis)[source]

Validates the axis

classmethod validate_surface_movement(in_air)[source]

Validates the surface movement

Module contents