WIP of extension implementation

Author: tknopp

Project.toml

@@ -4,23 +4,29 @@ authors = ["Tobias Knopp <[email protected]> and contributors"]
 version = "1.0.0"
 
 [deps]
-FFTW = "7a1cc6ca-52ef-59f5-83cd-3a7055c09341"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 LinearOperators = "5c8ed15e-5a4c-59e4-a42b-c7e8811fb125"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
+
+[weakdeps]
 Wavelets = "29a6e085-ba6d-5f35-a997-948ac2efa89a"
+FFTW = "7a1cc6ca-52ef-59f5-83cd-3a7055c09341"
+
+[extensions]
+LinearOperatorWaveletExt = "Wavelets"
+LinearOperatorFFTWExt = "FFTW"
 
 [compat]
 julia = "1.6"
-FFTW = "0.2, 1.0"
+FFTW = "1.0"
 LinearOperators = "2.3.3"
-Reexport = "0.2, 1.0"
-Wavelets = "0.8, 0.9"
+Reexport = "1.0"
+Wavelets = "0.9"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Test"]
+test = ["Test", "FFTW", "Wavelets"]

README.md

@@ -2,4 +2,22 @@
 
 [![Build Status](https://github.com/JuliaImageRecon/LinearOperatorCollection.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/JuliaImageRecon/LinearOperatorCollection.jl/actions/workflows/CI.yml?query=branch%3Amain)
 
-[![codecov.io](http://codecov.io/JuliaImageRecon/LinearOperatorCollection.jl/coverage.svg?branch=master)](http://codecov.io/github/JuliaImageRecon/LinearOperatorCollection.jl?branch=master)
+[![codecov.io](http://codecov.io/JuliaImageRecon/LinearOperatorCollection.jl/coverage.svg?branch=master)](http://codecov.io/github/JuliaImageRecon/LinearOperatorCollection.jl?branch=master)
+
+## Purpose
+
+This package contains a collection of linear operators that are in particular useful for multi-dimensional signal and image processing tasks. All operators are build using the LinearOperators.jl base type and derive from `AbstractLinearOperator`. For example this package
+provides operators for the FFT (Fast Fourier Transform) and its non-equidistant variant (NFFT), the DCT (Discrete Cosine Transform), and the Wavelet transform. This package, however, does not implement
+these transformation itself but uses established libraries for them. So in fact, LinearOperatorCollection's main purpose is to add a wrapper around low-level libraries like
+FFTW.jl and NFFT.jl, which allows to use the transformation as if they would be linear operators, i.e. implement `Op * x`, `adjoint(Op) * x` and the `mul!` based in-place variants of the former.
+
+## Installation
+
+Within Julia, use the package manager to install this package:
+```julia
+using Pkg
+Pkg.add("LinearOperatorCollection")
+```
+
+## Usage
+...

src/DCTOp.jl renamed to ext/LinearOperatorFFTWExt/DCTOp.jl

@@ -0,0 +1,7 @@
+module LinearOperatorFFTWExt
+
+include("FFTOp.jl")
+include("DCTOp.jl")
+include("DSTOp.jl")
+
+end

src/DSTOp.jl renamed to ext/LinearOperatorFFTWExt/DSTOp.jl

@@ -0,0 +1,5 @@
+module LinearOperatorWaveletExt
+  
+include("WaveletOp.jl")
+
+end

src/FFTOp.jl renamed to ext/LinearOperatorFFTWExt/FFTOp.jl

@@ -1,5 +1,11 @@
 export WaveletOp
 
+import LinearOperatorCollection: constructLinearOperator
+
+function constructLinearOperator(::Type{Op}; eltype::Type, shape::Tuple, wt=wavelet(WT.db2)) where Op <: WaveletOp{T} where T <: Number
+  return WaveletOpImpl(eltype, shape, wt)
+end
+
 """
   WaveletOp(shape, wt=wavelet(WT.db2))
 
@@ -11,7 +17,7 @@ a given input array.
 * `shape`                 - size of the Array to transform
 * (`wt=wavelet(WT.db2)`)  - Wavelet to apply
 """
-function WaveletOp(T::Type, shape, wt=wavelet(WT.db2))
+function WaveletOpImpl(T::Type, shape, wt=wavelet(WT.db2))
   return LinearOperator(T, prod(shape), prod(shape), false, false
             , (res,x)->dwt!(reshape(res,shape), reshape(x,shape), wt)
             , nothing

ext/LinearOperatorFFTWExt/LinearOperatorFFTWExt.jl

@@ -11,8 +11,6 @@ using Random
 using Reexport
 @reexport using Reexport
 @reexport using LinearOperators
-@reexport using FFTW
-@reexport using Wavelets
 
 LinearOperators.use_prod5!(op::opEye) = false
 LinearOperators.has_args5(op::opEye) = false
@@ -33,18 +31,27 @@ function wrapProd(prod::Function)
   return λ
 end
 
-include("FFTOp.jl")
-include("DCTOp.jl")
-include("DSTOp.jl")
-include("WaveletOp.jl")
 include("GradientOp.jl")
 include("SamplingOp.jl")
 include("WeightingOp.jl")
 include("NormalOp.jl")
 
 export linearOperator, linearOperatorList
 
-linearOperator(op::Nothing,shape,T::Type=ComplexF32) = nothing
+export constructLinearOperator
+export AbstractLinearOperatorFromCollection, WaveletOp, FFTOp, DCTOp, DSTOp
+
+abstract type AbstractLinearOperatorFromCollection{T} <: AbstractLinearOperator{T} end
+abstract type WaveletOp{T} <: AbstractLinearOperatorFromCollection{T} end
+abstract type FFTOp{T} <: AbstractLinearOperatorFromCollection{T} end
+abstract type DCTOp{T} <: AbstractLinearOperatorFromCollection{T} end
+abstract type DSTOp{T} <: AbstractLinearOperatorFromCollection{T} end
+
+function constructLinearOperator(::Type{<:AbstractLinearOperatorFromCollection}, args...; kargs...) 
+  error("Operator can't be constructed. You need to load another package!")
+end
+
+linearOperator(op::Nothing, shape, T::Type=ComplexF32) = nothing
 
 """
   returns a list of currently implemented `LinearOperator`s

ext/LinearOperatorWaveletExt/LinearOperatorWaveletExt.jl

@@ -3,6 +3,7 @@ using Test
 using Random
 using LinearAlgebra
 using FFTW
+using Wavelets
 
 include("testNormalOp.jl")
 include("testOperators.jl")