image_paradise 0.4.20

data/lib/image_paradise/svg/circle.rb

@@ -0,0 +1,106 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/svg/circle.rb'
+# =========================================================================== #
+module ImageParadise
+
+module Svg
+
+module Circle # === ImageParadise::Svg::Circle
+
+  # ========================================================================= #
+  # === DEFAULT_HEIGHT
+  # ========================================================================= #
+  DEFAULT_HEIGHT = '100'.freeze
+
+  # ========================================================================= #
+  # === DEFAULT_RADIUS
+  # ========================================================================= #
+  DEFAULT_RADIUS = '40'.freeze
+
+  # ========================================================================= #
+  # === Svg::Circle.create
+  #
+  # This will generate a SVG circle.
+  #
+  # A circle has to be synced though as otherwise it is not a circle.
+  # ========================================================================= #
+  def self.create(
+      height_and_width = DEFAULT_HEIGHT,
+      fill_colour      = 'red',
+      stroke_width     = '3',
+      radius           = DEFAULT_RADIUS
+    )
+    # ======================================================================= #
+    # === Handle Hash given as input to us next
+    # ======================================================================= #
+    if height_and_width.is_a? Hash
+      if height_and_width.has_key? :height
+        height_and_width = height_and_width.delete(:height) # This is ok because width and height are the same.
+      end
+      if height_and_width.has_key? :radius
+        radius = height_and_width.delete(:radius)
+        case radius
+        when :half_default_width
+          radius = DEFAULT_RADIUS.to_f / 2
+        when :quarter_default_width
+          radius = DEFAULT_RADIUS.to_f / 4
+        end
+      end if height_and_width.is_a? Hash
+      if height_and_width.has_key? :stroke_width
+        stroke_width = height_and_width.delete(:stroke_width)
+      end if height_and_width.is_a? Hash
+      if height_and_width.has_key? :colour
+        fill_colour = height_and_width.delete(:colour)
+      end if height_and_width.is_a? Hash
+      if height_and_width.respond_to? :empty?
+        height_and_width = DEFAULT_HEIGHT if height_and_width.empty?
+      end
+    end
+    # ======================================================================= #
+    # Convert the various arguments passed to this method into a String.
+    # ======================================================================= #
+    height_and_width = height_and_width.to_s.dup unless height_and_width.is_a? Hash
+    fill_colour      = fill_colour.to_s.dup
+    stroke_width     = stroke_width.to_s.dup
+    radius           = radius.to_i.to_s.dup
+    # ======================================================================= #
+    # === Handle random fill colour
+    # ======================================================================= #
+    if fill_colour == 'random'
+      fill_colour = Colours::HtmlColours.random.dup
+    end
+    _ = Svg.strip(
+      '<svg height="'+height_and_width+'" width="'+height_and_width+'">
+        <circle cx="50" cy="50" r="'+radius+'" stroke="black" stroke-width="'+stroke_width+'" fill="'+fill_colour+'" />'+
+        Svg.close_svg
+    )+N
+    _ = _.to_s.dup
+    Svg.add(_)
+    return _
+  end
+
+end
+
+# =========================================================================== #
+# === Svg.circle
+#
+# Always sync to the above method.
+#
+# Usage example:
+#
+#   Svg.circle(150,:blue,5,20)
+#
+# =========================================================================== #
+def self.circle(
+    a = '100',
+    b = 'red',
+    c = '3',
+    r = '40'
+  )
+  Svg::Circle.create(a,b,c,r)
+end
+
+end; end

data/lib/image_paradise/svg/feature.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/svg/feature.rb'
+# =========================================================================== #
+module ImageParadise
+
+module Svg
+
+class Feature # === ImageParadise::Svg::Feature
+
+  attr_accessor :stroke
+  attr_accessor :stroke_width
+  attr_accessor :fill
+  attr_accessor :fill_opacity
+  attr_accessor :stroke_opacity
+  attr_accessor :style
+
+  # ========================================================================= #
+  # === to_svg
+  # ========================================================================= #
+  def to_svg
+    '<overrideme/>'
+  end
+
+  # ========================================================================= #
+  # === attr_to_s
+  # ========================================================================= #
+  def attr_to_s(
+      attr_name, attr_val
+    )
+    return '' if attr_val.nil? 
+    " #{attr_name}=\"#{attr_val}\"" unless attr_val.to_s.empty?
+  end
+
+  # ========================================================================= #
+  # === point_to_s
+  # ========================================================================= #
+  def point_to_s(
+      x_attr_name, y_attr_name, point
+    )
+    return '' if point.nil? 
+    return_val = " #{x_attr_name}=\"#{point.x}\"" unless point.x.to_s.empty?
+    return_val + " #{y_attr_name}=\"#{point.y}\"" unless point.y.to_s.empty?
+  end
+
+end; end; end

data/lib/image_paradise/svg/rectangle.rb

@@ -0,0 +1,154 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/svg/rectangle.rb'
+# =========================================================================== #
+module ImageParadise
+
+module Svg
+
+module Rectangle # === ImageParadise::Svg::Rectangle
+
+  # ========================================================================= #
+  # === DEFAULT_WIDTH
+  # ========================================================================= #
+  DEFAULT_WIDTH = '400'
+
+  # ========================================================================= #
+  # === DEFAULT_HEIGHT
+  # ========================================================================= #
+  DEFAULT_HEIGHT = '180'
+
+  # ========================================================================= #
+  # === DEFAULT_FILL_COLOUR
+  # ========================================================================= #
+  DEFAULT_FILL_COLOUR = 'red'
+
+  # ========================================================================= #
+  # === Svg::Rectangle.create
+  #
+  # This will generate a SVG rectangle.
+  #
+  # A proper rectangle has a width and a height setting.
+  #
+  # You can optionally handle opacity if you pass in a block.
+  # ========================================================================= #
+  def self.create(
+      width        = DEFAULT_WIDTH,
+      height       = DEFAULT_HEIGHT,
+      fill_colour  = DEFAULT_FILL_COLOUR,
+      stroke_width = '3'
+    )
+
+    extra_elements = '' # Extra values for the SVG attribute.
+    opacity = ''.dup # This variable keeps track over whether we require opacity.
+
+    # ======================================================================= #
+    # === Handle block arguments next
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      # ===================================================================== #
+      # Next convert a Proc to its "real" value.
+      # ===================================================================== #
+      if yielded.is_a? Proc
+        yielded = yielded.call
+      end
+      if yielded.is_a?(String)
+        if yielded.include? 'opacity'
+          # ================================================================= #
+          # === Handle opacity
+          #
+          # Popular options are:
+          #
+          #   'fill-opacity:0.9;stroke-opacity:0.9'
+          #
+          # ================================================================= #
+          opacity << yielded
+          opacity << ';' unless opacity.end_with? ';'
+        end
+        if yielded.include? 'rounded'
+          # ================================================================= #
+          # === Handle rounded edges for a rectangle
+          #
+          # The rx and the ry attributes rounds the corners of the rectangle.
+          # ================================================================= #
+          extra_elements = ' x="50" y="20" rx="20" ry="20" '
+        end
+      end
+    end
+
+    # ======================================================================= #
+    # === Handle Hash given as input to us next
+    # ======================================================================= #
+    if width.is_a? Hash
+      if width.has_key? :fill_colour
+        fill_colour = width.delete(:fill_colour)
+      end
+      if width.has_key? :width
+        width = width.delete(:width)
+      end if width.is_a? Hash
+      if width.has_key? :height
+        height = width.delete(:height) # This is ok because width and height are the same.
+      end if width.is_a? Hash
+      if width.has_key? :stroke_width
+        stroke_width = width.delete(:stroke_width)
+      end if width.is_a? Hash
+      if width.has_key? :colour
+        fill_colour = width.delete(:colour)
+      end if width.is_a? Hash
+      unless width.is_a? Numeric
+        width = DEFAULT_WIDTH if width.empty?
+      end
+    end
+    # ======================================================================= #
+    # Convert the various arguments passed to this method into a String.
+    # ======================================================================= #
+    width         = width.to_s.dup unless width.is_a? Hash
+    height        = height.to_s
+    fill_colour   = fill_colour.to_s
+    stroke_width  = stroke_width.to_s
+    # ======================================================================= #
+    # === Handle random fill colour
+    # ======================================================================= #
+    if fill_colour == 'random'
+      fill_colour = Colours::HtmlColours.random
+    end
+    # ======================================================================= #
+    # We will put the inner-rectangle at 80%.
+    # ======================================================================= #
+    _ = Svg.strip(
+    '<svg width="'+width+'" height="'+height+'">
+
+        <rect '+extra_elements+'width="'+(width.to_f * 80 / 100).to_i.to_s+'" height="'+(height.to_f * 80 / 100).to_i.to_s+'" style="'+opacity+'fill:'+fill_colour+';stroke-width:'+stroke_width+';stroke:rgb(0,0,0)">
+        '+Svg.close_svg
+    )+N
+    _ = _.to_s.dup
+    Svg.add(_)
+    return _
+  end
+
+end
+
+# =========================================================================== #
+# === ImageParadise::Svg.rectangle
+#
+# Always sync to the above method.
+#
+# Usage examples:
+#
+#   Svg.rectangle(150,:blue,5,20)
+#
+# =========================================================================== #
+def self.rectangle(
+    a = Svg::Rectangle::DEFAULT_WIDTH,
+    b = Svg::Rectangle::DEFAULT_HEIGHT,
+    c = Svg::Rectangle::DEFAULT_FILL_COLOUR,
+    d = '3',
+    &block
+  )
+  Svg::Rectangle.create(a,b,c,d) { block }
+end
+
+end; end

data/lib/image_paradise/svg/svg.rb

@@ -0,0 +1,102 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Shared coded for the SVG component of the ImageParadise project
+# be stored here.
+# =========================================================================== #
+# require 'image_paradise/svg/svg.rb'
+# =========================================================================== #
+module ImageParadise
+
+module Svg # === ImageParadise::Svg
+
+  require 'image_paradise/project/project.rb'
+  require 'image_paradise/svg/circle.rb'
+  require 'image_paradise/svg/feature.rb'
+  require 'image_paradise/svg/rectangle.rb'
+
+  # ========================================================================= #
+  # === N
+  # ========================================================================= #
+  N = "\n"
+
+  # ========================================================================= #
+  # === @_
+  #
+  # This is a variable that will keep the big String.
+  # ========================================================================= #
+  @_ = ''.dup
+
+  # ========================================================================= #
+  # === Svg.reset
+  # ========================================================================= #
+  def self.reset
+    @_ = ''
+  end
+
+  # ========================================================================= #
+  # === Svg.strip
+  # ========================================================================= #
+  def self.strip(i)
+    return i.squeeze(' ')
+  end
+
+  # ========================================================================= #
+  # === Svg.string?
+  # ========================================================================= #
+  def self.string?
+    @_
+  end; self.instance_eval { alias [] string? } # === Svg[]
+
+  # ========================================================================= #
+  # === Svg.add
+  #
+  # Simply append onto @_.
+  # ========================================================================= #
+  def self.add(i = '')
+    i = i.to_s.dup
+    @_ << i
+  end
+
+  # ========================================================================= #
+  # === Svg.close_svg
+  #
+  # Simply close the <svg> tag here
+  # ========================================================================= #
+  def self.close_svg
+    return '</svg>'+N
+  end
+
+  # ========================================================================= #
+  # === Svg.chart_directory
+  #
+  # Give us the path towards the svg_-charts subdirectory.
+  # ========================================================================= #
+  def self.chart_directory
+    ::ImageParadise.project_base_dir?+'charts/'
+  end
+
+  # ========================================================================= #
+  # === Svg.load_chart_module
+  #
+  # This method will load the individual .rb files from the chart/
+  # subdirectory. Currently this is not in use though - perhaps one
+  # day when I get to use the chart-svg subsection.
+  # ========================================================================= #
+  def self.load_chart_module
+    these_files = Svg.chart_directory+'*.rb'
+    Dir[these_files].each {|file|
+      file = 'image_paradise/svg/charts/'+File.basename(file)
+      require file # And require it.
+    }
+  end; load_chart_module # And call it at once.
+
+  # ========================================================================= #
+  # === Svg.add
+  # ========================================================================= #
+  def self.add_linebreak
+    add "<br>#{N}"
+  end
+
+end; end

data/lib/image_paradise/toplevel_methods/add_black_border_to_this_image.rb

@@ -0,0 +1,94 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/toplevel_methods/add_black_border_to_this_image.rb'
+# =========================================================================== #
+module ImageParadise
+
+  require 'image_paradise/toplevel_methods/e.rb'
+  require 'image_paradise/toplevel_methods/esystem.rb'
+
+  # ========================================================================= #
+  # === ImageParadise.add_black_border_to_this_image
+  #
+  # This method will add a (black) border around the given input-image.
+  #
+  # Since as of February 2021 this does no longer have to be confined
+  # solely to black as colour; other colours can be used as well. See
+  # the third argument to this method.
+  #
+  # The -bordercolor commandline can be used to specify the colour
+  # of the border at hand.
+  #
+  # The -border 5x10 variant means to have a 5px border left-right,
+  # and a 10px border top-bottom, each. Note that a single value
+  # of 5 here means exactly the same as 5x5. USe the variant you
+  # prefer.
+  #
+  # Invocation example:
+  #
+  #   ImageParadise.add_black_border_to_this_image('foobar.png',3)
+  #
+  # ========================================================================= #
+  def self.add_black_border_to_this_image(
+      file_that_is_to_be_modified = 'foobar.png',
+      n_pixels                    = '1',
+      use_this_colour             = 'black', # Provide the colour here.
+      new_filename                = nil
+    )
+    n_pixels = n_pixels.to_s
+    if file_that_is_to_be_modified.is_a? Array
+      file_that_is_to_be_modified = file_that_is_to_be_modified.first
+    end
+    if File.exist? file_that_is_to_be_modified
+      extname = File.extname(file_that_is_to_be_modified) # Also has a leading '.' character.
+      unless new_filename
+        new_filename = file_that_is_to_be_modified.sub(
+          /#{File.extname(file_that_is_to_be_modified)}/,''
+        )
+        new_filename << '_'+use_this_colour.to_s+'_border_'+n_pixels+'px'
+        new_filename << extname
+      end
+      _ = "convert #{file_that_is_to_be_modified} "\
+          "-density 300 "\
+          "-shave #{n_pixels}x#{n_pixels} "\
+          "-bordercolor '#{use_this_colour}' "+ # Specify the colour of the border.
+          "-border #{n_pixels} "\
+          "#{new_filename}"
+      esystem _
+      if File.exist? new_filename
+        e "The file `#{new_filename}` has been created."
+      end
+      return new_filename # Return it here as well.
+    else
+      e 'No file exists at `'+file_that_is_to_be_modified+'`.'
+    end
+  end; self.instance_eval { alias add_border_to_this_image add_black_border_to_this_image } # === ImageParadise.add_border_to_this_image('foobar.png', 3, 'red')
+
+  # ========================================================================= #
+  # === ImageParadise.add_green_border_to_this_image
+  #
+  # Usage example:
+  #
+  #   ImageParadise.add_green_border_to_this_image('TANAKA.png','12')
+  #
+  # ========================================================================= #
+  def self.add_green_border_to_this_image(
+      file_that_is_to_be_modified = 'foobar.png',
+      n_pixels                    = '1',
+      new_filename                = nil
+    )
+    ::ImageParadise.add_border_to_this_image(
+      file_that_is_to_be_modified,
+      n_pixels,
+      'green',
+      new_filename
+    )
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  ImageParadise.add_black_border_to_this_image(ARGV)
+end # bordblack1 STUDIES.png

data/lib/image_paradise/toplevel_methods/create_animated_gif.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'create_animated_gif.rb'
+# =========================================================================== #
+module ImageParadise
+
+  # ========================================================================= #
+  # === INPUT_IMAGES_FOR_THE_CREATION_OF_ANIMATED_GIFS
+  # ========================================================================= #
+  INPUT_IMAGES_FOR_THE_CREATION_OF_ANIMATED_GIFS = '*.gif'
+
+  # ========================================================================= #
+  # === DELAY_FOR_THE_CREATION_OF_ANIMATED_GIFS
+  # ========================================================================= #
+  DELAY_FOR_THE_CREATION_OF_ANIMATED_GIFS = '100'
+
+  # ========================================================================= #
+  # === ImageParadise.create_animated_gif
+  #
+  # This method will create an animated gif.
+  #
+  # The input should be either an Array of input_images, or a string which
+  # will be used to create the command.
+  #
+  # A delay of 100 means 1 second delay.
+  # ========================================================================= #
+  def self.create_animated_gif(
+      input_images = INPUT_IMAGES_FOR_THE_CREATION_OF_ANIMATED_GIFS,
+      delay        = DELAY_FOR_THE_CREATION_OF_ANIMATED_GIFS
+    )
+    output_name = 'animated_gif.gif'
+    _ = 'convert -delay 100 -loop 0 '+input_images+' '+output_name
+    esystem _
+    e 'Finished creating `'+sfile(output_name)+'`.' if File.exist? output_name
+  end
+
+  # ========================================================================= #
+  # === create_animated_gif
+  # ========================================================================= #
+  def create_animated_gif(
+      input_images = INPUT_IMAGES_FOR_THE_CREATION_OF_ANIMATED_GIFS,
+      delay = DELAY_FOR_THE_CREATION_OF_ANIMATED_GIFS
+    )
+    ImageParadise.create_animated_gif(input_images, delay)
+  end
+
+end

data/lib/image_paradise/toplevel_methods/crop.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# We will tap into the project crop next.
+# =========================================================================== #
+# require 'image_paradise/toplevel_methods/crop.rb'
+# =========================================================================== #
+module ImageParadise
+
+  require 'image_paradise/crop/crop.rb'
+
+  # ========================================================================= #
+  # === crop
+  #
+  # Delegate towards the class-method above, called ImageParadise.crop()
+  # ========================================================================= #
+  def crop(
+      i                   = filename?,
+      crop_command_to_use = nil,
+      optional_hash       = {},
+      &block
+    )
+    ImageParadise.crop(
+      i, crop_command_to_use, optional_hash, &block
+    )
+  end
+
+end

data/lib/image_paradise/toplevel_methods/e.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/toplevel_methods/e.rb'
+# =========================================================================== #
+module ImageParadise
+
+  # ========================================================================= #
+  # === ImageParadise.e
+  # ========================================================================= #
+  def self.e(i = '')
+    puts i
+  end
+
+end

data/lib/image_paradise/toplevel_methods/esystem.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/toplevel_methods/esystem.rb'
+# =========================================================================== #
+module ImageParadise
+
+  require 'image_paradise/toplevel_methods/e.rb'
+
+  # ========================================================================= #
+  # === ImageParadise.esystem
+  # ========================================================================= #
+  def self.esystem(i)
+    e i
+    system(i)
+  end
+
+end

data/lib/image_paradise/toplevel_methods/extract_text_from_this_image.rb

@@ -0,0 +1,56 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/toplevel_methods/extract_text_from_this_image.rb'
+# =========================================================================== #
+require 'image_paradise/toplevel_methods/esystem.rb'
+
+module ImageParadise
+
+  # ========================================================================= #
+  # === ImageParadise.extract_text_from_this_image
+  #
+  # This method will use tesseract to extract/return text from the
+  # given image at hand.
+  #
+  # Invocation example:
+  #
+  #   ImageParadise.extract_text_from_this_image('foobar.png')
+  #   ImageParadise.extract_text_from_this_image('greyscaled_foo.jpg')
+  #   ImageParadise.extract_text_from_this_image 'greyscaled_image.png'
+  #
+  # ========================================================================= #
+  def self.extract_text_from_this_image(
+      i,
+      use_this_oem_value  = 1, # :default
+      do_show_the_command = false
+    )
+    i = i.join(' ').strip if i.is_a? Array
+    case use_this_oem_value
+    when :default
+      use_this_oem_value = 1
+    end
+    case do_show_the_command
+    when :do_show_the_command
+      do_show_the_command = true
+    end
+    use_this_command = "tesseract #{i} stdout -l eng --oem #{use_this_oem_value} --psm 3 2>&1"
+    if do_show_the_command
+      puts use_this_command
+    end
+    # ========================================================================= #
+    # An alternative to `` may be Open3.capture3(), such as like this:
+    #   require 'open3'
+    #   text, _,  _ = Open3.capture3(use_this_command)
+    #   puts text    
+    # ========================================================================= #
+    result = `#{use_this_command}`
+    return result.strip
+  end; self.instance_eval { alias return_text_from_this_image extract_text_from_this_image } # === ImageParadise.return_text_from_this_image
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  ImageParadise.extract_text_from_this_image(ARGV)
+end # extract_text_from_this_image