lucuma.itc.Itc.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.itc
import cats.data.NonEmptyList
import eu.timepit.refined.types.numeric.PosInt
import lucuma.core.math.SignalToNoise
import lucuma.core.math.Wavelength
import lucuma.core.util.TimeSpan
import lucuma.itc.search.*
trait Itc[F[_]]:
/**
* Compute the exposure time and number of exposures required to achieve the desired
* signal-to-noise under the requested conditions.
*/
def calculateIntegrationTime(
targetProfile: TargetProfile,
observingMode: ObservingMode,
constraints: ItcObservingConditions,
signalToNoise: SignalToNoise,
signalToNoiseAt: Option[Wavelength]
): F[NonEmptyList[IntegrationTime]]
/**
* Retrieve the graph data for the given mode and exposureTime and exposures
*/
def calculateGraph(
targetProfile: TargetProfile,
observingMode: ObservingMode,
constraints: ItcObservingConditions,
exposureTime: TimeSpan,
exposures: PosInt,
signalToNoiseAt: Option[Wavelength]
): F[GraphResult]
/**
* Calculate the signal to noise from graph data for the given mode and exposureTime and amount of
* exposures at a specific wavelength
*/
def calculateSignalToNoise(
graph: NonEmptyList[ItcChartGroup],
signalToNoiseAt: Option[Wavelength]
): F[SNCalcResult]
object Itc:
def apply[F[_]](using ev: Itc[F]): ev.type = ev