Polybench® Reference
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 another 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 (link).

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: link

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

Every object has the Caption property. This property is very important, because it is the name by which Polybench recognizes this object.
It is allowed to give multiple objects the same name, as long as the objects are of the same type. In that case, a reference to this caption includes all the objects with the same caption.
In Polybench, every object can be addressed by an Address specifier, which starts with the dollar sign, for example: $My Page.My Object. 'My Page' would be the Caption of a page, and 'My Object' the Caption of an object on that page.

Documentation
type: See description
Optional documentation of this object.

It is good practice to write in short notes why you have used this object, and why its properties are set the way they are set. If this object is an operator, the Documentation text is displayed below the operator symbol.

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 (link).

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.