Max Pooling 1D Layer

R2026b

1-D max pooling layer

Since R2024b

expand all in page
  • Max Pooling 1D Layer block

Libraries:
Deep Learning Toolbox / Deep Learning Layers / Pooling Layers

Description

The Max Pooling 1D Layer block performs downsampling by dividing the input into 1-D pooling regions, then computing the maximum of each region.

The dimension that the layer pools over depends on the layer input:

  • For time series and vector sequence input in the CT format (two dimensions corresponding to channels and time steps, in that order), the layer pools over the time dimension.

  • For 1-D image input in the SC format (two dimensions corresponding to spatial pixels and channels, in that order), the layer pools over the spatial dimension.

The exportNetworkToSimulink function generates this block to represent a maxPooling1dLayer object.

Examples

expand all

Export a trained neural network to Simulink® as layer blocks.

For most workflows, you do not need to create neural networks in Simulink. Instead, import or train a neural network in MATLAB® and export it to Simulink.

Suppose that you have a trained neural network net specified as a dlnetwork object. Export the network to Simulink using the exportNetworkToSimulink function.

mdlInfo = exportNetworkToSimulink(net)

Neural network as subsystem in Simulink. The subsystem has the name "my_model". It has one input with the name "data" and one output with the name "prob_flatten_out".

The exported Simulink model represents the neural network as a subsystem. To view the layer blocks, open the subsystem. This example shows the first few blocks of a neural network.

Neural network as layer blocks in Simulink. The subsystem has one input with the name data. The data input is connected to four layer blocks in series. The layer blocks in order are Zerocenter 2D, Convolution 2D, ReLU, and Max Pooling 2D layer blocks. There are more blocks in the model which have been cropped from the screenshot.

To view and edit the layer block parameters, open the corresponding layer block mask. This example shows the parameters for the ReLU block.

Block Parameters dialog for the ReLU block.

Using the layer block parameters, you can configure aspects like data types and execution options like sample times.

Limitations

  • Before R2026a: The Layer parameter supports the manual padding mode for only some padding sizes.

Ports

Input

expand all

Input data to downsample. The data must have two dimensions or fewer.

If the data has fewer than two dimensions, the block treats the input as having trailing singleton dimensions. For example, for scalar input, the block treats the input as a 1-by-1 array with dimensions that correspond to the Data format block parameter.

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | fixed point

Output

expand all

The result of downsampling the input data. The output data has two dimensions corresponding to the format that you specify with the Data format block parameter.

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | fixed point

Parameters

expand all

To edit block parameters interactively, use the Property Inspector. From the Simulink Toolstrip, on the Simulation tab, in the Prepare gallery, select Property Inspector.

Main

Specify the name of a workspace variable that contains a maxPooling1dLayer object from a trained network. The Max Pooling 1D Layer block configures itself by using the properties of the object.

Programmatic Use

Block Parameter: Layer
Type: workspace variable
Values: maxPooling1dLayer object
Default: 'layerObject'

Data format for the input data. The options use the same notation as the fmt argument of the dlarray object, except layer blocks do not support the Batch (B) dimension and instead assume an observation number of 1.

Programmatic Use

Block Parameter: DataFormat
Type: character vector
Values: 'CT' | 'SC'
Default: 'CT'

Data Types

Minimum value of the output range that the software checks.

The software uses the minimum value to perform:

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:

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, the software 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: Inherit via back propagation' | 'Inherit: Same as first input' | <data type expression>

Select this parameter to prevent Fixed-Point Tool 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 as int8 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'

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' | scalar
Default: '-1'

Programmatic Use: Add Block

To add the block programmatically, use the add_block function with one of these library block paths as the source.

"dlpoolinglib/Max Pooling 1D Layer"

Example: add_block("dlpoolinglib/Max Pooling 1D Layer","myModel/myBlock",MakeNameUnique="on")

For information about programmatic access to individual block parameters, see the Programmatic Use section of parameter descriptions on this page.

Extended Capabilities

expand all

C/C++ Code Generation
Generate C and C++ code using Simulink® Coder™.

Version History

Introduced in R2024b

expand all

See Also

| | | | | |

Topics