mirror of
https://github.com/publiclab/image-sequencer.git
synced 2025-12-16 21:29:58 +01:00
Added index to MODULES.md
This commit is contained in:
divy123
@@ -1,7 +1,38 @@
|
||||
Documentation of various Modules
|
||||
===
|
||||
|
||||
## Crop Module (crop)
|
||||
List of Module Documentations
|
||||
|
||||
1. [Crop](##crop-module)
|
||||
2. [Segmented-Colormap](##segmented-colormap-module)
|
||||
3. [FisheyeGl](##fisheyeGl-module)
|
||||
4. [Average](##average-module)
|
||||
5. [Blend](##blend-module)
|
||||
6. [Blur](##blur-module)
|
||||
7. [Brightness](##brightness-module)
|
||||
8. [Channel](##channel-module)
|
||||
9. [Colorbar](##colorbar-module)
|
||||
10. [Colormap](##colormap-module)
|
||||
11. [Contrast](##contrast-module)
|
||||
12. [Convolution](##convolutioon-module)
|
||||
13. [DecodeQr](##decodeQr-module)
|
||||
14. [Dynamic](##dynamic-module)
|
||||
15. [Edge-Detect](##edge-detect-module)
|
||||
16. [Gamma-Correction](##gamma-correction-module)
|
||||
17. [Gradient](##gradient-module)
|
||||
18. [Histogram](##histogram-module)
|
||||
19. [Import-image](##import-image-module)
|
||||
20. [Invert](##invert-module)
|
||||
21. [Ndvi](##ndvi-module)
|
||||
22. [Ndvi-Colormap](##ndvi-colormap-module)
|
||||
23. [Overlay](##overlay-module)
|
||||
24. [Resize](##resize-module)
|
||||
25. [Rotate](##rotate-module)
|
||||
26. [Saturation](##saturation-module)
|
||||
|
||||
|
||||
|
||||
##crop-module
|
||||
|
||||
This module is used to crop an image.
|
||||
|
||||
@@ -24,7 +55,7 @@ Where `options` is an object having the properties `x`, `y`, `w`, `h`. This diag
|
||||
* `options.h` : half of image height
|
||||
|
||||
|
||||
## Segmented Colormap Module (segmented-colormap)
|
||||
##segmented-colormap-module
|
||||
|
||||
This module is used to map the pixels of the image to a segmented colormap.
|
||||
|
||||
@@ -48,7 +79,7 @@ where `options` is an object with the property `colormap`. `options.colormap` ca
|
||||
|
||||
* A custom array.
|
||||
|
||||
## FisheyeGl (fisheye-gl)
|
||||
##fisheyeGl-module
|
||||
|
||||
This module is used for correcting Fisheye or Lens Distortion
|
||||
|
||||
@@ -69,7 +100,7 @@ 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)
|
||||
|
||||
## Average Module (average)
|
||||
##average-module
|
||||
|
||||
This module is used for averaging all the pixels of the image.
|
||||
|
||||
@@ -81,7 +112,7 @@ This module is used for averaging all the pixels of the image.
|
||||
.run()
|
||||
```
|
||||
|
||||
## Blend Module (blend)
|
||||
##blend-module
|
||||
|
||||
This module is used for blending two images .
|
||||
#### Usage
|
||||
@@ -96,7 +127,7 @@ where `options` is an object with the following properties:
|
||||
* offset: step of image with which current image is to be blended(Two steps back is -2, three steps back is -3 etc; default -2)
|
||||
* func: function used to blend two images (default : function(r1, g1, b1, a1, r2, g2, b2, a2) { return [ r1, g2, b2, a2 ] })
|
||||
|
||||
## Blur Module (blur)
|
||||
##blur-module
|
||||
|
||||
This module is used for applying a Gaussian blur effect.
|
||||
#### Usage
|
||||
@@ -110,7 +141,7 @@ This module is used for applying a Gaussian blur effect.
|
||||
where `options` is an object with the following property:
|
||||
* blur : Intensity of Gaussian blur (0 to 5; default 2)
|
||||
|
||||
## Brightness Module (brightness)
|
||||
##brightness-module
|
||||
|
||||
This module is used for changing the brightness of the image.
|
||||
|
||||
@@ -126,7 +157,7 @@ This module is used for changing the brightness of the image.
|
||||
where `options` is an object with the following property:
|
||||
* brightness : brightness of the image in percentage (0 to 100; default 100)
|
||||
|
||||
## Channel Module (channel)
|
||||
##channel-module
|
||||
|
||||
This module is used for forming a grayscale image by applying one of the three primary colors.
|
||||
|
||||
@@ -141,7 +172,7 @@ This module is used for forming a grayscale image by applying one of the three p
|
||||
where `options` is an object with the following property:
|
||||
* channel : color of the channel (red, green, blue; default green)
|
||||
|
||||
## Colorbar Module (colorbar)
|
||||
##colorbar-module
|
||||
|
||||
This module is used for displaying an image with a colorbar.
|
||||
|
||||
@@ -159,7 +190,7 @@ where `options` is an object with the following properties:
|
||||
* y : Y-position of the image on which the new image is overlayed (default 0)
|
||||
* h : height of resulting cropped image (default : 50% of input image width )
|
||||
|
||||
## Colormap Module (colormap)
|
||||
##colormap-module
|
||||
|
||||
This module is used for mapping brightness values (average of red, green & blue) to a given color lookup table, made up of a set of one more color gradients.
|
||||
|
||||
@@ -174,7 +205,7 @@ This module is used for mapping brightness values (average of red, green & blue)
|
||||
where `options` is an object with the following property:
|
||||
* colormap : Name of the Colormap ( greyscale, stretched, fastie, brntogrn, blutoredjet, colors16)
|
||||
|
||||
## Contrast Module (contrast)
|
||||
##contrast-module
|
||||
|
||||
This module is used for changing the contrast of the image.
|
||||
|
||||
@@ -189,7 +220,7 @@ This module is used for changing the contrast of the image.
|
||||
where `options` is an object with the following property:
|
||||
* contrast : contrast for the given image (-100 to 100; default : 70)
|
||||
|
||||
## Convolution Module (convolution)
|
||||
##convolution-module
|
||||
|
||||
This module is used for performing image-convolution.
|
||||
|
||||
@@ -205,7 +236,7 @@ where `options` is an object with the following properties:
|
||||
* constantFactor : a constant factor, multiplies all the kernel values by that factor (default : 1/9)
|
||||
* kernelValues : nine space separated numbers representing the kernel values in left to right and top to bottom format(default : 1 1 1 1 1 1 1 1 1)
|
||||
|
||||
## DecodeQr Module (decode-qr)
|
||||
##decodeQr-module
|
||||
|
||||
This module is used for decoding a QR in image (if present).
|
||||
|
||||
@@ -216,7 +247,7 @@ This module is used for decoding a QR in image (if present).
|
||||
.addSteps('decode-qr',options)
|
||||
.run()
|
||||
```
|
||||
## Dynamic Module (dynamic)
|
||||
##dynamic-module
|
||||
|
||||
This module is used for producing each color channel based on the original image's color.
|
||||
|
||||
@@ -234,7 +265,7 @@ where `options` is an object with the following properties:
|
||||
* blue : expression for blue channel (R, G, B and A as inputs; default b)
|
||||
* monochrome: fallback for other channels if none provided (default : r+g+b/3)
|
||||
|
||||
## Edge Detect Module (edge-detect)
|
||||
##edge-detect-module
|
||||
|
||||
This module is used for detecting images.
|
||||
#### Usage
|
||||
@@ -250,7 +281,7 @@ where `options` is an object with the following properties:
|
||||
* highThresholdRatio : Upper Threshold Ratio ( default : 0.2)
|
||||
* lowThresholdratio : Lower Threshold Ratio ( default : 0.2)
|
||||
|
||||
## Gamma Correction Module (gamma-correction)
|
||||
##gamma-correction-module
|
||||
|
||||
This module is used for applying gamma correction.
|
||||
#### Usage
|
||||
@@ -264,7 +295,7 @@ This module is used for applying gamma correction.
|
||||
where `options` is an object with the following property:
|
||||
* adjustement : Inverse of actual gamma factor (default 0.2)
|
||||
|
||||
## Gradient Module (gradient)
|
||||
##gradient-module
|
||||
|
||||
This module is used for finding gradient of the image.
|
||||
#### Usage
|
||||
@@ -275,7 +306,7 @@ This module is used for finding gradient of the image.
|
||||
.run()
|
||||
```
|
||||
|
||||
## Histogram Module (histogram)
|
||||
##histogram-module
|
||||
|
||||
This module is used for calculating histogram of the image.
|
||||
#### Usage
|
||||
@@ -289,7 +320,7 @@ This module is used for calculating histogram of the image.
|
||||
where `options` is an object with the following property:
|
||||
* gradient : boolean value used to toggle gradient along x-axis (true or false; default true)
|
||||
|
||||
## Import Image Module (import-image)
|
||||
##import-image-module
|
||||
|
||||
This module is used for importing a new image and replacing the original with it.
|
||||
#### Usage
|
||||
@@ -303,7 +334,7 @@ This module is used for importing a new image and replacing the original with it
|
||||
where `options` is an object with the following property:
|
||||
* url : url of the new image (local image url or data url;default : "./images/monarch.png")
|
||||
|
||||
## Invert Module (invert)
|
||||
##invert-module
|
||||
|
||||
This module is used for inverting the image.
|
||||
#### Usage
|
||||
@@ -314,7 +345,7 @@ This module is used for inverting the image.
|
||||
.run()
|
||||
```
|
||||
|
||||
## Ndvi Module (ndvi)
|
||||
##ndvi-module
|
||||
|
||||
This module is used for applying ndvi technique to the image.
|
||||
#### Usage
|
||||
@@ -328,7 +359,7 @@ This module is used for applying ndvi technique to the image.
|
||||
where `options` is an object with the following property:
|
||||
* filter : filter for NDVI (blue or red; default red)
|
||||
|
||||
## Ndvi-Colormap Module (ndvi-colormap)
|
||||
##ndvi-colormap-module
|
||||
|
||||
This module is used for demonstrating ndvi and colormap properties consecutively.
|
||||
#### Usage
|
||||
@@ -339,7 +370,7 @@ This module is used for demonstrating ndvi and colormap properties consecutively
|
||||
.run()
|
||||
```
|
||||
|
||||
## Overlay Module (overlay)
|
||||
##overlay-module
|
||||
|
||||
This module is used for overlaying an Image over another .
|
||||
#### Usage
|
||||
@@ -355,7 +386,7 @@ 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)
|
||||
|
||||
## Resize Module (resize)
|
||||
##resize-module
|
||||
|
||||
This module is used for resizing an image.
|
||||
#### Usage
|
||||
@@ -369,7 +400,7 @@ This module is used for resizing an image.
|
||||
where `options` is an object with the following property:
|
||||
* resize : Percentage value of resize (default 125%)
|
||||
|
||||
## Rotate Module (rotate)
|
||||
##rotate-module
|
||||
|
||||
This module is used for rotating an image.
|
||||
#### Usage
|
||||
@@ -383,7 +414,7 @@ This module is used for rotating an image.
|
||||
where `options` is an object with the following property:
|
||||
* rotate : angular value for rotation in degrees (between 0 and 360; default 0)
|
||||
|
||||
## saturation Module (saturation)
|
||||
##saturation-module
|
||||
|
||||
This module is used for changing the saturation of the image.
|
||||
#### Usage
|
||||
|
||||
Reference in New Issue
Block a user