panomosity 0.1.21 → 0.1.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d3f10415e998af6222a66b2fd33fa287467685da033820bf08549319dd233b3
-  data.tar.gz: 215dc04025125205c275d224b0d2710f2a1135d11cadbc0b40c42c61e093cb33
+  metadata.gz: bb087d6bb2baa65028d713d9dbe1a6137346533b039d163c88106a4c8f47ee92
+  data.tar.gz: 7bcb4253e575daf5bd2398d4bdc637fc09ee7a1f3cada8cf70094d3a0db8a180
 SHA512:
-  metadata.gz: f54e1297b2745fe8704df22c6cde677bfa19ec7d74554fe45ab05d00fbd6d5d88fc82d7b2bfcd99d57f640cef3d1226fa1068a4f1ee135f9462957c4903ab33f
-  data.tar.gz: ef4d5656bbd5a7d0747d68dde9ec8c4eaa3877a1c95a7032126b4f0b92d27f82c95c09dc040d9998556fa9f5dc5d345008a887ac1d312e0aa6ca5f67547f8e4f
+  metadata.gz: fae56434b44675d564715e477cd4416ff14495a4f80cad77a1c8ab7d029540c239bc14872d327dd4548967708737003c16b5f28061e92faa766c0fdb20c16b14
+  data.tar.gz: 1eafe48252190699713109523ab0def1b2ffbdf90aa35f9b9ce22e0a7a83a28f7de40c59bdf9a0f8f13b7bb3c4693ac9abd55dd64800dfb41300a3084ed2e96b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    panomosity (0.1.20)
+    panomosity (0.1.21)
 
 GEM
   remote: https://rubygems.org/

data/lib/panomosity.rb

@@ -58,8 +58,8 @@ module Panomosity
         options[:verbose] = v
       end
 
-      parser.on('-vv', '--vverbose', 'Run very verbosely') do |v|
-        options[:very_verbose] = v
+      parser.on('--verbosity LEVEL', Integer, 'Set verbosity level') do |v|
+        options[:verbosity] = v
       end
 
       parser.on('-h', '--help', 'Display this screen') do
@@ -70,6 +70,8 @@ module Panomosity
       parser.parse!(arguments)
     end
 
+    # default options
+    options[:verbosity] ||= 0
     runner = Runner.new(options)
     runner.run(ARGV[0])
   end

data/lib/panomosity/neighborhood_group.rb

@@ -84,7 +84,7 @@ module Panomosity
         logger.debug "#{ng.prdist_avg} #{ng.prdist_std} #{ng.control_points.count} x#{ng.x_avg} y#{ng.y_avg}"
       end
 
-      self.neighborhood_groups = neighborhood_groups.max_by(5) { |ng| ng.control_points.count }
+      self.neighborhood_groups = neighborhood_groups.sort_by { |ng| -ng.control_points.count }
     end
 
     def self.info

data/lib/panomosity/optimizer.rb

@@ -113,8 +113,8 @@ module Panomosity
     def calculate_average_distance
       Pair.calculate_neighborhoods(panorama)
       Pair.calculate_neighborhood_groups
-      horizontal_distances = NeighborhoodGroup.horizontal.map(&:prdist_avg)
-      vertical_distances = NeighborhoodGroup.vertical.map(&:prdist_avg)
+      horizontal_distances = NeighborhoodGroup.horizontal[0..4].map(&:prdist_avg)
+      vertical_distances = NeighborhoodGroup.vertical[0..4].map(&:prdist_avg)
       calculate_average(values: horizontal_distances + vertical_distances)
     end
 

data/lib/panomosity/pair.rb

@@ -90,7 +90,7 @@ module Panomosity
     end
 
     def self.log_detailed_neighborhood_info(name: :horizontal, pairs: [])
-      return unless @panorama.options[:very_verbose]
+      return unless @panorama.options[:verbosity] > 1
       logger.debug "showing #{name} pair information"
       pair = pairs.max_by { |p| p.control_points_of_best_neighborhood.count }
       logger.debug "best #{name} pair #{pair.to_s} found #{pair.control_points_of_best_neighborhood.count} control points"

data/lib/panomosity/panorama.rb

@@ -7,6 +7,7 @@ module Panomosity
     def initialize(input, options = {})
       @input = input
       @options = options
+      @options[:verbosity] ||= 0
       @images = Image.parse(@input)
       @variable = PanoramaVariable.parse(@input).first
       ControlPoint.parse(@input)
@@ -140,5 +141,107 @@ module Panomosity
       Pair.info
       NeighborhoodGroup.info
     end
+
+    def diagnose
+      Pair.calculate_neighborhoods(self)
+      Pair.calculate_neighborhood_groups
+
+      recommendations = []
+
+      logger.debug "total number of control points: #{control_points.count}"
+      logger.debug "total number of generated control points: #{control_points.select(&:generated?).count}"
+      logger.debug "total number of not generated control points: #{control_points.select(&:not_generated?).count}"
+
+      control_point_pair_ratio = Pair.without_enough_control_points(ignore_connected: true).count.to_f / Pair.all.count
+      logger.warn "More than 50% (#{(control_point_pair_ratio*100).round(4)}%) of pairs have fewer than 3 control points. May potentially cause issues." if control_point_pair_ratio >= 0.5
+
+      control_point_generated_ratio = control_points.select(&:generated?).count.to_f / control_points.select(&:not_generated?).count
+      if control_point_generated_ratio >= 0.3
+        message = <<~MESSAGE
+          More than 30% (#{(control_point_generated_ratio*100).round(4)}%) control points were generated.
+          This indicates a failure to find control points between images pairs due to poor lighting or insufficient complexity.
+        MESSAGE
+        logger.warn message
+      end
+
+      # neighborhood group tests
+      group_count = NeighborhoodGroup.horizontal.count
+      if group_count < 5
+        message = <<~MESSAGE
+          Total number of horizontal neighborhood groups is #{group_count} which is very low.
+          This can mean either low variation in control points distances or that not enough control points could be found.
+        MESSAGE
+        logger.warn message
+      end
+
+      group_std_avg = calculate_average(values: NeighborhoodGroup.horizontal[0..4].map(&:prdist_std))
+      if group_std_avg > 1.0
+        message = <<~MESSAGE
+          The standard deviation of distances in the top 5 horizontal neighborhood groups is #{group_std_avg} which is high.
+          The standard deviation implies that control points neighborhoods making up this group can vary more than 1.0 in distance.
+          On highly optimized images (with many good control points) this standard deviation should be near 0.
+          This could mean that even after optimization, there may be a seam on an individual pair.
+          This also means that the images may represent a 3D object that has perspective differences.
+        MESSAGE
+        logger.warn message
+      end
+
+      group_control_points = NeighborhoodGroup.horizontal.first.control_points.count
+      total_control_points = Pair.horizontal.map(&:control_points).flatten.uniq(&:raw).count
+      group_control_point_ratio = group_control_points.to_f / total_control_points
+      if group_control_point_ratio < 0.2
+        message = <<~MESSAGE
+          Less than 20% (#{(group_control_point_ratio*100).round(4)}%) of horizontal control points in the best
+          horizontal neighborhood group (#{group_control_points}) make up the total number of horizontal control points (#{total_control_points}).
+          This means panosmosity failed to find a neighborhood group that would include enough similarities between control point distances.
+          There will very likely be seams horizontally.
+        MESSAGE
+        logger.warn message
+        recommendations << 'horizontal'
+      end
+
+      group_count = NeighborhoodGroup.vertical.count
+      if group_count < 5
+        message = <<~MESSAGE
+          Total number of vertical neighborhood groups is #{group_count} which is very low.
+          This can mean either low variation in control points distances or that not enough control points could be found.
+        MESSAGE
+        logger.warn message
+      end
+
+      group_std_avg = calculate_average(values: NeighborhoodGroup.vertical[0..4].map(&:prdist_std))
+      if group_std_avg > 1.0
+        message = <<~MESSAGE
+          The standard deviation of distances in the top 5 vertical neighborhood groups is #{group_std_avg} which is high.
+          The standard deviation implies that control points neighborhoods making up this group can vary more than 1.0 in distance.
+          On highly optimized images (with many good control points) this standard deviation should be near 0.
+          This could mean that even after optimization, there may be a seam on an individual pair.
+          This also means that the images may represent a 3D object that has perspective differences.
+        MESSAGE
+        logger.warn message
+      end
+
+      group_control_points = NeighborhoodGroup.vertical.first.control_points.count
+      total_control_points = Pair.vertical.map(&:control_points).flatten.uniq(&:raw).count
+      group_control_point_ratio = group_control_points.to_f / total_control_points
+      if group_control_point_ratio < 0.2
+        message = <<~MESSAGE
+          Less than 20% (#{(group_control_point_ratio*100).round(4)}%) of vertical control points in the best
+          vertical neighborhood group (#{group_control_points}) make up the total number of vertical control points (#{total_control_points}).
+          This means panosmosity failed to find a neighborhood group that would include enough similarities between control point distances.
+          There will very likely be seams vertically.
+        MESSAGE
+        logger.warn message
+        recommendations << 'vertical'
+      end
+
+      if recommendations.empty?
+        logger.warn 'No recommendations'
+        puts 'none'
+      else
+        logger.warn 'Recommendations are to regenerate with control points generated from calibration cards:'
+        puts recommendations.join(',')
+      end
+    end
   end
 end

data/lib/panomosity/runner.rb

@@ -13,6 +13,7 @@ module Panomosity
       convert_horizontal_lines
       convert_translation_parameters
       crop_centers
+      diagnose
       fix_conversion_errors
       fix_unconnected_image_pairs
       generate_border_line_control_points
@@ -39,7 +40,7 @@ module Panomosity
       @compare_file = File.new(@compare, 'r').read if @compare
       @logger = Panomosity.logger
 
-      if options[:verbose] || options[:very_verbose]
+      if options[:verbose] || options[:verbosity] > 0
         @logger.level = Logger::DEBUG
       else
         @logger.level = Logger::INFO
@@ -233,6 +234,12 @@ module Panomosity
       save_file
     end
 
+    def diagnose
+      logger.info 'diagnosing errors'
+      panorama = Panorama.new(@input_file, @options)
+      panorama.diagnose
+    end
+
     def fix_conversion_errors
       logger.info 'fixing conversion errors'
       @lines = @input_file.each_line.map do |line|
@@ -249,7 +256,7 @@ module Panomosity
 
     def fix_unconnected_image_pairs
       logger.info 'fixing unconnected image pairs'
-      panorama = Panorama.new(@input_file)
+      panorama = Panorama.new(@input_file, @options)
       @lines = panorama.fix_unconnected_image_pairs
       save_file
     end
@@ -466,7 +473,7 @@ module Panomosity
 
     def optimize
       logger.info 'optimizing'
-      panorama = Panorama.new(@input_file)
+      panorama = Panorama.new(@input_file, @options)
       optimizer = Optimizer.new(panorama)
       optimizer.run
 

data/lib/panomosity/version.rb

@@ -1,3 +1,3 @@
 module Panomosity
-  VERSION = '0.1.21'
+  VERSION = '0.1.22'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panomosity
 version: !ruby/object:Gem::Version
-  version: 0.1.21
+  version: 0.1.22
 platform: ruby
 authors:
 - Oliver Garcia
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-13 00:00:00.000000000 Z
+date: 2018-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler