Skip to content

Commit

Permalink
Add FUN examples to x2y header
Browse files Browse the repository at this point in the history
  • Loading branch information
tsipkens committed May 13, 2021
1 parent 162a46e commit 43dc8c0
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions +tools/x2y.m
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@
% quantity in the first dimension of the grid and B is the quantity in the
% second dimension. FUN must be a linear function in logspace for A and B.
%
% FUN examples:
% A. mass-mobility > effective density-mobility
% FUN = @(a, b) 6 .* a ./ (pi .* b .^ 3) .* 1e9;
% B. mrBC-mp > frBC-mp
% FUN = @(a, b) a ./ b;
% C. mrBC-mp > fnrBC/mp
% FUN = @(a, b) 1 - a ./ b;
%
% Y = tools.x2y(X, GRID_X, FUN, DIM) applies the transformation while
% preserving the quantity in the DIM dimension of the input grid. For
% example, for mass-mobility distributions and the default of DIM = 2, the
Expand Down

0 comments on commit 43dc8c0

Please sign in to comment.