Type Members

1.  sealed abstract class Access extends Product with Serializable

   A role can be reduced to an AccessLevel by discarding the NGO role's partner, leaving us with a simple enumerated (and thus ordered) type.

   A role can be reduced to an AccessLevel by discarding the NGO role's partner, leaving us with a simple enumerated (and thus ordered) type. Usually this is all we care about when checking whether a user is allowed to do something.

2.  final case class AccessControlException(displayName: String, id: User.Id, role: Role, access: Access) extends Exception with Product with Serializable
3.  final case class CatalogInfo(catalog: CatalogName, id: NonEmptyString, objectType: Option[NonEmptyString]) extends Product with Serializable
4.  final case class ConstraintSet(imageQuality: ImageQuality, cloudExtinction: CloudExtinction, skyBackground: SkyBackground, waterVapor: WaterVapor, elevationRange: ElevationRange) extends Product with Serializable

   Constraints for an observation.

5.  sealed trait ElevationRange extends Product with Serializable
6.  final case class EmissionLine[T](lineWidth: Quantity[PosBigDecimal, math.units.KilometersPerSecond], lineFlux: Of[Measure[PosBigDecimal], LineFlux[T]]) extends Product with Serializable
7.  sealed abstract case class Ephemeris extends Product with Serializable

   Time-parameterized coordinates over a fixed interval, defined pairwise.

   Time-parameterized coordinates over a fixed interval, defined pairwise. Coordinates that fall between known instants are interpolated.

8.  final case class EphemerisCoordinates(coord: Coordinates, delta: Offset) extends Product with Serializable

   A coordinate along with a rate of change in RA and Dec for some time unit, expressed as an offset in p and q.

   A coordinate along with a rate of change in RA and Dec for some time unit, expressed as an offset in p and q. In reality the velocity information comes from horizons and is always arcseconds per hour in horizons data.

   coord

   coordinates

   delta

   rate of change in RA and dec, where the delta(RA)/time has been multiplied by the cosine of the dec

9.  trait EphemerisCoordinatesOptics extends AnyRef
10.  trait EphemerisJson extends AnyRef
11.  sealed trait EphemerisKey extends Product with Serializable

    Ephemeris data lookup key which uniquely identifies a non-sidereal object in the database.

12.  trait EphemerisOptics extends AnyRef
13.  sealed trait ExposureTimeMode extends Product with Serializable
14.  final case class GuestUser(id: User.Id) extends User with Product with Serializable

    Guest users have the weakest Role and no identifying information.

15.  type IntPercent = Refined[Int, ZeroTo100]
16.  final case class LocalObservingNight(toLocalDate: LocalDate) extends Product with Serializable

    A local observing night is defined as the period of time starting at 14:00 (inclusive) on one day and ending at 14:00 (exclusive) the next day.

    A local observing night is defined as the period of time starting at 14:00 (inclusive) on one day and ending at 14:00 (exclusive) the next day.

    A LocalObservingNight is site-agnostic. Use atSite to obtain precise start / end times in an ObservingNight.

17.  trait LocalObservingNightOptics extends AnyRef
18.  trait Night extends AnyRef

    Description of the start/end times for a night according to some criterion.

    Description of the start/end times for a night according to some criterion. For example, the official observing night begins and ends at 2PM local time while twilight bounded nights start and end according to defined angles of the sun below the horizon.

19.  type NonNegDuration = Refined[Duration, NonNegative]
20.  final case class ObservingNight(site: Site, toLocalObservingNight: LocalObservingNight) extends Night with Product with Serializable

    An observing night is defined as the period of time from 14:00 on one day until 14:00 on the following day.

    An observing night is defined as the period of time from 14:00 on one day until 14:00 on the following day. In a timezone that honors daylight saving, it is sometimes longer and sometimes shorter than a period of 24 hours.

    An ObservingNight pairs a Site with a LocalObservingNight to obtain precise start/end Instants.

21.  trait ObservingNightOptics extends AnyRef
22.  sealed abstract case class OrcidId extends Product with Serializable

    The ORCID iD is an https URI with a 16-digit number that is compatible with the ISO Standard (ISO 27729), also known as the International Standard Name Identifier (ISNI).

    The ORCID iD is an https URI with a 16-digit number that is compatible with the ISO Standard (ISO 27729), also known as the International Standard Name Identifier (ISNI). The last digit is a checksum that is either 0-9, or X.

    See also

    https://support.orcid.org/hc/en-us/articles/360006897674-Structure-of-the-ORCID-Identifier

23.  final case class OrcidProfile(orcidId: OrcidId, givenName: Option[String], familyName: Option[String], creditName: Option[String], primaryEmail: Option[String]) extends Product with Serializable

    An ORCID profile is an OrcidId and a set of optional fields.

24.  sealed abstract class Partner extends Product with Serializable

    NGO users are associated with a partner.

25.  sealed trait PosAngleConstraint extends Product with Serializable

    Position Angle Constraint model.

    Position Angle Constraint model. Defines how the position angle will be constrained.

26.  sealed trait PosAngleConstraintOptics extends AnyRef
27.  final case class Proposal(title: Option[NonEmptyString], proposalClass: ProposalClass, category: Option[TacCategory], toOActivation: ToOActivation, abstrakt: Option[NonEmptyString], partnerSplits: SortedMap[Partner, IntPercent]) extends Product with Serializable
28.  sealed trait ProposalClass extends AnyRef
29.  sealed abstract class Role extends AnyRef

    Each user has a current Role and a set of other roles they may assume.

    Each user has a current Role and a set of other roles they may assume. A role has (at least) an Access level.

30.  final case class Semester(year: Year, half: Half) extends Product with Serializable

    A (Year, Half) pair.

31.  final case class ServiceRole(serviceName: String) extends Role with Product with Serializable

    ServiceRole is used only for inter-service communication.

32.  final case class ServiceUser(id: User.Id, name: String) extends User with Product with Serializable

    Service users have the strongest Role and represent services themselves.

33.  final case class SiderealTracking(baseCoordinates: Coordinates, epoch: Epoch, properMotion: Option[ProperMotion], radialVelocity: Option[RadialVelocity], parallax: Option[Parallax]) extends Product with Serializable

    Time-parameterized coordinates, based on an observed position at some point in time (called the epoch) and measured velocities in distance (radialVelocity; i.e., doppler shift) and position (properMotion) per year.

    Time-parameterized coordinates, based on an observed position at some point in time (called the epoch) and measured velocities in distance (radialVelocity; i.e., doppler shift) and position (properMotion) per year. Given this information we can compute the position at any instant in time. The references below are extremely helpful, so do check them out if you're trying to understand the implementation.

    baseCoordinates

    observed coordinates at epoch

    epoch

    time of the base observation; typically Epoch.J2000

    properMotion

    proper velocity per year in lucuma.core.math.RightAscension and lucuma.core.math.Declination, if any

    radialVelocity

    radial velocity (km/y, positive if receding), if any

    parallax

    parallax, if any

    See also

    The pretty good wikipedia article

    Astronomical Almanac 1984 p.B39

    Astronomy and Astrophysics 134 (1984) p.1-6

34.  trait SiderealTrackingOptics extends AnyRef
35.  sealed trait SourceProfile extends Product with Serializable
36.  sealed trait SpectralDefinition[T] extends AnyRef
37.  sealed abstract class StandardRole extends Role

    The class of roles taken on by authenticated users.

38.  final case class StandardUser(id: User.Id, role: StandardRole, otherRoles: List[StandardRole], profile: OrcidProfile) extends User with Product with Serializable

    Standard users are authenticated and have a current role and ORCID profile, as well as a set of other roles they can assume.

39.  sealed trait Target extends Product with Serializable

    A target of observation.

40.  trait TargetOptics extends AnyRef
41.  sealed abstract case class TwilightBoundedNight extends Night with Product with Serializable

    The start and end of a particular night at a lucuma.core.enums.Site.

42.  trait TwilightBoundedNightOptics extends AnyRef
43.  sealed trait UnnormalizedSED extends Product with Serializable

    Unnormalized Spectral Energy Distribution.

    Unnormalized Spectral Energy Distribution.

    An unnormalized SED describes the shape of the SED across wavelengths. It's then normalized around a certain wavelength by using band brightnesses. By contrast, emission lines specify a normalized SED directly, without the need for band brightness information.

44.  sealed trait User extends Product with Serializable

    A user has [at least] an identity and a role.

45.  type ZeroTo100 = And[GreaterEqual[0], LessEqual[100]]