MathWorks Machine Translation
The automated translation of this page is provided by a general purpose third party translator tool.
MathWorks does not warrant, and disclaims all liability for, the accuracy, suitability, or fitness for purpose of the translation.
Limit input signal to the upper and lower saturation values
Simulink / Commonly Used Blocks
Simulink / Discontinuities
HDL Coder / Discontinuities
The Saturation block produces an output signal that is the value of the input signal bounded to the upper and lower saturation values. The upper and lower limits are specified by the parameters Upper limit and Lower limit.
Input  Output 

Lower limit ≤ Input value ≤ Upper limit  Input value 
Input value < Lower limit  Lower limit 
Input value > Upper limit  Upper limit 
Port_1
— Input signalThe input signal to the saturation algorithm.
Data Types: double
 single
 int8
 int16
 int32
 uint8
 uint16
 uint32
 fixed point
Port_1
— Output signalOutput signal that is the value of the input signal, upper saturation limit, or lower saturation limit.
Data Types: double
 single
 int8
 int16
 int32
 uint8
 uint16
 uint32
 fixed point
Upper limit
— Upper saturation boundary for the input signal0.5
(default)  scalar  vectorSpecify the upper bound on the input signal. If the input signal is greater than this boundary, then the output signal is set to this saturation value. The Upper limit parameter is converted to the output data type using roundtonearest and saturation. Upper limit must be greater than the Output minimum parameter and less than the Output maximum parameter.
Block Parameter:
UpperLimit 
Type: character vector 
Value: real scalar or vector 
Default:
'0.5' 
Lower limit
— Lower saturation boundary for the input signal0.5
(default)  scalar  vectorSpecify the lower bound on the input signal. If the input signal is less than this boundary, then the output signal is set to this saturation value. The Lower limit parameter is converted to the output data type using roundtonearest and saturation. Lower limit must be greater than the Output minimum parameter and less than the Output maximum parameter.
Block Parameter:
LowerLimit 
Type: character vector 
Value: real scalar or vector 
Default:
'0.5' 
Treat as gain when linearizing
— Specify the gain valueOn
(default)  BooleanSelect this check box to cause the commands to treat the gain as 1. The linearization commands in Simulink^{®} software treat this block as a gain in state space. Clear the box to have the commands treat the gain as 0.
Block Parameter:
LinearizeAsGain 
Type: character vector 
Values: 'off' 
'on' 
Default: 'on' 
Enable zerocrossing detection
— Enable zerocrossing detectionon
(default)  BooleanSelect to enable zerocrossing detection. For more information, see ZeroCrossing Detection.
Block Parameter:
ZeroCross 
Type: character vector, string 
Values: 'off' 
'on' 
Default: 'on' 
Sample time
— Specify sample time as a value other than 1
1
(default)  scalarSpecify the sample time as a value other than 1. For more information, see Specify Sample Time.
This parameter is not visible unless it is explicitly set to a value other than
1
. To learn more, see Blocks for Which Sample Time Is Not Recommended.
Block Parameter:
SampleTime 
Type: character vector 
Values: scalar 
Default:
'1' 
Click the Show data type assistant button to display the Data Type Assistant, which helps you set the data type attributes. For more information, see Specify Data Types Using Data Type Assistant.
Output minimum
— Minimum output value for range checking[]
(default)  scalarLower value of the output range that Simulink checks.
Simulink uses the minimum to perform:
Parameter range checking (see Specify Minimum and Maximum Values for Block Parameters) for some blocks.
Simulation range checking (see Signal Ranges and Enable Simulation Range Checking).
Automatic scaling of fixedpoint data types.
Optimization of the code that you generate from the model. This optimization can remove algorithmic code and affect the results of some simulation modes such as SIL or external mode. For more information, see Optimize using the specified minimum and maximum values (Simulink Coder).
Output minimum does not saturate or clip the actual output signal. Use the Saturation block instead.
Block Parameter:
OutMin 
Type: character vector 
Values: '[ ]' 
scalar 
Default: '[ ]' 
Output maximum
— Maximum output value for range checking[]
(default)  scalarUpper value of the output range that Simulink checks.
Simulink uses the maximum value to perform:
Parameter range checking (see Specify Minimum and Maximum Values for Block Parameters) for some blocks.
Simulation range checking (see Signal Ranges and Enable Simulation Range Checking).
Automatic scaling of fixedpoint data types.
Optimization of the code that you generate from the model. This optimization can remove algorithmic code and affect the results of some simulation modes such as SIL or external mode. For more information, see Optimize using the specified minimum and maximum values (Simulink Coder).
Output maximum does not saturate or clip the actual output signal. Use the Saturation block instead.
Block Parameter:
OutMax 
Type: character vector 
Values: '[ ]' 
scalar 
Default: '[ ]' 
Output data type
— Specify the output data typeInherit: Same as input
(default)  Inherit: Inherit via back propagation
 double
 single
 int8
 int32
 uint32
 int64
 uint64
 fixdt(1,16,2^0,0)
 <data type expression>
 ...Choose the data type for the output. The type can be inherited, specified directly, or
expressed as a data type object such as Simulink.NumericType
.
Block Parameter:
OutDataTypeStr 
Type: character vector 
Values: 'Inherit: Same as
input' , 'Inherit: Inherit via back
propagation' , 'single' , 'int8' ,
'uint8' , int16 ,
'uint16' , 'int32' ,
'uint32' , 'int64' ,
'uint64' , fixdt(1,16,0) ,
fixdt(1,16,2^0,0) ,
fixdt(1,16,2^0,0) . '<data type
expression>' 
Default: 'Inherit: Same as
input' 
Lock output data type setting against changes by the fixedpoint tools
— Prevent fixedpoint tools from overriding Output data typeoff
(default)  on
Select this parameter to prevent the fixedpoint tools from overriding the Output data type you specify on the block. For more information, see Use Lock Output Data Type Setting (FixedPoint Designer).
Block Parameter:
LockScale 
Type: character vector 
Values:
'off'  'on' 
Default:
'off' 
Integer rounding mode
— Specify the rounding mode for fixedpoint operationsFloor
(default)  Ceiling
 Convergent
 Nearest
 Round
 Simplest
 Zero
Choose one of these rounding modes.
Ceiling
Rounds both positive and negative numbers
toward positive infinity. Equivalent to the
MATLAB^{®}
ceil
function.
Convergent
Rounds number to the nearest representable
value. If a tie occurs, rounds to the nearest even
integer. Equivalent to the FixedPoint
Designer™
convergent
function.
Floor
Rounds both positive and negative numbers
toward negative infinity. Equivalent to the
MATLAB
floor
function.
Nearest
Rounds number to the nearest representable
value. If a tie occurs, rounds toward positive
infinity. Equivalent to the FixedPoint
Designer
nearest
function.
Round
Rounds number to the nearest representable
value. If a tie occurs, rounds positive numbers
toward positive infinity and rounds negative
numbers toward negative infinity. Equivalent to
the FixedPoint
Designer
round
function.
Simplest
Automatically chooses between round toward floor and round toward zero to generate rounding code that is as efficient as possible.
Zero
Rounds number toward zero. Equivalent to the
MATLAB
fix
function.
Block Parameter:
RndMeth 
Type: character vector 
Values:
'Ceiling' 
'Convergent' 
'Floor' 
'Nearest' 
'Round' 
'Simplest' 
'Zero' 
Default:
'Floor' 
For more information, see Rounding (FixedPoint Designer).
Data Types 

Direct Feedthrough 

Multidimensional Signals 

VariableSize Signals 

ZeroCrossing Detection 

For more information on HDL code generation, see Saturation.
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
Select web siteYou can also select a web site from the following list:
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.