docs: add one-liners to features (#71)

EscapedGibbon · web-flow · commit 14ab2c25d211 · 2023-11-02T14:26:57.000+01:00
close: #63
diff --git a/docs/Features/Comparison/Addition.md b/docs/Features/Comparison/Addition.md
@@ -2,6 +2,8 @@
 sidebar_position: 10
 ---
 
+_Makes an addition between two images._
+
 [Check options and parameters of `add` method](https://image-js.github.io/image-js-typescript/classes/Image.html#add 'github.io link')
 
 :::caution
diff --git a/docs/Features/Comparison/Hypotenuse.md b/docs/Features/Comparison/Hypotenuse.md
@@ -2,6 +2,8 @@
 sidebar_position: 30
 ---
 
+_Calculates the euclidean distance of two points between two images._
+
 [Check options and parameters of `hypotenuse` method](https://image-js.github.io/image-js-typescript/classes/Image.html#hypotenuse 'github.io link')
 
 :::caution
@@ -30,5 +32,5 @@ Where $$Value1$$ is a value of the pixel in the first image and $$Value2$$ is th
 | [`channels`](https://image-js.github.io/image-js-typescript/interfaces/HypotenuseOptions.html#channels) | no       | -                |
 
 :::caution
-Images must be compatible by size, bit depth, number of channels and number of alpha channels. However, for the resulting image the bit depth and number of channels depends on the input options.
+Images must be compatible by size, bit depth, number of channels and number of alpha channels. However, for the resulting image user can choose the bit depth of the resulting image as well as channels which the algorithm will be applied to.
 :::
diff --git a/docs/Features/Comparison/Logical conjunction.md b/docs/Features/Comparison/Logical conjunction.md
@@ -2,6 +2,8 @@
 sidebar_position: 100
 ---
 
+_Makes a logical conjunction between masks._
+
 [Check options and parameters of `and` method](https://image-js.github.io/image-js-typescript/classes/Mask.html#and 'github.io link')
 
 :::caution
diff --git a/docs/Features/Comparison/Logical disjunction.md b/docs/Features/Comparison/Logical disjunction.md
@@ -2,6 +2,8 @@
 sidebar_position: 110
 ---
 
+_Makes a logical disjunction between masks._
+
 [Check options and parameters of `or` method](https://image-js.github.io/image-js-typescript/classes/Mask.html#or 'github.io link')
 
 :::caution
diff --git a/docs/Features/Comparison/Subtraction.md b/docs/Features/Comparison/Subtraction.md
@@ -2,6 +2,8 @@
 sidebar_position: 20
 ---
 
+_Makes a subtraction between two images._
+
 [Check options and parameters of `subtract` method](https://image-js.github.io/image-js-typescript/classes/Image.html#subtract 'github.io link')
 
 Method called `subtract`, as the name suggests, takes another Image(or Mask) and makes a subtraction between each respective bit.
diff --git a/docs/Features/Filters/Blur.md b/docs/Features/Filters/Blur.md
@@ -4,6 +4,8 @@ sidebar_position: 30
 
 import BlurDemo from './blur.demo.tsx'
 
+_Reduces image details and sharpness by averaging or mixing neighboring pixel values._
+
 [Check options and parameters of `blur` method](https://image-js.github.io/image-js-typescript/classes/Image.html#blur 'link on github io')
 
 :::caution
diff --git a/docs/Features/Filters/Derivative.md b/docs/Features/Filters/Derivative.md
@@ -5,6 +5,8 @@ sidebar_position: 70
 import DerivativeDemo from './derivative.demo.tsx'
 import GradientDemo from './gradient.demo.tsx'
 
+_Gradient filter but using predefined kernels._
+
 [Check options and parameters of `derivative` method](https://image-js.github.io/image-js-typescript/classes/Image.html#derivativeFilter 'link on github io')
 
 :::caution
diff --git a/docs/Features/Filters/Gaussian Blur.md b/docs/Features/Filters/Gaussian Blur.md
@@ -4,6 +4,8 @@ sidebar_position: 40
 
 import GaussianBlurDemo from './gaussianBlur.demo.tsx'
 
+_A blur filter that uses gaussian function for smoothing._
+
 [Check options and parameters of `gaussianBlur` method](https://image-js.github.io/image-js-typescript/classes/Image.html#gaussianBlur 'link on github io')
 
 :::caution
diff --git a/docs/Features/Filters/Gradient.md b/docs/Features/Filters/Gradient.md
@@ -4,6 +4,8 @@ sidebar_position: 60
 
 import GradientDemo from './gradient.demo.tsx'
 
+_Highlights changes in color or intensity within an image by accentuating transitions and edges._
+
 [Check options and parameters of `gradient` method](https://image-js.github.io/image-js-typescript/functions/gradientFilter.html 'link on github.io')
 
 :::caution
diff --git a/docs/Features/Filters/Grayscale.md b/docs/Features/Filters/Grayscale.md
@@ -4,6 +4,8 @@ sidebar_position: 20
 
 import GrayDemo from './grayscale.demo.tsx'
 
+_Converts color image into shades of gray._
+
 [Check options and parameters of `grayscale` method](https://image-js.github.io/image-js-typescript/classes/Image.html#grey 'github.io link')
 
 :::caution
diff --git a/docs/Features/Filters/Invert.md b/docs/Features/Filters/Invert.md
@@ -6,6 +6,8 @@ import InvertDemo from './invert.demo.tsx'
 
 import InvertMaskDemo from './invert.mask.demo.tsx';
 
+_Reverses the colors of an image, transforming dark areas into light and vice versa._
+
 [Check options and parameters of `invert` method](https://image-js.github.io/image-js-typescript/classes/Image.html#invert 'github.io link')
 
 [Invert filter](<https://en.wikipedia.org/wiki/Negative_(photography)> 'wikipedia link on negative filtering') is an image processing technique used to reverse the color values of an image, creating a negative or "inverted" version of the original. In this process, the darkest areas become the lightest, and the lightest areas become the darkest, while the midtones are adjusted accordingly. The invert filter is a simple but effective way to create visual contrast and produce interesting effects.
diff --git a/docs/Features/Filters/Level.md b/docs/Features/Filters/Level.md
@@ -4,6 +4,8 @@ sidebar_position: 80
 
 import LevelDemo from './level.demo.tsx'
 
+_Redistributes pixel intensities to achieve a more uniform histogram distribution._
+
 [Check options and parameters of `level` method](https://image-js.github.io/image-js-typescript/classes/Image.html#level 'github.io link')
 
 :::caution
diff --git a/docs/Features/Filters/Median.md b/docs/Features/Filters/Median.md
@@ -4,6 +4,8 @@ sidebar_position: 50
 
 import MedianDemo from './median.demo.tsx'
 
+_Replaces each pixel's value with the median value of neighboring pixels, effectively reducing noise and preserving edge details._
+
 [Check options and parameters of `median` method](https://image-js.github.io/image-js-typescript/classes/Image.html#medianFilter 'github.io link')
 
 :::caution
diff --git a/docs/Features/Filters/Pixelate.md b/docs/Features/Filters/Pixelate.md
@@ -4,6 +4,8 @@ sidebar_position: 90
 
 import PixelateDemo from './pixelate.demo.tsx'
 
+_Reduces the level of detail in an image by replacing groups of pixels with a single representative pixel, creating a blocky or mosaic-like appearance._
+
 [Check options and parameters of `pixelate` method](https://image-js.github.io/image-js-typescript/classes/Image.html#pixelate 'github.io link')
 
 :::caution
diff --git a/docs/Features/Geometry/Flip.md b/docs/Features/Geometry/Flip.md
@@ -4,6 +4,8 @@ sidebar_position: 30
 
 import FlipDemo from './flip.demo.tsx'
 
+_Mirrors or reverses an image horizontally or vertically._
+
 [Check options and parameters of `flip` method](https://image-js.github.io/image-js-typescript/classes/Image.html#flip 'github.io link')
 
 :::caution
diff --git a/docs/Features/Geometry/Resize.md b/docs/Features/Geometry/Resize.md
@@ -4,6 +4,8 @@ sidebar_position: 10
 
 import ResizeDemo from './resize.demo.tsx'
 
+_Changes the size of an image._
+
 [Check options and parameters of `resize` method](https://image-js.github.io/image-js-typescript/classes/Image.html#resize 'github.io link')
 
 [Image rescaling](https://en.wikipedia.org/wiki/Image_scaling 'wikipedia link on image rescaling'), also known as image resizing or image scaling, is an image processing technique used to change the dimensions (size) of an image while maintaining its aspect ratio. Rescaling can involve both enlarging and reducing the image's size. The goal of image rescaling is to adapt an image to fit within specific dimensions, whether it's for display, printing, or other purposes.
diff --git a/docs/Features/Geometry/Rotate.md b/docs/Features/Geometry/Rotate.md
@@ -4,6 +4,8 @@ sidebar_position: 20
 
 import RotateDemo from './rotate.demo.tsx'
 
+_Rotates an image by a multiple of 90 degrees._
+
 [Check options and parameters of `rotate` method](https://image-js.github.io/image-js-typescript/classes/Image.html#rotate 'github.io link')
 
 Rotating images in image processing involves changing the orientation of the image by a certain angle. This can be useful for correcting the orientation of images, creating artistic effects, or preparing images for specific tasks. Just like with flipping, you can achieve this using various programming languages and image processing libraries.
diff --git a/docs/Features/Geometry/Transform and rotate.md b/docs/Features/Geometry/Transform and rotate.md
@@ -4,6 +4,8 @@ sidebar_position: 50
 
 import TransRotateDemo from './transformRotate.demo.tsx'
 
+_Rotates an image by any angle._
+
 [Check options and parameters of `transformRotate` method](https://image-js.github.io/image-js-typescript/classes/Image.html#transformRotate 'github.io link')
 
 `transformRotate` method rotates image anti-clockwise at any angle that user sets. It applies the same principle as [transform](./Transform.md 'internal link on transform demo') method, but user only needs to pass a rotation angle as a parameter instead of the whole matrix.
diff --git a/docs/Features/Geometry/Transform.md b/docs/Features/Geometry/Transform.md
@@ -4,6 +4,8 @@ sidebar_position: 40
 
 import TransformDemo from './transform.demo.tsx'
 
+_Applies linear transformations to an image, such as scaling, rotation, skewing, or warping, altering its shape or orientation._
+
 [Check options and parameters of `transform` method](https://image-js.github.io/image-js-typescript/classes/Image.html#transform 'github.io link')
 
 `transform` method uses transformation matrix to rotate, translate, and/or scale the image. User needs to pass on the matrix that will be applied to the image. Matrix must have 2 rows and 3 columns:
diff --git a/docs/Features/Morphology/Bottom Hat.md b/docs/Features/Morphology/Bottom Hat.md
@@ -4,6 +4,8 @@ sidebar_position: 60
 
 import BottomHatDemo from './bottomHat.demo.tsx'
 
+_Enhances the fine details or small objects within an image by subtracting an opened version of the image from the original._
+
 [Check options and parameters of `bottomHat` method](https://image-js.github.io/image-js-typescript/classes/Image.html#bottomHat 'github.io link')
 
 Similarly to [Top Hat](./Top%20Hat.md 'internal link to top hat'), [Bottom Hat](https://en.wikipedia.org/wiki/Top-hat_transform 'wikipedia link to top hat') operation computes the difference between two images. However, if top hat was using [opening method](./Opening.md 'internal link on open method'), bottom hat is using [closing method](./Closing.md 'internal link on close method').
diff --git a/docs/Features/Morphology/Canny Edge Detector.md b/docs/Features/Morphology/Canny Edge Detector.md
@@ -4,6 +4,8 @@ sidebar_position: 80
 
 import CannyEdgeDemo from './cannyEdgeDetector.demo.tsx'
 
+_Identifies edges in an image by detecting areas of rapid intensity changes, highlighting object boundaries and edges with thin and accurate lines._
+
 [Check options and parameters of `cannyEdgeDetector` method](https://image-js.github.io/image-js-typescript/classes/Image.html#cannyEdgeDetector 'github.io link')
 
 :::caution
diff --git a/docs/Features/Morphology/Closing.md b/docs/Features/Morphology/Closing.md
@@ -4,6 +4,8 @@ sidebar_position: 40
 
 import CloseDemo from './close.demo.tsx'
 
+_Combines a dilation filter followed by an erosion filter._
+
 [Check options and parameters of `close` method](https://image-js.github.io/image-js-typescript/classes/Image.html#close 'github.io link')
 
 Opposed to [opening](./Opening.md 'internal link to open method'), [closing process](<https://en.wikipedia.org/wiki/Closing_(morphology)> 'wikipedia link on closing') first [erodes](./Erosion.md 'internal link to erode method') an image and only then [dilates](./Dilation.md 'internal link to dilate method') it.
diff --git a/docs/Features/Morphology/Dilation.md b/docs/Features/Morphology/Dilation.md
@@ -4,6 +4,8 @@ sidebar_position: 20
 
 import DilateDemo from './dilate.demo.tsx'
 
+_Enlarges the size of foreground objects by iteratively expanding their boundaries._
+
 [Check options and parameters of `dilate` method](https://image-js.github.io/image-js-typescript/classes/Image.html#dilate 'github.io link')
 
 [Dilation](<https://en.wikipedia.org/wiki/Dilation_(morphology)> 'wikipedia link on dilation') is a fundamental morphological operation in image processing that is used to expand the size of foreground objects ([regions of interest](../../Glossary.md#roiregion-of-interest 'internal link on region of interest')) within an image while preserving their shape and structure. It involves moving a structuring element (also known as a [kernel](../../Glossary.md#kernel 'internal link on kernel')) over the image and replacing each pixel with the **maximum** value of the pixels covered by the structuring element. Dilation is commonly used for tasks like noise reduction, object enlargement, and feature enhancement.
diff --git a/docs/Features/Morphology/Erosion.md b/docs/Features/Morphology/Erosion.md
@@ -4,6 +4,8 @@ sidebar_position: 10
 
 import ErodeDemo from './erode.demo.tsx'
 
+_Reduces the size of foreground objects by iteratively shrinking their boundaries._
+
 [Check options and parameters of `erode` method](https://image-js.github.io/image-js-typescript/classes/Image.html#erode 'github.io link')
 
 [Erosion](https://en.wikipedia.org/wiki/Erosion 'wikipedia link on erosion') is a fundamental morphological operation in image processing that is used to reduce the size of foreground objects ([regions of interest](../../Glossary.md#roiregion-of-interest 'internal link on region of interest')) within an image while preserving their shape and structure. It works by moving a structuring element (also known as a [kernel](../../Glossary.md#kernel 'internal link on kernel')) over the image and replacing each pixel with the **minimum** value of the pixels covered by the structuring element. Erosion is particularly useful for tasks like noise reduction, edge detection, and object separation.
diff --git a/docs/Features/Morphology/Morphological Gradient.md b/docs/Features/Morphology/Morphological Gradient.md
@@ -4,6 +4,8 @@ sidebar_position: 70
 
 import MorphGradientDemo from './morphologicalGradient.demo.tsx'
 
+_Emphasizes the boundaries of objects in a binary or grayscale image by calculating the difference between the dilation and erosion of the image._
+
 [Check options and parameters of `morphologicalGradient` method](https://image-js.github.io/image-js-typescript/classes/Image.html#morphologicalGradient 'github.io link')
 
 :::caution
diff --git a/docs/Features/Morphology/Opening.md b/docs/Features/Morphology/Opening.md
@@ -4,6 +4,8 @@ sidebar_position: 30
 
 import OpenDemo from './open.demo.tsx'
 
+_Combines an erosion filter followed by a dilation filter._
+
 [Check options and parameters of `open` method](https://image-js.github.io/image-js-typescript/classes/Image.html#open 'github.io link')
 
 [Opening](<https://en.wikipedia.org/wiki/Opening_(morphology)#:~:text=In%20mathematical%20morphology%2C%20opening%20is,blue%20square%20with%20round%20corners.&text=denote%20erosion%20and%20dilation%2C%20respectively>) process in morphology involves a dilation of an image, followed by its erosion.
diff --git a/docs/Features/Morphology/Top Hat.md b/docs/Features/Morphology/Top Hat.md
@@ -4,6 +4,8 @@ sidebar_position: 50
 
 import TopHatDemo from './topHat.demo.tsx'
 
+_Enhances the fine details or small objects within an image by subtracting an opened version of the image from the original._
+
 [Check options and parameters of `topHat` method](https://image-js.github.io/image-js-typescript/classes/Image.html#topHat 'github.io link')
 
 In morphology and image processing, [Top Hat](https://en.wikipedia.org/wiki/Top-hat_transform 'wikipedia link on top hat') is an operation used to enhance or extract small bright regions or details from an image while suppressing the larger surrounding structures.
diff --git a/docs/Features/Operations/Threshold.md b/docs/Features/Operations/Threshold.md
@@ -1,5 +1,7 @@
 import ThresholdDemo from './threshold.demo.tsx'
 
+_Grayscale image into a binary image by setting a specific threshold value or algorithm._
+
 [Check options and parameters of `threshold` method](https://image-js.github.io/image-js-typescript/classes/Image.html#threshold 'github.io link')
 
 Thresholding is a common image processing technique used to segment an image into regions based on pixel intensity values. The goal of thresholding is to separate objects or features of interest from the background or noise by setting a threshold value that divides the pixel values into two groups: those above the threshold and those below it. Thresholding is widely used for tasks like object detection, image segmentation, and feature extraction.
