iptcheckinput

Check validity of array

iptcheckinput will be removed in a future release. Use validateattributes instead.

Syntax

iptcheckinput(A,valid_classes,valid_attributes, func_name,var_name,arg_pos)

Description

iptcheckinput(A,valid_classes,valid_attributes, func_name,var_name,arg_pos) checks the validity of the input array A and issues a formatted error message if the array is invalid.

• If the array has valid class and attributes as specified by valid_classes and valid_attributes, then iptcheckinput returns nothing.

• If the class or attributes are invalid, then iptcheckinput 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 iptcheckinput arguments.

Examples

Trigger Error When Array Is Not 2-D

To trigger this error message, create a 3-D array and then check for the attribute '2d'. C is not 2-D so iptcheckinput returns an error message.

A = [ 1 2 3; 4 5 6 ];
B = [ 7 8 9; 10 11 12];
C = cat(3,A,B);
iptcheckinput(C,{'numeric'},{'2d'},'func_name','var_name',2)

Function FUNC_NAME expected its second input, var_name, to be two-dimensional.

Input Arguments

A — Input array

array | ...

Input array, specified as an array.

valid_classes — Valid classes

cell array of character vectors

Valid classes of array A, specified as a cell array of character vectors. The tables list common classes for image processing applications.

Numeric Classes

int8	uint8	single
int16	uint16	double
int32	uint32
int64	uint64

Other Common Classes

categorical	char	cell
function_handle	logical	string
struct	table

You can use 'numeric' as an abbreviation for the set of classes uint8, uint16, uint32, int8, int16, int32, single, and double.

Example: {'logical' 'cell'} specifies that a valid array must be a logical array or a cell array.

valid_attributes — Valid attributes

{} | cell array of character vectors

Valid attributes of array A, specified as a cell array of character vectors. The table lists the supported attributes in alphabetical order.

2d	column	even	finite
integer	nonempty	nonnan	nonnegative
nonsparse	nonzero	odd	positive
real	row	scalar	twod
vector

If you specify valid_attributes as the empty cell array {}, then iptcheckinput does not check the attributes of A.

Example: {'real' 'nonempty' 'finite'} specifies that a valid array must be real and nonempty and contain only finite values.

func_name — Function name

character vector | string scalar

Function name to include in an error message when A is an invalid array, 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 A is an invalid array, 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 A is an invalid array, specified as a positive integer.

Version History

Introduced before R2006a