4
4
[ ![ codecov.io] ( http://codecov.io/github/JeffFessler/LinearMapsAA.jl/coverage.svg?branch=master )] ( http://codecov.io/github/JeffFessler/LinearMapsAA.jl?branch=master )
5
5
https://github.com/JeffFessler/LinearMapsAA.jl
6
6
7
- UNDER CONSTRUCTION!
8
-
9
7
This package is an overlay for the
10
8
[ ` LinearMaps.jl ` ] ( https://github.com/Jutho/LinearMaps.jl )
11
9
package
12
10
that allows one to represent linear operations
13
11
(like the FFT)
14
12
as a object that appears to the user like a matrix
15
- but internally uses fast computations
13
+ but internally uses user-defined fast computations
16
14
for operations, especially multiplication.
17
15
18
- The extra ` AA ` in the package name has two meanings.
16
+ The extra ` AA ` in the package name here has two meanings.
19
17
20
18
- Objects of type ` LinearMapAA ` are subtypes of ` AbstractArray{T,2} ` , i.e.,
21
19
[ conform to the requirements of an ` AbstractMatrix ` ] ( https://docs.julialang.org/en/latest/manual/interfaces/#man-interface-array-1 )
20
+ type.
22
21
23
22
- The package was developed in Ann Arbor, Michigan :)
24
23
25
24
Any ` AbstractArray `
26
25
must support a ` getindex ` operation.
27
26
The maintainers of the ` LinearMaps.jl ` package
28
- [ do not wish to add getindex there] ( https://github.com/Jutho/LinearMaps.jl/issues/38 )
27
+ [ have not wished to add getindex there] ( https://github.com/Jutho/LinearMaps.jl/issues/38 ) ,
29
28
so this package adds that feature
30
29
(without committing "type piracy").
31
30
32
- A bonus feature supported by ` LinearMapsAA `
31
+ A bonus feature provided by ` LinearMapsAA `
33
32
is that a user can include a ` NamedTuple ` of properties
34
33
with it, and then retrieve those later
35
34
using the ` A.key ` syntax like one would do with a struct (composite type).
@@ -43,8 +42,9 @@ a wavelet transform arises
43
42
from some mother wavelet,
44
43
and it can be convenient
45
44
to carry those properties with the object itself.
46
- The properties are lost when one combines
47
- two ` LinearMapAA ` objects by adding, multiplying, concatenating, etc.
45
+ Currently
46
+ the properties are lost when one combines
47
+ two or more ` LinearMapAA ` objects by adding, multiplying, concatenating, etc.
48
48
49
49
50
50
## Examples
@@ -89,10 +89,11 @@ This software was developed at the
89
89
by
90
90
[ Jeff Fessler] ( http://web.eecs.umich.edu/~fessler )
91
91
and his
92
- [ group] ( http://web.eecs.umich.edu/~fessler/group ) .
92
+ [ group] ( http://web.eecs.umich.edu/~fessler/group ) ,
93
+ with substantial inspiration drawn
94
+ from the ` LinearMaps ` package.
93
95
94
96
95
- todo:
96
97
This package is included in the
97
98
Michigan Image Reconstruction Toolbox (MIRT.jl)
98
99
and is exported there
@@ -105,6 +106,12 @@ such as using the nice
105
106
[ Kronecker.jl] ( https://github.com/MichielStock/Kronecker.jl )
106
107
package.
107
108
109
+ This package provides similar functionality
110
+ as the ` Fatrix ` / ` fatrix ` object in the
111
+ [ Matlab version of MIRT] ( https://github.com/JeffFessler/mirt ) .
112
+
113
+ ## Getting started
114
+
108
115
For detailed installation instructions, see:
109
116
[ doc/start.md] ( https://github.com/JeffFessler/MIRT.jl/blob/master/doc/start.md )
110
117
0 commit comments