Engee documentation

RITM Spectrum Ex

Transmission of spectral data.

blockType: CFunction

Path in the library:

/RITM/RITM Plot/RITM Spectrum Ex

Description

Block RITM Spectrum Ex designed to transfer spectral data from the model Engee on the KPM monitor «RITM». The block allows you to display one or more spectra on a single graph.

Unlike the streaming schedule, the block transmits to the KPM monitor «RITM» an entire data frame: an array of frequencies and one or more arrays of amplitudes.

Assumptions and limitations

  • One block creates one spectral graph on the dashboard of the KPM monitor «RITM».

  • Up to eight spectra can be displayed on a single graph.

  • The first input freq sets the values along the axis .

  • The inputs ampl1, …​, amplN set the values of the spectra along the axis .

  • All input vectors must have the same length.

  • When the number of spectra changes, the number of input ports of the block automatically changes.

  • When changing the parameter Количество точек спектра: the expected dimension of the input signals is changed.

  • With the location value −1 The chart is placed on the dashboard automatically.

  • With the fixed range enabled parameter values Минимум Y: and Максимум Y: used to set the vertical range of the graph.

Ports

Input

# freq — values on the axis
vector

Details

Vector of values along the axis frequencies, bin numbers, or other coordinates of the spectrum.

The dimension of the input ports is set by the parameter Количество точек спектра:. For example, if this parameter is set to 1024, then the input ports have the dimension (1024,); and if the value 2048 Then — (2048,).

The dimensions of the input vector freq and all input vectors amplN must match.

Data types

Float64

Complex numbers support

No

# ampl1 — spectrum amplitudes
vector

Details

Vector of spectrum amplitudes . The number of input ports depends on the parameter Количество спектров:.

The dimension of the input ports is set by the parameter Количество точек спектра:. For example, if this parameter is set to 1024, then the input ports have the dimension (1024,); and if the value 2048 Then — (2048,).

The dimensions of all input vectors amplN and input vector freq must match.

Data types

Float64

Complex numbers support

No

Parameters

Основные параметры:

# Расположение графика на дашборде (-1 для автоматического расположения): — index of the chart position on the dashboard

Details

The index of the chart position on the dashboard of the KPM monitor «RITM». Meaning −1 enables automatic location.

Default value

-1

A name for programmatic use

m_plot_index

Configurable

None

Calculated

Yes

# Название графика: — chart title

Details

The chart title displayed on the KPM monitor «RITM».

Default value

"Spectrum"

A name for programmatic use

m_title

Configurable

None

Calculated

Yes

# Количество точек спектра: — the number of points in each input vector

Details

The number of points in each input vector is freq and amplN.

Default value

1024

A name for programmatic use

m_points_amount

Configurable

None

Calculated

Yes

# Количество спектров: — the number of spectra displayed on one graph

+ 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8

Details

The number of spectra displayed on a single graph. Acceptable values: from 1 before 8.

Values

1 | 2 | 3 | 4 | 5 | 6 | 7 | 8

Default value

1

A name for programmatic use

m_spectrum_count

Configurable

None

Calculated

Yes

# Подпись оси X: — horizontal axis signature

Details

The text signature of the horizontal axis.

Default value

"freq"

A name for programmatic use

m_x_label

Configurable

None

Calculated

Yes

# Подпись оси Y: — vertical axis signature

Details

The text signature of the vertical axis.

Default value

"ampl"

A name for programmatic use

m_y_label

Configurable

None

Calculated

Yes

# Фиксировать диапазон Y: — enables or disables a fixed range on the axis
false | true

Details
Values

false | true

Default value

false (disabled)

A name for programmatic use

m_fixed_y_range

Configurable

None

Calculated

Yes

# Минимум Y: — minimum value of the axis

Details

Minimum value of the axis .

Dependencies

To use this parameter, set for the parameter Фиксировать диапазон Y: meaning true.

Default value

0.0

A name for programmatic use

m_fixed_y_min

Configurable

None

Calculated

Yes

# Максимум Y: — the maximum value of the axis

Details

Maximum axis value .

Dependencies

To use this parameter, set for the parameter Фиксировать диапазон Y: meaning true.

Default value

1.0

A name for programmatic use

m_fixed_y_max

Configurable

None

Calculated

Yes

Спектр 1

# Подпись в легенде: — the name of the spectrum

Details

The name of the spectrum displayed in the graph legend.

Default value

"spectrum_1"

A name for programmatic use

m_spectrum_1_name

Configurable

None

Calculated

Yes

# Толщина линии: — the thickness of the spectrum line

+ Тонкая | Средняя | Толстая

Details
Values

Thin | Average | Tolstoy

Default value

Thin

A name for programmatic use

m_spectrum_1_width

Configurable

None

Calculated

Yes

# Цвет линии: — color of the spectrum line

+ Красный | Оранжевый | Зелёный | Бирюзовый | Голубой | Синий | Фиолетовый | Пурпурный

Details
Values

Red | Orange | Green | Turquoise | Blue | Blue | Violet | Purple

Default value

Blue

A name for programmatic use

m_spectrum_1_color

Configurable

None

Calculated

Yes