addImages

R2026b

Add new images to image index

Syntax

addImages(imageIndex,imds)

addImages(imageIndex,I,imageId)

addImages(___,Name=Value)

Description

addImages(imageIndex,imds) adds the images in imds to imageIndex.

addImages(imageIndex,I,imageId) adds an image, I, to imageIndex, specified by the image identifier imageId.

addImages(___,Name=Value) specifies options using one or more name-value arguments in addition to any combination of input arguments from previous syntaxes.

Examples

Add Image to Image Index

Define a set of images to search

imageFiles = ...
  {'elephant.jpg', 'cameraman.tif', ...
   'peppers.png',  'saturn.png',...
   'pears.png',    'stapleRemover.jpg', ...
   'football.jpg', 'mandi.tif', ...
   'kids.tif',     'liftingbody.png', ...
   'office_5.jpg', 'gantrycrane.png', ...
   'moon.tif',     'circuit.tif', ...
   'tape.png',     'coins.png'};

imds = imageDatastore(imageFiles);

Learn the visual vocabulary of the image view set.

numlevels = 1;
branchingFactor = 1000;
bag = bagOfFeatures(imds,'PointSelection','Detector', ...
        'TreeProperties',[numlevels,branchingFactor],'Verbose',false);

Create an image search index.

imageIndex = invertedImageIndex(bag);

Add to the image view set images to the image search index.

addImages(imageIndex,imds);

Encoding images using Bag-Of-Features.
--------------------------------------

* Encoding 16 images...done.

Input Arguments

imageIndex — Image search index

invertedImageIndex object

Image search index, specified as an invertedImageIndex object.

imds — Images

ImageDatastore object

Images, specified as an ImageDatastore object. imds contains new images to add to an existing index. The function does not ignore duplicate images.

I — Input image

M-by-N-by-3 array | M-by-N 2-D matrix

Input image, specified as either an M-by-N-by-3 array, representing a truecolor image, or an M-by-N array, representing a 2-D grayscale image.

imageId — Indexed image identifier

positive integer

Indexed image identifier, specified as an positive integer.

Name-Value Arguments

Example: UseParallel="auto"

Verbose — Display progress information

true (default) | false

Display progress information, specified as a logical scalar. By default, the addImages function displays progress information. To hide the display, specify this argument as false.

UseParallel — Option to perform computations in parallel

"off" (default) | "auto" | "on"

Since R2026b

Option to perform computations in parallel using a parallel pool of workers, specified as one of these values:

• "off" — Run in serial on the MATLAB client.

• "auto" — Use a parallel pool if one is open or if MATLAB can automatically create one. If a parallel pool is not available, run in serial on the MATLAB client.

• "on" — Use a parallel pool if one is open or if MATLAB can automatically create one. If a parallel pool is not available, throw an error.

If you do not have a parallel pool open and automatic pool creation is enabled, MATLAB opens a pool using the default cluster profile. Using parallel computing requires Parallel Computing Toolbox™. For more information, see Run MATLAB Functions with Automatic Parallel Support (Parallel Computing Toolbox).

Data Types: char | string

Tips

• The addImages function supports parallel computing using multiple MATLAB^® workers. Enable parallel computing from the Computer Vision Toolbox Preferences dialog box. To open Computer Vision Toolbox™ preferences, on the Home tab, in the Environment section, select Preferences. Then select Computer Vision Toolbox.

Extended Capabilities

C/C++ Code Generation

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

Usage notes and limitations:

For code generation, the addImages object does not support the ImageDatastore object as input. Instead, specify the input as a structure with fields Images and Locations. The Images field must contain a cell array of grayscale or RGB color images. The Locations field must contain a cell array of the file paths to the locations of input images.

GPU Code Generation

Generate CUDA® code for NVIDIA® GPUs using GPU Coder™.

Refer to the usage notes and limitations in the C/C++ Code Generation section. The same usage notes and limitations apply to GPU code generation.

Automatic Parallel Support

Accelerate code by automatically running computation in parallel using Parallel Computing Toolbox™.

addImages has automatic parallel support.

To run computations in parallel, set the UseParallel argument to "on" or "auto".

For more information, see Run MATLAB Functions with Automatic Parallel Support (Parallel Computing Toolbox).

Version History

Introduced in R2015a

R2026b: New UseParallel name-value argument

The addImages function now supports the UseParallel name-value argument to control parallel execution. Set UseParallel to "on" or "auto" to run computations in parallel.