Merge pull request #17 from JuliaImageRecon/nh/tree

Implement AbstractTree interface

Author: nHackel

Project.toml

@@ -4,13 +4,15 @@ authors = ["nHackel <[email protected]> and contributors"]
 version = "0.4.0"
 
 [deps]
+AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"
 LRUCache = "8ac3fa9e-de4c-5943-b1dc-09c6b5f20637"
 Observables = "510215fc-4207-5dde-b226-833fc4488ee2"
 Scratch = "6c6a2e73-6563-6170-7368-637461726353"
 TOML = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
 ThreadPools = "b189fb0b-2eb5-4ed4-bc0c-d34c51242431"
 
 [compat]
+AbstractTrees = "0.4"
 LRUCache = "1.6"
 Observables = "0.5.5"
 Scratch = "1.2"
@@ -19,14 +21,14 @@ ThreadPools = "2.1"
 julia = "1.9"
 
 [extras]
-Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
 ImageGeoms = "9ee76f2b-840d-4475-b6d6-e485c9297852"
 ImagePhantoms = "71a99df6-f52c-4da1-bd2a-69d6f37f3252"
+LinearOperatorCollection = "a4a2c56f-fead-462a-a3ab-85921a5f2575"
 RadonKA = "86de8297-835b-47df-b249-c04e8db91db5"
 RegularizedLeastSquares = "1e9c538a-f78c-5de5-8ffb-0b6dbe892d23"
-LinearOperatorCollection = "a4a2c56f-fead-462a-a3ab-85921a5f2575"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
 test = ["Test", "RadonKA", "ImagePhantoms", "ImageGeoms", "CairoMakie", "LinearOperatorCollection", "RegularizedLeastSquares", "Statistics"]

README.md

@@ -4,7 +4,7 @@
 
 [![](https://img.shields.io/badge/docs-latest-blue.svg)](https://JuliaImageRecon.github.io/AbstractImageReconstruction.jl)
 
-[![codecov.io](http://codecov.io/github/JuliaImageRecon/AbstractImageReconstruction.jl/coverage.svg?branch=master)](http://codecov.io/github/JuliaImageRecon/AbstractImageReconstruction.jl?branch=master)
+[![codecov.io](http://codecov.io/github/JuliaImageRecon/AbstractImageReconstruction.jl/coverage.svg?branch=main)](http://codecov.io/github/JuliaImageRecon/AbstractImageReconstruction.jl?branch=main)
 
 
 This package contains an interface and type hierarchy for image reconstruction algorithms and their parameters, together with associated utility tools.

src/AbstractImageReconstruction.jl

@@ -5,7 +5,9 @@ using ThreadPools
 using Observables
 using Scratch
 using LRUCache
+using AbstractTrees
 
+import AbstractTrees: parent, children
 import Base: put!, take!, fieldtypes, fieldtype, ismissing, propertynames, parent, hash, wait, isready, lock, unlock
 
 include("AlgorithmInterface.jl")

src/RecoPlans/RecoPlans.jl

@@ -60,6 +60,24 @@ Return the `Observable` for the `name` property of `plan`. Equivalent to `plan[n
 """
 Base.getindex(plan::RecoPlan{T}, name::Symbol) where {T} = getfield(plan, :values)[name]
 
+# Tree Interface
+"""
+    parent(plan::RecoPlan)
+
+Return the parent of `plan`.
+"""
+AbstractTrees.parent(plan::RecoPlan) = getfield(plan, :parent)
+AbstractTrees.ParentLinks(::Type{<:RecoPlan}) = AbstractTrees.StoredParents()
+function AbstractTrees.children(plan::RecoPlan)
+  result = Vector{RecoPlan}()
+  for prop in propertynames(plan)
+    if getproperty(plan, prop) isa RecoPlan
+      push!(result, getproperty(plan, prop))
+    end
+  end
+  return result
+end
+
 export types, type
 types(::AbstractRecoPlan{T}) where {T<:AbstractImageReconstructionParameters} = fieldtypes(T)
 type(::AbstractRecoPlan{T}, name::Symbol) where {T<:AbstractImageReconstructionParameters} = fieldtype(T, name)
@@ -179,13 +197,7 @@ end
 clear!(plan::RecoPlan{T}, preserve::Bool = true) where {T<:AbstractImageReconstructionAlgorithm} = clear!(plan.parameter, preserve)
 
 
-export parent, parent!, parentproperty, parentproperties
-"""
-    parent(plan::RecoPlan)
-
-Return the parent of `plan`.
-"""
-parent(plan::RecoPlan) = getfield(plan, :parent)
+export parent!, parentproperty, parentproperties
 """
     parent!(plan::RecoPlan, parent::RecoPlan)