Skip to content

Commit de6d0d6

Browse files
authored
Update README.md
1 parent 77d6e69 commit de6d0d6

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ None of the models are exported to avoid namespace clashes, but it can be verbos
3737
```julia
3838
julia> using PSFModels: Gaussian
3939

40-
julia> model = Gaussian(8)
40+
julia> model = Gaussian(fwhm=8)
4141
```
4242

4343
or you can create an alias for `PSFModels`
@@ -49,7 +49,7 @@ const M = PSFModels
4949
# julia version 1.6 or above
5050
import PSFModels as M
5151

52-
model = M.Gaussian(10)
52+
model = M.Gaussian(fwhm=10)
5353
```
5454

5555
## Usage
@@ -59,14 +59,14 @@ For more in-depth usage and examples, please see the [documentation](https://jul
5959
```julia
6060
using PSFModels
6161

62-
m = PSFModels.Gaussian(8) # bivariate gaussian with a FWHM of 8 pixels
63-
m = PSFModels.Gaussian((7.4, 8.2)) # specify FWHM for each axis
64-
m = PSFModels.Gaussian([1 0; 0 1]) # specify FWHM as a correlated matrix
62+
m = PSFModels.Gaussian(fwhm=8) # bivariate gaussian with a FWHM of 8 pixels
63+
m = PSFModels.Gaussian(fwhm=(7.4, 8.2)) # specify FWHM for each axis
6564

66-
m = PSFModels.Gaussian(12, 25, 8.2) # specifiy location in pixel coordinates
67-
m = PSFModels.Gaussian([12, 25], 8.2)
65+
m = PSFModels.Gaussian(x=12, y=25, fwhm=8.2) # specifiy location in pixel coordinates
66+
m = PSFModels.Gaussian(pos=[12, 25], fwhm=8.2)
67+
m = PSFModels.Gaussian(r=5, theta=30, fwhm=8.2) # polar coordinates
6868

69-
mf0 = PSFModels.Gaussian{Float32}(8.2) # output guaranteed to be Float32
69+
mf0 = PSFModels.Gaussian(Float32, fwhm=8.2) # output guaranteed to be Float32
7070
```
7171

7272
```julia

0 commit comments

Comments
 (0)