latticeExtensions

.gitignore

@@ -28,6 +28,9 @@ Sumita.jl
 
 ## Julia.gitignore ##
 
+# files generated by VSCode Counter
+.VSCodeCounter/
+
 # Files generated by invoking Julia with --code-coverage
 *.jl.cov
 *.jl.*.cov

docs/Project.toml

@@ -5,6 +5,7 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 GLMakie = "e9467ef8-e4e7-5192-8a1a-b1aee30e663a"
 Images = "916415d5-f1e6-5110-898d-aaa5f9f070e0"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
+Luxor = "ae8d54c2-7ccd-5906-9d76-62fc9837b5bc"
 Makie = "ee78f7c6-11fb-53f2-987a-cfe4a2b5a57a"
 OpticSim = "24114763-4efb-45e7-af0e-cde916beb153"
 Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"

docs/make.jl

@@ -23,7 +23,8 @@ makedocs(
         "Geometry" => [
             "Basic Types" => "basic_types.md",
             "Primitives" => "primitives.md",
-            "CSG" => "csg.md"
+            "CSG" => "csg.md",
+            "Repeating Structures" => "repeat.md"
         ],
         "Optical" => [
             "Systems" => "systems.md",

docs/src/repeat.md

@@ -0,0 +1,63 @@
+# Repeating Structures
+
+The Repeat module contains functions for creating regular repeated patterns. This could be pixels in a display grid, or mirrors in an active optics telescope. Repeated patterns are defined by creating an object that inherits from the abstract type [`Basis`](@ref sources).
+
+Subtypes supporting the Basis interface should implement these functions:
+
+Returns the neighbors in ring n surrounding centerpoint, excluding centerpoint
+```
+neighbors(::Type{B},centerpoint::Tuple{T,T},neighborhoodsize::Int) where{T<:Real,B<:Basis}
+```
+Returns the lattice basis vectors that define the lattice
+```
+basis(a::S) where{S<:Basis}
+```
+Returns the vertices of the unit polygon for the basis that tiles the plane 
+```
+tilevertices(a::S) where{S<:Basis}
+```
+
+A lattice is described by a set of lattice vectors eᵢ which are stored in a [`Basis`](@ref sources) object. You can create bases in any dimension. Points in the lattice are indexed by integer coordinates. These lattice coordinates can be converted to Cartesian coordinates by indexing the LatticeBasis object. 
+``` @example example
+using OpticSim, OpticSim.Repeat
+a = LatticeBasis([1.0,5.0],[0.0,1.0])
+a[3,3]
+```
+
+The Lattice points are defined by a weighted sum of the basis vectors:
+```
+latticepoint = ∑αᵢ*eᵢ
+```
+where the αᵢ are integer weights.
+
+The [`HexBasis1`](@ref sources) constructor defines a symmetric basis for hexagonal lattices 
+```@example 
+using OpticSim, OpticSim.Repeat
+basis(HexBasis1())
+```
+The [`rectangularlattice`](@ref sources) function creates a rectangular lattice basis. 
+
+There are a few visualization functions for special 2D lattices. [`Vis.drawhexcells`](@ref sources) draws a set of hexagonal cells. Using [`Repeat.hexcellsinbox`](@ref sources) we can draw all the hexagonal cells that fit in a rectangular box:
+
+```@example 
+using OpticSim
+Vis.drawhexcells(50,Repeat.hexcellsinbox(2,2))
+HTML(Vis.drawhexcells(50,Repeat.hexcellsinbox(2,2), format=:svg)) #hide
+```
+
+There is also a function to compute the n rings of a cell x, i.e., the cells which can be reached by taking no more than n steps along the lattice from x:
+
+```@example 
+using OpticSim
+Vis.drawhexcells(50,Repeat.neighbors(Repeat.HexBasis1,(0,0),2))
+HTML(Vis.drawhexcells(50,Repeat.neighbors(Repeat.HexBasis1,(0,0),2), format=:svg)) #hide
+```
+
+You can also draw all the cells contained within an n ring:
+
+```@example 
+using OpticSim
+Vis.drawhexcells(50,Repeat.region(Repeat.HexBasis1,(0,0),2))
+HTML(Vis.drawhexcells(50,Repeat.region(Repeat.HexBasis1,(0,0),2), format=:svg)) #hide
+```
+

src/Examples/Examples.jl

@@ -9,16 +9,19 @@ using ..OpticSim.Vis
 using ..OpticSim.Geometry
 using ..OpticSim.Emitters
 using ..OpticSim.GlassCat
+using ..OpticSim.Repeat
 
 using StaticArrays
 using DataFrames: DataFrame
 using Images
 using Unitful
 using Plots
 using LinearAlgebra
+import Luxor
 
 include("docs_examples.jl")
 include("other_examples.jl")
+include("repeating_structure_examples.jl.jl")
 
 end #module Examples
 export Examples

src/Examples/repeating_structure_examples.jl.jl

@@ -0,0 +1,23 @@
+# MIT license
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# See LICENSE in the project root for full license information.
+
+
+
+#############################################################################
+
+"""draw the 2 neighbors of the hex cell at coordinates (0,0)"""
+drawhexneighbors() =  Luxor.@svg Vis.drawhexcells(50,Repeat.neighbors(Repeat.HexBasis1,(0,0),2))
+export drawneighbors
+
+"""draw hex cell at coordinates (0,0) and the 1 and 2 neighbors"""
+drawhexregion() = Luxor.@svg Vis.drawhexcells(50,Repeat.region(Repeat.HexBasis1,(0,0),2))
+export drawhexregion
+
+"""draw hex cells that fit within a rectangular box centered at coordinates (0,0). Use fill color yellow."""
+drawhexrect() = Luxor.@svg Vis.drawhexcells(50,Repeat.hexcellsinbox(2,2),"yellow")
+export drawhexrect
+
+"""draw hex cells that fit within a rectangular box centered at coordinates (0,0). Use random fill colors selected for maximum distinguishability."""
+drawhexrectcolors() =  Luxor.@svg Vis.drawhexcells(50,Repeat.hexcellsinbox(4,4))
+export drawhexrectcolors

src/OpticSim.jl

@@ -29,6 +29,7 @@ import .GlassCat: plot_indices, index, polyfit_indices, absairindex, absorption,
 
 include("Geometry/Geometry.jl")
 include("Optical/Optical.jl")
+include("RepeatingStructures/Repeat.jl")
 include("Vis/Vis.jl")
 include("Examples/Examples.jl")
 include("Optimization/Optimization.jl")