update root branch name

Author: mileslucas

.github/workflows/ci.yml

@@ -1,7 +1,10 @@
 name: CI
 on:
-  - push
-  - pull_request
+  push:
+    branches: [main]
+    tags: ["*"]
+  pull_request:
+    branches: [main]
 jobs:
   test:
     name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}

README.md

@@ -1,8 +1,8 @@
 # PSFModels.jl
 
-[![Build Status](https://github.com/juliaastro/PSFModels.jl/workflows/CI/badge.svg?branch=master)](https://github.com/juliaastro/PSFModels.jl/actions)
+[![Build Status](https://github.com/juliaastro/PSFModels.jl/workflows/CI/badge.svg?branch=main)](https://github.com/juliaastro/PSFModels.jl/actions)
 [![PkgEval](https://juliaci.github.io/NanosoldierReports/pkgeval_badges/P/PSFModels.svg)](https://juliaci.github.io/NanosoldierReports/pkgeval_badges/report.html)
-[![Coverage](https://codecov.io/gh/juliaastro/PSFModels.jl/branch/master/graph/badge.svg?branch=master)](https://codecov.io/gh/juliaastro/PSFModels.jl)
+[![Coverage](https://codecov.io/gh/juliaastro/PSFModels.jl/branch/main/graph/badge.svg?branch=main)](https://codecov.io/gh/juliaastro/PSFModels.jl)
 [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliaastro.github.io/PSFModels.jl/stable)

docs/src/index.md

@@ -5,9 +5,9 @@ CurrentModule = PSFModels
 # PSFModels.jl
 
 [![GitHub](https://img.shields.io/badge/Code-GitHub-black.svg)](https://github.com/juliaastro/PSFModels.jl)
-[![Build Status](https://github.com/juliaastro/PSFModels.jl/workflows/CI/badge.svg?branch=master)](https://github.com/juliaastro/PSFModels.jl/actions)
+[![Build Status](https://github.com/juliaastro/PSFModels.jl/workflows/CI/badge.svg?branch=main)](https://github.com/juliaastro/PSFModels.jl/actions)
 [![PkgEval](https://juliaci.github.io/NanosoldierReports/pkgeval_badges/P/PSFModels.svg)](https://juliaci.github.io/NanosoldierReports/pkgeval_badges/report.html)
-[![Coverage](https://codecov.io/gh/juliaastro/PSFModels.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/juliaastro/PSFModels.jl)
+[![Coverage](https://codecov.io/gh/juliaastro/PSFModels.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/juliaastro/PSFModels.jl)
 [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 ## Installation
@@ -54,7 +54,7 @@ PSFModels
 
 ## Benchmarks
 
-The benchmarks can be found in the [`bench/`](https://github.com/JuliaAstro/PSFModels.jl/tree/master/bench) folder. To run them, first install the python dependencies
+The benchmarks can be found in the [`bench/`](https://github.com/JuliaAstro/PSFModels.jl/tree/main/bench) folder. To run them, first install the python dependencies
 
 ```
 $ pip install -r bench/requirements.txt

src/gaussian.jl

@@ -25,11 +25,12 @@ f(x | x̂, Q) = exp[-4ln(2) * (x - x̂)ᵀ Q (x - x̂)]
 where `Q` is the inverse covariance matrix (or precision matrix). This is equivalent to the inverse of the FWHM matrix after squaring each element.
 """
 struct Gaussian{T,FT,VT<:AbstractVector,IT<:Tuple} <: PSFModel{T}
+    amp::T
     pos::VT
     fwhm::FT
     indices::IT
 
-    Gaussian{T}(pos::VT, fwhm::FT, indices::IT) where {T,VT<:AbstractVector,FT,IT<:Tuple} = new{T,FT,VT,IT}(pos, fwhm, indices)
+    Gaussian{T}(amp::T, pos::VT, fwhm::FT, indices::IT) where {T,VT<:AbstractVector,FT,IT<:Tuple} = new{T,FT,VT,IT}(amp, pos, fwhm, indices)
 end
 
 # Alias Normal -> Gaussian
@@ -45,36 +46,38 @@ const Normal = Gaussian
 # default type is Float64
 Gaussian(args...; kwargs...) = Gaussian{Float64}(args...; kwargs...)
 # parse indices from maxsize
-Gaussian{T}(pos::AbstractVector, fwhm; maxsize=3) where {T} = Gaussian{T}(pos, fwhm, indices_from_extent(pos, fwhm, maxsize))
+Gaussian{T}(pos::AbstractVector; fwhm, amp=one(T), maxsize=3) where {T} = Gaussian{T}(amp, pos, fwhm, indices_from_extent(pos, fwhm, maxsize))
 # default position is [0, 0]
-Gaussian{T}(fwhm; kwargs...) where {T} = Gaussian{T}(SA[0, 0], fwhm; kwargs...)
+Gaussian{T}(; kwargs...) where {T} = Gaussian{T}(SA[0, 0]; kwargs...)
 # # parse position to vector
-Gaussian{T}(x::Number, y::Number, fwhm; kwargs...) where {T} = Gaussian{T}(SA[x, y], fwhm; kwargs...)
-Gaussian{T}(xy::Tuple, fwhm; kwargs...) where {T} = Gaussian{T}(SVector(xy), fwhm; kwargs...)
+Gaussian{T}(x::Number, y::Number; kwargs...) where {T} = Gaussian{T}(SA[x, y]; kwargs...)
+Gaussian{T}(xy::Tuple; kwargs...) where {T} = Gaussian{T}(SVector(xy); kwargs...)
 # # translate polar coordinates to cartesian, optionally recentering
-Gaussian{T}(p::Polar, fwhm; origin=SA[0, 0], kwargs...) where {T} = Gaussian{T}(CartesianFromPolar()(p) .+ origin, fwhm; kwargs...)
+Gaussian{T}(p::Polar; origin=SA[0, 0], kwargs...) where {T} = Gaussian{T}(CartesianFromPolar()(p) .+ origin; kwargs...)
 
 Base.size(g::Gaussian) = map(length, g.indices)
 Base.axes(g::Gaussian) = g.indices
 
+const GAUSS_PRE = -4 * log(2)
+
 # covers scalar case
 function (g::Gaussian{T})(point::AbstractVector) where T
     Δ = sqeuclidean(point, g.pos)
-    val = exp(-4 * log(2) * Δ / g.fwhm^2)
+    val = g.amp * exp(GAUSS_PRE * Δ / g.fwhm^2)
     return convert(T, val)
 end
 # covers vector case
 function (g::Gaussian{T,<:Union{Tuple,AbstractVector}})(point::AbstractVector) where T
     weights = SA[1/first(g.fwhm)^2, 1/last(g.fwhm)^2] # manually invert
     Δ = wsqeuclidean(point, g.pos, weights)
-    val = exp(-4 * log(2) * Δ)
+    val = g.amp * exp(GAUSS_PRE * Δ)
     return convert(T, val)
 end
 
 # matrix case
 function (g::Gaussian{T,<:AbstractMatrix})(point::AbstractVector) where T
     R = point - g.pos
     Δ = R' * ((g.fwhm .^2) \ R)
-    val = exp(-4 * log(2) * Δ)
+    val = g.amp * exp(GAUSS_PRE * Δ)
     return convert(T, val)
 end