README-en.md edited on August 1, 2016 at 4:45 pm

README-en.md

@@ -4,11 +4,11 @@
 ![main2.png](images/main2-small.png)
 ![main3.png](images/main3-small.png)
 
-[Verano 2016 - Ive]
+[Verano 2016 - Ive - Coralys]
 
-Two common tasks when working with arrays of data is to search for and sort the data in ascending or descending order. Two well known simple sorting algorithms are Selection Sort and Bubble Sort. Sorting algorithms make up part of many programs; for example, contact lists, search engines, etc. In this laboratory experience you will complete an application to process images and pratice the use of sorting algorithms. You will also learn about the `QImage` library from `Qt` and about the median filter used in image processing to remove noise, in this case a pesky tourist.
+Two common tasks when working with arrays of data is to search for and sort the data in ascending or descending order. Two well known simple sorting algorithms are the Selection Sort and the Bubble Sort. Sorting algorithms make up part of many programs; for example, contact lists, search engines, etc. In this laboratory experience, you will complete an application to process images and pratice the use of sorting algorithms. You will also learn about the `QImage` library from `Qt` and about the median filter used in image processing to remove noise, in this case, a pesky tourist.
 
-##Objectives
+## Objectives
 
 1. Practice sorting arrays by selection and the bubble method.
 
@@ -22,15 +22,16 @@ Two common tasks when working with arrays of data is to search for and sort the
 
 This laboratory experience is an adaptation of the nifty assignment presented by John Nicholson in [1].
 
+
 ## Pre-Lab:
 
 Before arriving at the laboratory you should have:
 
 1. Reviewed the selection sort and bubble sort algorithms.
 
-2. Familiarized yourself with the `push_back()`, `at(i)`,  `size()`, `clear()` methods in the C++ `vector` class.
+2. Familiarized yourself with the `push_back()`, `at(i)`,  `size()`, and `clear()` methods in the C++ `vector` class.
 
-3. Familiariezed yourself with the `width()`, `height()`, `pixel(i, j)`, `setPixel(i,j, pixel)` methods in the `QImage` class from `Qt`.
+3. Familiariezed yourself with the `width()`, `height()`, `pixel(i, j)`, and `setPixel(i,j, pixel)` methods in the `QImage` class from `Qt`.
 
 4. Studied the concepts and instructions for the laboratory session.
 
@@ -42,7 +43,7 @@ Before arriving at the laboratory you should have:
 
 ## Pixels:
 
-The smallest element in an image is called a pixel. This unit consists of a single color. Since each color is a combination of tones of the primary red, green and blue colors, it is coded as an unsigned integer whose bytes represent the tones of red, green and blue of the pixel (Figure 1). One fourth of a byte specifies what is known as the *alpha composition*, which defines the opacity of the pixel (0xff is completely opaque and 0x00 is completely transparent, i.e. invisible). This combination is known as the *ARGB* of the color for “Alpha-Red-Green-Blue”. For example a pixel of pure red has an RGB representation of `0xffff0000`, while a pixel of pure white has an RGB representation of `0xffffffff` (since the color white is the combination of the red, green and blue tones in their maximum intensity). Throughout this lab we will assume the pixel’s alpha has total opacity (0xff).
+The smallest element in an image is called a pixel. This unit consists of a single color. Since each color is a combination of tones of the primary red, green and blue colors, it is coded as an unsigned integer whose bytes represent the tones of red, green and blue of the pixel (Figure 1). One fourth of a byte specifies what is known as the *alpha composition*, which defines the opacity of the pixel (0xff is completely opaque and 0x00 is completely transparent, i.e. invisible). This combination is known as the *ARGB* of the color for “Alpha-Red-Green-Blue”. For example a pixel of pure red has an RGB representation of `0xffff0000`, while a pixel of pure white has an RGB representation of `0xffffffff` (since the color white is the combination of the red, green and blue tones in their maximum intensity). Throughout this laboratory experience, we will assume the pixel’s alpha has total opacity (0xff).
 
 ---
 
@@ -63,9 +64,9 @@ Today’s laboratory experience will use the `QImage` class. This class permits
 
 ## Image Processing
 
-Image processing is used in a wide variety of socially relevant applications.  People daily apply image processing filters to their pictures before posting them in a social media.  Social media, cameras, and mobile devices use image processing for face recognition. Researchers use image processing to count organisms inside a scanned space, to detect anomalies inside computer tomography (CT) scans, and in general to reveal information about scanned objects. 
+Image processing is used in a wide variety of socially relevant applications. People daily apply image processing filters to their pictures before posting them in a social media.  Social media, cameras, and mobile devices use image processing for face recognition. Researchers use image processing to count organisms inside a scanned space, to detect anomalies inside computer tomography (CT) scans, and in general to reveal information about scanned objects. 
 
-The median filter is one of the simplest filters used in image processing. It is very useful for removing undesired objects from images. Let's say that you encounter the most interesting tree in the world and you would like to photograph it.  You set up your photography equipment, the light is perfect, the colors are beautiful. To be sure that you capture the perfect photo you take three of them. However, at the exact moment that the photos were taken a pesky tourist photobombed your master creation.  The median filter will help you remove the tourist from the photo by merging the three photos into a tourist-free nature shot.
+The median filter is one of the simplest filters used in image processing. It is very useful for removing undesired objects from images. Let's say that you encounter the most interesting tree in the world and you would like to photograph it.  You set up your photography equipment, the light is perfect, and the colors are beautiful. To be sure that you capture the perfect photo, you take three of them. However, at the exact moment that the photos were taken a pesky tourist photobombed your master creation.  The median filter will help you remove the tourist from the photo by merging the three photos into a tourist-free nature shot.
 
 Given three or more images of the same space, a median filter works as follows: for each pixel position $$(x,y)$$ find the median color among the images, then use the median color in the merged image.  
 
@@ -87,8 +88,9 @@ For example, the median of {3,5,2,7,11} is 5 since the ordered array is {2, 3, 5
 
 The method we will be using in this laboratory experience to acquire the median of various pixels will be the following: we will determine the median of its red, green and blue components, and then create a new pixel using these medians. The following example illustrates the procedure.
 
-####Example:
-Suppose we have to find the median of the three pixels with values `0xff223344`, `0xff112233`, `0xff001155`.
+#### Example:
+
+Suppose we have to find the median of the three pixels with values `0xff223344`, `0xff112233`, and `0xff001155`.
 
 * The median of the red component is 0x11 (since the red components are `0x22`, `0x11` y `0x00`).
 * The median of the green component is 0x22 (since the green components are `0x33`, `0x22` y `0x11`).
@@ -116,22 +118,22 @@ Notice that the result can be a pixel with a color that did not exist among the
 For this laboratory experiences you will need to know how to use the following methods for the `vector` C++ class:
 
 * `push_back()`  // to insert an element at the end of the vector
-* `at(i)`               // get element at position i
-* `size()`            // get the number of elements in the vector
-* `clear()`          // empty the vector/remove the elements.
+* `at(i)`        // get element at position i
+* `size()`       // get the number of elements in the vector
+* `clear()`      // empty the vector/remove the elements.
 
 The following functions are useful to work with data of type `QRgb`:
 
-* `qRed(pixel)`      // returns the tone of the red color of the pixel
+* `qRed(pixel)`    // returns the tone of the red color of the pixel
 * `qGreen(pixel)`  // returns the tone of the green color of the pixel
-* `qBlue(pixel)`     // returns the tone of the blue color of the pixel
+* `qBlue(pixel)`   // returns the tone of the blue color of the pixel
 
 The objects of the `QImage` class have the following methods that will be useful to manipulate the pixels of an image:
 
-* `width()`		// get the width of the image
-* `height()`		// get the height of the image
-* `pixel(i, j)` 		// gets the color of the pixel at position `(i,j)`
-* `setPixel(i, j, pixel)` 	// sets the pixel at position `(i,j`) to the QRgb color pixel.
+* `width()` // get the width of the image
+* `height()` // get the height of the image
+* `pixel(i, j)` // gets the color of the pixel at position `(i,j)`
+* `setPixel(i, j, pixel)` // sets the pixel at position `(i,j`) to the QRgb color pixel.
 * `qRgb(int red, int green, int blue)` // returns a `QRgb` pixel composed of the values of red, green and blue received.
 
 ### Examples:
@@ -192,35 +194,35 @@ int main() {
 
 ## Laboratory Session:
 
-The project `PeskyTourist` contains the skeleton for the application to remove the noise from an image. In today’s laboratory experience yu will complete the application to process images using the median filter to remove the noise of an image, in this case a pesky tourist. You will be working in the `Filter.cpp` file.
+The project `PeskyTourist` contains the skeleton for the application to remove the noise from an image. In today’s laboratory experience, you will complete the application to process images using the median filter to remove the noise of an image, in this case, a pesky tourist. You will be working in the `Filter.cpp` file.
 
-#### General algorithm to remove  noise from an image
+#### General algorithm to remove noise from an image
 
 ```
 
 Input: VI, a vector with N images
 Output: an image without noise
 ---------------------------------------
-For each position x, y:
-     P is a vector of size N
-    Assign to the elements of P the values of the pixels in position (x, y) of the N images in VI
-    M = median of the pixels of P
- Assign the value of M to the pixel (x, y) of the image without noise.
+1. For each position x, y:
+     * P is a vector of size N
+     * Assign to the elements of P the values of the pixels in position (x, y) of the N images in VI
+     * M = median of the pixels of P
+     * Assign the value of M to the pixel (x, y) of the image without noise.
 
 ```
 
 ## Exercise 1: Implement the function to order a vector of integers
 
-To find the median of the components of the colors in a pixel, we have to use a sorting function. In this part you will implement selection sort.
+To find the median of the components of the colors in a pixel, we have to use a sorting function. In this part you will implement the Selection Sort.
 
 #### Instructions
 
 1. Load the project  `PeskyTourist` into `QtCreator`. There are two ways to do this:
 	
-	* Using the virtual machine: Double click the file `PeskyTourist.pro` located in the folder `/home/eip/labs/sorting-peskytourist` of your virtual machine.
-	* Downloading the project’s folder from `Bitbucket`: Use a terminal and write the command `git clone http:/bitbucket.org/eip-uprrp/sorting-peskytourist` to download the folder `tema-nombre` from `Bitbucket`. Double click the file `PeskyTourist.pro` located in the folder that you downloaded to your computer.
+	* Using the virtual machine: Double click the file `PeskyTourist.pro` located in the folder `/home/Documents/eip/sorting-peskytourist` of your virtual machine.
+	* Downloading the project’s folder from `Bitbucket`: Use a terminal and write the command `git clone http:/bitbucket.org/eip-uprrp/sorting-peskytourist` to download the folder `sort-peskytourist` from `Bitbucket`. Double click the file `PeskyTourist.pro` located in the folder that you downloaded to your computer.
 
-2. The code that we provide creates the interface in Figure 3.
+2. Configure the project and run the program by clicking the green arrow in the menu on the left side of the Qt Creator window. The code that we provide creates the interface in Figure 3.
 
     ---
 
@@ -232,10 +234,11 @@ To find the median of the components of the colors in a pixel, we have to use a
 
 3. Press the `Load Images` button and look for the directory `ImagesPeskyTourist` that contains the images of the pesky tourist.
 
-4. Your first task is to complete the `Sort` function that receives a vector of integer. The function should order the integers of the vector in ascending order using the selection method.
+4. Your first task is to complete the `Sort` function that receives a vector of integers. The function should order the integers of the vector in ascending order using the selection method.
 
 5. Create a unit test to validate the `Sort` function and invoke it from the `RemoveNoise` function.
 
+
 ### Exercise 2: Calculate the median of a vector of integers
 
 #### Instructions
@@ -244,9 +247,10 @@ To find the median of the components of the colors in a pixel, we have to use a
 
 2. Create a unit test to validate the `Median` function and invoke it from the `RemoveNoise` function.
 
+
 ### Exercise 3: Calculate the median of each pixel
 
-Complete the function `MedianPixel` that receives a vector of pixels (of type `QRgb`) and return the pixel `QRgb` corresponding to the median of the pixels. The median of the pixels is composed of the median of each color component of the pixels.
+ Complete the `MedianPixel` function that receives a vector of pixels (of type `QRgb`) and returns the pixel `QRgb` corresponding to the median of the pixels. The median of the pixels is composed of the median of each color component of the pixels.
 
 In the code we provide a function you can use to validate the `MedianPixel` function.
 
@@ -271,7 +275,7 @@ When you complete the function, the `Remove Noise` button will execute your algo
 
 ##Deliverables
 
-Use "Deliverable" in Moodle to upload the `Filter.cpp` file that contains the functions you implemented in this laboratory experience. Remember to use good programming techniques, include the names of the programmers involved, and to document your program.
+Use "Deliverable" in Moodle to upload the `Filter.cpp` file that contains the functions you implemented in this laboratory experience. Remember to use good programming techniques, by including the names of the programmers involved, and documenting your program.
 
 ---