complexConvolution1dLayer
R2026bDescription
A complex 1-D convolutional layer applies sliding complex convolutional filters to 1-D input. The layer convolves the input by first moving the filters along the input and computing the dot product of the weights and the input, and then adding a bias term.
The dimension that the layer convolves over depends on the layer input:
For time series and vector sequence input (data with three dimensions corresponding to the channels, observations, and time steps), the layer convolves over the time dimension.
For 1-D image input (data with three dimensions corresponding to the spatial pixels, channels, and observations), the layer convolves over the spatial dimension.
For 1-D image sequence input (data with four dimensions corresponding to the spatial pixels, channels, observations, and time steps), the layer convolves over the spatial dimension.
Creation
Syntax
Description
creates a complex 1-D convolutional layer and sets the layer = complexConvolution1dLayer(filterSize,numFilters)FilterSize and NumFilters properties.
specifies additional options using one or more name-value arguments. For example,
layer = complexConvolution1dLayer(filterSize,numFilters,Name=Value)complexConvolution1dLayer(filterSize,numFilters,Padding=1) specifies
padding of size 1 on the left and right of the layer input.
Input Arguments
Width of the filters, specified as a positive integer.
This argument sets the FilterSize property.
Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64
Number of filters, specified as a positive integer. This number determines the number of channels (feature maps) in the layer output.
This argument sets the NumFilters property.
Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64
Name-Value Arguments
Specify optional pairs of arguments as
Name1=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.
Example: complexConvolution1dLayer(11,96,Padding=1) creates a
complex 1-D convolutional layer with 96 filters of size 11, and specifies padding of size
1 on the left and right of the layer input.
Step size for traversing the input, specified as a positive integer.
This argument sets the Stride property.
Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64
Factor for dilated convolution (also known as atrous convolution), specified as a positive integer.
Use dilated convolutions to increase the receptive field (the area of the input that 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 (FilterSize –
1) .* DilationFactor + 1. For example, a 1-by-3 filter with a dilation factor
of 2 is equivalent to a 1-by-5 filter with zeros between the
elements.
This argument sets the DilationFactor property.
Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64
Padding to apply to the input, specified as one of the following:
"same"— Apply padding such that the output size isceil(inputSize/Stride), whereinputSizeis the length of the input. WhenStrideis1, the output is the same size as the input."causal"— Apply left padding to the input, equal to(FilterSize - 1) .* DilationFactor. WhenStrideis1, the output is the same size as the input.Nonnegative integer scalar
sz— Add padding of sizeszto both ends of the input.Vector
[l r]of nonnegative integers — Add padding of sizelto the left of the input andrto the right of the input.
This argument sets the PaddingSize and PaddingMode properties.
Example: Padding=[2 1] adds padding of size 2 to the left of
the input and size 1 to the right of the input.
Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | char | string
Value with which to pad the input data, specified as one of these values:
PaddingValue | Description | Example |
|---|---|---|
| Scalar | Pad with the specified scalar value. |
|
"symmetric-include-edge" | Pad using mirrored values of the input, including the edge values. |
|
"symmetric-exclude-edge" | Pad using mirrored values of the input, excluding the edge values. |
|
"replicate" | Pad using repeated border elements of the input. |
|
This argument sets the PaddingValue property.
Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | char | string
Complex Number Support: Yes
Number of input channels, specified as one of these values:
"auto"— Automatically determine the number of input channels at training time.Positive integer — Configure the layer for the specified number of input channels.
NumChannelsand the number of channels in the layer input data must match. For example, if the input is an RGB image, thenNumChannelsmust be 3. If the input is the output of a convolutional layer with 16 filters, thenNumChannelsmust be 16.
This argument sets the NumChannels property.
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:
"complex-glorot-normal"– Initialize the weights with the complex normal Glorot initializer [1]. The complex normal Glorot initializer independently samples real and imaginary parts of the weights from a normal distribution with zero mean and variance1/(numIn + numOut)."complex-glorot-uniform-square"– Initialize the weights with the complex uniform square Glorot initializer [1]. The complex uniform square Glorot initializer independently samples real and imaginary parts of the weights from a uniform distribution in the interval(-sqrt(3/(numIn + numOut)), sqrt(3/(numIn + numOut)))."complex-he-normal"– Initialize the weights with the complex normal He initializer [1]. The complex normal He initializer samples real and imaginary parts of the weights from a normal distribution with zero mean and variance1/numIn."complex-he-uniform-square"– Initialize the weights with the complex uniform square He initializer [1]. The complex uniform square He initializer samples real and imaginary parts of the weights from a uniform distribution in the interval(-sqrt(3/numIn), sqrt(3/numIn))."complex-narrow-normal"— Initialize the real and imaginary parts of the weights by independently sampling from a normal distribution with a mean of zero and a variance of1e-4/2, such that the total variance is1e-4."zeros"– Initialize the weights with a real array of zeros."ones"– Initialize the weights with a real array of ones.Function handle — Initialize the weights with a custom function. If you specify a function handle, then the function syntax must be of the form
weights = func(sz), whereszis the size of the weights. For an example, see Specify Custom Weight Initialization Function.
Here, numIn = FilterSize*NumChannels and
numOut = FilterSize*NumFilters.
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:
"zeros"— Initialize the biases with zeros."ones"— Initialize the biases with ones."complex-narrow-normal"— Initialize the real and imaginary parts of the weights by independently sampling from a normal distribution with a mean of zero and a variance of1e-4/2, such that the total variance is1e-4.Function handle — Initialize the biases with a custom function. If you specify a function handle, then the function must have the form
bias = func(sz), whereszis the size of the biases.
The layer only initializes the biases when the Bias
property is empty.
Data Types: char | string | function_handle
Layer weights for the convolution operation, specified as a
FilterSize-by-NumChannels-by-NumFilters
numeric array or [].
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.
This argument sets the Weights property.
Data Types: single | double
Complex Number Support: Yes
Layer biases for the convolution operation, specified as a
1-by-NumFilters numeric array or [].
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. If
Bias is empty, then software uses the initializer
specified by the BiasInitializer property.
This argument sets the Bias property.
Data Types: single | double
Complex Number Support: Yes
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.
This argument sets the WeightLearnRateFactor property.
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.
This argument sets the BiasLearnRateFactor property.
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, if WeightL2Factor 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.
This argument sets the WeightL2Factor property.
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.
This argument sets the BiasL2Factor property.
Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64
Properties
1-D Convolution
This property is read-only after object creation. To set this property, use the corresponding
positional input argument when you create the ComplexConvolution1DLayer
object.
Width of the filters, specified as a positive integer.
Data Types: double
This property is read-only after object creation. To set this property, use the corresponding
positional input argument when you create the ComplexConvolution1DLayer
object.
Number of filters, specified as a positive integer. This number determines the number of channels (feature maps) in the layer output.
Data Types: double
Step size for traversing the input, specified as a positive integer.
If the stride size is less than the pooling window size, then the pooling regions overlap.
Data Types: double
Factor for dilated convolution (also known as atrous convolution), specified as a positive integer.
Use dilated convolutions to increase the receptive field (the area of the input that 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 (FilterSize –
1) .* DilationFactor + 1. For example, a 1-by-3 filter with a dilation factor
of 2 is equivalent to a 1-by-5 filter with zeros between the
elements.
The ComplexConvolution1DLayer object stores this property as double
type.
Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64
Size of padding to apply to each side of the input, specified as a vector
[l r] of two nonnegative integers, where l is
the padding applied to the left and r is the padding applied to the
right. To use the same value for both the left and right sizes, you can also specify a
scalar value.
When you create a layer, use the Padding
name-value argument to specify the padding size.
Data Types: double
This property is read-only after object creation. To set this property, use the
Padding name-value argument when you create the
ComplexConvolution1DLayer object.
Method to determine padding size, specified as one of the following:
'manual'– Pad using the integer or vector specified byPadding.'same'– Apply padding such that the output size isceil(inputSize/Stride), whereinputSizeis the length of the input. WhenStrideis1, the output is the same as the input.'causal'– Apply causal padding. Pad the left of the input with padding size(FilterSize - 1) .* DilationFactor.
Data Types: char
This property is read-only after object creation. To set this property, use the corresponding
name-value argument when you create the ComplexConvolution1DLayer object.
Value to pad data, specified as one of these values:
PaddingValue | Description | Example |
|---|---|---|
| Scalar | Pad with the specified scalar value. | |
"symmetric-include-edge" | Pad using mirrored values of the input, including the edge values. | |
"symmetric-exclude-edge" | Pad using mirrored values of the input, excluding the edge values. | |
"replicate" | Pad using repeated border elements of the input. |
The ComplexConvolution1DLayer object stores this property as a character vector or double type.
Data Types: double | char
This property is read-only after object creation. To set this property, use the corresponding
name-value argument when you create the ComplexConvolution1DLayer object.
Number of input channels, specified as one of these values:
"auto"— Automatically determine the number of input channels at training time.Positive integer — Configure the layer for the specified number of input channels.
NumChannelsand the number of channels in the layer input data must match. For example, if the input is an RGB image, thenNumChannelsmust be 3. If the input is the output of a convolutional layer with 16 filters, thenNumChannelsmust be 16.
The ComplexConvolution1DLayer object stores this property as a character vector or double type.
Data Types: double | char
Parameters and Initialization
Function to initialize the weights, specified as one of the following:
"complex-glorot-normal"– Initialize the weights with the complex normal Glorot initializer [1]. The complex normal Glorot initializer independently samples real and imaginary parts of the weights from a normal distribution with zero mean and variance1/(numIn + numOut)."complex-glorot-uniform-square"– Initialize the weights with the complex uniform square Glorot initializer [1]. The complex uniform square Glorot initializer independently samples real and imaginary parts of the weights from a uniform distribution in the interval(-sqrt(3/(numIn + numOut)), sqrt(3/(numIn + numOut)))."complex-he-normal"– Initialize the weights with the complex normal He initializer [1]. The complex normal He initializer samples real and imaginary parts of the weights from a normal distribution with zero mean and variance1/numIn."complex-he-uniform-square"– Initialize the weights with the complex uniform square He initializer [1]. The complex uniform square He initializer samples real and imaginary parts of the weights from a uniform distribution in the interval(-sqrt(3/numIn), sqrt(3/numIn))."complex-narrow-normal"— Initialize the real and imaginary parts of the weights by independently sampling from a normal distribution with a mean of zero and a variance of1e-4/2, such that the total variance is1e-4."zeros"– Initialize the weights with a real array of zeros."ones"– Initialize the weights with a real array of ones.Function handle — Initialize the weights with a custom function. If you specify a function handle, then the function syntax must be of the form
weights = func(sz), whereszis the size of the weights. For an example, see Specify Custom Weight Initialization Function.
Here, numIn = FilterSize*NumChannels and
numOut = FilterSize*NumFilters.
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:
"zeros"— Initialize the biases with zeros."ones"— Initialize the biases with ones."complex-narrow-normal"— Initialize the real and imaginary parts of the weights by independently sampling from a normal distribution with a mean of zero and a variance of1e-4/2, such that the total variance is1e-4.Function handle — Initialize the biases with a custom function. If you specify a function handle, then the function must have the form
bias = func(sz), whereszis the size of the biases.
The layer only initializes the biases when the Bias property
is empty.
Data Types: char | string | function_handle
Layer weights for the convolution operation, specified as a
FilterSize-by-NumChannels-by-NumFilters
numeric array or [].
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.
Data Types: single | double
Complex Number Support: Yes
Layer biases for the convolution operation, specified as a
1-by-NumFilters numeric array or [].
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. If Bias is
empty, then software uses the initializer specified by the BiasInitializer property.
Data Types: single | double
Complex Number Support: Yes
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: double
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.
The ComplexConvolution1DLayer object stores this property as double
type.
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, if WeightL2Factor 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: double
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.
The ComplexConvolution1DLayer object stores this property as double
type.
Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64
Layer
This property is read-only.
Number of inputs to the layer, represented as 1. This layer has a
single input only.
Data Types: double
This property is read-only.
Input name, represented as {'in'}. This layer has a single input
only.
This property is read-only.
Number of outputs from the layer, represented as 1. This layer has
a single output only.
Data Types: double
This property is read-only.
Output name, represented as {'out'}. This layer has a single output
only.
Examples
Create a complex 1-D convolutional layer with 96 filters of width 11 and the name "complex-conv1d".
layer = complexConvolution1dLayer(11,96,Name="complex-conv1d")layer =
ComplexConvolution1DLayer with properties:
Name: 'complex-conv1d'
Hyperparameters
FilterSize: 11
NumChannels: 'auto'
NumFilters: 96
Stride: 1
DilationFactor: 1
PaddingMode: 'manual'
PaddingSize: [0 0]
PaddingValue: 0
Learnable Parameters
Weights: []
Bias: []
Show all properties
Algorithms
Complex 1-D convolutional layers support real-valued and complex-valued inputs. The output is always complex, even if the inputs, weights, and biases are real.
A complex 1-D convolutional layer applies sliding complex convolutional filters to 1-D input. The layer convolves the input by moving the filters along the input and computing the dot product of the weights and the input, then adding a bias term.
The dimension that the layer convolves over depends on the layer input:
For time series and vector sequence input (data with three dimensions corresponding to the channels, observations, and time steps), the layer convolves over the time dimension.
For 1-D image input (data with three dimensions corresponding to the spatial pixels, channels, and observations), the layer convolves over the spatial dimension.
For 1-D image sequence input (data with four dimensions corresponding to the spatial pixels, channels, observations, and time steps), the layer convolves over the spatial dimension.
Most 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:
"S"— Spatial"C"— Channel"B"— Batch"T"— Time"U"— Unspecified
For example, you can represent vector sequence data as a 3-D array, in which the first
dimension corresponds to the channel dimension, the second dimension corresponds to the
batch dimension, and the third dimension corresponds to the time dimension. This
representation is in the format "CBT" (channel, batch, time).
You can interact with these dlarray objects in automatic differentiation
workflows, such as those for:
developing a custom layer
using a
functionLayerobjectusing the
forwardandpredictfunctions withdlnetworkobjects
This table shows the supported input formats of ComplexConvolution1DLayer 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 to
a FunctionLayer 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 of the formats that the layer supports. The
layer might support additional formats, such as formats with additional
"S" (spatial) or "U" (unspecified)
dimensions.
| Input Format | Output Format |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
References
[1] Barrachina, Jose Agustin, Chengfang Ren, Gilles Vieillard, Christelle Morisseau, and Jean-Philippe Ovarlez. "Theory and Implementation of Complex-Valued Neural Networks". Preprint, submitted February 16, 2023. https://arxiv.org/abs/2302.08286
[2] Trabelsi, Chiheb, Olexa Bilaniuk, Ying Zhang, Dmitriy Serdyuk, Sandeep Subramanian, João Felipe Santos, Soroush Mehri, Negar Rostamzadeh, Yoshua Bengio, and Christopher J Pal. "Deep Complex Networks". Preprint, submitted February 25, 2018. https://arxiv.org/abs/1705.09792.
Version History
Introduced in R2026b
MATLAB Command
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.
选择网站
选择网站以获取翻译的可用内容,以及查看当地活动和优惠。根据您的位置,我们建议您选择:。
您也可以从以下列表中选择网站:
如何获得最佳网站性能
选择中国网站(中文或英文)以获得最佳网站性能。其他 MathWorks 国家/地区网站并未针对您所在位置的访问进行优化。
美洲
- América Latina (Español)
- Canada (English)
- United States (English)
欧洲
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)