Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make the width contain units and add start/end functions #386

Merged
merged 1 commit into from Sep 1, 2021
Merged

Make the width contain units and add start/end functions #386

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
60 changes: 38 additions & 22 deletions modules/core/shared/src/main/scala/lucuma/core/enum/MagnitudeBand.scala
View file
Open in desktop
Expand Up @@ -7,8 +7,16 @@ package enum

import cats.Order
import cats.syntax.eq._
import coulomb._
import coulomb.refined._
import eu.timepit.refined.auto._
import eu.timepit.refined.numeric.Positive
import eu.timepit.refined.types.numeric.PosInt
import lucuma.core.math.Wavelength
import lucuma.core.math.units.Nanometer
import lucuma.core.util.Enumerated
import spire.std.any._
import spire.syntax.all._

/**
* Enumerated type for magnitude band.
Expand All @@ -19,32 +27,40 @@ sealed abstract class MagnitudeBand(
val shortName: String,
val longName: String,
val center: Wavelength,
val width: Int,
val width: Quantity[PosInt, Nanometer],
val magnitudeSystem: MagnitudeSystem
) extends Product with Serializable
) extends Product with Serializable {
require(center.toPicometers.value >= width.value / 2)

def end: Wavelength = Wavelength(center.toPicometers + (width.value.value / 2).withRefinedUnit[Positive, Nanometer])
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a big deal here, but I think you can avoid stripping the units off width for the division and then adding them back on by center.toPicometers + width / 2.withRefinedUnit[Positive, Unitless].

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes you can see
erikerlandson/coulomb#211


// The require above lets ensure we can do this unsafe refine conversion
import coulomb.refined.policy.unsoundRefinedConversions._
def start: Wavelength = Wavelength(center.toPicometers - (width.value.value / 2).withRefinedUnit[Positive, Nanometer])
}

object MagnitudeBand {

/** @group Constructors */ case object SloanU extends MagnitudeBand("SloanU", "u", "UV", Wavelength.unsafeFromInt(356000), 46, MagnitudeSystem.AB)
/** @group Constructors */ case object SloanG extends MagnitudeBand("SloanG", "g", "Green", Wavelength.unsafeFromInt(483000), 99, MagnitudeSystem.AB)
/** @group Constructors */ case object SloanR extends MagnitudeBand("SloanR", "r", "Red", Wavelength.unsafeFromInt(626000), 96, MagnitudeSystem.AB)
/** @group Constructors */ case object SloanI extends MagnitudeBand("SloanI", "i", "Far red", Wavelength.unsafeFromInt(767000), 106, MagnitudeSystem.AB)
/** @group Constructors */ case object SloanZ extends MagnitudeBand("SloanZ", "z", "Near infrared", Wavelength.unsafeFromInt(910000), 125, MagnitudeSystem.AB)
/** @group Constructors */ case object U extends MagnitudeBand("U", "U", "Ultraviolet", Wavelength.unsafeFromInt(360000), 75, MagnitudeSystem.Vega)
/** @group Constructors */ case object B extends MagnitudeBand("B", "B", "Blue", Wavelength.unsafeFromInt(440000), 90, MagnitudeSystem.Vega)
/** @group Constructors */ case object V extends MagnitudeBand("V", "V", "Visual", Wavelength.unsafeFromInt(550000), 85, MagnitudeSystem.Vega)
/** @group Constructors */ case object Uc extends MagnitudeBand("Uc", "UC", "UCAC", Wavelength.unsafeFromInt(610000), 63, MagnitudeSystem.Vega)
/** @group Constructors */ case object R extends MagnitudeBand("R", "R", "Red", Wavelength.unsafeFromInt(670000), 100, MagnitudeSystem.Vega)
/** @group Constructors */ case object I extends MagnitudeBand("I", "I", "Infrared", Wavelength.unsafeFromInt(870000), 100, MagnitudeSystem.Vega)
/** @group Constructors */ case object Y extends MagnitudeBand("Y", "Y", "Y", Wavelength.unsafeFromInt(1020000), 120, MagnitudeSystem.Vega)
/** @group Constructors */ case object J extends MagnitudeBand("J", "J", "J", Wavelength.unsafeFromInt(1250000), 240, MagnitudeSystem.Vega)
/** @group Constructors */ case object H extends MagnitudeBand("H", "H", "H", Wavelength.unsafeFromInt(1650000), 300, MagnitudeSystem.Vega)
/** @group Constructors */ case object K extends MagnitudeBand("K", "K", "K", Wavelength.unsafeFromInt(2200000), 410, MagnitudeSystem.Vega)
/** @group Constructors */ case object L extends MagnitudeBand("L", "L", "L", Wavelength.unsafeFromInt(3760000), 700, MagnitudeSystem.Vega)
/** @group Constructors */ case object M extends MagnitudeBand("M", "M", "M", Wavelength.unsafeFromInt(4770000), 240, MagnitudeSystem.Vega)
/** @group Constructors */ case object N extends MagnitudeBand("N", "N", "N", Wavelength.unsafeFromInt(10470000), 5230, MagnitudeSystem.Vega)
/** @group Constructors */ case object Q extends MagnitudeBand("Q", "Q", "Q", Wavelength.unsafeFromInt(20130000), 1650, MagnitudeSystem.Vega)
/** @group Constructors */ case object Ap extends MagnitudeBand("Ap", "AP", "Apparent", Wavelength.unsafeFromInt(550000), 85, MagnitudeSystem.Vega)
/** @group Constructors */ case object SloanU extends MagnitudeBand("SloanU", "u", "UV", Wavelength(356000), 46.withRefinedUnit[Positive, Nanometer], MagnitudeSystem.AB)
/** @group Constructors */ case object SloanG extends MagnitudeBand("SloanG", "g", "Green", Wavelength(483000), 99.withRefinedUnit[Positive, Nanometer], MagnitudeSystem.AB)
/** @group Constructors */ case object SloanR extends MagnitudeBand("SloanR", "r", "Red", Wavelength(626000), 96.withRefinedUnit[Positive, Nanometer], MagnitudeSystem.AB)
/** @group Constructors */ case object SloanI extends MagnitudeBand("SloanI", "i", "Far red", Wavelength(767000), 106.withRefinedUnit[Positive, Nanometer], MagnitudeSystem.AB)
/** @group Constructors */ case object SloanZ extends MagnitudeBand("SloanZ", "z", "Near infrared", Wavelength(910000), 125.withRefinedUnit[Positive, Nanometer], MagnitudeSystem.AB)
/** @group Constructors */ case object U extends MagnitudeBand("U", "U", "Ultraviolet", Wavelength(360000), 75.withRefinedUnit[Positive, Nanometer], MagnitudeSystem.Vega)
/** @group Constructors */ case object B extends MagnitudeBand("B", "B", "Blue", Wavelength(440000), 90.withRefinedUnit[Positive, Nanometer], MagnitudeSystem.Vega)
/** @group Constructors */ case object V extends MagnitudeBand("V", "V", "Visual", Wavelength(550000), 85.withRefinedUnit[Positive, Nanometer], MagnitudeSystem.Vega)
/** @group Constructors */ case object Uc extends MagnitudeBand("Uc", "UC", "UCAC", Wavelength(610000), 63.withRefinedUnit[Positive, Nanometer], MagnitudeSystem.Vega)
/** @group Constructors */ case object R extends MagnitudeBand("R", "R", "Red", Wavelength(670000), 100.withRefinedUnit[Positive, Nanometer], MagnitudeSystem.Vega)
/** @group Constructors */ case object I extends MagnitudeBand("I", "I", "Infrared", Wavelength(870000), 100.withRefinedUnit[Positive, Nanometer], MagnitudeSystem.Vega)
/** @group Constructors */ case object Y extends MagnitudeBand("Y", "Y", "Y", Wavelength(1020000), 120.withRefinedUnit[Positive, Nanometer], MagnitudeSystem.Vega)
/** @group Constructors */ case object J extends MagnitudeBand("J", "J", "J", Wavelength(1250000), 240.withRefinedUnit[Positive, Nanometer], MagnitudeSystem.Vega)
/** @group Constructors */ case object H extends MagnitudeBand("H", "H", "H", Wavelength(1650000), 300.withRefinedUnit[Positive, Nanometer], MagnitudeSystem.Vega)
/** @group Constructors */ case object K extends MagnitudeBand("K", "K", "K", Wavelength(2200000), 410.withRefinedUnit[Positive, Nanometer], MagnitudeSystem.Vega)
/** @group Constructors */ case object L extends MagnitudeBand("L", "L", "L", Wavelength(3760000), 700.withRefinedUnit[Positive, Nanometer], MagnitudeSystem.Vega)
/** @group Constructors */ case object M extends MagnitudeBand("M", "M", "M", Wavelength(4770000), 240.withRefinedUnit[Positive, Nanometer], MagnitudeSystem.Vega)
/** @group Constructors */ case object N extends MagnitudeBand("N", "N", "N", Wavelength(10470000), 5230.withRefinedUnit[Positive, Nanometer], MagnitudeSystem.Vega)
/** @group Constructors */ case object Q extends MagnitudeBand("Q", "Q", "Q", Wavelength(20130000), 1650.withRefinedUnit[Positive, Nanometer], MagnitudeSystem.Vega)
/** @group Constructors */ case object Ap extends MagnitudeBand("Ap", "AP", "Apparent", Wavelength(550000), 85.withRefinedUnit[Positive, Nanometer], MagnitudeSystem.Vega)

/** All members of MagnitudeBand, in canonical order. */
val all: List[MagnitudeBand] =
Expand Down