Simulink.ImageType

Specify image data type

Since R2021b

Description

Use a Simulink.ImageType object to set and share image data types for signal, state, and parameter data in a model.

1. Create an instance of this class in the MATLAB^® base workspace.

2. Set the properties of the object to describe the image.

3. Assign the data type to supported blocks, which have a Data type parameter, that you want to conform to the data type.

The benefits of the Simulink.ImageType data type include:

• Strong typing of image data at model interfaces.

• Carrying image data attributes such as color format and pixel data type, eliminating the need to create and maintain secondary signals.

• Enabling the Simulink^® environment to interpret the data as an image.

• Enabling custom data type replacement with third party implementation, such as the OpenCV class cv::Mat.

Note

To simulate a model that contains Simulink.ImageType signal, set the model configuration parameter Language (SimTargetLang) to C++.

Creation

To create a Simulink.NumericType object programmatically, use the Simulink.NumericType function described below.

Syntax

imageType = Simulink.ImageType

imageType = Simulink.ImageType(Rows,Columns,Channels)

imageType = Simulink.ImageType(Rows,Columns,Channels,'ClassUnderlying',ClassUnderlying,'ColorFormat',ColorFormat,'Layout',Layout)

Description

imageType = Simulink.ImageType returns a Simulink.Parameter object with default property values.

imageType = Simulink.ImageType(Rows,Columns,Channels) returns a Simulink.ImageType object and initializes the Rows, Columns, and Channels property to the specified values.

imageType = Simulink.ImageType(Rows,Columns,Channels,'ClassUnderlying',ClassUnderlying,'ColorFormat',ColorFormat,'Layout',Layout) returns a Simulink.ImageType object and additionally initializes the optional properties ClassUnderlying, ColorFormat, and Layout to the specified values.

Properties

Rows — Number of rows in image data

480 (default) | positive integer

Number of rows in the image data, specified as a positive integer.

Example: 480

Data Types: double

Columns — Number of columns in image data

640 (default) | positive integer

Number of columns in the image data, specified as a positive integer.

Example: 640

Data Types: double

Channels — Number of color channels or samples for each pixel in array

3 (default) | 1 | 4

Number of color channels or samples for each pixel in the array, specified as 1, 3, or 4. The number of channels must correspond to the number of color channels in the color format of the image data. These are the values of Channels for the supported color formats:

Color Format	Channels
Grayscale	1
RGB	3
BGR	3
BGRA	4

Example: 3

Data Types: double

ClassUnderlying — Data type of underlying image data

'uint8' (default) | 'int8' | 'uint16' | 'int16' | 'uint32' | 'int32' | 'single' | 'double' | 'boolean'

Data type of the underlying image data, specified as one of these values:

• 'uint8'

• 'int8'

• 'uint16'

• 'int16'

• 'uint32'

• 'int32'

• 'single'

• 'double'

• 'boolean'

Example: 'uint8'

Data Types: char | string

ColorFormat — Color format of underlying image data

'RGB' (default) | 'Grayscale' | 'BGR' | 'BGRA'

Color format of the underlying image data, specified as 'RGB', 'Grayscale', 'BGR', or 'BGRA'. The color format determines what each color channel of a pixel in the image represents.

Example: 'RGB'

Data Types: char | string

Layout — Memory arrangement of matrix data in image

'ColumnMajor' (default) | 'RowMajor'

Memory arrangement of the matrix data in the image, specified as 'ColumnMajor' or 'RowMajor'.

Example: 'ColumnMajor'

Data Types: char | string

Examples

Configure Data as Simulink.ImageType Data Type

1. Create a Simulink.ImageType object with default values.

   imageType = Simulink.ImageType;

   imageType = 
   
     ImageType with properties:
   
                  Rows: 480
                  Cols: 640
              Channels: 3
       ClassUnderlying: 'uint8'
           ColorFormat: 'RGB'
                Layout: 'ColumnMajor'

2. Set the properties of the object to describe the image.

   imageType.Rows = 720
   imageType.Cols = 860

   You can then reference this object from supported blocks that have a Data type field parameter.

Limitations

These blocks support simulation and code generation of a Simulink.ImageType object:

Block Library	Block Name
Sources	Ground (Simulink) From Multimedia File
Signal Routing	Goto (Simulink) From (Simulink) Data Store Read (Simulink) Data Store Write (Simulink) Data Store Memory (Simulink) Switch (Simulink) Multiport Switch (Simulink) Merge (Simulink) Variant Source (Simulink) Variant Merge (internal block added during code generation) Mux (Simulink) Demux (Simulink) Vector Concatenate, Matrix Concatenate (Simulink) Selector (Simulink)
Sinks	Terminator (Simulink) To Workspace (Simulink) (simulation only) Record (Simulink) (simulation only) Video Viewer (simulation only)
Ports & Subsystems	Inport (Simulink) Outport (Simulink) Subsystem (Simulink) Enabled Subsystem (Simulink) Triggered Subsystem (Simulink) Function-Call Subsystem (Simulink) Resettable Subsystem (Simulink) For Iterator Subsystem (Simulink) Model (Simulink)
Discrete	Unit Delay (Simulink)
Signal Attributes	Signal Conversion (Simulink) Signal Specification (Simulink)
User-Defined Functions	Initialize Function (Simulink) Reset Function (Simulink) Terminate Function (Simulink) Simulink Function (Simulink) block with side I/O and arguments

Extended Capabilities

C/C++ Code Generation

Generate C and C++ code using MATLAB® Coder™.

Usage notes and limitations:

• Supports C++ code generation. To generate code, set the model configuration parameter Language (TargetLang) to C++ and the Language standard to C++11 (ISO).

Version History

Introduced in R2021b