Custom Labeling Functions - MATLAB & Simulink - MathWorks United Kingdom (2024)

• The first input argument, x, is the input signal. When writing the function, expect x to be a matrix where each column contains data corresponding to a channel. If the channels have different lengths, then expect x to be a cell array of column vectors.

• The second input argument, t, stores the time values. When writing the function, expect t to be a matrix where each column contains time information corresponding to a channel. If the channels have different lengths, then expect t to be a cell array of column vectors.

  Note

  • For single-channel members, custom autolabeling functions get data and time values as double-precision vectors.

  • For multichannel members, custom autolabeling functions get data and time values as matrices or cell arrays.

  • Custom autolabeling functions get all the channels of a member as input, but they do not have to operate on all. You can choose which channels you want the function to operate on.

• The third input argument, parentLabelVal, is the parent label value associated with the output sublabel and contains a numeric, logical, or string scalar. This argument is passed in only for functions that automate the labeling of sublabels. If the function is for a parent label, expect parentLabelVal to be empty.

• The fourth input argument, parentLabelLoc, contains:

  • An empty vector when the parent label is an attribute

  • A two-element numeric row vector of region of interest (ROI) limits when the parent label is an ROI

  • A numeric scalar representing a point location when the parent label is a point

  This argument is passed in only for functions that automate the labeling of sublabels. If the function is for a parent label, expect parentLabelLoc to be empty.

  Note

  • For parent labels, the autolabeling function operates on each selected member.

  • For sublabels, the autolabeling function operates on one parent label instance at a time for each selected member.

  See Also

  Add text descriptions to data pointsPlotting Specific Points in Matlab - A Detailed Guide and Its Applications2-D line plot - MATLAB plotLabel Graph Nodes and Edges - MATLAB & Simulink - MathWorks Deutschland

• Use varargin to specify additional input arguments. If you do not have additional input arguments, you can omit varargin. Enter the additional arguments as an ordered comma-separated list in the dialog box that appears when you click the Auto-Label button.

• The first output argument, labelVals, contains the label values. labelVals must be:

  • A numeric, logical, or string scalar when the output labels are attributes

  • A column vector with numeric, logical, or string values when the output labels are ROIs or points

• The second output argument, labelLocs, contains the label locations. labelLocs must be:

  • An empty vector when the output labels are attributes

  • A two-column matrix of ROI limits when the output labels are ROIs

  • A column vector of point locations when the output labels are points

• To implement your algorithm, you can use any function from MATLAB^® or from any toolbox installed in your system.

• Name — Specify the name of the function you want to add.

• Description — Add a short description of what the function does and describe the optional input arguments.

• Label Type — Specify the type of label that the function generates. Select Attribute (the default), ROI, or Point.

  Note

  Based on the Label Type you specify, Signal Labeler places the function in the appropriate category in the Automate Value gallery. When you select a label definition, the gallery enables only those functions that can be used with that definition type.

Note

Using the Manage Custom Functions option changes only the function descriptions displayed in the Automate Value gallery. If you want to change the description in the file that contains the function, you must edit the file.