Skip to content

Commit a28c4ce

Browse files
committed
Updated README and Contents.m
1 parent e143be9 commit a28c4ce

File tree

3 files changed

+37
-24
lines changed

3 files changed

+37
-24
lines changed

Contents.m

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,12 @@
88
% crdvelout=itrf2itrf(crdvelin,from,to,yearin,yearout)
99
% crdout=itrf2itrf(crdin,from,to,yearin)
1010
%
11-
% Main function:
11+
% Main functions:
1212
%
1313
% itrf2itrf - Transform coordinates/velocities between various ITRF's and
1414
% ETRF2000, ETRF2014 and ETRF2020.
1515
% pmmvel - Get velocity from Plate Motion Model parameters.
16+
% itrfmap - Plot map of velocity and coordinate changes between ITRF/ETRF.
1617
%
1718
% Other functions:
1819
%
@@ -28,8 +29,10 @@
2829
% dijkstra - Find shortest path in a graph using Dijkstra's algorithm
2930
% trafo3d - 3D similarity transformation with 7 or 14 parameters
3031
%
31-
% Demo/test functions:
32+
% Demo/test scripts:
3233
%
34+
% demoitrfmap- Demo with itrfmap mapping velocity/coordinate changes
35+
% liveitrfmap- Live editor (*.mlx) itrfmap analysis tool
3336
% testitrf - Test itrf2itrf using actual ITRF coordinates
3437
% testpmm - Test Plate Model Motion (PMM) functions
3538
%
@@ -80,12 +83,4 @@
8083
% [3924687.552 301132.856 5001910.904 -.0150 .0164 .0070], ...
8184
% 'ITRF2000','ETRF2000',1997.0,1989.0)
8285
%
83-
% The Matlab functions in this package are free software: you can redistribute
84-
% it and/or modify it under the terms of the GNU General Public License as
85-
% published by the Free Software Foundation <http://www.gnu.org/licenses/>.
86-
%
87-
% This software is distributed in the hope that it will be useful, but WITHOUT
88-
% ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
89-
% FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
90-
%
9186
% (c) Hans van der Marel, Delft University of Technology, 2012-2025.

README.md

Lines changed: 32 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,38 +6,49 @@ International Terrestrial Reference Frame (ITRF) Matlab Toolbox
66
Coordinate transformations between different ITRS and ETRS89 realizations.
77
--------------------------------------------------------------------------
88

9-
## Synopsis:
9+
## Synopsis
10+
11+
Coordinate and velocity transformations between International and European Terrestrial Reference
12+
Frame (ITRF/ETRF) realizations, plate motion models (PMM) and analysis of velocity and coordinate
13+
changes between reference frames.
1014

11-
crdvelout=itrf2itrf(crdvelin,from,to,yearin,yearout)
12-
crdout=itrf2itrf(crdin,from,to,yearin)
15+
> crdvelout=itrf2itrf(crdvelin,from,to,yearin,yearout)
16+
> crdout=itrf2itrf(crdin,from,to,yearin)
17+
18+
> demoitrfmap
19+
20+
![itrfmap_example](./itrfmap_example.png)
1321

1422
## Functions
1523

16-
**Main functions:**
24+
**Main functions**
1725

1826
itrf2itrf - Transform coordinates/velocities between various ITRF's and ETRF2000, ETRF2014 and ETRF2020.
1927
pmmvel - Get velocity from Plate Motion Model parameters.
28+
itrfmap - Plot map of velocity and coordinate changes between ITRF/ETRF.
2029

21-
**Other functions:**
30+
**Other functions**
2231

2332
itrftp - Get ITRF transformation parameters at a certain epoch
2433
itrftables - Print table with transformation parameters between ITRF's.
2534
itrf2etrf - Transform coordinates/velocities between ITRFyy and ETRFyy.
2635

27-
**Support functions:**
36+
**Support functions**
2837

2938
itrftpdef - Define ITRF transformation parameters
3039
etrftpdef - Define ETRF transformation parameters
3140
pmmpar - Define Plate Motion Model parameters.
3241
dijkstra - Find shortest path in a graph using Dijkstra's algorithm
3342
trafo3d - 3D similarity transformation with 7 or 14 parameters
3443

35-
**Demo/test functions:**
44+
**Demo/test scripts**
3645

46+
demoitrfmap- Demo with itrfmap mapping velocity/coordinate changes
47+
liveitrfmap- Live editor (.mlx) itrfmap analysis tool
3748
testitrf - Test itrf2itrf using actual ITRF coordinates
3849
testpmm - Test Plate Model Motion (PMM) functions
3950

40-
## Notes:
51+
## Notes
4152

4253
(1) itrf2itrf supports also transformations between ITRFyy and ETRF2000, ETRF2014 and ETRF2020.
4354

@@ -64,7 +75,7 @@ To preform transformations between legacy ETRF split the transform in two steps,
6475

6576
(3) Dijkstra's algorithm to find the shortest path is used to construct all possible combinations of transformations.
6677

67-
## Examples:
78+
## Examples
6879

6980
crdvelout=itrf2itrf( ...
7081
[ 3899225.258 396731.815 5015078.341 -.0130 .0158 .0092 ; ...
@@ -80,10 +91,17 @@ To preform transformations between legacy ETRF split the transform in two steps,
8091
[3924687.552 301132.856 5001910.904 -.0150 .0164 .0070], ...
8192
'ITRF2000','ETRF2000',1997.0,1989.0)
8293

83-
The Matlab functions in this package are free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as
84-
published by the Free Software Foundation <http://www.gnu.org/licenses/>.
94+
## License notice
95+
96+
The following notice applies to all Matlab functions and scripts in this repository.
8597

86-
This software is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
87-
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
98+
Copyright 2012-2025 Hans van der Marel, Delft University of Technology.
8899

89-
(c) Hans van der Marel, Delft University of Technology, 2012-2025.
100+
Licensed under the Apache License, Version 2.0 (the "License");
101+
you may not use this file except in compliance with the License.
102+
You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 .
103+
Unless required by applicable law or agreed to in writing, software
104+
distributed under the License is distributed on an "AS IS" BASIS,
105+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
106+
See the License for the specific language governing permissions and
107+
limitations under the License.

itrfmap_example.png

255 KB
Loading

0 commit comments

Comments
 (0)