Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
lucuma.core.model.SourceProfile.scala Maven / Gradle / Ivy
// Copyright (c) 2016-2023 Association of Universities for Research in Astronomy, Inc. (AURA)
// For license information see LICENSE or https://opensource.org/licenses/BSD-3-Clause
package lucuma.core.model
import cats.Eq
import cats.syntax.all.*
import eu.timepit.refined.cats.given
import lucuma.core.enums.Band
import lucuma.core.math.Angle
import lucuma.core.math.BrightnessUnits.*
import lucuma.core.math.BrightnessValue
import lucuma.core.math.Wavelength
import lucuma.core.math.dimensional.*
import monocle.Focus
import monocle.Lens
import monocle.Optional
import monocle.Prism
import monocle.Traversal
import monocle.macros.GenPrism
import scala.collection.immutable.SortedMap
sealed trait SourceProfile extends Product with Serializable {
/**
* Convert to a `Point` source profile. Units are converted to their `Integrated` versions, if
* necessary.
*/
def toPoint: SourceProfile.Point
/**
* Convert to a `Uniform` source profile. Units are converted to their `Surface` versions, if
* necessary.
*/
def toUniform: SourceProfile.Uniform
/**
* Convert to a `Gaussian` source profile. Units are converted to their `Integrated` versions, if
* necessary.
*/
def toGaussian: SourceProfile.Gaussian
}
object SourceProfile {
/**
* Point source.
*
* @param spectralDefinition
* integrated spectral definition
*/
final case class Point(spectralDefinition: SpectralDefinition[Integrated]) extends SourceProfile {
override def toPoint: Point = this
override def toUniform: Uniform =
Uniform(spectralDefinition.to[Surface])
override def toGaussian: Gaussian = Gaussian(Angle.Angle0, spectralDefinition)
}
object Point {
given Eq[Point] = Eq.by(_.spectralDefinition)
/** @group Optics */
val spectralDefinition: Lens[Point, SpectralDefinition[Integrated]] =
Focus[Point](_.spectralDefinition)
}
/**
* Uniform source.
*
* @param spectralDefinition
* integrated spectral definition
*/
final case class Uniform(spectralDefinition: SpectralDefinition[Surface]) extends SourceProfile {
override def toPoint: Point = Point(spectralDefinition.to[Integrated])
override def toUniform: Uniform = this
override def toGaussian: Gaussian =
Gaussian(Angle.Angle0, spectralDefinition.to[Integrated])
}
object Uniform {
given Eq[Uniform] = Eq.by(_.spectralDefinition)
/** @group Optics */
val spectralDefinition: Lens[Uniform, SpectralDefinition[Surface]] =
Focus[Uniform](_.spectralDefinition)
}
/**
* Gaussian source. For a good discussion of seeing see the ["Astronomical seeing" wikipedia
* entry](https://en.wikipedia.org/wiki/Astronomical_seeing).
*
* @param fwhm
* full width at half maximum of the seeing disc (typically in arcsec)
* @param spectralDefinition
* integrated spectral definition
*/
final case class Gaussian(
fwhm: Angle,
spectralDefinition: SpectralDefinition[Integrated]
) extends SourceProfile {
override def toPoint: Point = Point(spectralDefinition)
override def toUniform: Uniform = Uniform(spectralDefinition.to[Surface])
override def toGaussian: Gaussian = this
}
object Gaussian {
given Eq[Gaussian] = Eq.by(x => (x.fwhm, x.spectralDefinition))
/** @group Optics */
val fwhm: Lens[Gaussian, Angle] =
Focus[Gaussian](_.fwhm)
/** @group Optics */
val spectralDefinition: Lens[Gaussian, SpectralDefinition[Integrated]] =
Focus[Gaussian](_.spectralDefinition)
}
given Eq[SourceProfile] = Eq.instance {
case (a @ Point(_), b @ Point(_)) => a === b
case (a @ Uniform(_), b @ Uniform(_)) => a === b
case (a @ Gaussian(_, _), b @ Gaussian(_, _)) => a === b
case _ => false
}
/** @group Optics */
val point: Prism[SourceProfile, Point] = GenPrism[SourceProfile, Point]
/** @group Optics */
val uniform: Prism[SourceProfile, Uniform] = GenPrism[SourceProfile, Uniform]
/** @group Optics */
val gaussian: Prism[SourceProfile, Gaussian] = GenPrism[SourceProfile, Gaussian]
/** @group Optics */
val integratedSpectralDefinition: Optional[SourceProfile, SpectralDefinition[Integrated]] =
Optional[SourceProfile, SpectralDefinition[Integrated]](p =>
point
.andThen(Point.spectralDefinition)
.getOption(p)
.orElse(
gaussian
.andThen(Gaussian.spectralDefinition)
.getOption(p)
)
)(v => {
case p @ Point(_) => Point.spectralDefinition.replace(v)(p)
case p @ Gaussian(_, _) => Gaussian.spectralDefinition.replace(v)(p)
case p => p
})
/** @group Optics */
val surfaceSpectralDefinition: Optional[SourceProfile, SpectralDefinition[Surface]] =
uniform.andThen(Uniform.spectralDefinition)
/** @group Optics */
val fwhm: Optional[SourceProfile, Angle] =
gaussian.andThen(Gaussian.fwhm)
/** @group Optics */
val integratedBandNormalizedSpectralDefinition
: Optional[SourceProfile, SpectralDefinition.BandNormalized[Integrated]] =
integratedSpectralDefinition.andThen(SpectralDefinition.bandNormalized[Integrated])
/** @group Optics */
val surfaceBandNormalizedSpectralDefinition
: Optional[SourceProfile, SpectralDefinition.BandNormalized[Surface]] =
surfaceSpectralDefinition.andThen(SpectralDefinition.bandNormalized[Surface])
/** @group Optics */
val integratedEmissionLinesSpectralDefinition
: Optional[SourceProfile, SpectralDefinition.EmissionLines[Integrated]] =
integratedSpectralDefinition.andThen(SpectralDefinition.emissionLines[Integrated])
/** @group Optics */
val surfaceEmissionLinesSpectralDefinition
: Optional[SourceProfile, SpectralDefinition.EmissionLines[Surface]] =
surfaceSpectralDefinition.andThen(SpectralDefinition.emissionLines[Surface])
/** @group Optics */
val unnormalizedSED: Optional[SourceProfile, Option[UnnormalizedSED]] =
Optional[SourceProfile, Option[UnnormalizedSED]](p =>
integratedSpectralDefinition
.andThen(SpectralDefinition.unnormalizedSED[Integrated])
.getOption(p)
.orElse(
surfaceSpectralDefinition
.andThen(SpectralDefinition.unnormalizedSED[Surface])
.getOption(p)
)
)(v => {
case p @ Uniform(_) =>
surfaceSpectralDefinition.andThen(SpectralDefinition.unnormalizedSED[Surface]).replace(v)(p)
case p =>
integratedSpectralDefinition
.andThen(SpectralDefinition.unnormalizedSED[Integrated])
.replace(v)(p)
})
/** @group Optics */
val integratedBrightnesses
: Optional[SourceProfile, SortedMap[Band, BrightnessMeasure[Integrated]]] =
integratedSpectralDefinition.andThen(SpectralDefinition.brightnesses[Integrated])
/** @group Optics */
val surfaceBrightnesses: Optional[SourceProfile, SortedMap[Band, BrightnessMeasure[Surface]]] =
surfaceSpectralDefinition.andThen(SpectralDefinition.brightnesses[Surface])
/** @group Optics */
val integratedBrightnessesT: Traversal[SourceProfile, BrightnessMeasure[Integrated]] =
integratedSpectralDefinition.andThen(SpectralDefinition.brightnessesT[Integrated])
/** @group Optics */
val surfaceBrightnessesT: Traversal[SourceProfile, BrightnessMeasure[Surface]] =
surfaceSpectralDefinition.andThen(SpectralDefinition.brightnessesT[Surface])
/** @group Optics */
def integratedBrightnessIn[T](b: Band): Traversal[SourceProfile, BrightnessMeasure[Integrated]] =
integratedSpectralDefinition.andThen(SpectralDefinition.brightnessIn[Integrated](b))
/** @group Optics */
def surfaceBrightnessIn[T](b: Band): Traversal[SourceProfile, BrightnessMeasure[Surface]] =
surfaceSpectralDefinition.andThen(SpectralDefinition.brightnessIn[Surface](b))
/** @group Optics */
val integratedWavelengthLines
: Optional[SourceProfile, SortedMap[Wavelength, EmissionLine[Integrated]]] =
integratedSpectralDefinition.andThen(SpectralDefinition.wavelengthLines[Integrated])
/** @group Optics */
val surfaceWavelengthLines
: Optional[SourceProfile, SortedMap[Wavelength, EmissionLine[Surface]]] =
surfaceSpectralDefinition.andThen(SpectralDefinition.wavelengthLines[Surface])
/** @group Optics */
val integratedWavelengthLinesT: Traversal[SourceProfile, EmissionLine[Integrated]] =
integratedSpectralDefinition.andThen(SpectralDefinition.wavelengthLinesT[Integrated])
/** @group Optics */
val surfaceWavelengthLinesT: Traversal[SourceProfile, EmissionLine[Surface]] =
surfaceSpectralDefinition.andThen(SpectralDefinition.wavelengthLinesT[Surface])
/** @group Optics */
def integratedWavelengthLineIn(
w: Wavelength
): Traversal[SourceProfile, EmissionLine[Integrated]] =
integratedSpectralDefinition.andThen(SpectralDefinition.wavelengthLineIn[Integrated](w))
/** @group Optics */
def surfaceWavelengthLineIn[T](w: Wavelength): Traversal[SourceProfile, EmissionLine[Surface]] =
surfaceSpectralDefinition.andThen(SpectralDefinition.wavelengthLineIn[Surface](w))
/** @group Optics */
val integratedFluxDensityContinuum: Optional[SourceProfile, FluxDensityContinuumMeasure[Integrated]] =
integratedSpectralDefinition.andThen(SpectralDefinition.fluxDensityContinuum[Integrated])
/** @group Optics */
val surfaceFluxDensityContinuum: Optional[SourceProfile, FluxDensityContinuumMeasure[Surface]] =
surfaceSpectralDefinition.andThen(SpectralDefinition.fluxDensityContinuum[Surface])
/**
* Returns the band and brightness value for the band closest to the given wavelength.
*/
def extractBand[T](w: Wavelength, bMap: SortedMap[Band, BrightnessMeasure[T]]): Option[(Band, BrightnessValue, Units)] =
bMap.minByOption { case (b, _) =>
(w.toPicometers.value.value - b.center.toPicometers.value.value).abs
}.map(x => (x._1, x._2.value, x._2.units))
extension(sp: SourceProfile)
/**
* Returns the band and brightness of a source profile for the band closest to the given wavelength.
* It is only valid for source profiles with integrated or surface brightnesses.
* (Emission lines not supported)
*/
def nearestBand(wavelength: Wavelength): Option[(Band, BrightnessValue, Units)] =
SourceProfile
.integratedBrightnesses
.getOption(sp)
.flatMap(bMap => extractBand[Integrated](wavelength, bMap))
.orElse(
SourceProfile
.surfaceBrightnesses
.getOption(sp)
.flatMap(bMap => extractBand[Surface](wavelength, bMap))
)
}
