Class: Spectrogram
Prev
Next
Working with KstScript

Class: Spectrogram

This class represents a spectrogram (CSD) object in Kst.

Inherits: DataObject

Collection class: SpectrogramCollection

Constructors:

  • Spectrogram ( vector, freq [, average [, len [, apodize [, removeMean]]]] )

Properties:

Spectrogram ( Vector vector, number freq [, boolean average [, number len [, boolean apodize [, boolean removeMean]]]] )

  • Vector vector - The vector to use as input to the spectrogram.

  • number freq - The frequency for the spectrogram.

  • boolean average - [OPTIONAL]

  • number len - The base 2 logarithm of the length of the power spectrum. Should be an integer >= 4. [OPTIONAL]

  • boolean apodize - If true, sharp discontinuities are removed. [OPTIONAL]

  • boolean removeMean - True if the mean should be removed before performing the transform. [OPTIONAL]

Creates a new power spectrum (PSD) object in Kst. Units are V and Hz by default.

Vector vector

The input vector for the spectrogram.

number length

Contains the base 2 logarithm of the length of the spectrogram. Should be an integer >= 4.

number output

the normalization for the transform:

  • 0 - amplitude spectral density

  • 1 - power spectral density

  • 2 - amplitude spectrum

  • 3 - power spectrum

boolean removeMean

True if the mean should be removed before performing the transform.

number average

boolean apodize

If true, sharp discontinuities are removed.

number apodizeFn

The apodization function to be used in the case that apodize is true:

  • 0 - default

  • 1 - bartlett

  • 2 - blackman

  • 3 - connes

  • 4 - cosine

  • 5 - gaussian

  • 6 - hamming

  • 7 - hann

  • 8 - welch

  • 9 - uniform

number frequency

Contains the sampling rate of the spectrogram.

Matrix matrix [Read-Only]

The matrix for the spectrogram.

string vUnits

A string containing the units for the vector.

string rUnits

A string containing the units for the rate.

number windowSize

The window size of the spectrogram.

boolean interpolateHoles

True if the transform should automatically interpolate over missing data values.

Prev
Next
Home
Class: Size 
 Class: SpectrogramCollection
Up


Would you like to make a comment or contribute an update to this page?
Send feedback to the KDE Docs Team