pyva.data.matrixClasses.DataAxis

class pyva.data.matrixClasses.DataAxis(data, **kwargs)

Bases: object

Class for handling 1D data axis e.g. the time of requency axis

data

data axis samples

Type:: ndarray

type

Type:: of data e.g. time, frequency @type str

__init__(data, **kwargs)

Class constructor of data:axis

Parameters:

data (ndarray) – data axis samples.
**kwargs (dict) – Arbitrary argument list.
typestr (str) – type string e.g. ‘pressure
typeID (int) – corresponding typeID
type (DOFtype) – DOFtype

Raises:

ValueError – DESCRIPTION.

Methods

`__init__`(data, **kwargs)	Class constructor of data:axis
`isa`(typestr)	Check is self is of type typestr
`label`()	Creates text label of DataAxis
`octave_band`([f_min, f_max, ...])	Method for octave / log space creation.

Attributes

`angular_frequency`	Provides the angular frequency independent from frequency type
`data`	Property method for data
`frequency`	Provides the frequency independent from frequency type
`shape`	shape method of DataAxis object
`type`	DOFtype of DataAxis
`typeID`	returns: DESCRIPTION.
`unit`	Provides units of DataAxis

property angular_frequency

Provides the angular frequency independent from frequency type

Returns:: angular frequency
Return type:: ndarray
Raises:: ValueError – When self is no frequency type.

property data

Property method for data

Returns:: data axis samples.
Return type:: ndarray

property frequency

Provides the frequency independent from frequency type

Returns:: frequency
Return type:: ndarray
Raises:: ValueError – When self is no frequency type.

isa(typestr)

Check is self is of type typestr

Parameters:: typestr (str) – typestr.
Returns:: True if typestr = ‘DataAxis’.
Return type:: bool

label()

Creates text label of DataAxis

Returns:: DataAxis label.
Return type:: str

static octave_band(f_min=1570.7963267948965, f_max=25132.741228718343, bands_per_octave=3, typeID=21)

Method for octave / log space creation.

Depending on the typeID parameter the center frequencies are given Hertz or as angular frequency in sec^-1

Parameters:

f_min (float) – lower frequency limit
f_max (float) – upper frequency limit
bands_per_octave (integer, optional) – frequency points per octave band. The default is 3.
typeID (integer, optional) – typeID 18 frequency, 21 angular frequency. The default is 21.

Returns:

with center log spaces center frequencies

Return type:

DataAxis

property shape

shape method of DataAxis object

Returns:: (1,Ndata) .
Return type:: tuple

property type

DOFtype of DataAxis

Returns:: DOFtype of DataAxis.
Return type:: DOFtype

property typeID: returns: DESCRIPTION. :rtype: TYPE

property unit

Provides units of DataAxis

Returns:: units of dataaxis.
Return type:: units