Skip to content

Commit 5e0260f

Browse files
hvandermarelhvandermarel
authored
Update README.md
1 parent 0e99552 commit 5e0260f

File tree

1 file changed

+65
-70
lines changed

1 file changed

+65
-70
lines changed

‎README.md‎

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

9-
# Synopsis:
9+
## Synopsis:
1010

11-
crdvelout=itrf2itrf(crdvelin,from,to,yearin,yearout)
12-
crdout=itrf2itrf(crdin,from,to,yearin)
11+
crdvelout=itrf2itrf(crdvelin,from,to,yearin,yearout)
12+
crdout=itrf2itrf(crdin,from,to,yearin)
1313

14-
# Main functions:
14+
## Functions
15+
16+
**Main functions:**
1517

16-
> itrf2itrf - Transform coordinates/velocities between various ITRF's and
17-
> ETRF2000, ETRF2014 and ETRF2020.
18-
> pmmvel - Get velocity from Plate Motion Model parameters.
18+
itrf2itrf - Transform coordinates/velocities between various ITRF's and ETRF2000, ETRF2014 and ETRF2020.
19+
pmmvel - Get velocity from Plate Motion Model parameters.
1920

20-
# Other functions:
21+
**Other functions:**
2122

22-
> itrftp - Get ITRF transformation parameters at a certain epoch
23-
> itrftables - Print table with transformation parameters between ITRF's.
24-
> itrf2etrf - Transform coordinates/velocities between ITRFyy and ETRFyy.
23+
itrftp - Get ITRF transformation parameters at a certain epoch
24+
itrftables - Print table with transformation parameters between ITRF's.
25+
itrf2etrf - Transform coordinates/velocities between ITRFyy and ETRFyy.
2526

26-
# Support functions:
27+
**Support functions:**
2728

28-
itrftpdef - Define ITRF transformation parameters
29-
etrftpdef - Define ETRF transformation parameters
30-
pmmpar - Define Plate Motion Model parameters.
31-
dijkstra - Find shortest path in a graph using Dijkstra's algorithm
32-
trafo3d - 3D similarity transformation with 7 or 14 parameters
29+
itrftpdef - Define ITRF transformation parameters
30+
etrftpdef - Define ETRF transformation parameters
31+
pmmpar - Define Plate Motion Model parameters.
32+
dijkstra - Find shortest path in a graph using Dijkstra's algorithm
33+
trafo3d - 3D similarity transformation with 7 or 14 parameters
3334

34-
# Demo/test functions:
35+
**Demo/test functions:**
3536

36-
testitrf - Test itrf2itrf using actual ITRF coordinates
37-
testpmm - Test Plate Model Motion (PMM) functions
37+
testitrf - Test itrf2itrf using actual ITRF coordinates
38+
testpmm - Test Plate Model Motion (PMM) functions
3839

39-
# Notes:
40-
41-
(1) itrf2itrf supports also transformations between ITRFyy and ETRF2000,
42-
ETRF2014 and ETRF2020.
43-
(2) itrf2etrf only supports transformations between ITRFyy and ETRFyy, or
44-
vice versa, for the same year.
45-
46-
crdvelout=itrf2etrf(crdvelin,from,to,yearin,yearout)
47-
crdout=itrf2etrf(crdin,from,to,yearin)
48-
49-
Mainly useful for legacy ETRF. For operations involving ETRF2000,
50-
ETRF2014 and ETRF2020 you are better off with itrf2itrf.
51-
To preform transformations between legacy ETRF split the transform
52-
in two steps, e.g.
53-
54-
ITRFxx -> ETRFxx itrf2etrf
55-
ETRFxx -> ITRFxx itrf2etrf
56-
ITRFxx -> ETRFyy :
57-
ITRFxx -> ITRFyy itrf2itrf
58-
ITRFyy -> ETRFyy itrf2etrf
59-
ETRFxx -> ITRFyy :
60-
ETRFxx -> ITRFxx itrf2etrf
61-
ITRFxx -> ITRFyy itrf2itrf
62-
ETRFxx -> ETRFyy :
63-
ETRFxx -> ITRFxx itrf2etrf
64-
ITRFxx -> ITRFyy itrf2itrf
65-
ITRFyy -> ETRFyy itrf2etrf
66-
67-
(3) Dijkstra's algorithm to find the shortest path is used to construct
68-
all possible combinations of transformations.
69-
70-
Examples:
40+
## Notes:
41+
42+
(1) itrf2itrf supports also transformations between ITRFyy and ETRF2000, ETRF2014 and ETRF2020.
43+
44+
(2) itrf2etrf only supports transformations between ITRFyy and ETRFyy, or vice versa, for the same year.
45+
46+
crdvelout=itrf2etrf(crdvelin,from,to,yearin,yearout)
47+
crdout=itrf2etrf(crdin,from,to,yearin)
48+
49+
itrf2etrs is only useful for legacy ETRF. For operations involving ETRF2000, ETRF2014 and ETRF2020 you are better off with itrf2itrf.
50+
To preform transformations between legacy ETRF split the transform in two steps, e.g.
51+
52+
ITRFxx -> ETRFxx itrf2etrf
53+
ETRFxx -> ITRFxx itrf2etrf
54+
ITRFxx -> ETRFyy :
55+
ITRFxx -> ITRFyy itrf2itrf
56+
ITRFyy -> ETRFyy itrf2etrf
57+
ETRFxx -> ITRFyy :
58+
ETRFxx -> ITRFxx itrf2etrf
59+
ITRFxx -> ITRFyy itrf2itrf
60+
ETRFxx -> ETRFyy :
61+
ETRFxx -> ITRFxx itrf2etrf
62+
ITRFxx -> ITRFyy itrf2itrf
63+
ITRFyy -> ETRFyy itrf2etrf
64+
65+
(3) Dijkstra's algorithm to find the shortest path is used to construct all possible combinations of transformations.
66+
67+
## Examples:
7168

72-
crdvelout=itrf2itrf( ...
73-
[ 3899225.258 396731.815 5015078.341 -.0130 .0158 .0092 ; ...
74-
3812141.404 395731.729 4995987.219 .0004 -.0013 .0002 ],...
75-
'ITRF2005','ITRF2000',2008.4,2000.0)
76-
77-
crdout=itrf2itrf( ...
78-
[ 3899225.258 396731.815 5015078.341 ; ...
79-
3812141.404 395731.729 4995987.219 ],...
80-
'ITRF2005','ITRF2000',2008.4)
81-
82-
crdvelout=itrf2itrf( ...
83-
[3924687.552 301132.856 5001910.904 -.0150 .0164 .0070], ...
84-
'ITRF2000','ETRF2000',1997.0,1989.0)
85-
86-
The Matlab functions in this package are free software: you can redistribute
87-
it and/or modify it under the terms of the GNU General Public License as
69+
crdvelout=itrf2itrf( ...
70+
[ 3899225.258 396731.815 5015078.341 -.0130 .0158 .0092 ; ...
71+
3812141.404 395731.729 4995987.219 .0004 -.0013 .0002 ],...
72+
'ITRF2005','ITRF2000',2008.4,2000.0)
73+
74+
crdout=itrf2itrf( ...
75+
[ 3899225.258 396731.815 5015078.341 ; ...
76+
3812141.404 395731.729 4995987.219 ],...
77+
'ITRF2005','ITRF2000',2008.4)
78+
79+
crdvelout=itrf2itrf( ...
80+
[3924687.552 301132.856 5001910.904 -.0150 .0164 .0070], ...
81+
'ITRF2000','ETRF2000',1997.0,1989.0)
82+
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
8884
published by the Free Software Foundation <http://www.gnu.org/licenses/>.
8985

90-
This software is distributed in the hope that it will be useful, but WITHOUT
91-
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
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
9287
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
9388

9489
(c) Hans van der Marel, Delft University of Technology, 2012-2025.

0 commit comments

Comments
 (0)