astronoby 0.3.0 → 0.4.0

data/lib/astronoby/util/maths.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Astronoby
+  module Util
+    module Maths
+      class << self
+        # Source:
+        #  Title: Astronomical Algorithms
+        #  Author: Jean Meeus
+        #  Edition: 2nd edition
+        #  Chapter: 3 - Interpolation
+
+        # @param values [Array<Numeric>] First term
+        # @param factor [Numeric] Interpolation factor
+        # @return [Float] Interpolated value
+        def interpolate(values, factor)
+          unless factor.between?(0, 1)
+            raise IncompatibleArgumentsError,
+              "Interpolation factor must be between 0 and 1"
+          end
+
+          if values.length == 3
+            return interpolate_3_terms(values, factor)
+          elsif values.length == 5
+            return interpolate_5_terms(values, factor)
+          end
+
+          raise IncompatibleArgumentsError,
+            "Only 3 or 5 terms are supported for interpolation"
+        end
+
+        private
+
+        # @return [Float] Interpolated value
+        def interpolate_3_terms(terms, factor)
+          y1, y2, y3 = terms
+
+          a = y2 - y1
+          b = y3 - y2
+          c = b - a
+
+          y2 + (factor / 2.0) * (a + b + factor * c)
+        end
+
+        # @return [Float] Interpolated value
+        def interpolate_5_terms(terms, factor)
+          y1, y2, y3, y4, y5 = terms
+
+          a = y2 - y1
+          b = y3 - y2
+          c = y4 - y3
+          d = y5 - y4
+
+          e = b - a
+          f = c - b
+          g = d - c
+
+          h = f - e
+          j = g - f
+
+          k = j - h
+
+          y3 +
+            factor * ((b + c) / 2.0 - (h + j) / 12.0) +
+            factor**2 * (f / 2.0 - k / 24.0) +
+            factor**3 * (h + j) / 12.0 +
+            factor**4 * k / 24.0
+        end
+      end
+    end
+  end
+end

data/lib/astronoby/util/time.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Astronoby
+  module Util
+    module Time
+      # @param date [Date]
+      # @param decimal [Numeric] Hour of the day, in decimal hours
+      # @return [::Time] Date and time
+      def self.decimal_hour_to_time(date, decimal)
+        absolute_hour = decimal.abs
+        hour = absolute_hour.floor
+
+        unless hour.between?(0, Constants::HOURS_PER_DAY)
+          raise(
+            IncompatibleArgumentsError,
+            "Hour must be between 0 and #{Constants::HOURS_PER_DAY.to_i}, got #{hour}"
+          )
+        end
+
+        decimal_minute = Constants::MINUTES_PER_HOUR * (absolute_hour - hour)
+        absolute_decimal_minute = (
+          Constants::MINUTES_PER_HOUR * (absolute_hour - hour)
+        ).abs
+        minute = decimal_minute.floor
+        second = Constants::SECONDS_PER_MINUTE *
+          (absolute_decimal_minute - absolute_decimal_minute.floor)
+
+        ::Time.utc(date.year, date.month, date.day, hour, minute, second).round
+      end
+
+      # @param instant [Numeric, Time, Date, DateTime]
+      # @return [Integer, Float] Number of leap seconds for the given instant
+      def self.terrestrial_universal_time_delta(instant)
+        # Source:
+        #  Title: Astronomical Algorithms
+        #  Author: Jean Meeus
+        #  Edition: 2nd edition
+        #  Chapter: 10 - Dynamical Time and Universal Time
+
+        jd = case instant
+        when Numeric
+          instant
+        when ::Time, ::Date, ::DateTime
+          Epoch.from_time(instant)
+        else
+          raise IncompatibleArgumentsError,
+            "Expected a Numeric, Time, Date or DateTime object, got #{instant.class}"
+        end
+
+        return 69 if jd >= 2457754.5
+        return 68 if jd >= 2457204.5
+        return 67 if jd >= 2456109.5
+        return 66 if jd >= 2454832.5
+        return 65 if jd >= 2453736.5
+        return 64 if jd >= 2451179.5
+        return 63 if jd >= 2450814.5
+
+        theta = ((jd - Epoch::J1900) / 365.25) / 100.0
+        if (2415020.5...2450814.5).cover?(jd) # 1900 - 1997
+          return -2.44 +
+              87.24 * theta +
+              815.20 * theta**2 -
+              2_637.80 * theta**3 -
+              18_756.33 * theta**4 +
+              124_906.15 * theta**5 -
+              303_191.19 * theta**6 +
+              372_919.88 * theta**7 -
+              232_424.66 * theta**8 +
+              58_353.42 * theta**9
+        elsif (2378496.5...2415020.5).cover?(jd) # 1800 - 1899
+          return -2.5 +
+              228.95 * theta +
+              5_218.61 * theta**2 +
+              56_282.84 * theta**3 +
+              324_011.78 * theta**4 +
+              1_061_660.75 * theta**5 +
+              2_087_298.89 * theta**6 +
+              2_513_807.78 * theta**7 +
+              1_818_961.41 * theta**8 +
+              727_058.63 * theta**9 +
+              123_563.95 * theta**10
+        end
+
+        0.0
+      end
+    end
+  end
+end

data/lib/astronoby/util/trigonometry.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "bigdecimal/math"
-
 module Astronoby
   module Util
     module Trigonometry
@@ -15,10 +13,12 @@ module Astronoby
           return angle if y.positive? && x.positive?
 
           if y.negative? && x.positive?
-            return Angle.from_degrees(angle.degrees + 360)
+            return Angle.from_degrees(
+              angle.degrees + Constants::DEGREES_PER_CIRCLE
+            )
           end
 
-          Angle.from_degrees(angle.degrees + 180)
+          Angle.from_degrees(angle.degrees + Constants::DEGREES_PER_CIRCLE / 2)
         end
       end
     end

data/lib/astronoby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Astronoby
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/astronoby.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
+require "astronoby/constants"
 require "astronoby/angle"
 require "astronoby/angles/dms"
 require "astronoby/angles/hms"
 require "astronoby/epoch"
-require "astronoby/body"
 require "astronoby/bodies/sun"
 require "astronoby/coordinates/ecliptic"
 require "astronoby/coordinates/equatorial"
@@ -12,6 +12,8 @@ require "astronoby/coordinates/horizontal"
 require "astronoby/aberration"
 require "astronoby/equinox_solstice"
 require "astronoby/errors"
+require "astronoby/events/observation_events"
+require "astronoby/events/twilight_events"
 require "astronoby/geocentric_parallax"
 require "astronoby/mean_obliquity"
 require "astronoby/nutation"
@@ -21,6 +23,8 @@ require "astronoby/refraction"
 require "astronoby/time/greenwich_sidereal_time"
 require "astronoby/time/local_sidereal_time"
 require "astronoby/util/astrodynamics"
+require "astronoby/util/maths"
+require "astronoby/util/time"
 require "astronoby/util/trigonometry"
 require "astronoby/true_obliquity"
 require "astronoby/version"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: astronoby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Rémy Hannequin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-29 00:00:00.000000000 Z
+date: 2024-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: matrix
@@ -92,13 +92,15 @@ files:
 - lib/astronoby/angles/dms.rb
 - lib/astronoby/angles/hms.rb
 - lib/astronoby/bodies/sun.rb
-- lib/astronoby/body.rb
+- lib/astronoby/constants.rb
 - lib/astronoby/coordinates/ecliptic.rb
 - lib/astronoby/coordinates/equatorial.rb
 - lib/astronoby/coordinates/horizontal.rb
 - lib/astronoby/epoch.rb
 - lib/astronoby/equinox_solstice.rb
 - lib/astronoby/errors.rb
+- lib/astronoby/events/observation_events.rb
+- lib/astronoby/events/twilight_events.rb
 - lib/astronoby/geocentric_parallax.rb
 - lib/astronoby/mean_obliquity.rb
 - lib/astronoby/nutation.rb
@@ -109,6 +111,8 @@ files:
 - lib/astronoby/time/local_sidereal_time.rb
 - lib/astronoby/true_obliquity.rb
 - lib/astronoby/util/astrodynamics.rb
+- lib/astronoby/util/maths.rb
+- lib/astronoby/util/time.rb
 - lib/astronoby/util/trigonometry.rb
 - lib/astronoby/version.rb
 homepage: https://github.com/rhannequin/astronoby
@@ -126,7 +130,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/astronoby/body.rb

@@ -1,155 +0,0 @@
-# frozen_string_literal: true
-
-module Astronoby
-  class Body
-    DEFAULT_REFRACTION_VERTICAL_SHIFT = Angle.from_dms(0, 34, 0)
-    RISING_SETTING_HOUR_ANGLE_RATIO_RANGE = (-1..1)
-
-    def initialize(equatorial_coordinates)
-      @equatorial_coordinates = equatorial_coordinates
-    end
-
-    # Source:
-    #  Title: Practical Astronomy with your Calculator or Spreadsheet
-    #  Authors: Peter Duffett-Smith and Jonathan Zwart
-    #  Edition: Cambridge University Press
-    #  Chapter: 33 - Rising and setting
-
-    # @param latitude [Astronoby::Angle] Latitude of the observer
-    # @param longitude [Astronoby::Angle] Longitude of the observer
-    # @param date [Date] Date of the event
-    # @param apparent [Boolean] Compute apparent or true data
-    # @param vertical_shift [Astronoby::Angle] Vertical shift correction angle
-    # @return [Time, nil] Sunrise time
-    def rising_time(
-      latitude:,
-      longitude:,
-      date:,
-      apparent: true,
-      vertical_shift: nil
-    )
-      time_ratio = time_ratio(latitude, apparent, vertical_shift)
-      return nil unless RISING_SETTING_HOUR_ANGLE_RATIO_RANGE.cover?(time_ratio)
-
-      hour_angle = Angle.acos(time_ratio)
-      local_sidereal_time = LocalSiderealTime.new(
-        date: date,
-        time: right_ascension.hours - hour_angle.hours,
-        longitude: longitude
-      )
-
-      local_sidereal_time.to_gst.to_utc
-    end
-
-    # Source:
-    #  Title: Practical Astronomy with your Calculator or Spreadsheet
-    #  Authors: Peter Duffett-Smith and Jonathan Zwart
-    #  Edition: Cambridge University Press
-    #  Chapter: 33 - Rising and setting
-
-    # @param latitude [Astronoby::Angle] Latitude of the observer
-    # @param apparent [Boolean] Compute apparent or true data
-    # @param vertical_shift [Astronoby::Angle] Vertical shift correction angle
-    # @return [Astronoby::Angle, nil] Sunrise azimuth
-    def rising_azimuth(latitude:, apparent: true, vertical_shift: nil)
-      time_ratio = time_ratio(latitude, apparent, vertical_shift)
-      return nil unless RISING_SETTING_HOUR_ANGLE_RATIO_RANGE.cover?(time_ratio)
-
-      azimuth_ratio = azimuth_ratio(latitude, apparent, vertical_shift)
-
-      Angle.acos(azimuth_ratio)
-    end
-
-    # Source:
-    #  Title: Practical Astronomy with your Calculator or Spreadsheet
-    #  Authors: Peter Duffett-Smith and Jonathan Zwart
-    #  Edition: Cambridge University Press
-    #  Chapter: 33 - Rising and setting
-
-    # @param latitude [Astronoby::Angle] Latitude of the observer
-    # @param longitude [Astronoby::Angle] Longitude of the observer
-    # @param date [Date] Date of the event
-    # @param apparent [Boolean] Compute apparent or true data
-    # @param vertical_shift [Astronoby::Angle] Vertical shift correction angle
-    # @return [Time, nil] Sunset time
-    def setting_time(
-      latitude:,
-      longitude:,
-      date:,
-      apparent: true,
-      vertical_shift: nil
-    )
-      time_ratio = time_ratio(latitude, apparent, vertical_shift)
-      return unless RISING_SETTING_HOUR_ANGLE_RATIO_RANGE.cover?(time_ratio)
-
-      hour_angle = Angle.acos(time_ratio)
-      local_sidereal_time = LocalSiderealTime.new(
-        date: date,
-        time: right_ascension.hours + hour_angle.hours,
-        longitude: longitude
-      )
-
-      local_sidereal_time.to_gst.to_utc
-    end
-
-    # Source:
-    #  Title: Practical Astronomy with your Calculator or Spreadsheet
-    #  Authors: Peter Duffett-Smith and Jonathan Zwart
-    #  Edition: Cambridge University Press
-    #  Chapter: 33 - Rising and setting
-
-    # @param latitude [Astronoby::Angle] Latitude of the observer
-    # @param apparent [Boolean] Compute apparent or true data
-    # @param vertical_shift [Astronoby::Angle] Vertical shift correction angle
-    # @return [Astronoby::Angle, nil] Sunset azimuth
-    def setting_azimuth(latitude:, apparent: true, vertical_shift: nil)
-      time_ratio = time_ratio(latitude, apparent, vertical_shift)
-      return nil unless RISING_SETTING_HOUR_ANGLE_RATIO_RANGE.cover?(time_ratio)
-
-      azimuth_ratio = azimuth_ratio(latitude, apparent, vertical_shift)
-
-      Angle.from_degrees(360 - Angle.acos(azimuth_ratio).degrees)
-    end
-
-    private
-
-    def time_ratio(latitude, apparent, vertical_shift)
-      shift = if vertical_shift
-        vertical_shift
-      elsif apparent
-        DEFAULT_REFRACTION_VERTICAL_SHIFT
-      else
-        Angle.zero
-      end
-
-      term1 = shift.sin + latitude.sin * declination.sin
-      term2 = latitude.cos * declination.cos
-
-      -term1 / term2
-    end
-
-    def azimuth_ratio(latitude, apparent, vertical_shift)
-      shift = if vertical_shift
-        vertical_shift
-      elsif apparent
-        DEFAULT_REFRACTION_VERTICAL_SHIFT
-      else
-        Angle.zero
-      end
-
-      (declination.sin + shift.sin * latitude.cos) / (shift.cos * latitude.cos)
-    end
-
-    def azimuth_component(latitude)
-      declination.sin / latitude.cos
-    end
-
-    def right_ascension
-      @equatorial_coordinates.right_ascension
-    end
-
-    def declination
-      @equatorial_coordinates.declination
-    end
-  end
-end