deutsch

STIMP_noise: MANUAL




PURPOSE


The archive contains several programs for noise reduction und noise creation.

ARCHIVE CONTENTS


The archive should enclude the following files (file lenght at the end of the line):

main directory

directory bin/

directory bin.030882/

directory bin.ppc/

directory doc/

directory doc/gfx/

directory help/

directory source/

directory source/include/

directory source/include/STIMP/

directory source/pgmbinomial/

directory source/pgmlulu/

directory source/pgmmaximin/

directory source/pgmmean/

directory source/pgmmedian/

directory source/pgmminimax/

directory source/pgmpseudomedian/

directory source/pnmaddnoise/

directory source/pnmimpnoise/

directory source/pnmwhitenoise/

directory source/ppmadapmedian/

directory source/ppmcolmedian/

directory source/ppmvecmedian/

directory Ultraconv/

If one of this files is missing, it would be better to get a full version of the archive, best you get it directly from my homepage.


COPYRIGHT


All files in this archive are copyrighted, that means (c) Stefan Diener. It is not allowed to
Any exception requires my personal agreement.

It is allowed (accepting the restrictions above) to use the program and the source code for non-commercial purposes for free. If the source code (or a part of it) is used in another application or a given program will be developed further the developer has to ensure that both in program and new source codes full credits to the original author are given. I would be very happy getting a notice about the new developments. That means that I´m expecting a short message, for instance a quite short e-mail.

The author may change this copyright notice in further releases.

GUARANTEE


Just a joke ! No guarantee given ! There´s no guarantee whether the program runs on your computer or that it will do the job you thought it should. No- body gives any liability for damages caused by proper or inproper use of the program. There´s no guarantee that the program´s output will be correct. No liability too. You are using the program at your own risk.

BUT: I was heavily working to debug the program and I spent a lot of time for testing it. The chance of undiscovered bugs is still greater than zero.


VERSION


This guide was made for the second release of this package. You have to take a look at the program´s documentations for the current version mubers. If you have a newer version of the whole archive just forget this file.

APPEAL


You may use this archive and all included programs for free (see chapter "copyright"). But you have to remember that I spent a lot of time for coding the programs and writing this file. I don´t expect any money from you (as shareware usually requires), but I would be very glad getting support from you. Best you take a look at my homepage and fill out the form at the support page. If you are interested in you may take part in a mailing list (no fears - quiting this list is easy !). So you will be informed about any news and updates.


INSTALLATION


  1. Use the Installer-script "Install" !

  2. You may install the whole package by hand too:
    1. Create a new directory on your harddisc called "STIMP", for example
      "DH4:PBM/STIMP". If there´s already such a directory skip this part.
    2. You have to add an assign for the volume "STIMP:" to the new directory, for example "assign STIMP: DH4:PBM/STIMP". I suggest to add this line to your User-Startup file or to your Startup-Sequence. Please note that it is neccessary to reset your Amiga before the assign becomes working. (But please wait until the end of this installation !)
    3. Now you have to create subdirectories "bin" and "help" (you may create "doc" and "source" too), for instance "DH4:PBM/STIMP/bin" (the same as "STIMP:bin").
    4. Copy the programs from the "bin"-directory to "STIMP:bin" according to your computer´s CPU. If you own at least a MC68030 and a FPU MC68882 you have to copy the programs from the directory "bin.030882" to "STIMP:bin". If you don´t have at least a MC68030 or you own no FPU you have to use the blank 68000 versions. If you are so happy owning a PowerPC, just use the binaries from the directory "bin.ppc".
    5. To execute the programs without explicit typing in the whole path you have to add the directory "STIMP:bin" to the system´s search path, easily by doing an "assign C: STIMP:bin add". I suggest to add this line to your User-Startup or Startup-Sequence too. Note: Add it after the "assign STIMP: <path>" line ! (Don´t forget the reset at the end of the installation.)
    6. Copy all files from the directory "help" to "STIMP:help".
    7. Copy all files from the directory "doc" to "STIMP:doc".
    8. If you are interested in the source code, copy all files from the directory "source" to "STIMP:source".
    9. If you wanna use the programs together with Ultraconv you have to modify the file "Uconv:Commands/Filters":
      1. Run the script "Ultraconv/AddNewFilters.Skript":
        "execute Ultraconv/AddNewFilters.Skript"
        This will automaticaly create the new filter file and will copy it to the right destination.
      2. Load the file "Uconv:Commands/Filters" into an editor. Append the file "Ultraconv/NewFilters". You have to delete the first line of the appended file (a line that only consists of the number 26). Now you have to add 26 to the number in the very first line of the new file and replace the old number by the new value. Save the new file to "Uconv:Commands/Filters". Done.

    Installation finished !

USAGE OF THE PROGRAMS


You can get the usage of one of the programs by starting it without any options: for instance "pgmmedian". If no usage appers, it is possible that the installation was not succesfull or any other error appeared ... (Maybe you forgot the reset ?)

Note: The option "-?" is no longer available.

I think that the programs help texts should be enough for a short expla- nation of all options. If you need more information you have to take a look at the programs documentation.

Some hints for the "Syntax" line:

FOR PPC-USER ONLY: If you are using a PowerPC-CPU some things are different. At first you have to use the executeables with the suffix ".elf" and you have to run all these programs using the "runelf" command, for instance: "runelf pgmmedian.elf <...parameters...>".


REDIRECTIONS


A new feature is the possibility to use input- and output-redirection. The only thing you have to do is replacing the (now useless) file name by a "-". Some examples:
  1. normal form:
    "pgmmedian lena.pgm result.pgm"
    (where lena.pgm is the input file and result.pgm the output file)
  2. output-redirection:
    "pgmmedian lena.pgm - >result.pgm"
  3. input-redirection:
    "pgmmedian - result.pgm <lena.pgm"
  4. input- and output-redirection:
    "pgmmedian - - <lena.pgm >result.pgm"
  5. using pipes (greets from UNIX):
    "pgmmedian lena.pgm - | pnmmargin -a0 -m5 - result.pgm"
  6. or more complicated with 2 pipes:
    "pnmaddnoise -w0.8 -p20.0 lena.pgm - | pgmmedian - - | pnmview -"
    (Note: You need a newer version than 0.01ß of the program pnmview to use the input-redirection ...)

I added this feature mainly for use with Ultraconv, but it is useful for running the programs on UNIX too.

Note: You need additional software to use pipes on AmigaOS.

RESTRICTIONS


Only the binary versions of PBM/PGM/PPM-files are supported. That means that you can not use file with the markers P1, P2 and P3 (text versions). I decided to do so because all programs of the NetPBM package write binary files and the text versions have the big fault to produce unneccessary big files. In practice this is no real restriction.

SOURCE CODE


Well, I tried to comment the source code and the include files as good as possible. I don´t want to explain the whole source, because I think that the comments will give enough help to you. Anyway, I will release a description of the include files in the next future. This will be a so called "developer release" for all of you who want to code something with STIMP. As you may noticed you don´t have to take care of file operations, so you only have to code the algorithm for transforming the picture(s) ... I suggest to take a look at my homepage and joining the STIMP mailing list.


ULTRACONV


Author:

Ultraconv homepage:

Introduction:

(Note: The following lines are the original introduction chapter from the Ultraconv guide made by Felix Schwarz. Thanx, Felix !)

Kind of support:


WHAT MEANS STIMP ?


If you read the installation part, you might be wondered by "STIMP". It´s quite simple: "STefan´s IMage Processing". Not surprising, isn´t it ?


ENVIRONMENT


Compiler:

Computer:

The PPC-executeables are compiled by Felix Schwarz (bs168@fen.baynet.de) on an Amiga 4000 (68060/50 MHz, PPC 604e/180 MHz) using SAS/C, PowerUP- Version Beta10. Thanx a lot, Felix !


AUTHOR


name : Stefan Diener
e-mail : Stefan.Diener@tu-clausthal.de
WWW : http://www.math.tu-clausthal.de/~masd/index.html
address : Bornrasen 12, D-99762 Osterode, Germany