You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api-reference.md
+13-12Lines changed: 13 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -94,8 +94,8 @@ __Methods:__
94
94
*_combineWith( similarFilterInstance )_ for any filter that supports combination of a similar filter with itself, else does nothing
95
95
*_serialize( )_ serialize filter's parameters (for use with parallel worker filters)
96
96
*_unserialize( data )_ unserialize filter's parameters (for use with parallel worker filters)
97
-
*_worker( [enable=true] )_ enable/disable parallel filter worker for this filter (each filter can have its own worker filter transparently)
98
-
*_apply( srcImg [, destImg=srcImg][, callback] )_ apply the filter to a dest Image instance using imageData from srcImage (the destImage will be changed after the filter application)
97
+
*_worker/thread( [enabled=true] )_ enable/disable parallel filter thread/worker for this filter (each filter can have its own worker filter in another thread transparently)
98
+
*_apply( srcImg [, destImg=srcImg][, callback] )_ apply the filter to a dest Image instance using imageData from srcImage (the destImage output will be changed after the filter application, the filters can be removed if image is restorable)
99
99
100
100
101
101
###Color Matrix Filter
@@ -161,7 +161,7 @@ image.apply( grc ); // image is a FILTER.Image instance, see examples
161
161
162
162
````
163
163
164
-
NOTE: The (filter) apply method will actually change the image to which it is applied
164
+
NOTE: The (filter) apply method will actually change the image output to which it is applied, the filters can be removed if image is restorable
165
165
166
166
167
167
###Table Lookup Filter
@@ -218,7 +218,7 @@ image.apply( invertPosterize ); // image is a FILTER.Image instance, see examp
218
218
219
219
````
220
220
221
-
NOTE: The (filter) apply method will actually change the image to which it is applied
221
+
NOTE: The (filter) apply method will actually change the image output to which it is applied, the filters can be removed if image is restorable
222
222
223
223
224
224
###Convolution Matrix Filter
@@ -294,7 +294,7 @@ image.apply( emboss ); // image is a FILTER.Image instance, see examples
294
294
295
295
````
296
296
297
-
NOTE: The (filter) apply method will actually change the image to which it is applied
297
+
NOTE: The (filter) apply method will actually change the image output to which it is applied, the filters can be removed if image is restorable
298
298
299
299
300
300
###Displacement Map Filter
@@ -344,7 +344,7 @@ image.apply( dF ); // image is a FILTER.Image instance, see examples
344
344
345
345
````
346
346
347
-
NOTE: The (filter) apply method will actually change the image to which it is applied
347
+
NOTE: The (filter) apply method will actually change the image output to which it is applied, the filters can be removed if image is restorable
348
348
349
349
350
350
###Geometric Map Filter
@@ -398,7 +398,7 @@ image.apply( gF ); // image is a FILTER.Image instance, see examples
398
398
399
399
````
400
400
401
-
NOTE: The (filter) apply method will actually change the image to which it is applied
401
+
NOTE: The (filter) apply method will actually change the image output to which it is applied, the filters can be removed if image is restorable
402
402
403
403
404
404
###Morphological Filter
@@ -447,7 +447,7 @@ image.apply( dilate ); // image is a FILTER.Image instance, see examples
447
447
448
448
````
449
449
450
-
NOTE: The (filter) apply method will actually change the image to which it is applied
450
+
NOTE: The (filter) apply method will actually change the image output to which it is applied, the filters can be removed if image is restorable
451
451
452
452
453
453
###Statistical Filter
@@ -493,7 +493,7 @@ image.apply( median ); // image is a FILTER.Image instance, see examples
493
493
494
494
````
495
495
496
-
NOTE: The (filter) apply method will actually change the image to which it is applied
496
+
NOTE: The (filter) apply method will actually change the image output to which it is applied, the filters can be removed if image is restorable
497
497
498
498
499
499
@@ -557,18 +557,18 @@ emboss.turnOn( false ); // turn off the emboss filter while on the chain with
557
557
558
558
````
559
559
560
-
NOTE: The (filter) apply method will actually change the image to which it is applied
560
+
NOTE: The (filter) apply method will actually change the image output to which it is applied, the filters can be removed if image is restorable
561
561
562
562
###Plugins and Inline Filters
563
563
564
564
The library can be extended by custom plugins which add new filters.
565
565
A comprehensive framework is provided for creating plugins that function the same as built-in filters (see examples at /src/plugins/Noise.js etc..)
566
566
567
-
**NOTE** Included Plugins **DO SUPPORT** parallel worker filters (see code and examples)
567
+
**NOTE** Included Plugins **DO SUPPORT** parallel thread/worker filters (see code and examples)
568
568
569
569
For creating Inline Filters a custom class is provided _FILTER.CustomFilter_ .
570
570
571
-
**NOTE2** Custom Filters **DO SUPPORT** parallel filter workers (make sure the custom function does not reference external data so it can be serialized correctly)
571
+
**NOTE2** Custom Filters **DO SUPPORT** parallel filter threads/workers (make sure the custom function does not reference external data so it can be serialized correctly)
572
572
573
573
Example:
574
574
@@ -603,6 +603,7 @@ __Included Plugins__ (see examples for how to use)
603
603
* __RGBEqualize__ : apply histogram equalization per separate color channel
604
604
* __Pixelate__ : fast pixelate the image to the given scale
605
605
* __TriangularPixelate__ : fast triangular pixelate the image to the given scale
606
+
* __HexagonalPixelate__ : fast hexagonal pixelate the image to the given scale (TODO)
606
607
* __HSVConverter__ : convert the image to HSV color space
607
608
* __YCbCrConverter__ : convert the image to YCbCr color space (similar filter exists also in __ColorMatrixFilter__ )
608
609
* __HueExtractor__ : extract a range of hues from the image
Copy file name to clipboardExpand all lines: readme.md
+19Lines changed: 19 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -65,6 +65,25 @@ This is a library for filtering images/video in JavaScript using HTML5 features
65
65
Some filters code has been adapted from open source libraries (mostly flash and java, plus a couple from javascript libraries), see the comments in the code for details.
66
66
67
67
68
+
***Image Processing Library in Java** (http://www.jhlabs.com/ip/filters/)
*[fundamentals of image processing](http://www.tnw.tudelft.nl/fileadmin/Faculteit/TNW/Over_de_faculteit/Afdelingen/Imaging_Science_and_Technology/Research/Research_Groups/Quantitative_Imaging/Education/doc/FIP2_3.pdf)
82
+
*[fundamentals of image processing](http://www.cs.dartmouth.edu/farid/downloads/tutorials/fip.pdf)
83
+
*[image filtering basics for machine vision](http://www.cse.usf.edu/~r1k/MachineVisionBook/MachineVision.files/MachineVision_Chapter4.pdf)
0 commit comments