Converts the sample frequency (Fs) to a constant value.

Fs

Overview

Use this operator to get the input sample frequency (Fs) as a constant value at the output.
The current sample frequency is sometimes required to make timing calculations.

Operator ports

Input Any: Any sample type. The connection is not limited to one type of signal.

Output Fs: Floating point values
This is a Constant output, which does not output a signal, but a single value. A constant output does not have a sample frequency and is therefore recognized by Polybench to be a constant. Many calculations can be performed on constants as well as signals (or a combination of both). If an operator performs a calculation on constants only, it becomes a constant operator itself.

Constants and any other data source are allowed to be mixed without synchronization ("Synchronizer").

In a schematic, connectors that are connected to constant outputs are always colored black, while connections from other data sources may be colored differently.

Properties

Find more information about changing properties here: "Properties Viewer"

Caption

type: Word or phrase
The name of the object in the project. This name must not contain '.', '$' nor '@' characters.

For more information about the rules and usage of the Caption property, please refer to "Caption property - background and usage".

Documentation

type: See description
Optional documentation of this object. If this object is an operator, the Documentation text is displayed below the operator symbol.

Variable Parameters

Find more information about Variable Parameters here: "Variable Parameters"

type: See description
The sample frequency at the input of this operator.

Details

The Fs constant opererator does not produce a signal. So if you connect a constant to a viewer directly, no signal will appear. In order to convert the constant value to a constant signal, use the Clocked Constant ("Clocked Constant").

The Fs constant operator shows the current input sample frequency below its symbol as well.

You may connect the Fs constant operator to any kind of signal that has a sample frequency. The output of the operator is always of type floating point value.
If the input connection does not have a sample frequency, because it is constant, or irregular, then the sample frequency translates to 0.