ISWLabToolkit/LabWaveProperties.m at main · HartharnSam/ISWLabToolkit · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
function LabWaveProperties(filename, y_ref, clrmap, type, amplitude)
%LabWaveProperties - Takes user mouse click input to measure streamline
%displacement of digiflow timeseries image. Saves all to png image

%
% Inputs:
%    filename - filename as "ts_c200" (potentially including path), without
%    extension
%    y_ref - [Optional] Reference y line to plot (usually pyc depth)
%    clrmap - [Optional] Colormap to use
%    type - [Optional, default "amp"] Parameter set to calculate ("amp" or
%    "wavelength")
%
% Other m-files required: dfireadvel; plot_dfi; mginput
% Subfunctions: none
% MAT-files required: none
%
% See also:
% Author: Sam Hartharn-Evans
% School of Mathematics, Statistics and Physics, Newcastle University
% email address: s.hartharn-evans2@newcastle.ac.uk
% GitHub: https://github.com/HartharnSam
% 15-Feb-2022; Last revision: 26-Jun-2024
% MATLAB Version: 9.10.0.1851785 (R2021a) Update 6

%---------------------------------------------------
%% BEGIN CODE %%
%---------------------------------------------------
close all;
input_fnm = join([filename, ".dfi"], '');

% Load and plot data
if nargin > 2
    ArgsIn.colormap = clrmap;
else
    ArgsIn.colormap = 'greyscale';
end
if nargin < 4
    type = 'amp'
end
plot_dfi(input_fnm, 'TimeSeries', 'none', ArgsIn); hold on;
xlabel('t (s)'); ylabel('y (m)')
set(gca, 'XDir', 'normal')

% Plot on reference line (if specified)
if nargin > 1
    yline(y_ref, 'w-', 'LineWidth', 2);
    yline(y_ref, 'k--', 'LineWidth', 1);
end

%
im = dfireadvel(input_fnm);
cannyedge = true;
if cannyedge
    Im = edge(im.cdata, 'Canny', [.001 .2]);
    contour(im.x, im.y, Im, '-', 'Color', [0 1 1]);

else
    contour(im.x, im.y, im.cdata, '-', 'Color', [1 1 1].*.2)
end

switch lower(type)
    case 'amp'
        % Pick points & Plot picked points
        [x, y] = mginput(2); % Pick
        plt = plot(x, y, 'r-x'); % Plot
        datatip(plt, x(1), y(1)); datatip(plt, x(2), y(2), 'location', 'southwest'); % Show

        % Display results to Command Window
        fprintf('Streamline Traced : %.3f \n', y(1));
        fprintf('Amplitude : %.3f m \n', -diff(y));
        fprintf('Time min : %.3f s \n', x(2));

        % Save figure with the data
        exportgraphics(gcf, join([filename, '.png'], ''));
    case 'wavelength'
        yline(y_ref-amplitude/2, 'w-', 'LineWidth', 2);
        yline(y_ref-amplitude/2, 'k--', 'LineWidth', 1);

        [x, y] = mginput(2); % Pick
        plt = plot(x, y, 'r-x'); % Plot
        datatip(plt, x(1), y(1)); datatip(plt, x(2), y(2), 'location', 'southwest'); % Show

        % Display results to Command Window
        fprintf('Time difference : %.3f s \n', diff(x));
        %fprintf('Time min : %.3f s \n', x(2));

        % Save figure with the data
        exportgraphics(gcf, join([filename, '_wl.png'], ''));
end


%---------------------------------------------------
%% END OF CODE %%
% --------------------------------------------------