PATimeSeries

PATimeSeries#

class patato.PATimeSeries(data, dimensions, coordinates=None, attributes=None, hdf5_sub_name=None, algorithm_id=None)#

Bases: PARawData

PATimeSeries is the data structure for time-domain raw PA data.

__init__(data, dimensions, coordinates=None, attributes=None, hdf5_sub_name=None, algorithm_id=None)#
Parameters:

  • data

  • dimensions

  • coordinates

  • attributes

  • hdf5_sub_name

  • algorithm_id.

Methods

__init__(data, dimensions[, coordinates, ...])

ax_0_exists()

copy([cls])

from_numpy(dataset, wavelengths, fs[, ...])

Create a PATimeSeries class from a NumPy array.

get_ax1_label_meaning()

get_hdf5_group_name()

get_hdf5_sub_name()

imshow([ax, roi_mask, mask_roi, cmap, ...])

is_single_instance()

save(scan_writer)

to_2d()

to_opencl(queue)

two_dims()

Attributes

attributes

ax_0_labels

ax_1_labels

cmap

dtype

extent

n_im_dim

ndim

numpy_array

raw_data

save_output

shape

shape_2d

values

classmethod from_numpy(dataset: _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes], wavelengths: _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes], fs: float, speed_of_sound: float | None = None)[source]#

Create a PATimeSeries class from a NumPy array.

Parameters:

  • dataset (np.ndarray)

  • wavelengths (np.ndarray)

  • fs (float)

  • speed_of_sound (float)

Return type:

PATimeSeries

Contents