Merge

.travis.yml

@@ -0,0 +1,22 @@
+language: python
+python:
+  - "3.6"
+
+# command to install dependencies
+install:
+  - pip install -r requirements.txt
+  - pip install codecov
+  - pip install pytest-cov
+
+# command to run tests & document coverage
+addons:
+  apt:
+    packages:
+      - python-coverage
+script:
+  - pytest
+  - pytest --cov=AutoTransformPy tests/
+
+# code coverage badge
+after_success:
+  - codecov

AutoTransformPy/__init__.py

@@ -0,0 +1 @@
+name = "AutoTransformPy"

AutoTransformPy/mirror.py

@@ -30,31 +30,38 @@ def mirror (image_path, direction = 'all'):
     mirrored_images: np.array
     """
 
-    # check for valid input parameters
+    try:
+        # check for valid input parameters
+        if not isinstance(image_path, str):
+            raise TypeError("The file path must be a string.")
 
-    if not isinstance(image_path, str):
-        raise TypeError("The file path must be a string.")
+        if not isinstance(direction, str):
+            raise TypeError("The direction must be a string: 'horizontal', 'vertical', or 'all'")
 
-    if not isinstance(direction, str):
-        raise TypeError("The direction must be a string: 'horizontal', 'vertical', or 'all'")
+        if not direction.lower() in ["horizontal","vertical", "all"]:
+            raise ValueError("The direction must be 'horizontal', 'vertical' or 'all'")
 
-    if not direction in ["horizontal","vertical", "all"]:
-        raise ValueError("The direction must be 'horizontal', 'vertical' or 'all'")
+        img = imread(image_path)
 
-    if not os.path.isfile(image_path):
-        raise FileNotFoundError("No image found at path")
+    except TypeError as e:
+        print("Invalid parameter types. Correct parameter types: image_path: str, num_images: int, direction: string")
+        raise e
+    except ValueError as e:
+        print("Invalid direction value. The direction must be a string: 'horizontal', 'vertical', or 'all'")
+        raise e
+    except FileNotFoundError as e:
+        raise e
 
     # import image as array
-    img = imread(image_path)
     mirrored_images = [img]
 
     # flip horizontally
-    if direction == 'horizontal' or direction == 'all':
+    if direction.lower() == 'horizontal' or direction.lower() == 'all':
         horiz_image = np.fliplr(img)
         mirrored_images.append(horiz_image)
 
     # flip vertically
-    if direction == 'vertical' or direction == 'all':
+    if direction.lower() == 'vertical' or direction.lower() == 'all':
         vert_image = img[::-1]
         mirrored_images.append(vert_image)
 

AutoTransformPy/rotate.py

@@ -1,6 +1,14 @@
+# Copyright 2019 Brenden Everitt
+# Licensed under the MIT License
+# Use of this file must be in compliance with the License, LICENSE.md
+#
+# February 2019
+# This script is for AutoTransformPy function Rotate.
+
 from skimage.io import imread
 from skimage.transform import rotate as rot
 import numpy as np
+import os
 
 def rotate (image_path, num_images, max_rotation):
     """Returns an array of images of length num_images randomly rotated a random degree up to max_rotation
@@ -24,27 +32,37 @@ def rotate (image_path, num_images, max_rotation):
     rotated_images: np.array
     """
 
-    # Check for valid input paramters types
-    if not isinstance(image_path, str):
-        raise TypeError("The file path must be a string.")
+    try:
+        # Check for valid input paramters types
+        if not isinstance(image_path, str):
+            raise TypeError("The file path must be a string.")
+
+        if not isinstance(num_images, int):
+            raise TypeError("The number of images returned must be an integer.")
 
-    if not isinstance(num_images, int):
-        raise TypeError("The number of images returned must be an integer.")
+        if not isinstance(max_rotation, int):
+            raise TypeError("The maximum rotation of images must be an integer.")
 
-    if not isinstance(max_rotation, int):
-        raise TypeError("The maximum rotation of images must be an integer.")
+        # Check for valid input paramter values
+        if num_images < 1:
+            raise ValueError("The number of images returned must be 1 or greater.")
 
-    # Check for valid input paramter values
-    if num_images < 1:
-        raise ValueError("The number of images returned must be 1 or greater.")
+        if max_rotation < 1 or max_rotation > 360:
+            raise ValueError("The maximum rotation must be between 1 and 360.")
 
-    if max_rotation < 1 or max_rotation > 360:
-        raise ValueError("The maximum rotation must be between 1 and 360.")
+        org_image = imread(image_path)
+    except TypeError as e:
+        print("Invalid parameter types. Correct parameter types: image_path: str, num_images: int, max_rotation: int")
+        raise e
+    except ValueError as e:
+        print("Invalid max_rotation value. max_rotation must be greater than 1 and less than 360.")
+        raise e
+    except FileNotFoundError as e:
+        raise e
 
     # Perform image rotation
     rotations = np.random.randint(-max_rotation, max_rotation, num_images)
-    org_image = imread(image_path)
-    rotated_images = []
+    rotated_images = [org_image]
 
     for a_rotation in rotations:
         rotated_images.append(rot(org_image, a_rotation, resize=False))

AutoTransformPy/translate.py

@@ -24,23 +24,33 @@ def translate (image_path, num_images, max_translation):
     """
 
     # Check for valid input paramters types
-    if not isinstance(image_path, str):
-        raise TypeError("The file path must be a string.")
+    try:
+        if not isinstance(image_path, str):
+            raise TypeError("The file path must be a string.")
 
-    if not isinstance(num_images, int):
-        raise TypeError("The number of images returned must be an integer.")
+        if not isinstance(num_images, int):
+            raise TypeError("The number of images returned must be an integer.")
 
-    if not isinstance(max_translation, int):
-        raise TypeError("The maximum translation of images must be an integer.")
+        if not isinstance(max_translation, int):
+            raise TypeError("The maximum translation of images must be an integer.")
 
-    # Check for valid input paramter values
-    if num_images < 1:
-        raise ValueError("The number of images returned must be 1 or greater.")
+        # Check for valid input paramter values
+        if num_images < 1:
+            raise ValueError("The number of images returned must be 1 or greater.")
 
-    org_image = imread(image_path)
+        org_image = imread(image_path)
 
-    if max_translation >= org_image.shape[0] or max_translation >= org_image.shape[1]:
-        raise ValueError("The maximum translation must be less than the width and height of the image.")
+        if max_translation >= org_image.shape[0] or max_translation >= org_image.shape[1]:
+            raise ValueError("The maximum translation must be less than the width and height of the image.")
+
+    except TypeError as e:
+        print("Invalid parameter types. Correct parameter types: image_path: str, num_images: int, max_translation: int")
+        raise e
+    except ValueError as e:
+        print("Invalid max_translation value. max_translation must be greater than 1 and less than the width and height of the image.")
+        raise e
+    except FileNotFoundError as e:
+        raise e
 
     # Perform image translation
     translations = (np.random.randint(-max_translation, max_translation, num_images), np.random.randint(-max_translation, max_translation, num_images))

README.md

@@ -1,19 +1,30 @@
-# AutoTransform
+# AutoTransformPy  <img src="docs/logopy.png" width="160" align="right"/>
 
-### Contributors
+[![Build Status](https://travis-ci.org/UBC-MDS/AutoTransformPy.svg?branch=master)](https://travis-ci.org/UBC-MDS/AutoTransformPy)
+[![codecov](https://codecov.io/gh/UBC-MDS/AutoTransformPy/branch/master/graph/badge.svg)](https://codecov.io/gh/UBC-MDS/AutoTransformPy)
+
+
+## Contributors
 
 | Name | GitHub |
 |---|---|
 | Alycia Butterworth | [alyciakb](https://github.com/alyciakb) |
 | Brenden Everitt | [everittB](https://github.com/everittB) |
 | Rayce Rossum | [RayceRossum](https://github.com/RayceRossum) |
 
+To contribute to this project, you must adhere to the terms outlined in our [Code of Conduct.](https://github.com/UBC-MDS/AutoTransformPy/blob/master/CONDUCT.md)
 
-### Overview
+## Overview
 
 A common application of supervised machine learning is identifying the object of an image. One issue that users encounter is a model misclassifying a new image because the object is rotated or translated in some way that was not captured in the training images. The purpose of this package is to create a more robust set of images for users to train their model with. The package will accept an image as an input, apply a series of transformations to it, and return an array of transformed pixel values. Transformations include: rotating, mirroring, and translating (shifting the object's location in the frame).
 
-### Functions
+## Installation
+
+In your console, type:
+
+`pip install git+https://github.com/UBC-MDS/AutoTransformPy.git`
+
+## Functions
 
 #### Rotate
 
@@ -28,31 +39,24 @@ Mirrors an image in the horizontal and/or vertical direction and returns the pix
 Translate will move an image within its frame, so that the topic of the image will be shifted to a new location in the frame. The distance and direction of translation will be chosen randomly, but the user specifies the maximum distance of the translation and the number of images they want generated. It returns the pixel values of the translated images.
 
 
-### Python Environment
+## Python Environment
 
 Scikit-image is a image processing package that contains functions for performing various operations to images, such as rotating or resizing, among many others. AutoTransformPy utilizes some of this packages functionality and builds it out, so the user can easily gain many variations of an image. The intended usage of this package is for the development of a larger set of training images for the training of an image classification algorithms.
 
 
-### Installation
+## Usage
 
-To install AuttoTransformPy:
+### Rotate
 
-1. Clone AutoTransformPy to your local machine: `git clone https://github.com/UBC-MDS/AutoTransformPy.git`
-2. Navigate to the repository in your terminal.
-3. Install input: `python setup.py install`
-4. You can now use AutoTransformPy. Seee usage instructions below:
+```
+from AutoTransformPy.rotate import rotate
 
-### Usage
-
-#### Rotate
-
-`from AutoTransformPy.rotate import rotate`
-
-`rotate(image_path, num_images, max_rotation)`
+rotate(image_path, num_images, max_rotation)
+```
 
 **Arguments:**
 
-- `image_path`: file path of the imput image (string)
+- `image_path`: file path of the input image (string)
 - `num_images`: number of randomly rotated images to be returned (integer)
 - `max_rotation`: maximum allowable degrees of rotation of the images (integer) between 1 and 360
 
@@ -65,15 +69,17 @@ To install AuttoTransformPy:
 - `rotate("../tests/imgs/milad.jpg", 10, 280)`
 
 
-#### Mirror
+### Mirror
 
-`from AutoTransformPy.mirror import mirror`
+```
+from AutoTransformPy.mirror import mirror
 
-`mirror(image_path, direction)`
+mirror(image_path, direction)
+```
 
 **Arguments:**
 
-- `image_path`: file path of the imput image (string)
+- `image_path`: file path of the input image (string)
 - `direction`: direction of mirroring (string, optional) 'horizontal', 'vertical', or 'all'. If not specified, defaults to 'all'
 
 **Output:**
@@ -85,11 +91,13 @@ To install AuttoTransformPy:
 - `mirror("../tests/imgs/milad.jpg", "horizontal")`
 
 
-#### Translate
+### Translate
 
-`from AutoTransformPy.translate import translate`
+```
+from AutoTransformPy.translate import translate
 
-`translate(image_path, num_images, max_translation)`
+translate(image_path, num_images, max_translation)
+```
 
 **Arguments:**
 
@@ -106,14 +114,41 @@ To install AuttoTransformPy:
 - `translate("../tests/imgs/milad.jpg", 5, 80)`
 
 
-### Package Dependencies
+## Package Dependencies
 
 - `numpy`
 - `skimage`
 - `os`
 
 
-| File | Description |
-|---|---|
-| [Lab x Solution](https://github.ubc.ca/MDS-2018-19/DSCI_) | My solution file to Lab x |
+## Full Usage Example
+
+```
+# pip install git+https://github.com/UBC-MDS/AutoTransformPy.git
+
+from AutoTransformPy.mirror import mirror
+from AutoTransformPy.rotate import rotate
+from AutoTransformPy.translate import translate
+
+# perform transformations
+m = mirror("../tests/imgs/milad.jpg", "horizontal")
+r = rotate("../tests/imgs/milad.jpg", 10, 280)
+t = translate("../tests/imgs/milad.jpg", 5, 80)
+
+# view dimensions of returned arrays
+# it will be a 4D array, with the 1st dimension representing how many photos are in the array
+m.shape  # mirror function
+r.shape  # rotate function
+t.shape  # translate function
+
+# You can use skimage.io to view the transformed images:
+from skimage.io import imshow
+
+# display original image
+imshow(m[0])  # using mirror function as example
 
+# display one of the transformed images
+imshow(m[1])  # mirror function
+imshow(r[1])  # rotate function
+imshow(t[1])  # translate function
+```

requirements.txt

@@ -0,0 +1,3 @@
+python_version>='3.6'
+numpy>=1.14
+scikit-image>=0.13

tests/.coverage

@@ -1 +1 @@
-!coverage.py: This is a private format, don't read it directly!{"lines":{"/home/rayce/Assignments/Block 5/DSCI 524/AutoTransformPy-Master/AutoTransformPy/mirror.py":[8,9,10,12,35,38,39,36,41,42,44,45,48,49,52,53,54,57,62,64,58,59],"/home/rayce/Assignments/Block 5/DSCI 524/AutoTransformPy-Master/AutoTransformPy/__init__.py":[1],"/home/rayce/Assignments/Block 5/DSCI 524/AutoTransformPy-Master/AutoTransformPy/rotate.py":[1,2,3,5,28,29,31,32,34,35,38,41,42,39,45,46,47,49,50,52],"/home/rayce/Assignments/Block 5/DSCI 524/AutoTransformPy-Master/AutoTransformPy/translate.py":[1,2,3,5,27,28,30,31,33,34,37,40,42,43,38,46,47,49,50,51,53]}}
+!coverage.py: This is a private format, don't read it directly!{"lines":{"/home/rayce/Assignments/Block 5/DSCI 524/AutoTransformPy/AutoTransformPy/mirror.py":[8,9,10,12,33,35,38,39,46,47,48,36,41,42,49,50,51,44,52,53,56,59,60,61,64,69,71,65,66],"/home/rayce/Assignments/Block 5/DSCI 524/AutoTransformPy/AutoTransformPy/__init__.py":[1],"/home/rayce/Assignments/Block 5/DSCI 524/AutoTransformPy/AutoTransformPy/rotate.py":[8,9,10,11,13,35,37,38,54,55,56,40,41,43,44,47,50,51,57,58,59,48,53,60,61,64,65,67,68,70],"/home/rayce/Assignments/Block 5/DSCI 524/AutoTransformPy/AutoTransformPy/translate.py":[1,2,3,5,27,28,29,46,47,48,31,32,34,35,38,41,43,44,49,50,51,39,56,57,59,60,61,63]}}