@database RankOrder.guide
@author "Volker Remuß"
@(c) "Copyright © 1998, 1999 Volker Remuß"
@$VER: RankOrder.guide 1.0ß
@node Main "RankOrder - Manual"

                                   RankOrder
                             Plugin for ArtEffect2+

                           © 1998, 1999 Volker Remuß
                                @{" Copyright Note " link Copyright}
                              All rights reserved

                      Manual for RankOrder - PlugIn V1.0ß

                                    Freeware
                       It is free what you give me for :)


           Contents
          ----------

       @{" Introduction    " link Introduction}  What is it
       @{" Liability       " link Liability}  Legal stuff
       @{" Requirements    " link Requirements}  guess
       @{" Installation    " link Installation}  quite easy

       @{" Usage           " link Usage}  how to ...

       @{" Notes           " link Notes}  maybe interesting
       @{" History         " link History}  the story so far
       @{" Author          " link Author}  me

@endnode

@node Introduction "RankOrder: Introduction"

                                  Introduction
                                 --------------

   RankOrder is a plugin for the famous image-manipulation-program
   ArtEffect2/3+. As a normal PlugIn it integrates seamlessly in ArtEffect's
   menu and waits happily for your attention.

   Rank-Order-Filters are a known family of filters including: Minimum, Maximum
   and Median. This plugin can be each of them and anything between.
   It is much faster than ArtEffect's Minimum, Maximum and Median and has
   more functionality.

   The filter sorts all the colors around the filtered pixel by brightness and
   takes the color at the user selected rank.

@endnode

@node Liability "RankOrder: Liability"

                                   Liability
                                  -----------

With the usage of RankOrder you agree to the following
announcement-declaration:

       THERE IS NO LIABILITY TO THIS PROGRAM-PACKAGE,IN REFERENCE TO THE
       ASSERTED LAWS. THE COPYRIGHT OWNERS, AND/OR A  THIRD PARTY, PLACE
       THIS PROGRAM PACKAGE AT YOUR DISPOSAL "AS  IS" (EXCEPT WHERE THIS
       IS FIXED ANYWHERE ELSE IN A WRITTEN WAY) WITHOUT ANY GUARANTEE IN
       ANY  FORM (INDIRECT OR DIRECT FORM). THE FULL RISK OF QUALITY AND
       FUNCTIONALITY  OF THIS PROGRAM IS AT YOUR OWN. IF THE PROGRAM HAS
       A BUG, YOU HAVE TO PAY  ALL COSTS  OF THE NECESSARY SERVICE-WORKS
       AND REPAIRS FOR YOURSELF.

       UNDER  NO  CIRCUMSTANCES,  THE  COPYRIGHT OWNERS OR A THIRD PARTY
       DISTRIBUTING THIS PROGRAM PACKAGE, AS ALLOWED, JUST  BEFORE,  CAN
       NOT  BE  HELD  RESPONSIBLE  FOR  ANY  DAMAGE CAUSED IN ANY USUAL,
       SPECIAL, OR ACCIDENTAL WAY OR BY THE PROGRAM PACKAGE (SURROUNDING
       BUT NOT RESTRICTED ARE THE LOSS OF DATA OR NOTCORRECTLY DISPLAYED
       DATA OR LOSSES CAUSED BY YOU OR A THIRD PARTY OR BY A FAULTY WORK
       OF THIS PROGRAM PACKAGE  WITH  OTHER PROGRAMS), ALSO IF THE OWNER
       OR A THIRD PARTY HAS BEEN POINTED AT SUCH POSSIBILITIES OF DAMAGE.

@endnode

@node Installation "RankOrder: Installation"

                                  Installation
                                 --------------

- copy the files from drawer plugins2/ to ArtEffect:plugins2/

- copy the Guide whereever you can retrieve it.

After the next start of ArtEffect2+ the menuentry "RankOrder VR..." should
be available in Menu Filter/Pixelate.

@endnode

@node Requirements "RankOrder: Requirements"

                                  Requirements
                                 --------------

- the only thing you need is ArtEffect2+

@endnode

@node Usage "RankOrder: Usage"

                                     Usage
                                    -------

   The usage is quite easy, after calling the plugin via menu, you will see a
   little window.

   Just below the preview is a cycle gadget to select wether the plugin should
   work in color, grayscale or black&white. Operating in grayscale is faster and
   will convert the picture to gray on-the-fly.
   Black & White is a high-speed-mode for pictures that are already monochrome,
   it does not do a threshold to convert to black & white.

   Radius is the radius around every pixel that will be taken into calculation
   for the actual calculated pixel. E.g. for a Radius of 10 the Matrix has a
   size of 21x21 pixels and is taking 441 surrounding pixels into calculation.

   Workmode
   RankOrder can process in
      Normal: Only pixels of the original picture are used for calculation
      Line Recursive: The upper lines are taken from the output of the filter
      Full Recursive: The upper lines and lefter pixels are taken from the output
                      of the filter
                      I have to admit that full recursive is a little useless,
                      but how knows what the creative mind out there might do
                      whith it.

   Radius
   Radius within the plugin collects the pixels.

   Rank
   The rank the filter should take as result in percent (see @{"Introduction" link Introduction}).
     0: Minimum filter
    50: Median filter
   100: Maximum filter

   Blend
   The filter output can be blended with the origin picture.
     0: only source picture
   100: only filter output

@endnode

@node Notes "RankOrder: Notes"

                                     Notes
                                    -------

 - RankOrder was written on an Amiga 4000 with Cyberstorm MK1 060 and
   compiled with SAS/C 6.58.

 - This PlugIn has no AREXX-Interface and is not localized nor the documentation
   is avaiable in any other language than english (or whatever this is here).
   That may or may not change in the future.

 - If you are interested in getting the information how long an operation took
   try this: setenv VRPLUGINTIMING 1
   

@endnode

@node History "RankOrder: History"

                                    History
                                   ---------

V1.0ß

- changed: Made some changes to speed-up things with ArtEffect3

- changed: Filtereffect is adapted to Previewzoom. Zoomed Previews now
           should come close the real look.

- changed: mask is respected in preview (as usual in ArtEffect only if maximum)

- changed: some optimizations

V0.9

- changed: almost everything just added :)
- added: everything


@endnode

@node Author "RankOrder: Author"




                                     Author
                                    --------

                                  Volker Remuß
                               Viktoria - Ufer 7
                                  13597 Berlin

                         email: remuss@cs.tu-berlin.de
                           Telefon: +49-[0]30-3332391

                   Soon: http://user.cs.tu-berlin.de/~remuss/

                     Please report any bugs you came across
                                      and
                       feel free to ask for new features

              Gimme feedback and if it only is to say: "I use it."

@endnode

@node Copyright "RankOrder: Copyright Note"

                                 Copyright Note
                                ----------------

   This software product is copyrighted by the @{" author " link Author}.

   All rights reserved.

   It is not allowed to include this software product in any commercial
   package without written permission of the @{" author " link Author}.

   It is not allowed to boundle this software product with anything
   without written permission of the @{" author " link Author}.

   It may not be sold in any way.

   The only granted exception is the Aminet-CD.

@endnode
