pingwyn.core.Profile

class pingwyn.core.Profile(arr, x=None, metadata={})

Bases: ndarray

A container for a x,y-curve.

This class extends numpy.ndarray, meaning that the profile data can be accessed as if it were a numpy array. The metadata attribute houses additional information for the physical experiment that was performed and from what curve data this profile was constructed.

A Profile object has a NxM shape, where N is the number of curves present in the profile and M is the number of data points measured in the channel. The shape of attribute “x” should equal M.

metadata

A dictionary containing relevant metadata, such as setpoints, channel name, units and referenced files.

Type:

dict

x

The points that make up the x-axes of all curves present in the profile.

Type:

array_like

__init__(*args: Any, **kwargs: Any) None

Methods

Attributes

metadata

x