# v_yticksi

## PURPOSE

V_YTIXKSI labels the y-axis of a plot using SI multipliers S=(AH)

## SYNOPSIS

function s=v_yticksi(ah)

## DESCRIPTION

    V_YTIXKSI labels the y-axis of a plot using SI multipliers S=(AH)

      Inputs:  AH       axis handle [default: current axes]

     Outputs:  S        optional global SI multiplier (see usage below)

     Usage:   (1) plot(...);
                  v_yticksi;

              (2) plot(...);
                  ylabel(['Frequency (' v_yticksi 'Hz)']);

     The first form will label the tick marks on the y-axis of the current plot
     using SI multipliers where appropriate. This is particularly useful for log
     plots which MATLAB does not label very well.
     The second form will, if possible, use a single SI multiplier for all the tick
     marks; this global multiplier can be incorporated into the axis label as shown.

## CROSS-REFERENCE INFORMATION

This function calls:

- v_xyzticksi V_XYZTIXKSI labels an axis of a plot using SI multipliers S=(AX,AH)

This function is called by:

- v_bark2frq V_BARK2FRQ Convert the BARK frequency scale to Hertz FRQ=(BARK)
- v_cent2frq V_FRQ2ERB Convert Hertz to Cents frequency scale [C,CR]=(FRQ)
- v_correlogram V_CORRELOGRAM calculate correlogram [y,ty]=(x,inc,nw,nlag,m,fs)
- v_erb2frq V_ERB2FRQ Convert ERB frequency scale to Hertz FRQ=(ERB)
- v_frq2bark V_FRQ2BARK Convert Hertz to BARK frequency scale BARK=(FRQ)
- v_frq2cent V_FRQ2ERB Convert Hertz to Cents frequency scale [C,CR]=(FRQ)
- v_frq2erb V_FRQ2ERB Convert Hertz to ERB frequency scale ERB=(FRQ)
- v_frq2mel V_FRQ2ERB Convert Hertz to Mel frequency scale MEL=(FRQ)
- v_mel2frq V_MEL2FRQ Convert Mel frequency scale to Hertz FRQ=(MEL)
- v_phon2sone V_PHON2SONE convert PHON loudness values to SONEs s=(p)
- v_spgrambw V_SPGRAMBW Draw spectrogram [T,F,B]=(s,fs,mode,bw,fmax,db,tinc,ann)

## SOURCE CODE

    0001 function s=v_yticksi(ah)
    0002 %V_YTIXKSI labels the y-axis of a plot using SI multipliers S=(AH)
    0003 %
    0004 %  Inputs:  AH       axis handle [default: current axes]
    0005 %
    0006 % Outputs:  S        optional global SI multiplier (see usage below)
    0007 %
    0008 % Usage:   (1) plot(...);
    0009 %              v_yticksi;
    0010 %
    0011 %          (2) plot(...);
    0012 %              ylabel(['Frequency (' v_yticksi 'Hz)']);
    0013 %
    0014 % The first form will label the tick marks on the y-axis of the current plot
    0015 % using SI multipliers where appropriate. This is particularly useful for log
    0016 % plots which MATLAB does not label very well.
    0017 % The second form will, if possible, use a single SI multiplier for all the tick
    0018 % marks; this global multiplier can be incorporated into the axis label as shown.
    0019
    0020 %       Copyright (C) Mike Brookes 2009
    0021 %      Version: $Id: v_yticksi.m 10865 2018-09-21 17:22:45Z dmb $
    0022 %
    0023 %   VOICEBOX is a MATLAB toolbox for speech processing.
    0024 %   Home page: http://www.ee.ic.ac.uk/hp/staff/dmb/voicebox/voicebox.html
    0025 %
    0026 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
    0027 %   This program is free software; you can redistribute it and/or modify
    0028 %   it under the terms of the GNU Lesser General Public License as published by
    0029 %   the Free Software Foundation; either version 3 of the License, or
    0030 %   (at your option) any later version.
    0031 %
    0032 %   This program is distributed in the hope that it will be useful,
    0033 %   but WITHOUT ANY WARRANTY; without even the implied warranty of
    0034 %   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    0035 %   GNU Lesser General Public License for more details.
    0036 %
    0037 %   You can obtain a copy of the GNU Lesser General Public License from
    0038 %   https://www.gnu.org/licenses/ .
    0039 %
    0040 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
    0041 if ~nargin
    0042     ah=gca;
    0043 end
    0044 if nargout
    0045 s=v_xyzticksi(2,ah);
    0046 else
    0047     v_xyzticksi(2,ah);
    0048 end