Skip to content

Commit 4e39556

Browse files
author
Nikos M
committed
readme/reference update
1 parent 77f4c2d commit 4e39556

File tree

2 files changed

+32
-12
lines changed

2 files changed

+32
-12
lines changed

api-reference.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,8 @@ __Methods:__
9494
* _combineWith( similarFilterInstance )_ for any filter that supports combination of a similar filter with itself, else does nothing
9595
* _serialize( )_ serialize filter's parameters (for use with parallel worker filters)
9696
* _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)
9999

100100

101101
###Color Matrix Filter
@@ -161,7 +161,7 @@ image.apply( grc ); // image is a FILTER.Image instance, see examples
161161

162162
````
163163

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
165165

166166

167167
###Table Lookup Filter
@@ -218,7 +218,7 @@ image.apply( invertPosterize ); // image is a FILTER.Image instance, see examp
218218

219219
````
220220

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
222222

223223

224224
###Convolution Matrix Filter
@@ -294,7 +294,7 @@ image.apply( emboss ); // image is a FILTER.Image instance, see examples
294294

295295
````
296296

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
298298

299299

300300
###Displacement Map Filter
@@ -344,7 +344,7 @@ image.apply( dF ); // image is a FILTER.Image instance, see examples
344344

345345
````
346346

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
348348

349349

350350
###Geometric Map Filter
@@ -398,7 +398,7 @@ image.apply( gF ); // image is a FILTER.Image instance, see examples
398398

399399
````
400400

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
402402

403403

404404
###Morphological Filter
@@ -447,7 +447,7 @@ image.apply( dilate ); // image is a FILTER.Image instance, see examples
447447

448448
````
449449

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
451451

452452

453453
###Statistical Filter
@@ -493,7 +493,7 @@ image.apply( median ); // image is a FILTER.Image instance, see examples
493493

494494
````
495495

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
497497

498498

499499

@@ -557,18 +557,18 @@ emboss.turnOn( false ); // turn off the emboss filter while on the chain with
557557

558558
````
559559

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
561561

562562
###Plugins and Inline Filters
563563

564564
The library can be extended by custom plugins which add new filters.
565565
A comprehensive framework is provided for creating plugins that function the same as built-in filters (see examples at /src/plugins/Noise.js etc..)
566566

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)
568568

569569
For creating Inline Filters a custom class is provided _FILTER.CustomFilter_ .
570570

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)
572572

573573
Example:
574574

@@ -603,6 +603,7 @@ __Included Plugins__ (see examples for how to use)
603603
* __RGBEqualize__ : apply histogram equalization per separate color channel
604604
* __Pixelate__ : fast pixelate the image to the given scale
605605
* __TriangularPixelate__ : fast triangular pixelate the image to the given scale
606+
* __HexagonalPixelate__ : fast hexagonal pixelate the image to the given scale (TODO)
606607
* __HSVConverter__ : convert the image to HSV color space
607608
* __YCbCrConverter__ : convert the image to YCbCr color space (similar filter exists also in __ColorMatrixFilter__ )
608609
* __HueExtractor__ : extract a range of hues from the image

readme.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,25 @@ This is a library for filtering images/video in JavaScript using HTML5 features
6565
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.
6666

6767

68+
* **Image Processing Library in Java** (http://www.jhlabs.com/ip/filters/)
69+
* **AS3 Image Processing Library** (http://je2050.de/imageprocessing/)
70+
* **AS3 ColorMatrix by GSkinner** (http://gskinner.com/blog/archives/2007/12/colormatrix_cla.html)
71+
* **JSManipulate** (https://github.com/JoelBesada/JSManipulate)
72+
* **glfx.js** (https://github.com/evanw/glfx.js)
73+
74+
75+
76+
Some image processing theory, basics and tutorials:
77+
78+
79+
* [digital image filtering (with emphasis on imagemagick)](http://www.fmwconcepts.com/imagemagick/digital_image_filtering.pdf)
80+
* [image processing basics](http://www.csd.uwo.ca/courses/CS4487a/Lectures/lec03_image_proc.pdf)
81+
* [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)
84+
85+
86+
6887

6988
###Features
7089

0 commit comments

Comments
 (0)