iptcheckmap

Check validity of colormap

Syntax

iptcheckmap(map,func_name,var_name,arg_pos)

Description

iptcheckmap(map,func_name,var_name,arg_pos) checks the validity of the colormap map and issues a formatted error message if the colormap is invalid.

• If the colormap is valid, then iptcheckmap returns nothing.

• If the colormap is invalid, then iptcheckmap issues a formatted error message that includes information about the function name (func_name), the variable name (var_name), and the argument position (arg_pos). These values are used only to create the error message, not to check whether the array is valid.

The figure shows the format of the error message and indicates which parts you can customize using iptcheckmap arguments.

Examples

Trigger Error For Invalid Colormap

bad_map = ones(10);
iptcheckmap(bad_map,"myfun","var_name",2)

Function MYFUN expected input number 2, var_name, to be a valid colormap. Valid
colormaps must be nonempty, double, 2-D matrices with 3 columns.

Input Arguments

map — Colormap

numeric array

Colormap, specified as a numeric array.

func_name — Function name

character vector | string scalar

Function name to include in an error message when map is an invalid colormap, specified as a character vector or string scalar.

Data Types: char | string

var_name — Variable name

character vector | string scalar

Variable name to include in an error message when map is an invalid colormap, specified as a character vector or string scalar.

Data Types: char | string

arg_pos — Argument position

positive integer

Argument position to include in an error message when map is an invalid colormap, specified as a positive integer.

Extended Capabilities

C/C++ Code Generation

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

iptcheckmap supports the generation of C code (requires MATLAB^® Coder™). For more information, see Code Generation for Image Processing.

Version History

Introduced before R2006a