Skip to content

Commit 9f9ba86

Browse files
author
dsweber2
committed
link to the docs. Finally working docs.
1 parent 0886344 commit 9f9ba86

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,6 @@
33
[![Build Status](https://travis-ci.com/dsweber2/FourierFilterFlux.jl.svg?branch=master)](https://travis-ci.com/dsweber2/FourierFilterFlux.jl)
44
[![Codecov](https://codecov.io/gh/dsweber2/FourierFilterFlux.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/dsweber2/FourierFilterFlux.jl)
55
[![Coveralls](https://coveralls.io/repos/github/dsweber2/FourierFilterFlux.jl/badge.svg?branch=master)](https://coveralls.io/github/dsweber2/FourierFilterFlux.jl?branch=master)
6+
[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://dsweber2.github.io/FourierFilterFlux.jl/dev)
67

78
See the docs for details

docs/src/coreType.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
TODO: include notes about gpu usage
1+
```@setup 1DconvEx
2+
using Plots; gr()
3+
Plots.reset_defaults()
4+
```
25
# ConvFFT type #
36
The core type of this package. As a simple example in 1D:
47
```@example 1DconvEx
@@ -8,7 +11,7 @@ w[55:60,2] = randn(6)
811
ŵ = rfft(w, 1)
912
W = ConvFFT(ŵ,nothing,(128,1,2))
1013
plot(W, title="Time domain Filters", dispReal=true,
11-
apply=identity, vis=1:2)
14+
apply=identity, vis=1:2);
1215
savefig("randFilters.svg")#hide
1316
```
1417
![](randFilters.svg)
@@ -20,7 +23,7 @@ this to a signal `x`, which is non-zero at only the two boundary locations:
2023
x = zeros(128,1,2);
2124
x[1,1,2] = 1; x[end,1,2] = -1; # positive on one side and negative on the other
2225
r = W(x); size(r)
23-
plot(r[:,:,1,2],title="convolved with x") #hide
26+
plot(r[:,:,1,2],title="convolved with x"); #hide
2427
savefig("convolveWx.svg") #hide
2528
```
2629
![](convolveWx.svg)
@@ -35,7 +38,7 @@ address this, e.g. `Pad(6)`
3538
``` @example 1DconvEx
3639
W = ConvFFT(ŵ,nothing,(128,1,2),boundary= Pad(6))
3740
r =W(x); size(r)
38-
plot(r[:,:,1,2],title="convolved with x") #hide
41+
plot(r[:,:,1,2],title="convolved with x"); #hide
3942
savefig("convolveWxPad.svg") #hide
4043
```
4144
![](convolveWxPad.svg)
@@ -51,7 +54,7 @@ filt = ConvFFT(ex2Dsize, 3, relu, trainable=true,bias=false)
5154
plot(heatmap(filt,dispReal=true,vis=1,colorbar=false,title="Filter 1"),
5255
heatmap(filt,dispReal=true,vis=2,colorbar=false,title="Filter 2"),
5356
heatmap(filt,dispReal=true,vis=3,colorbar=false, title="Filter 3"),
54-
layout=(1,3))
57+
layout=(1,3));
5558
savefig("2Dfilts.svg") #hide
5659
```
5760
![](2Dfilts.svg)
@@ -68,7 +71,7 @@ genEx(n) = [(cpu(randn(ex2Dsize)), true) for i=1:n];
6871
Flux.train!(loss, params(filt), genEx(100), ADAM())
6972
plot(heatmap(filt,vis=1), heatmap(filt,vis=2), heatmap(filt,vis=3),
7073
heatmap(targetConv,vis=1), heatmap(targetConv,vis=2),
71-
heatmap(targetConv,vis=3))
74+
heatmap(targetConv,vis=3));
7275
savefig("fitting2Dfilts.svg") #hide
7376
```
7477
![](fitting2Dfilts.svg)
@@ -113,9 +116,9 @@ The arguments are
113116
using a rfft, this is only the postive frequencies in the first dimension
114117
(vertical in the 2D shearlet plots and horizontal in the 1D plot).
115118
``` @example 1DconvEx
116-
plot(heatmap(W2,title="first shearlet"), heatmap(W2,vis=4,title="Fourth shearlet"))
119+
plot(heatmap(W2,title="first shearlet"), heatmap(W2,vis=4,title="Fourth shearlet"));
117120
savefig("demoVis.svg") #hide
118-
plot(W1,vis=:,title="All of the Morlet Wavelets")
121+
plot(W1,vis=:,title="All of the Morlet Wavelets");
119122
savefig("demoVis1D.svg") #hide
120123
```
121124
![](demoVis.svg)

0 commit comments

Comments
 (0)