Convolution3DLayer - 3-D convolutional layer - MATLAB (original) (raw)

Description

A 3-D convolutional layer applies sliding cuboidal convolution filters to 3-D input. The layer convolves the input by moving the filters along the input vertically, horizontally, and along the depth, computing the dot product of the weights and the input, and then adding a bias term.

The dimensions that the layer convolves over depends on the layer input:

Creation

Syntax

Description

`layer` = convolution3dLayer([filterSize](#mw%5F4b57fac4-adbc-4b30-ac71-7eefd68970c6),[numFilters](#mw%5F6c10bfd7-1bcf-4191-9645-ab06fba31d8b)) creates a 3-D convolutional layer and sets the FilterSize and NumFilters properties.

`layer` = convolution3dLayer([filterSize](#mw%5F4b57fac4-adbc-4b30-ac71-7eefd68970c6),[numFilters](#mw%5F6c10bfd7-1bcf-4191-9645-ab06fba31d8b),[Name=Value](#namevaluepairarguments)) sets optional properties using one or more name-value arguments.

example

Input Arguments

expand all

Height, width, and depth of the filters, specified as a vector[h w d] of three positive integers, whereh is the height, w is the width, and d is the depth.filterSize defines the size of the local regions to which the neurons connect in the input.

When creating the layer, you can specifyfilterSize as a scalar to use the same value for the height, width, and depth.

Example: [5 5 5] specifies filters with a height, width, and depth of 5.

Number of filters, specified as a positive integer. This number corresponds to the number of neurons in the layer that connect to the same region in the input. This parameter determines the number of channels (feature maps) in the layer output.

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

Name-Value Arguments

expand all

Specify optional pairs of arguments asName1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: convolution3dLayer(3,16,Padding="same") creates a 3-D convolutional layer with 16 filters of size [3 3 3] and"same" padding. At training time, the software calculates and sets the size of the padding so that the layer output has the same size as the input.

Step size for traversing the input in three dimensions, specified as a vector [a b c] of three positive integers, where a is the vertical step size,b is the horizontal step size, andc is the step size along the depth. When creating the layer, you can specify Stride as a scalar to use the same value for step sizes in all three directions.

Example: [2 3 1] specifies a vertical step size of 2, a horizontal step size of 3, and a step size along the depth of 1.

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

Factor for dilated convolution (also known as atrous convolution), specified as a vector [h w d] of three positive integers, where h is the vertical dilation,w is the horizontal dilation, andd is the dilation along the depth. When creating the layer, you can specifyDilationFactor as a scalar to use the same value for dilation in all three directions.

Use dilated convolutions to increase the receptive field (the area of the input which the layer can see) of the layer without increasing the number of parameters or computation.

The layer expands the filters by inserting zeros between each filter element. The dilation factor determines the step size for sampling the input or equivalently the upsampling factor of the filter. It corresponds to an effective filter size of (Filter Size – 1) .* Dilation Factor + 1. For example, a 3-by-3-by-3 filter with the dilation factor [2 2 2] is equivalent to a 5-by-5-by-5 filter with zeros between the elements.

Example: [2 3 1] dilates the filter vertically by a factor of 2, horizontally by a factor of 3, and along the depth by a factor of 1.

Input edge padding, specified as one of these values:

Example: Padding=1 adds one row of padding to the top and bottom, one column of padding to the left and right, and one plane of padding to the front and back of the input.

Example: Padding="same" adds padding so that the output has the same size as the input (if the stride equals 1).

Value to pad data, specified as one of the following:

PaddingValue Description Example
Scalar Pad with the specified scalar value. [314159265]→[0000000000000000314000015900002650000000000000000]
"symmetric-include-edge" Pad using mirrored values of the input, including the edge values. [314159265]→[5115995133144113314415115995622655662265565115995]
"symmetric-exclude-edge" Pad using mirrored values of the input, excluding the edge values. [314159265]→[5626562951595141314139515951562656295159514131413]
"replicate" Pad using repeated border elements of the input [314159265]→[3331444333144433314441115999222655522265552226555]

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | char | string

Number of input channels, specified as one of the following:

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | char | string

Function to initialize the weights, specified as one of the following:

The layer only initializes the weights when theWeights property is empty.

Data Types: char | string | function_handle

Function to initialize the biases, specified as one of these values:

The layer initializes the biases only when theBias property is empty.

Data Types: char | string | function_handle

Initial layer weights for the convolutional layer, specified as a numeric array.

The layer weights are learnable parameters. You can specify the initial value of the weights directly using the Weights property of the layer. When you train a network, if the Weights property of the layer is nonempty, then the trainnet function uses the Weights property as the initial value. If the Weights property is empty, then the software uses the initializer specified by the WeightsInitializer property of the layer.

At training time, Weights is aFilterSize(1)-by-FilterSize(2)-by-FilterSize(3)-by-NumChannels-by-NumFilters array.

Data Types: single | double

Initial layer biases for the convolutional layer, specified as a numeric array.

The layer biases are learnable parameters. When you train a neural network, if Bias is nonempty, then the trainnet and trainNetwork functions use the Bias property as the initial value. If Bias is empty, then software uses the initializer specified by BiasInitializer.

At training time, Bias is a 1-by-1-by-1-by-NumFilters array.

Data Types: single | double

Learning rate factor for the weights, specified as a nonnegative scalar.

The software multiplies this factor by the global learning rate to determine the learning rate for the weights in this layer. For example, ifWeightLearnRateFactor is2, then the learning rate for the weights in this layer is twice the current global learning rate. The software determines the global learning rate based on the settings you specify using the trainingOptions function.

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

Learning rate factor for the biases, specified as a nonnegative scalar.

The software multiplies this factor by the global learning rate to determine the learning rate for the biases in this layer. For example, if BiasLearnRateFactor is 2, then the learning rate for the biases in the layer is twice the current global learning rate. The software determines the global learning rate based on the settings you specify using the trainingOptions function.

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

L2 regularization factor for the weights, specified as a nonnegative scalar.

The software multiplies this factor by the global_L2_ regularization factor to determine the_L2_ regularization for the weights in this layer. For example, ifWeightL2Factor is 2, then the L2 regularization for the weights in this layer is twice the global_L2_ regularization factor. You can specify the global_L2_ regularization factor using the trainingOptions function.

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

L2 regularization factor for the biases, specified as a nonnegative scalar.

The software multiplies this factor by the global_L2_ regularization factor to determine the_L2_ regularization for the biases in this layer. For example, ifBiasL2Factor is 2, then the L2 regularization for the biases in this layer is twice the global_L2_ regularization factor. The software determines the global_L2_ regularization factor based on the settings you specify using the trainingOptions function.

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

Layer name, specified as a character vector or a string scalar. For Layer array input, the trainnet and dlnetwork functions automatically assign names to layers with the name "".

This argument sets the Name property.

Data Types: char | string

Properties

expand all

3-D Convolution

Height, width, and depth of the filters, specified as a vector[h w d] of three positive integers, whereh is the height, w is the width, and d is the depth.FilterSize defines the size of the local regions to which the neurons connect in the input.

When creating the layer, you can specifyFilterSize as a scalar to use the same value for the height, width, and depth.

Example: [5 5 5] specifies filters with a height, width, and depth of 5.

This property is read-only.

Number of filters, specified as a positive integer. This number corresponds to the number of neurons in the layer that connect to the same region in the input. This parameter determines the number of channels (feature maps) in the layer output.

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

Step size for traversing the input in three dimensions, specified as a vector[a b c] of three positive integers, where a is the vertical step size, b is the horizontal step size, andc is the step size along the depth. When creating the layer, you can specify Stride as a scalar to use the same value for step sizes in all three directions.

Example: [2 3 1] specifies a vertical step size of 2, a horizontal step size of 3, and a step size along the depth of 1.

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

Factor for dilated convolution (also known as atrous convolution), specified as a vector [h w d] of three positive integers, where h is the vertical dilation,w is the horizontal dilation, andd is the dilation along the depth. When creating the layer, you can specify DilationFactor as a scalar to use the same value for dilation in all three directions.

Use dilated convolutions to increase the receptive field (the area of the input which the layer can see) of the layer without increasing the number of parameters or computation.

The layer expands the filters by inserting zeros between each filter element. The dilation factor determines the step size for sampling the input or equivalently the upsampling factor of the filter. It corresponds to an effective filter size of (Filter Size – 1) .* Dilation Factor + 1. For example, a 3-by-3-by-3 filter with the dilation factor [2 2 2] is equivalent to a 5-by-5-by-5 filter with zeros between the elements.

Example: [2 3 1] dilates the filter vertically by a factor of 2, horizontally by a factor of 3, and along the depth by a factor of 1.

Size of padding to apply to input borders, specified as 2-by-3 matrix[t l f;b r k] of nonnegative integers, where t and b are the padding applied to the top and bottom in the vertical direction, l and r are the padding applied to the left and right in the horizontal direction, and f and k are the padding applied to the front and back along the depth. In other words, the top row specifies the prepadding and the second row defines the postpadding in the three dimensions.

When you create a layer, use the Padding name-value argument to specify the padding size.

Example: [1 2 4; 1 2 4] adds one row of padding to the top and bottom, two columns of padding to the left and right, and four planes of padding to the front and back of the input.

Method to determine padding size, specified as "manual" or"same".

The software automatically sets the value of PaddingMode based on the Padding argument value you specify when creating a layer.

The Convolution3DLayer object stores this property as a character vector.

Value to pad data, specified as one of these values:

PaddingValue Description Example
Scalar Pad with the specified scalar value. [314159265]→[0000000000000000314000015900002650000000000000000]
"symmetric-include-edge" Pad using mirrored values of the input, including the edge values. [314159265]→[5115995133144113314415115995622655662265565115995]
"symmetric-exclude-edge" Pad using mirrored values of the input, excluding the edge values. [314159265]→[5626562951595141314139515951562656295159514131413]
"replicate" Pad using repeated border elements of the input [314159265]→[3331444333144433314441115999222655522265552226555]

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | char | string

This property is read-only.

Number of input channels, specified as one of the following:

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | char | string

Parameters and Initialization

Function to initialize the weights, specified as one of the following:

The layer only initializes the weights when the Weights property is empty.

Data Types: char | string | function_handle

Function to initialize the biases, specified as one of these values:

The layer initializes the biases only when the Bias property is empty.

The Convolution3DLayer object stores this property as a character vector or a function handle.

Data Types: char | string | function_handle

Layer weights for the convolutional layer, specified as a numeric array.

The layer weights are learnable parameters. You can specify the initial value of the weights directly using the Weights property of the layer. When you train a network, if the Weights property of the layer is nonempty, then the trainnet function uses the Weights property as the initial value. If the Weights property is empty, then the software uses the initializer specified by the WeightsInitializer property of the layer.

At training time, Weights is aFilterSize(1)-by-FilterSize(2)-by-FilterSize(3)-by-NumChannels-by-NumFilters array.

Data Types: single | double

Layer biases for the convolutional layer, specified as a numeric array.

The layer biases are learnable parameters. When you train a neural network, if Bias is nonempty, then the trainnet function uses the Bias property as the initial value. IfBias is empty, then software uses the initializer specified by BiasInitializer.

At training time, Bias is a 1-by-1-by-1-by-NumFilters array.

Data Types: single | double

Learning Rate and Regularization

Learning rate factor for the weights, specified as a nonnegative scalar.

The software multiplies this factor by the global learning rate to determine the learning rate for the weights in this layer. For example, if WeightLearnRateFactor is 2, then the learning rate for the weights in this layer is twice the current global learning rate. The software determines the global learning rate based on the settings you specify using the trainingOptions function.

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

Learning rate factor for the biases, specified as a nonnegative scalar.

The software multiplies this factor by the global learning rate to determine the learning rate for the biases in this layer. For example, if BiasLearnRateFactor is 2, then the learning rate for the biases in the layer is twice the current global learning rate. The software determines the global learning rate based on the settings you specify using the trainingOptions function.

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

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

L2 regularization factor for the biases, specified as a nonnegative scalar.

The software multiplies this factor by the global L2 regularization factor to determine the L2 regularization for the biases in this layer. For example, if BiasL2Factor is 2, then the L2 regularization for the biases in this layer is twice the global L2 regularization factor. The software determines the global L2 regularization factor based on the settings you specify using the trainingOptions function.

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

Layer

Data Types: char | string

This property is read-only.

Number of inputs to the layer, stored as 1. This layer accepts a single input only.

Data Types: double

This property is read-only.

Input names, stored as {'in'}. This layer accepts a single input only.

Data Types: cell

This property is read-only.

Number of outputs from the layer, stored as 1. This layer has a single output only.

Data Types: double

This property is read-only.

Output names, stored as {'out'}. This layer has a single output only.

Data Types: cell

Examples

collapse all

Create a 3-D convolution layer with 16 filters, each with a height, width, and depth of 5. Use a stride (step size) of 4 in all three directions.

layer = convolution3dLayer(5,16,Stride=4)

layer = Convolution3DLayer with properties:

          Name: ''

Hyperparameters FilterSize: [5 5 5] NumChannels: 'auto' NumFilters: 16 Stride: [4 4 4] DilationFactor: [1 1 1] PaddingMode: 'manual' PaddingSize: [2×3 double] PaddingValue: 0

Learnable Parameters Weights: [] Bias: []

Show all properties

Include a 3-D convolution layer in a Layer array.

layers = [ ... image3dInputLayer([28 28 28 3]) convolution3dLayer(5,16,Stride=4) reluLayer maxPooling3dLayer(2,Stride=4) fullyConnectedLayer(10) softmaxLayer]

layers = 6×1 Layer array with layers:

 1   ''   3-D Image Input   28×28×28×3 images with 'zerocenter' normalization
 2   ''   3-D Convolution   16 5×5×5 convolutions with stride [4  4  4] and padding [0  0  0; 0  0  0]
 3   ''   ReLU              ReLU
 4   ''   3-D Max Pooling   2×2×2 max pooling with stride [4  4  4] and padding [0  0  0; 0  0  0]
 5   ''   Fully Connected   10 fully connected layer
 6   ''   Softmax           softmax

To specify the weights and bias initializer functions, use the WeightsInitializer and BiasInitializer properties respectively. To specify the weights and biases directly, use the Weights and Bias properties respectively.

Specify Initialization Functions

Create a 3-D convolutional layer with 32 filters, each with a height, width, and depth of 5. Specify the weights initializer to be the He initializer.

filterSize = 5; numFilters = 32; layer = convolution3dLayer(filterSize,numFilters, ... 'WeightsInitializer','he')

layer = Convolution3DLayer with properties:

          Name: ''

Hyperparameters FilterSize: [5 5 5] NumChannels: 'auto' NumFilters: 32 Stride: [1 1 1] DilationFactor: [1 1 1] PaddingMode: 'manual' PaddingSize: [2×3 double] PaddingValue: 0

Learnable Parameters Weights: [] Bias: []

Show all properties

Note that the Weights and Bias properties are empty. At training time, the software initializes these properties using the specified initialization functions.

Specify Custom Initialization Functions

To specify your own initialization function for the weights and biases, set the WeightsInitializer and BiasInitializer properties to a function handle. For these properties, specify function handles that take the size of the weights and biases as input and output the initialized value.

Create a convolutional layer with 32 filters, each with a height, width, and depth of 5. Specify initializers that sample the weights and biases from a Gaussian distribution with a standard deviation of 0.0001.

filterSize = 5; numFilters = 32;

layer = convolution3dLayer(filterSize,numFilters, ... 'WeightsInitializer', @(sz) rand(sz) * 0.0001, ... 'BiasInitializer', @(sz) rand(sz) * 0.0001)

layer = Convolution3DLayer with properties:

          Name: ''

Hyperparameters FilterSize: [5 5 5] NumChannels: 'auto' NumFilters: 32 Stride: [1 1 1] DilationFactor: [1 1 1] PaddingMode: 'manual' PaddingSize: [2×3 double] PaddingValue: 0

Learnable Parameters Weights: [] Bias: []

Show all properties

Again, the Weights and Bias properties are empty. At training time, the software initializes these properties using the specified initialization functions.

Specify Weights and Bias Directly

Create a 3-D convolutional layer compatible with color images. Set the weights and bias to W and b in the MAT file Conv3dWeights.mat respectively.

filterSize = 5; numFilters = 32; load Conv3dWeights

layer = convolution3dLayer(filterSize,numFilters, ... 'Weights',W, ... 'Bias',b)

layer = Convolution3DLayer with properties:

          Name: ''

Hyperparameters FilterSize: [5 5 5] NumChannels: 3 NumFilters: 32 Stride: [1 1 1] DilationFactor: [1 1 1] PaddingMode: 'manual' PaddingSize: [2×3 double] PaddingValue: 0

Learnable Parameters Weights: [5-D double] Bias: [1×1×1×32 double]

Show all properties

Here, the Weights and Bias properties contain the specified values. At training time, if these properties are non-empty, then the software uses the specified values as the initial weights and biases. In this case, the software does not use the initializer functions.

Suppose the size of the input is 28-by-28-by-28-by-1. Create a 3-D convolutional layer with 16 filters, each with a height of 6, a width of 4, and a depth of 5. Set the stride in all dimensions to 4.

Make sure the convolution covers the input completely. For the convolution to fully cover the input, the output dimensions must be integer numbers. When there is no dilation, the _i_-th output dimension is calculated as (imageSize(i) - filterSize(i) + padding(i)) / stride(i) + 1.

Construct the convolutional layer. Specify 'Padding' as a 2-by-3 matrix. The first row specifies prepadding and the second row specifies postpadding in the three dimensions.

layer = convolution3dLayer([6 4 5],16,'Stride',4,'Padding',[1 0 0;1 0 1])

layer = Convolution3DLayer with properties:

          Name: ''

Hyperparameters FilterSize: [6 4 5] NumChannels: 'auto' NumFilters: 16 Stride: [4 4 4] DilationFactor: [1 1 1] PaddingMode: 'manual' PaddingSize: [2×3 double] PaddingValue: 0

Learnable Parameters Weights: [] Bias: []

Show all properties

Algorithms

expand all

A convolutional layer applies sliding convolutional filters to the input. A 3-D convolutional layer extends the functionality of a 2-D convolutional layer to a third dimension, depth. The layer convolves the input by moving the filters along the input vertically, horizontally, and along the depth, computing the dot product of the weights and the input, and then adding a bias term. To learn more, see the definition of convolutional layer on the convolution2dLayer reference page.

The dimensions that the layer convolves over depends on the layer input:

Layers in a layer array or layer graph pass data to subsequent layers as formatted dlarray objects. The format of a dlarray object is a string of characters in which each character describes the corresponding dimension of the data. The format consists of one or more of these characters:

For example, you can describe 2-D image data that is represented as a 4-D array, where the first two dimensions correspond to the spatial dimensions of the images, the third dimension corresponds to the channels of the images, and the fourth dimension corresponds to the batch dimension, as having the format "SSCB" (spatial, spatial, channel, batch).

You can interact with these dlarray objects in automatic differentiation workflows, such as those for developing a custom layer, using a functionLayer object, or using the forward and predict functions withdlnetwork objects.

This table shows the supported input formats of Convolution3DLayer objects and the corresponding output format. If the software passes the output of the layer to a custom layer that does not inherit from the nnet.layer.Formattable class, or aFunctionLayer object with the Formattable property set to 0 (false), then the layer receives an unformatted dlarray object with dimensions ordered according to the formats in this table. The formats listed here are only a subset. The layer may support additional formats such as formats with additional "S" (spatial) or"U" (unspecified) dimensions.

Input Format Output Format
"SSSCB" (spatial, spatial, spatial, channel, batch) "SSSCB" (spatial, spatial, spatial, channel, batch)
"SSCBT" (spatial, spatial, channel, batch, time) "SSCBT" (spatial, spatial, channel, batch, time)
"SSSCBT" (spatial, spatial, spatial, channel, batch, time) "SSSCBT" (spatial, spatial, spatial, channel, batch, time)

In dlnetwork objects, Convolution3DLayer objects also support these input and output format combinations.

Input Format Output Format
"SSSC" (spatial, spatial, spatial, channel) "SSSC" (spatial, spatial, spatial, channel)
"SSCT" (spatial, spatial, channel, time) "SSCT" (spatial, spatial, channel, time)
"SSSCT" (spatial, spatial, spatial, channel, time) "SSSCT" (spatial, spatial, spatial, channel, time)

References

[1] Glorot, Xavier, and Yoshua Bengio. "Understanding the Difficulty of Training Deep Feedforward Neural Networks." In Proceedings of the Thirteenth International Conference on Artificial Intelligence and Statistics, 249–356. Sardinia, Italy: AISTATS, 2010. https://proceedings.mlr.press/v9/glorot10a/glorot10a.pdf

[2] He, Kaiming, Xiangyu Zhang, Shaoqing Ren, and Jian Sun. "Delving Deep into Rectifiers: Surpassing Human-Level Performance on ImageNet Classification." In 2015 IEEE International Conference on Computer Vision (ICCV), 1026–34. Santiago, Chile: IEEE, 2015. https://doi.org/10.1109/ICCV.2015.123

Version History

Introduced in R2019a