skymap 0.0.1 → 0.1.0

data/lib/skymap/canvas.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Skymap
+  Canvas = Data.define(:size, :padding) do
+    def center
+      Point.new(x: size / 2.0, y: size / 2.0)
+    end
+
+    def radius
+      size / 2.0 - padding
+    end
+  end
+end

data/lib/skymap/catalog/constellation_lines.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "csv"
+
+module Skymap
+  module Catalog
+    class ConstellationLines
+      include Enumerable
+
+      PATH = File.expand_path(
+        "../../../data/constellations/iau.csv",
+        __dir__
+      )
+
+      def each
+        CSV.foreach(PATH, headers: true) do |row|
+          yield line_from(row)
+        end
+      end
+
+      private
+
+      def line_from(row)
+        ConstellationLine.new(
+          constellation: row["constellation"],
+          from: hr_numbers(row["from_hr"]),
+          to: hr_numbers(row["to_hr"]),
+          weight: row["weight"].to_sym
+        )
+      end
+
+      def hr_numbers(value)
+        value.split.map(&:to_i)
+      end
+    end
+  end
+end

data/lib/skymap/catalog/stars.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "csv"
+
+module Skymap
+  module Catalog
+    class Stars
+      include Enumerable
+
+      PATH = File.expand_path("../../../data/stars.csv", __dir__)
+
+      def each
+        CSV.foreach(PATH, headers: true) do |row|
+          yield star_from(row)
+        end
+      end
+
+      private
+
+      def star_from(row)
+        Star.new(
+          hr: row["hr"].to_i,
+          equatorial_coordinates: Astronoby::Coordinates::Equatorial.new(
+            right_ascension: Astronoby::Angle.from_hours(
+              row["right_ascension"].to_f
+            ),
+            declination: Astronoby::Angle.from_degrees(row["declination"].to_f),
+            epoch: Astronoby::JulianDate::J2000
+          ),
+          magnitude: row["magnitude"].to_f
+        )
+      end
+    end
+  end
+end

data/lib/skymap/chart.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Skymap
+  class Chart
+    def initialize(observer:, instant:, canvas:)
+      @observer = observer
+      @instant = instant
+      @canvas = canvas
+    end
+
+    def render(*layers)
+      context = Context.new(
+        observer: @observer,
+        instant: @instant,
+        canvas: @canvas
+      )
+      elements = layers.flat_map { |layer| layer.elements(context) }
+
+      Renderer::SVG.new(canvas: @canvas).render(elements)
+    end
+  end
+end

data/lib/skymap/constellation_line.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Skymap
+  ConstellationLine = Data.define(:constellation, :from, :to, :weight)
+end

data/lib/skymap/context.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Skymap
+  class Context
+    attr_reader :canvas
+
+    def initialize(observer:, instant:, canvas:)
+      @observer = observer
+      @instant = instant
+      @canvas = canvas
+      @horizontal = {}
+      @projections = {}
+    end
+
+    def horizontal(star)
+      coordinates = star.equatorial_coordinates
+      key = [
+        coordinates.right_ascension,
+        coordinates.declination,
+        coordinates.epoch
+      ]
+
+      @horizontal[key] ||= Astronoby::DeepSkyObject
+        .new(equatorial_coordinates: coordinates)
+        .at(@instant)
+        .observed_by(@observer)
+        .horizontal
+    end
+
+    def position(star)
+      horizontal = horizontal(star)
+      project(altitude: horizontal.altitude, azimuth: horizontal.azimuth)
+    end
+
+    def project(altitude:, azimuth:, radius: @canvas.radius)
+      projection(radius).project(altitude: altitude, azimuth: azimuth)
+    end
+
+    private
+
+    def projection(radius)
+      @projections[radius] ||= Projection::Stereographic.new(
+        center: @canvas.center,
+        radius: radius
+      )
+    end
+  end
+end

data/lib/skymap/layers/cardinal_directions.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Skymap
+  module Layers
+    class CardinalDirections
+      CARDINAL_DIRECTIONS = {"N" => 0, "E" => 90, "S" => 180, "W" => 270}
+      CARDINAL_SIZE_RATIO = 0.6
+
+      def elements(context)
+        canvas = context.canvas
+
+        CARDINAL_DIRECTIONS.map do |text, azimuth|
+          position = context.project(
+            altitude: Astronoby::Angle.zero,
+            azimuth: Astronoby::Angle.from_degrees(azimuth),
+            radius: canvas.radius + canvas.padding / 2.0
+          )
+          Renderer::Label.new(
+            position: position,
+            text: text,
+            size: canvas.padding * CARDINAL_SIZE_RATIO
+          )
+        end
+      end
+    end
+  end
+end

data/lib/skymap/layers/constellation_lines.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Skymap
+  module Layers
+    class ConstellationLines
+      LINE_WIDTH_RATIOS = {bold: 0.0044, normal: 0.003, thin: 0.0017}
+
+      def initialize(lines:, stars:)
+        @lines = lines
+        @stars = stars
+      end
+
+      def elements(context)
+        stars_by_hr = @stars.to_h { |star| [star.hr, star] }
+
+        @lines.filter_map do |line|
+          ends = [line.from, line.to].map { |hrs| stars_by_hr.values_at(*hrs) }
+          next if ends.flatten.include?(nil)
+
+          directions = ends.map do |end_stars|
+            direction(end_stars.map { |star| context.horizontal(star) })
+          end
+          next if directions.all? { |direction| direction.last.negative? }
+
+          from, to = ends.each_with_index.map do |end_stars, index|
+            if directions[index].last.negative?
+              project_direction(
+                context,
+                horizon_crossing(directions[1 - index], directions[index])
+              )
+            else
+              Point.midpoint(end_stars.map { |star| context.position(star) })
+            end
+          end
+          Renderer::Line.new(
+            from: from,
+            to: to,
+            width: LINE_WIDTH_RATIOS.fetch(line.weight) * context.canvas.radius
+          )
+        end
+      end
+
+      private
+
+      def direction(horizontals)
+        vectors = horizontals.map do |horizontal|
+          [
+            horizontal.altitude.cos * horizontal.azimuth.cos,
+            horizontal.altitude.cos * horizontal.azimuth.sin,
+            horizontal.altitude.sin
+          ]
+        end
+        vectors.transpose.map(&:sum)
+      end
+
+      def horizon_crossing(above, below)
+        above.zip(below).map do |from, to|
+          above.last * to - below.last * from
+        end
+      end
+
+      def project_direction(context, direction)
+        x, y, = direction
+        context.project(
+          altitude: Astronoby::Angle.zero,
+          azimuth: Astronoby::Angle.from_radians(Math.atan2(y, x))
+        )
+      end
+    end
+  end
+end

data/lib/skymap/layers/stars.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Skymap
+  module Layers
+    class Stars
+      DEFAULT_MAGNITUDE_LIMIT = 5
+      MAX_RADIUS_MAGNITUDE = -1.5
+      MIN_STAR_RADIUS_RATIO = 0.0025
+      MAX_STAR_RADIUS_RATIO = 0.02
+      STAR_SIZE_EXPONENT = 1.5
+
+      def initialize(stars:, magnitude_limit: DEFAULT_MAGNITUDE_LIMIT)
+        @stars = stars
+        @magnitude_limit = magnitude_limit
+      end
+
+      def elements(context)
+        star_size = StarSize.new(
+          brightest_magnitude: MAX_RADIUS_MAGNITUDE,
+          faintest_magnitude: @magnitude_limit,
+          min_radius: MIN_STAR_RADIUS_RATIO * context.canvas.radius,
+          max_radius: MAX_STAR_RADIUS_RATIO * context.canvas.radius,
+          exponent: STAR_SIZE_EXPONENT
+        )
+
+        @stars.filter_map do |star|
+          next if star.magnitude > @magnitude_limit
+
+          next if context.horizontal(star).altitude.negative?
+
+          Renderer::Dot.new(
+            center: context.position(star),
+            radius: star_size.radius(star.magnitude)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/skymap/point.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Skymap
+  Point = Data.define(:x, :y) do
+    def self.midpoint(points)
+      new(
+        x: points.sum(&:x).fdiv(points.size),
+        y: points.sum(&:y).fdiv(points.size)
+      )
+    end
+  end
+end

data/lib/skymap/projection/stereographic.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Skymap
+  module Projection
+    class Stereographic
+      def initialize(center:, radius:)
+        @center = center
+        @radius = radius
+      end
+
+      def project(altitude:, azimuth:)
+        distance = @radius * altitude.cos / (1 + altitude.sin)
+
+        Point.new(
+          x: @center.x - distance * azimuth.sin,
+          y: @center.y - distance * azimuth.cos
+        )
+      end
+    end
+  end
+end

data/lib/skymap/renderer/dot.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Skymap
+  module Renderer
+    Dot = Data.define(:center, :radius)
+  end
+end

data/lib/skymap/renderer/label.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Skymap
+  module Renderer
+    Label = Data.define(:position, :text, :size)
+  end
+end

data/lib/skymap/renderer/line.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Skymap
+  module Renderer
+    Line = Data.define(:from, :to, :width)
+  end
+end

data/lib/skymap/renderer/svg.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require "victor"
+
+module Skymap
+  module Renderer
+    class SVG
+      SKY_COLOR = "#000000"
+      HORIZON_COLOR = "#3262a8"
+      HORIZON_WIDTH = 3
+      STAR_COLOR = "#ffffff"
+      LINE_COLOR = "#46689c"
+      LABEL_COLOR = HORIZON_COLOR
+      LABEL_FONT = "sans-serif"
+
+      def initialize(canvas:)
+        @canvas = canvas
+      end
+
+      def render(elements)
+        svg = Victor::SVG.new(
+          viewBox: "0 0 #{@canvas.size} #{@canvas.size}",
+          width: @canvas.size,
+          height: @canvas.size
+        )
+
+        svg.circle(
+          cx: @canvas.center.x.round(2),
+          cy: @canvas.center.y.round(2),
+          r: @canvas.radius.round(2),
+          fill: SKY_COLOR,
+          stroke: HORIZON_COLOR,
+          stroke_width: HORIZON_WIDTH
+        )
+
+        elements.each do |element|
+          case element
+          when Line then draw_line(svg, element)
+          when Dot then draw_dot(svg, element)
+          when Label then draw_label(svg, element)
+          else raise ArgumentError, "unknown element: #{element.class}"
+          end
+        end
+
+        svg.render
+      end
+
+      private
+
+      def draw_line(svg, line)
+        svg.line(
+          x1: line.from.x.round(2),
+          y1: line.from.y.round(2),
+          x2: line.to.x.round(2),
+          y2: line.to.y.round(2),
+          stroke: LINE_COLOR,
+          stroke_width: line.width.round(2),
+          stroke_linecap: "round"
+        )
+      end
+
+      def draw_dot(svg, dot)
+        svg.circle(
+          cx: dot.center.x.round(2),
+          cy: dot.center.y.round(2),
+          r: dot.radius.round(2),
+          fill: STAR_COLOR
+        )
+      end
+
+      def draw_label(svg, label)
+        svg.text(
+          label.text,
+          x: label.position.x.round(2),
+          y: label.position.y.round(2),
+          font_size: label.size.round(2),
+          font_family: LABEL_FONT,
+          text_anchor: "middle",
+          dominant_baseline: "central",
+          fill: LABEL_COLOR
+        )
+      end
+    end
+  end
+end

data/lib/skymap/star.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Skymap
+  Star = Data.define(:hr, :equatorial_coordinates, :magnitude)
+end

data/lib/skymap/star_size.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Skymap
+  class StarSize
+    def initialize(
+      brightest_magnitude:,
+      faintest_magnitude:,
+      min_radius:,
+      max_radius:,
+      exponent:
+    )
+      @brightest_magnitude = brightest_magnitude
+      @faintest_magnitude = faintest_magnitude
+      @min_radius = min_radius
+      @max_radius = max_radius
+      @exponent = exponent
+    end
+
+    def radius(magnitude)
+      brightness = (@faintest_magnitude - magnitude)
+        .fdiv(@faintest_magnitude - @brightest_magnitude)
+        .clamp(0, 1)
+
+      @min_radius + brightness**@exponent * (@max_radius - @min_radius)
+    end
+  end
+end

data/lib/skymap/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Skymap
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/skymap.rb

@@ -1,5 +1,24 @@
 # frozen_string_literal: true
 
+require "astronoby"
+
+require_relative "skymap/canvas"
+require_relative "skymap/catalog/constellation_lines"
+require_relative "skymap/catalog/stars"
+require_relative "skymap/chart"
+require_relative "skymap/constellation_line"
+require_relative "skymap/context"
+require_relative "skymap/layers/cardinal_directions"
+require_relative "skymap/layers/constellation_lines"
+require_relative "skymap/layers/stars"
+require_relative "skymap/point"
+require_relative "skymap/projection/stereographic"
+require_relative "skymap/renderer/dot"
+require_relative "skymap/renderer/label"
+require_relative "skymap/renderer/line"
+require_relative "skymap/renderer/svg"
+require_relative "skymap/star"
+require_relative "skymap/star_size"
 require_relative "skymap/version"
 
 module Skymap

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: skymap
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Rémy Hannequin
@@ -9,6 +9,48 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: astronoby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: victor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: irb
   requirement: !ruby/object:Gem::Requirement
@@ -37,6 +79,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -89,7 +145,26 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- data/constellations/iau.csv
+- data/stars.csv
 - lib/skymap.rb
+- lib/skymap/canvas.rb
+- lib/skymap/catalog/constellation_lines.rb
+- lib/skymap/catalog/stars.rb
+- lib/skymap/chart.rb
+- lib/skymap/constellation_line.rb
+- lib/skymap/context.rb
+- lib/skymap/layers/cardinal_directions.rb
+- lib/skymap/layers/constellation_lines.rb
+- lib/skymap/layers/stars.rb
+- lib/skymap/point.rb
+- lib/skymap/projection/stereographic.rb
+- lib/skymap/renderer/dot.rb
+- lib/skymap/renderer/label.rb
+- lib/skymap/renderer/line.rb
+- lib/skymap/renderer/svg.rb
+- lib/skymap/star.rb
+- lib/skymap/star_size.rb
 - lib/skymap/version.rb
 homepage: https://github.com/rhannequin/skymap
 licenses: