astro_calc 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3bae937f1f4e32b23b2477119fde49eaba8ea26
-  data.tar.gz: 2a5ee8135379263084867614fb9660838174da83
+  metadata.gz: 31511e036e6ad014aa8f9ee6445239d877807a5c
+  data.tar.gz: 8bbd419eb39144b1e0fda6523a0efbe2504a35ac
 SHA512:
-  metadata.gz: ce25c945b4ce006706b58e499bf53a2cef89b3479a726af7c044df0b1f6bc6b0a1a14351261f5144db0b49115bb74440b76cf296670971ed100ba02fcc0c4aa0
-  data.tar.gz: 0b1a2d459d4b7bfb50e0daa0a7ec99ba73cd60bc17e05de5263b9ef59eb26a7c6690ba94755d384d464f065568b99882010ebd0776aa5a19bb7b190de6e98526
+  metadata.gz: 4a351113e25f3e34722367b275822bf47f75ad6fad50ab64531268bbd1bceb6f7b76a12951990a8fbe7a0bb1a012bf1383327b009f314a2f281fce67ca69219e
+  data.tar.gz: 3fa4329ae7633ec5806dd5fa714b689670cf39644138d19f29830024116ff590d4490c42febafb957e78dcc1276382bb3c90be5fd707f10abece87f7bc2edd09

data/lib/astro_calc/moon_phases.rb

@@ -1,5 +1,7 @@
 require "date"
 
+#Credits
+#{https://github.com/tingletech/moon-phase tingletech}
 class MoonPhase
   YEAR_IN_DAYS = 365.25
   LIMIT_JULIAN_CALENDAR = 2299160
@@ -88,13 +90,19 @@ class MoonPhase
     end
   end
 
-  #normalize values to range 0...1
+  # Normalizes the value to be in the range 0..1
+  #
+  # @param value [Float] the value to normalize
+  # @return [Float] the normalized value
   def normalize(value)
     value -= value.floor 
     value += 1 if value < 0
     value
   end
 
+  # Provides the unicode characters for the moon phase
+  #
+  # @return [String] the unicode string showing the moon phase
   def unicode  
     case @phase 
       when 0.0625..0.1875 then "\uD83C\uDF12"
@@ -108,13 +116,17 @@ class MoonPhase
     end
   end
   
+  # Calculates the magnification for a given telescope and eyepiece
+  #
+  # @param options [Hash] the options for SVG generation
+  # @return [String] the SVG output
   def svg(options = {})
     default_options = {
       include_style: true,
-      height: 200,
+      height: "200px",
       background_color: "#111111",
-      left: 75,
-      top: 75,
+      left: "35%",
+      top: "75px",
       moon_color: "#CDCDCD",
       shadow_color: "#000000"
     }
@@ -124,8 +136,8 @@ class MoonPhase
     
     if options[:include_style] then
       output << "<style>"
-      output << "#moonholder { height: #{options[:height]}px; background-color: #{options[:background_color]}; }"
-      output << "#moon       { position:absolute; left:#{options[:left]}px; top:#{options[:top]}px; }"
+      output << "#moonholder { height: #{options[:height]}; background-color: #{options[:background_color]}; }"
+      output << "#moon       { position:absolute; left:#{options[:left]}; top:#{options[:top]}; }"
       output << ".moon       { fill: #{options[:moon_color]}; }"
       output << ".moonback   { stroke: #{options[:shadow_color]}; stroke-width: 1px; height: 180px; }"
       output << "</style>"

data/lib/astro_calc/telescopes.rb

@@ -0,0 +1,119 @@
+#Credits
+#{http://www.nexstarsite.com/_RAC/articles/formulas.htm Mike Swanson}
+class Telescopes
+
+  MM_IN_INCH       = 25.4
+  RAYLEIGH_LIMIT   = 5.5
+  DAWES_LIMIT      = 4.56
+  UNIT_MILLIMETERS = :millimeters
+  UNIT_INCHES      = :inches
+
+  attr_accessor  :unit
+
+  def initialize(unit = UNIT_MILLIMETERS)
+    @unit = unit
+  end
+  
+  # Calculates the magnification for a given telescope and eyepiece
+  #
+  # @param telescope [Integer] the focal length of the telescope tube
+  # @param eyepiece [Integer] the focal length of the eyepiece
+  # @return [Float] the magnification of the instrument
+  def magnification(telescope, eyepiece)
+    magnification = telescope / eyepiece
+  end
+
+  # Calculates the maximum probable magnification for a telescope
+  #
+  # @param diameter [Integer] the diameter of the telescope tube
+  # @return [Float] the maximum magnification usable with the given diameter
+  def maximum_magnification(diameter)
+    maximum = diameter * 2
+    maximum /= MM_IN_INCH if options[:unit] == UNIT_INCHES
+  end
+
+  # Calculates the focal ration of a telescope
+  #
+  # @param length [Integer] the focal length of the telescope
+  # @param aperture [Integer] the aperture of the telescope tube
+  # @return [Float] the focal ratio of the instrument
+  def focal_ratio(length, aperture)
+    ratio = length / aperture
+  end
+
+  # Calculates the diameter of the light leaving the eyepiece
+  #
+  # @param aperture [Integer] the aperture of the telescope tube
+  # @param magnification [Integer] the magnification of the instrument
+  # @return [Float] the diameter of the total light rays
+  def exit_pupil_for_binoculars(aperture, magnification)
+    exit_pupil = aperture / magnification
+  end
+  
+  # Calculates the maximum probable magnification for a telescope
+  #
+  # @param diameter [Integer] the diameter of the telescope tube
+  # @return [Float] the maximum magnification usable with the given diameter
+  def exit_pupil_for_telescope(length, ratio)
+    exit_pupil = length / ratio
+  end
+
+  # Calculates the true field of view
+  #
+  # @param apparent [Integer] the apparent field of view of the eyepiece 
+  # @param magnification [Integer] the magnification of the telescope and eyepiece
+  # @return [Float] the true field of view of the instrument
+  def true_field_of_view(apparent, magnification)
+    tfov = apparent / magnification
+  end
+
+  # Calculates the resolving limit of the instrument according to Rayleigh
+  #
+  # @param diameter [Integer] the diameter of the telescope tube
+  # @return [Float] the maximum magnification usable with the given diameter
+  def rayleigh_limit(aperture)
+    case @unit
+    when UNIT_MILLIMETERS 
+      limit = RAYLEIGH_LIMIT  / aperture / MM_IN_INCH
+    when UNIT_INCHES      
+      limit = RAYLEIGH_LIMIT  / aperture
+    end    
+  end
+
+  # Calculates the resolving limit of the instrument according to Dawes
+  #
+  # @param diameter [Integer] the diameter of the telescope tube
+  # @return [Float] the maximum magnification usable with the given diameter
+  def dawes_limit(aperture)
+    case @unit
+    when UNIT_MILLIMETERS 
+      limit = DAWES_LIMIT  / aperture / MM_IN_INCH
+    when UNIT_INCHES      
+      limit = DAWES_LIMIT  / aperture
+    end    
+  end
+
+  # Calculates the light gathering power between two instruments
+  #
+  # @param large_aperture [Integer] the aperture of the larger instrument
+  # @param small_aperture [Integer] the aperture of the smaller instrument
+  # @return [Float] the light gathering power of the instrument
+  def light_gathering_power(large_aperture, small_aperture)
+    power =  (large_aperture * large_aperture) / (small_aperture * small_aperture)
+  end
+
+  # Calculates the maximum probable magnification for a telescope
+  #
+  # @param aperture [Integer] the aperture in centimeters of the telescope tube
+  # @return [Float] the maximum magnitude with the given aperture
+  def limiting_magnitude(aperture)
+    case @unit
+    when UNIT_MILLIMETERS 
+      limit = 5 * Math::log10(aperture * 10) + 7.5
+    when UNIT_INCHES      
+      limit = 5 * Math::log10(aperture / 2.54) + 7.5
+    end        
+  end
+
+end
+

data/lib/astro_calc/version.rb

@@ -1,3 +1,3 @@
 module AstroCalc
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/astro_calc.rb

@@ -1,5 +1,6 @@
 require "astro_calc/version"
 require "astro_calc/moon_phases"
+require "astro_calc/telescopes"
 
 module AstroCalc
   # Your code goes here...

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: astro_calc
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Reuben Mallaby
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-28 00:00:00.000000000 Z
+date: 2016-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,6 +72,7 @@ files:
 - bin/setup
 - lib/astro_calc.rb
 - lib/astro_calc/moon_phases.rb
+- lib/astro_calc/telescopes.rb
 - lib/astro_calc/version.rb
 homepage: http://mallaby.me/projects/astro_calc
 licenses: