Zerocenter 3D - 3-D input layer with zerocenter normalization - Simulink (original) (raw)
3-D input layer with zerocenter
normalization
Since R2024b
Libraries:
Deep Learning Toolbox / Deep Learning Layers / Input Layer Normalizations
Description
The Zerocenter 3D block inputs 3-dimensional image data (data with four dimensions corresponding to three spatial dimensions and one channel dimension, in that order) to a neural network and rescales the input by subtracting the value of theMean
property of the layer object that you pass into the block.
The exportNetworkToSimulink function generates this block to represent an image3dInputLayer object that has the Normalization
parameter set to"zerocenter"
.
Limitations
- The Layer parameter does not support objects that have the
SplitComplexInputs
property set to1
(true
). - The block supports only input data that has 1 or 3 channels corresponding to grayscale or RGB image data, respectively.
Ports
Input
Input data to normalize. The data must have four dimensions corresponding to three spatial dimensions and one channel dimension, in that order.
Data Types: single
| double
| int8
| int16
| int32
| int64
| uint8
| uint16
| uint32
| uint64
| fixed point
Output
Normalized output data. The output data has four dimensions corresponding to three spatial dimensions and one channel dimension, in that order.
Data Types: single
| double
| int8
| int16
| int32
| int64
| uint8
| uint16
| uint32
| uint64
| fixed point
Parameters
To edit block parameters interactively, use theProperty Inspector. From the Simulink® Toolstrip, on the Simulation tab, in thePrepare gallery, select Property Inspector.
Main
Specify the name of a workspace variable that contains animage3dInputLayer
object that comes from a trained network and has the Normalization
property set to"zerocenter"
. The Zerocenter 3D block configures itself by using the properties of the object and calculates the block output by using the Mean
property of the object.
Programmatic Use
Block Parameter: Layer |
---|
Type: workspace variable |
Values: image3dInputLayer object |
Default: 'layerObject' |
Data format for the input data. The options use the same notation as the fmt argument of thedlarray
object, except layer blocks do not support the Batch (B
) dimension and instead assume an observation number of1
.
Programmatic Use
Block Parameter: DataFormat |
---|
Type: character vector |
Values: 'SSSC' |
Default: 'SSSC' |
Data Types
Minimum value of the output range that the software checks.
The software uses the minimum value to perform:
- Parameter range checking for some blocks. For more information, see Specify Minimum and Maximum Values for Block Parameters (Simulink).
- Simulation range checking. For more information, see Specify Signal Ranges (Simulink) andEnable Simulation Range Checking (Simulink).
- Automatic scaling of fixed-point 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, seeOptimize using the specified minimum and maximum values (Embedded Coder).
Tips
Output minimum does not saturate or clip the actual output signal. Use the Saturation (Simulink) block instead.
Programmatic Use
To set the block parameter value programmatically, use the set_param (Simulink) function.
Parameter: | OutMin |
---|---|
Values: | '[]' (default) | scalar in quotes |
Maximum value of the output range that the software checks.
The software uses the maximum value to perform:
- Parameter range checking for some blocks. For more information, see Specify Minimum and Maximum Values for Block Parameters (Simulink).
- Simulation range checking. For more information, see Specify Signal Ranges (Simulink) andEnable Simulation Range Checking (Simulink).
- Automatic scaling of fixed-point 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, seeOptimize using the specified minimum and maximum values (Embedded Coder).
Tips
Output maximum does not saturate or clip the actual output signal. Use the Saturation (Simulink) block instead.
Programmatic Use
To set the block parameter value programmatically, use the set_param (Simulink) function.
Parameter: | OutMax |
---|---|
Values: | '[]' (default) | scalar in quotes |
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
. When you select Inherit: Inherit via internal rule
, Simulink chooses a data type to balance numerical accuracy, performance, and generated code size, while taking into account the properties of the embedded target hardware.
Programmatic Use
To set the block parameter value programmatically, use the set_param (Simulink) function.
Parameter: | OutDataTypeStr | |||||
---|---|---|---|---|---|---|
Values: | 'Inherit: Inherit via internal rule' (default) | 'Inherit: Keep MSB' | 'Inherit: Keep LSB' | 'Inherit: Inherit via back propagation' | 'Inherit: Same as first input' | 'Inherit: Same as accumulator' |
Select this parameter to prevent the fixed-point tools from overriding the Output data type you specify on the block. For more information, see Use Lock Output Data Type Setting (Fixed-Point Designer).
Programmatic Use
To set the block parameter value programmatically, use the set_param (Simulink) function.
Parameter: | LockScale |
---|---|
Values: | 'off' (default) | 'on' |
Specify the rounding mode for fixed-point operations. For more information, see Rounding Modes (Fixed-Point Designer).
Block parameters always round to the nearest representable value. To control the rounding of a block parameter, enter an expression using a MATLAB® rounding function in the mask field.
Programmatic Use
To set the block parameter value programmatically, use the set_param (Simulink) function.
Parameter: | RndMeth | |||||
---|---|---|---|---|---|---|
Values: | 'Floor' (default) | 'Ceiling' | 'Convergent' | 'Nearest' | 'Round' | 'Simplest' | 'Zero' |
Specify whether integer overflows saturate or wrap.
on
— Overflows saturate to either the minimum or maximum value that the data type can represent.off
— Overflows wrap to the appropriate value that the data type can represent.
For example, the maximum value that the signed 8-bit integer int8
can represent is 127. Any block operation result greater than the maximum value causes overflow of the 8-bit integer.
- With this parameter selected, the block output saturates at 127. Similarly, the block output saturates at a minimum output value of –128.
- With this parameter cleared, the software interprets the overflow-causing value as
int8
, which can produce an unintended result. For example, a block result of 130 (binary 1000 0010) expressed asint8
is –126.
Tips
- Set this parameter to
on
when your model has a possible overflow and you want explicit saturation protection in the generated code. - To optimize the efficiency of your generated code, keep the default
off
setting for this parameter. Using the default setting also helps you avoid overspecifying how the block handles out-of-range signals. For more information, see Troubleshoot Signal Range Errors (Simulink). - When you select this parameter, saturation applies to every internal operation on the block, not just the output or the result.
- In general, the code generation process can detect when overflow is not possible. In this case, the code generator does not produce saturation code.
Programmatic Use
To set the block parameter value programmatically, use the set_param (Simulink) function.
Parameter: | SaturateOnIntegerOverflow |
---|---|
Values: | 'off' (default) | 'on' |
The block casts the value of the Mean
property of the object that you specify with the Layer parameter to this data type.The type can be inherited, specified directly, or expressed as a data type object such as Simulink.NumericType
.
Programmatic Use
To set the block parameter value programmatically, use the set_param (Simulink) function.
Parameter: | MeanDataTypeStr | |
---|---|---|
Values: | 'Inherit: Inherit via back propagation' (default) | 'Inherit: Inherit from 'Constant value'' |
Execution
Specify the discrete interval between sample time hits or specify another type of sample time, such as continuous (0
) or inherited (-1
). For more options, see Types of Sample Time (Simulink).
By default, the block inherits its sample time based on the context of the block within the model.
Programmatic Use
To set the block parameter value programmatically, use the set_param (Simulink) function.
Parameter: SampleTime |
---|
Data Types: char |
Values: '-1' (default) | scalar |
Extended Capabilities
Version History
Introduced in R2024b
Starting in R2025a, the default value for the Layer parameter is 'layerObject'
. In previous versions, the default value is 'layer'
. If you have code that programmatically creates Simulink and relies on variables with the name 'layer'
, update your code so that the variable has the name 'layerObject'
.