Skip to content

Commit

Permalink
Rename dB parameter 'order' -> 'factor'
Browse files Browse the repository at this point in the history
  • Loading branch information
henrikt-ma committed Dec 4, 2022
1 parent 94147ac commit 648fcd7
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions chapters/annotations.tex
Expand Up @@ -216,18 +216,18 @@ \subsubsection{Axis Properties}\label{axis-properties}
\begin{lstlisting}[language=modelica]
record dB
extends AxisScale;
Integer order(min = 1);
Integer factor(min = 1);
end dB;
\end{lstlisting}%
\index{dB@\robustinline{dB} (decibel axis scale)}

The mandatory \lstinline!order! is used to define a tick label conversion according to $y \mapsto \text{\lstinline!order!}\, \operatorname{log}_{10}(y)$.
The mandatory \lstinline!factor! is used to define a tick label conversion according to $y \mapsto \text{\lstinline!factor!}\, \operatorname{log}_{10}(y)$.
This mapping shall be applied before presenting values in tick labels.
It is recommended that value of \lstinline!order! is somehow indicated on the axis or its tick labels, for example by presenting a major tick label as $8\, \mathrm{dB}_{20}$.
It is recommended that value of \lstinline!factor! is somehow indicated on the axis or its tick labels, for example by presenting a major tick label as $8\, \mathrm{dB}_{20}$.
Major axis ticks are preferred at integer converted values, and minor ticks should be placed at evenly distributed converted values (similar to a linear axis scale).

\begin{nonnormative}
The two values of \lstinline!order! which are in widespread use are 10 and 20.
The two values of \lstinline!factor! which are in widespread use are 10 and 20.
10 is typically used when plotting signal power, and 20 is typically used when plotting signal amplitude.
\end{nonnormative}

Expand Down

0 comments on commit 648fcd7

Please sign in to comment.