Skip to content
This repository was archived by the owner on Nov 6, 2023. It is now read-only.

Commit c753667

Browse files
committed
Clean docstring of ClusterProcess
1 parent 20e60b9 commit c753667

File tree

1 file changed

+0
-40
lines changed

1 file changed

+0
-40
lines changed

src/processes/cluster.jl

Lines changed: 0 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -14,46 +14,6 @@ a point pattern from another point process.
1414
Alternatively, specify the parent process `proc`, the offspring process
1515
`offs` and the geometry function `gfun`. It is a function that takes a
1616
parent point and returns a geometry or domain for the offspring process.
17-
18-
## Examples
19-
20-
Matern cluster process:
21-
22-
```julia
23-
p = ClusterProcess(
24-
PoissonProcess(1),
25-
PoissonProcess(1000),
26-
parent -> Ball(parent, 0.2)
27-
)
28-
```
29-
30-
Inhomogenegeous parent process with fixed number of offsprings:
31-
32-
```julia
33-
p = ClusterProcess(
34-
PoissonProcess(s -> 1 * sum(coordinates(s) .^ 2)),
35-
BinomialProcess(100),
36-
parent -> Ball(parent, 0.2)
37-
)
38-
```
39-
40-
Inhomogenegeous parent process and inhomogeneneous offspring process:
41-
42-
```julia
43-
p = ClusterProcess(
44-
PoissonProcess(s -> 0.1 * sum(coordinates(s) .^ 2)),
45-
parent -> rand(PoissonProcess(x -> 5000 * sum((x - parent).^2)), Ball(parent, 0.5))
46-
)
47-
```
48-
49-
Inhomogenegeous parent process and regularsampling:
50-
51-
```julia
52-
p = ClusterProcess(
53-
PoissonProcess(s -> 0.2 * sum(coordinates(s) .^ 2)),
54-
parent -> PointSet(sample(Sphere(parent, 0.1), RegularSampling(10)))
55-
)
56-
```
5717
"""
5818
struct ClusterProcess{P<:PointProcess,F<:Function} <: PointProcess
5919
proc::P

0 commit comments

Comments
 (0)