despeck 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 20d7af52df2f57a1c99cd47b9d63dcd28fb34280
+  data.tar.gz: 50b513bab961b88f9c7c7396e881c7cab07eeb67
+SHA512:
+  metadata.gz: b88335d7ff52faacb2d14e7745e01e1e117e6056c4905891e8448ea53d3af40d5056786351d981cd882e7371b8f0a9a7ee04acb0a6b2f980ccdc8cd963cc21f3
+  data.tar.gz: 5f84d9d3e8429dc8e3462f404a6719b17e8a56a54c9eafb3291cc21e8776e4f2e8ed248d1bf89a74afa7f0b20a6d25b045c8a496c79bf10e2de1f4bf5fa598aa

data/.gitignore

@@ -0,0 +1,12 @@
+.DS_Store
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ronald.tse@ribose.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in despeck.gemspec
+gemspec

data/README.adoc

@@ -0,0 +1,128 @@
+= despeck: remove unwanted stamps or watermarks from scanned images
+
+`despeck` is a Ruby gem that helps you remove unwated stamps or watermarks from
+scanned images/PDFs, primarily prior to OCR.
+
+Its image processing operations are based on libvips via the
+https://github.com/jcupitt/ruby-vips[ruby-vips] Ruby-bindings.
+
+It can be used to:
+
+* detect uniform watermarks from a series of images,
+* output a watermark pattern file (image, mask) that describes a watermark pattern, and
+* remove a specified watermark pattern from input images regardless of the
+  location of the watermark on these images.
+
+Assumptions on input:
+
+* The input may be a single image, or a PDF of multiple pages of images
+* In the case of multiple pages, not all pages may have the watermark
+* The input images are assumed to be purely monochrome text-based.
+* The watermarks are colored and are located in a similar location within all
+  the pages. For example, if the watermark is a GREEN SQUARE PATTERN, for all
+  the pages that contain this mark, despeck will attempt to detect this pattern
+  and remove them
+
+== Quick start
+
+[source,sh]
+----
+gem install despeck
+----
+
+== Functionality
+
+despect has three functions:
+
+. recognize a common watermark from a set of input images. All of the input
+  images for detection should contain at least one of this mark.
+. output a file that specifies a particular watermark pattern (and the color of
+  it)
+. remove a specified mark (from a "watermark pattern file" provided by step 2)
+  from a series of input images. These input images may or may not contain this
+  watermark.
+
+== Usage (library)
+
+TODO: under development.
+
+== Usage (command-line)
+
+=== Detection
+
+The command shall do the following.
+
+1. The command shall take the input of a PDF / image(s)
+2. The command outputs a file that contains the detected watermark(s)
+
+This is the sample help output for `despeck extract`.
+
+[source]
+----
+$ despeck extract -h
+
+Usage:
+  despeck extract [options] <inputfile> <outputfile>
+
+    [-s sensitivity]
+      An integer value from 0 to 100 to indicate sensitivity of the watermark
+      detection algorithm.
+
+    [-w watermark-color-hint-in-RGB]
+      One or more RGB 8-bit values in hexadecimal (0x00 to 0xFF), separated by
+      commas for each RGB channel, to indicate the approximate color of the
+      watermark. 
+    
+      The significant bits (0 to 8) should be indicated after the full
+      color hexadecimal value. Example: "FF,AA,88/6" to indicate that the last 2
+      bits of this color value are to be ignored.
+
+    <inputfile>
+      The input file(s)
+
+    <outputfile>
+      The file to output the watermark image to.
+
+    If multiple watermark candidates are detected, multiple watermark images
+----
+
+
+=== Removal
+
+1. The command shall take the input of a PDF / image(s) and the watermark image
+2. The command outputs a file that does not contain the watermark
+
+Internally, it:
+
+1. Investigates each page and detect which ones has a watermark.
+2. For pages that do not contain the mark, just output it to the output file.
+3. For the pages that contain the watermark, remove the mark and output to the output file.
+4. Output the final PDF that all pages have the watermark removed.
+
+This is the sample help output for `despeck remove`.
+
+[source]
+----
+$ despeck remove -h
+
+Usage:
+  despeck remove [options] <inputfile> <watermarkfile> <outputfile>
+
+    This command removes the watermark specified in <watermarkfile> from
+    <inputfile>, and outputs the resulting image(s) in outputfile.
+
+    [-s sensitivity]
+      An integer value from 0 to 100 to indicate sensitivity of the watermark
+      removal algorithm.
+
+    <inputfile>
+      The input file(s)
+
+    <watermarkfile>
+      The watermark file
+
+    <outputfile>
+      The file to output the resulting images that have the specified watermark
+      removed.
+----
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "despeck"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/despeck.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "despeck/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "despeck"
+  spec.version       = Despeck::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
+
+  spec.summary       = 'Removes stamps and watermarks from scanned images for OCR, "removes specks"'
+  spec.description   = 'Removes stamps and watermarks from scanned images for OCR, "removes specks"'
+
+  spec.homepage      = "https://github.com/riboseinc/despeck"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/despeck.rb

@@ -0,0 +1,5 @@
+require "despeck/version"
+
+module Despeck
+  # Your code goes here...
+end

data/lib/despeck/version.rb

@@ -0,0 +1,3 @@
+module Despeck
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: despeck
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Removes stamps and watermarks from scanned images for OCR, "removes specks"
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.adoc
+- Rakefile
+- bin/console
+- bin/setup
+- despeck.gemspec
+- lib/despeck.rb
+- lib/despeck/version.rb
+- samples/red-circle/10-06.pdf
+- samples/red-circle/10-08.pdf
+- samples/red-circle/10-09.pdf
+- samples/red-circle/10-11.pdf
+- samples/red-circle/a-despecked.jpg
+- samples/red-circle/a.jpg
+- samples/red-circle/b.jpg
+- samples/red-circle/c.jpg
+- samples/red-circle/despecked-portion-parameters.png
+- samples/red-circle/despecked-portion.png
+- samples/red-circle/despecked-watermark-parameters.png
+- samples/red-circle/despecked-watermark.png
+homepage: https://github.com/riboseinc/despeck
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Removes stamps and watermarks from scanned images for OCR, "removes specks"
+test_files: []