imat_fn/get_units_labels


Purpose

Get units labels for the supplied imat_fn.

Syntax

str=get_units_labels(f)
str=get_units_labels(f,type)
str=get_units_labels(f,type,'full')

Description

GET_UNITS_LABELS returns a cell array of strings the size of the input imat_fn F which contains the units label string for each of the functions. TYPE specifies which axis to return the units labels for. If an empty string is supplied, the default type will be used. The optional input string 'full' specifies whether to use the units abbreviations or their full names. Leaving this argument off uses abbreviations.

TYPE can be one of the following:

'abscissa' Abscissa
'ordinate' (default) Ordinate (numerator/denominator)
'ordnum' Ordinate numerator
'ordden' Ordinate denominator
'zaxis' Z Axis

Examples

>> f=imat_fn(1,'ordnumdatatype','acceleration');
>> setunits('in');
>> get_units_labels(f)

ans =
    'in/s^2'

>> get_units_labels(f,'ordinate','full')

ans =
    'inch/second^2'

>>

See Also

imat_shp/get_units_labels, imat_result/get_units_labels