% description of data saved in UCIT
%
% afarris 2010May10
% This code is designed to be read, not run
type('explanation_of_data_saved_in_UCIT.m')
return

% Our data is all related to a coast following reference line.  The
% reference line is made of straight sections.
% Along the reference line there are pre-determined, numbered
% points at 20m spacing.  These can be called profile origins or reference
% line points.  At each profile origin a profile line is defined that is
% perpendicular to the reference line.
%
% There will be two kinds of data saved. Historical shorelines and lidar
% shorelines.  Historical shorelines will be simpler, mainly a shoreline
% position. 

%% All of the following refers to lidar shorelines.  
% Lidar shorelines have lots of extra data associated with them.
%  The most important information is shoreline position.  This can be
%  expressed two ways, as distance to reference line (or porfile origin)
%  and as (UTM easting and northing).

% So the basic data is 
profileNum %(what does Ben call it?
shorePos
shoreNorth
shoreEast

%% Profile data
% Each shoreline position was found from a group of lidar points within 1m
% of each profile line.  For each profile there are 2 main variables,
%  x: distance along the profile-- distance from profile origin and 
%  y: height (meters)

% So additional data is
x %(vector)
y %(vector)

% Now in the process of calcuation the shoreline position from (x,y)
% several other variables are calculated and saved:

Wx %(the actual x values used in the regression)  (vector)
Wx %(the actual y values used in the regression)  (vector)
fitz %the valule of the regression at each Wx  (vector)

% all of these values will need another dimension.

%% Regression info

% a lot more information is calculated with the shoreline position, 

% these are all scalers

regressionError 
regWindowLen 
landwardXofWindow 
slope 
lidarError 
waterLevel 
mhw 
rSquared 
extrapError 
totalError 
highWaterFlag 
actionCode 
headlandFlag 

%% Bias data

% Even more data is collected and calcuated to calculate the bias.
% (the bias is the error in comparing a MHW shoreline with a proxy
% shoreline

% this cacluation is done as 1km averages, so while there is data for each
% profile point, they only vary every 1 km

% these are all scalers
bias
Hs %(significant wave height)
L0 %(deep water wave length)
tanb %(1 km averaged slope)
bias_error
Hs_error
L0_error
tanb_error 

