iptcheckconn

Check validity of connectivity argument

Syntax

iptcheckconn(conn,func_name,var_name,arg_pos)

Description

iptcheckconn(conn,func_name,var_name,arg_pos) checks if conn is a valid pixel connectivity and issues a formatted error message if the connectivity is invalid.

• If the connectivity is valid, then iptcheckconn returns nothing. Valid connectivities are one of these scalar values: 1, 4, 6, 8, 18, or 26. A connectivity can also be a 3-by-3-by- ... -by-3 array of 0s and 1s. The central element of a connectivity array must be nonzero and the array must be symmetric about its center.

• If the connectivity is invalid, then iptcheckconn 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 pixel connectivity is valid.

Examples

Check Validity of 4-by-4 Matrix

Create a 4-by-4 array and pass it as the connectivity argument.

iptcheckconn(eye(4),'myfun','myvar',2)

eye(4) is not a valid pixel connectivity so iptcheckconn returns an error message:

Function MYFUN expected input number 2, myvar, to be a valid connectivity specifier. A nonscalar
connectivity specifier must be 3-by-3-by- ... -by-3.

Input Arguments

conn — Pixel connectivity

numeric scalar | numeric array

Pixel connectivity to check, specified as a numeric scalar or array.

Data Types: double | logical

func_name — Function name

character vector | string scalar

Function name to include in an error message when conn is an invalid pixel connectivity, 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 conn is an invalid pixel connectivity, 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 conn is an invalid pixel connectivity, specified as a numeric scalar.

Extended Capabilities

C/C++ Code Generation

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

Usage notes and limitations:

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

• When generating code, all input arguments must be compile-time constants.