Document the new modules and docs-link for all modules (#841)

* Document the new modules and doc-link for all modules

This commit introdueces new modules to image-sequencer
	- Dither
	- Draw Rectangle
	- Paint Bucket
	- Tint
	- Threshold
	- WhiteBalance

fixes #719

* Update docs/MODULES.md

Co-Authored-By: lohitha02 <lohithabhagam123@gmail.com>

* Update MODULES.md

* Update info.json

* Update MODULES.md

* Update info.json

* Update info.json

docs/MODULES.md

@@ -6,30 +6,38 @@ List of Module Documentations
 1.  [Crop](#crop-module)
 2.  [Segmented-Colormap](#segmented-colormap-module)
 3.  [FisheyeGl](#fisheyeGl-module)
-4.  [Average](#average-module)
+4.  [Add QR](#Add-QR-module)
-5.  [Blend](#blend-module)
+5.  [Average](#average-module)
-6.  [Blur](#blur-module)
+6.  [Blend](#blend-module)
-7.  [Brightness](#brightness-module)
+7.  [Blur](#blur-module)
-8.  [Channel](#channel-module)
+8.  [Brightness](#brightness-module)
-9.  [Colorbar](#colorbar-module)
+9.  [Channel](#channel-module)
-10. [Colormap](#colormap-module)
+10. [Colorbar](#colorbar-module)
-11. [Contrast](#contrast-module)
+11. [Colormap](#colormap-module)
-12. [Convolution](#convolutioon-module)
+12. [Contrast](#contrast-module)
-13. [DecodeQr](#decodeQr-module)
+13. [Convolution](#convolution-module)
-14. [Dynamic](#dynamic-module)
+14. [DecodeQr](#decodeQr-module)
-15. [Edge-Detect](#edge-detect-module)
+15. [Dither](#dither-module)
-16. [Gamma-Correction](#gamma-correction-module)
+16. [DrawRectangle](#draw-rectangle-module)
-17. [Gradient](#gradient-module)
+17. [Dynamic](#dynamic-module)
-18. [Histogram](#histogram-module)
+18. [Edge-Detect](#edge-detect-module)
-19. [Import-image](#import-image-module)
+19. [FlipImage](#flipimage-module)
-20. [Invert](#invert-module)
+20. [Gamma-Correction](#gamma-correction-module)
-21. [Ndvi](#ndvi-module)
+21. [Gradient](#gradient-module)
-22. [Ndvi-Colormap](#ndvi-colormap-module)
+22. [Histogram](#histogram-module)
-23. [Overlay](#overlay-module)
+23. [Import-image](#import-image-module)
-24. [Resize](#resize-module)
+24. [Invert](#invert-module)
-25. [Rotate](#rotate-module)
+25. [Ndvi](#ndvi-module)
-26. [Saturation](#saturation-module)
+26. [Ndvi-Colormap](#ndvi-colormap-module)
-
+27. [Overlay](#overlay-module)
+28. [PaintBucket](#paint-bucket-module)
+29. [Resize](#resize-module)
+30. [ReplaceColor](#replacecolor-module)
+31. [Rotate](#rotate-module)
+32. [Saturation](#saturation-module)
+33. [Threshold](#threshold)
+34. [Tint](#tint)
+35. [WhiteBalance](#white-balance)
 
 
 ## crop-module
@@ -100,6 +108,23 @@ where `options` is an object with the following properties:
 * x : Field of View x (0 to 2; default 1)
 * y : Field of View y (0 to 2; default 1)
 
+## add-qr-module
+
+This module Adds QR corresponding to the given string.
+
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('add-qr',options)
+           .run()
+```
+
+where `options` is an object with the following properties:
+* size : size of QR code in pixels (default 200)
+* qrCodeString : input string to generate QR code
+
+
 ## average-module
 
 This module is used for averaging all the pixels of the image.
@@ -247,6 +272,42 @@ This module is used for decoding a QR in image (if present).
            .addSteps('decode-qr',options)
            .run()
 ```
+
+## dither-module
+
+This module approximates a color from a mixture of other colors when the required color is not available, creating illusions of the color that is not present actually.
+
+[more info on wikipedia](https://en.wikipedia.org/wiki/Dither)
+
+## Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('dither',options)
+           .run()
+```
+where `options` is an object with the following property:
+* dither : Can select the name of the Dithering Algorithm(default none)
+ 
+## draw-rectangle-module
+
+This module helps to draw a rectangle on the image with a starting and ending corner with the specified thickness and color of the border.
+
+## Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('draw-rectangle',options)
+           .run()
+```
+where `options` is an object with the following properties:
+* startingX : starting x position of the rectangle (default 0)
+* startingY : starting y position of the rectangle (default 0)
+* endX      : last x position of the rectangle (default "width")
+* endY      : last y position of the rectangle (default "height")
+* thickness : thickness of the border (default 1)
+* color     : RGBA values separated by a space (default "0 0 0 255") 
+
 ## dynamic-module
 
 This module is used for producing each color channel based on the original image's color.
@@ -281,6 +342,22 @@ where `options` is an object with the following properties:
 * highThresholdRatio : Upper Threshold Ratio ( default : 0.2)
 * lowThresholdratio : Lower Threshold Ratio ( default : 0.2)
 
+## flipimage-module 
+
+This module is used for flipping the image on the selected axis.
+#### Usage
+
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('flip-image',options)
+           .run()
+```
+
+where `options` is an object with the following properties:
+* Axis : select the required axis (default : vertical)
+
+
 ## gamma-correction-module
 
 This module is used for applying gamma correction.
@@ -386,6 +463,24 @@ where `options` is an object with the following properties:
 * y : Y-position of the image on which the new image is overlayed (default 0)
 * offset : offset to the step on which the output of the last step is overlayed (default -2)
 
+## paint-bucket-module
+
+This module fills any polygonal shape with the specified color in pixels.
+
+## Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('paint-bucket',options)
+           .run()
+```
+
+where `options` is an object with the following property:
+* startingX : it is the value of the starting x-cordinate (default 10)
+* startingY : it is the value of the starting y-cordinate (default 10)
+* fillColor : they are four spaced seperated numbers representing the RGBA values of fill-color (default "100 100 100 255")
+* tolerance : it is the % tolerance (default 10)
+
 ## resize-module
 
 This module is used for resizing an image.
@@ -400,6 +495,22 @@ This module is used for resizing an image.
 where `options` is an object with the following property:
 * resize : Percentage value of resize (default 125%)
 
+## replacecolor-module
+
+This module is used in replacing the color with grey or any desired color.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('replace-color',options)
+           .run()
+```
+where `options` is an object with the following properties:
+* replaceMethod : replaces with the desired color (default greyscale)
+* replaceColor : three space separated numbers representing the RGB values of color to be filled (default "0 0 255")
+* color : three space separated numbers representing the RGB values of color to be replaced (default "228 86 81")
+* tolerance : it is the % tolerance (default 50)
+
 ## rotate-module
 
 This module is used for rotating an image.
@@ -428,4 +539,49 @@ This module is used for changing the saturation of the image.
 where `options` is an object with the following property:
 * saturation : saturation for the new image (between 0 and 2; default 0)
 
+## Threshold 
+
+Thresholding is used to create binary images.
+
+## Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('threshold',options)
+           .run()
+```
+where `options` is an object with the following property:
+* threshold : it allows to select the types of thresholding (default "manual thresholding")
+* input : it allows to select the range of thresholding value (default 120)
+
+
+## Tint 
+
+It adds color tint to an image
+
+## Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('tint',options)
+           .run()
+```
+where `options` is an object with the following property:
+* color : RGB values seperated by a space (default "0 0 255")
+* factor : amount of tint (default 0.5)
+
+
+## White Balance
+
+This Change the colour balance of the image by adjusting the colour temperature.
+
+## Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('white-balance',options)
+           .run()
+```
+where `options` is an object with the following property:
+* temperature : temperature between 0 - 40,000 kelvin (default 6000)
 

src/modules/AddQR/info.json

@@ -14,6 +14,6 @@
         "default": "https://github.com/publiclab/image-sequencer"
       }
     },
-    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#add-qr-module"
   }
   

src/modules/Average/info.json

@@ -3,5 +3,5 @@
     "description": "Average all pixel color",
     "inputs": {
     },
-    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#average-module"
 }

src/modules/Blend/info.json

@@ -13,5 +13,5 @@
       "default": "function(r1, g1, b1, a1, r2, g2, b2, a2) { return [ r1, g2, b2, a2 ] }"
     }
   },
-  "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+  "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#blend-module"
 }

src/modules/Blur/info.json

@@ -11,5 +11,5 @@
             "step": 0.25
         }
     },
-    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#blur-module"
 }

src/modules/Brightness/info.json

@@ -10,5 +10,5 @@
           "max": "200"
       }
   },
-  "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+  "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#brightness-module"
 }

src/modules/Channel/info.json

@@ -9,5 +9,5 @@
       "values": ["red", "green", "blue"]
     }
   },
-  "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+  "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#channel-module"
 }

src/modules/Colorbar/info.json

@@ -29,5 +29,5 @@
             "default": 10
         }
     },
-    "docs-link": "https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+    "docs-link": "https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#colorbar-module"
 }

src/modules/Colormap/info.json

@@ -9,5 +9,5 @@
       "values": ["default","greyscale","bluwhtgrngis","stretched","fastie","brntogrn","blutoredjet","colors16"]
     }
   },
-  "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+  "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#colormap-module"
 }

src/modules/Contrast/info.json

@@ -10,5 +10,5 @@
             "max": 100
         }
     },
-    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#contrast-module"
 }

src/modules/Convolution/info.json

@@ -16,5 +16,5 @@
         "placeholder": "1 1 1 1 1 1 1 1 1"
       }
     },
-    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#convolution-module"
 }

src/modules/Crop/info.json

@@ -30,5 +30,5 @@
       "placeholder": "255 255 255 255"
     }
   },
-  "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+  "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#crop-module"
 }

src/modules/DecodeQr/info.json

@@ -8,5 +8,5 @@
       "type": "string"
     }
   },
-  "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+  "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#decodeqr-module"
 }

src/modules/Dither/info.json

@@ -8,6 +8,7 @@
         "default": "none",
         "values": ["none","floydsteinberg","bayer","Atkinson"]
       }
-    }
+    },
+	"docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#dither-module"
 }
   

src/modules/DrawRectangle/info.json

@@ -37,5 +37,6 @@
         "desc": "RGBA values separated by a space",
         "default": "0 0 0 255"
       }
-    }
+    },
+ "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#draw-rectangle-module"
 }

src/modules/Dynamic/info.json

@@ -23,5 +23,5 @@
       "default": "r + g + b"
     }
   },
-  "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+  "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#dynamic-module"
 }

src/modules/EdgeDetect/info.json

@@ -27,5 +27,5 @@
             "step": 0.05
         }
     },
-    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#edge-detect-module"
 }

src/modules/FisheyeGl/info.json

@@ -63,5 +63,5 @@
       "default": "(inbuilt)"
     }
   },
-  "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+  "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#fisheyegl-module"
 }

src/modules/FlipImage/info.json

@@ -8,5 +8,6 @@
       "default": "Vertical",
       "values": ["Horizontal", "Vertical"]
     }
-  }
+  },
+   "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#flipimage-module"
 }

src/modules/GammaCorrection/info.json

@@ -10,5 +10,5 @@
             "max": 1
         }
     },
-    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#gamma-correction-module"
 }

src/modules/Gradient/info.json

@@ -2,5 +2,5 @@
     "name": "Gradient",
     "description": "Gives a gradient of the image",
     "inputs": {},
-    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#gradient-module"
 }

src/modules/Histogram/info.json

@@ -12,5 +12,5 @@
             ]
         }
     },
-    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#histogram-module"
 }

src/modules/ImportImage/info.json

@@ -9,5 +9,5 @@
       "default": "./images/monarch.png"
     }
   },
-  "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+  "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#import-image-module"
 }

src/modules/Invert/info.json

@@ -3,5 +3,5 @@
   "description": "Inverts the image.",
   "inputs": {
   },
-  "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+  "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#invert-module"
 }

src/modules/Ndvi/info.json

@@ -9,5 +9,5 @@
       "values": ["red", "blue"]
     }
   },
-  "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+  "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#ndvi-module"
 }

src/modules/NdviColormap/info.json

@@ -2,5 +2,5 @@
     "name": "NDVI-Colormap",
     "description": "Sequentially Applies NDVI and Colormap steps",
     "inputs": {},
-    "docs-link": "https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+    "docs-link": "https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#ndvi-colormap-module"
 }

src/modules/Overlay/info.json

@@ -18,5 +18,5 @@
             "default": -2
         }
     },
-    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#overlay-module"
 }

src/modules/PaintBucket/info.json

@@ -26,5 +26,6 @@
         "max": "100",
         "step": "1"
       }
-  } 
+  },
+ "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#paint-bucket-module" 
 }

src/modules/ReplaceColor/info.json

@@ -28,5 +28,6 @@
           "max": "100",
           "step": "1"
         }
-    } 
+    },
+	"docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#replacecolor-module" 
   }

src/modules/Resize/info.json

@@ -8,5 +8,5 @@
       "default": "125%"
     }
   },
-  "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+  "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#resize-module"
 }

src/modules/Rotate/info.json

@@ -11,5 +11,5 @@
         "step": "1"
       }
     },
-    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#rotate-modul"
   }

src/modules/Saturation/info.json

@@ -11,5 +11,5 @@
             "step": 0.1
         }
     },
-    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#saturation-module"
 }

src/modules/Threshold/info.json

@@ -16,5 +16,6 @@
       "max": "255",
       "step": "1"
     }
-  }
+  },
+ "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#threshold"
 }

src/modules/Tint/info.json

@@ -15,5 +15,6 @@
           "max": "1",
           "step": "0.01"
       }
-  }
+  },
+ "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#tint"
 }

src/modules/WhiteBalance/info.json

@@ -8,5 +8,5 @@
         "default": 6000
       }
     },
-    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md"
+    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#white-balance"
 }