Skip to content

Commit 565aee7

Browse files
committed
update README
1 parent 593ef9c commit 565aee7

File tree

2 files changed

+32
-2
lines changed

2 files changed

+32
-2
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
*.asv
22
*.m~
3+
README.html

README.md

+31-2
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,45 @@ This Matlab function set consists of some useful functions for phase retrival an
1010
# Function usage
1111

1212
## hio2d.m
13-
1413
Developed by Fienup [1], well known and widely used algorithm for XCDI resarch.Supports oversampling smoothness develped by Miao's group [2].
1514

15+
### Syntax
16+
```
17+
function R = hio2d(Fabs, S, n)
18+
function R = hio2d(Fabs, S, n, ukwn, alpha)
19+
```
20+
1621
## ghio.m
1722
Developed by Chien-Chun Chen *et al*. when he was in Institute of Physics in Academia Sinica [3].
1823

19-
## shrinkwrap.m
24+
### Syntax
25+
```
26+
function R = ghio2d(Fabs, S, n, gen, rep, checker, alpha)
27+
function [R, G, efs] = ghio2d(Fabs, S, n, gen, rep, checker, alpha)
28+
```
2029

30+
31+
## shrinkwrap.m
2132
Developed by S. Marchesini *et al*. [4].
2233

34+
### Syntax
35+
```
36+
gshrinkwrap(Fabs, n1, uknwn, gen, n2);
37+
gshrinkwrap(Fabs, n1, ukwn, gen, n2, alpha);
38+
gshrinkwrap(Fabs, n1, ukwn, gen, n2, alpha, sigma, cutoff1, cutoff2);
39+
```
40+
41+
42+
## gshrinkwrap.m
43+
44+
### Syntax
45+
```
46+
gshrinkwrap(Fabs, n1, uknwn, gen, n2, rep);
47+
gshrinkwrap(Fabs, n1, ukwn, gen, n2, rep, alpha);
48+
gshrinkwrap(Fabs, n1, ukwn, gen, n2, rep, alpha, sigma, cutoff1, cutoff2);
49+
```
50+
51+
2352
# References
2453

2554
[1] J.R. Fienup, Appl. Opt. **21**, 2758 (1982).

0 commit comments

Comments
 (0)