Documentation of regress_eof

Global Index (short | long) | Local contents | Local Index (short | long)

Function Synopsis

[out, ccoef] = regress_eof(temp, pcs, lags);

Help text


  [out, ccoef] = regress_eof(dat, pcs, lags);

  Here 'dat' refers to the variable to regress onto 'pcs'.

  The variable 'lags' refers to a vector of leads/lags, where
    -1 refers to 'dat' leading 'pcs', and +1 refers to 'pcs'
    leading 'dat'.

Cross-Reference Information

This function calls	This function is called by
remove_mean timeseries	regress_flux get_ubar_gradtprime get_uprime_gradtbar plot_60s60n_terms eq_tend_terms eq_tend_terms2 figure1 lagged_correlation lagged_regressions regress_velocity wbar_dtpdz_hc0-80 get_hctend_terms get_hp_hctend_terms get_hctend_terms plot_lp_pac_regressions plot_regressions eq_tend_terms eq_tend_terms2 calc_eq_tend_terms eq_tend_terms eq_tend_terms2 get_hctend_terms plot_30s30n_EOF_regressions plot_30s30n_regressions plot_30s30n_terms plot_ceof_heat_sft plot_wbtp_tcline_reg tcline_regression eq_tend_terms plot_ceof_heat_sft pdo_statistics cartoon2 gu_philander ml_slp_pcs_ppcs_2 annular_mode calc_eq_tend_terms cartoon2 check_atl_trop_vwnd check_pac_trop_vwnd compare_eof_regions cospectrum coup_run_stats ct_lpct_regs ct_seasonal eof_height eof_sst eof_sst_slp eq_tend_terms eq_tend_terms2 eq_tend_terms3 fig1 figure1 flux_sst_corr get_dhcdt get_flux_terms get_hctend_terms get_hp_flux_terms get_hp_hctend_terms get_NAO get_ubar_gradtprime get_ubtp get_udtdx get_uprime_gradtbar get_uptb get_vdtdy get_wbar_dtprimedz get_wbtp get_wdtdz get_windstress get_wprime_dtbardz get_wptb gu_philander gu_philander2 gu_philander3 gu_philander4 gu_philander5 gu_philander_20degiso gu_philander_HP gu_philander_thesis hc_eofs hc_sst_lagged_regression hc_sst_lagged_regression_color hoffmoeller_corr_plot hoffmoeller_plot HP10_eq_tend_terms HP10_LP9_wreg HP_HC_evolution_30s30n intraseasonal_NAO lag_regress_on_ct lagged_1000yr_regression lagged_regression lagged_regressions look_at_coup_run look_at_stoc_run look_hc_terms LP9_eq_tend_terms LP_HC_evolution_30s30n LPPC1_regression MIX_regressions ml_coup_slp_eof ml_eof_regressions ml_ppcs_thesis ML_projections ml_run_stats ml_run_stats2 ml_run_stats3 ml_run_stats4 ml_slp_pcs_ppcs ml_slp_pcs_ppcs_2 nhem_eofs npac_sst_eofs pdo_calc plot_30s30n_EOF_regressions plot_30s30n_EOF_terms plot_30s30n_terms plot_3d plot_60s60n_terms plot_daily_1daycorr plot_EOF1_EOF2_0-270mHC plot_eq_currents plot_lag_regress2 plot_lag_regressions plot_lag_regressions_color plot_lp_pac_regressions plot_lp_pac_terms plot_pac_regressions plot_reg_HEAT_SFC plot_reg_TAUX_z250 plot_regressions plot_regressions_HP_LP plot_regressions_HP_LP_thesis plot_variance_explained plot_wbtp_tcline_reg plot_zerolag_terms PNA_index_regs project_windstress reg_obs_onto_BPppcs reg_SST_onto_SLP_variosBPs reg_stuff_onto_BPppcs regress_ddt_co2 regress_hp_lp_ct regress_NP_eof regress_sv regress_wbc residual_term sst_tau_hc_color_fig sst_tau_hc_fig storm_1pt_corr_map tcline_regression tendency_terms tendency_terms2 vert_ubtp_uptb vert_vdtdy_wdtdz vert_vptb_wptb wbar_dtpdz_hc0-80 wind_stress write_netcdf wstp_upwelling wtrsfcairtemppna zonal_depth_eq

This function calls

This function is called by

Listing of function regress_eof

function [out, ccoef] = regress_eof(temp, pcs, lags);

if nargin < 2;
  error('There must be at least 2 inputs, ''dat'' and ''pcs'' ');
elseif nargin < 3;
  lags = 0;
end

sz_temp = size(temp);
ndim = length(sz_temp);
temp = reshape(temp, sz_temp(1), prod(sz_temp(2:ndim)));
clim = mean(temp);
kp = find(~isnan(clim));
temp = temp(:,kp);
[temp, tem] = remove_mean(temp);
stdtemp = std(temp);

nlag = length(lags);
num = 1;

if (size(pcs,1)==1); pcs=pcs'; end;
timeseries = (pcs(:,num) - mean(pcs(:,num)))./std(pcs(:,num));

for j = 1:nlag;
  if lags(j) > 0;
    tm = timeseries(1:(sz_temp(1)-lags(j)));
    tem = temp((1+lags(j)):sz_temp(1),:);
  elseif lags(j) < 0;
    tm = timeseries((1-lags(j)):sz_temp(1));
    tem = temp(1:(sz_temp(1)+lags(j)),:);
  elseif lags(j) == 0;
    tm = timeseries;
    tem = temp;
  end

  out(j, :) = tm' * tem ./ (sz_temp(1)-abs(lags(j))-1);
  ccoef(j,:) = out(j,:) ./ stdtemp;
end;

tem = NaN*ones(nlag, prod(sz_temp(2:ndim)));
tem(:,kp) = out;
out = reshape(tem, [nlag sz_temp(2:ndim)]);

tem = NaN*ones(nlag, prod(sz_temp(2:ndim)));
tem(:,kp) = ccoef;
ccoef = reshape(tem, [nlag sz_temp(2:ndim)]);