IM: im_lib.h Source File

previous page next page
im_lib.h

00001 /** \file
00002  * \brief Library Management and Main Documentation
00003  *
00004  * See Copyright Notice in this file.
00005  * $Id: Exp $
00006  */
00007 
00008 #ifndef __IM_LIB_H
00009 #define __IM_LIB_H
00010 
00011 #if defined(__cplusplus)
00012 extern "C" {
00013 #endif
00014 
00015       
00016 /** \defgroup lib Library Management
00017  * \par
00018  * Usefull definitions for about dialogs and 
00019  * for checking the compiled version with the linked version for dynamic libraries.
00020  * \par
00021  * See \ref im_lib.h
00022  * @{
00023  */
00024 #define IM_AUTHOR "Antonio Scuri"
00025 #define IM_COPYRIGHT  "Copyright (C) 1994-2004 Tecgraf/PUC-Rio and PETROBRAS S/A"
00026 #define IM_VERSION "3.0.3"
00027 #define IM_VERSION_DATE "2004/10/14"
00028 /** @} */
00029 
00030 /** Library release number used in the compilation time. \n
00031  * You can compare this with the value returned by \ref imVersionNumber.
00032  * \ingroup lib */
00033 #define IM_VERSION_NUMBER 300003
00034 
00035 /** Returns the library current version.
00036  * \ingroup lib */
00037 const char* imVersion(void);
00038 
00039 /** Returns the library current version release date.
00040  * \ingroup lib */
00041 const char* imVersionDate(void);
00042 
00043 /** Returns the library current version number.
00044  * \ingroup lib */
00045 int imVersionNumber(void);
00046 
00047 
00048 #if defined(__cplusplus)
00049 }
00050 #endif
00051 
00052 
00053 /*! \mainpage IM
00054  * <CENTER>
00055  * <H3> Image Representation, Storage, Capture and Processing </H3>
00056  * Tecgraf: Computer Graphics Technology Group, PUC-Rio, Brazil \n
00057  * http://www.tecgraf.puc-rio.br/im \n
00058  * mailto:im@tecgraf.puc-rio.br
00059  * </CENTER>
00060  *
00061  * \section over Overview
00062  * \par
00063  * IM is a toolkit for Digital Imaging. 
00064  * \par
00065  * It provides support for image capture, several image file formats and many image processing operations. 
00066  * \par
00067  * Image representation includes scientific data types (like IEEE floating point data) 
00068  * and attributes (or metadata like GeoTIFF and Exif tags).
00069  * Animation, video and volumes are supported as image sequences, 
00070  * but there is no digital audio support.
00071  * \par
00072  * The main goal of the library is to provide a simple API and abstraction
00073  * of images for scientific applications.
00074  * \par
00075  * The toolkit API is written in C. 
00076  * The core library source code is implemented in C++ and it is very portable, 
00077  * it can be compiled in Windows and UNIX with no modifications. 
00078  * New image processing operations can be implemented in C or in C++.
00079  * \par
00080  * IM is free software, can be used for public and commercial applications.
00081  * \par
00082  * This work was developed at Tecgraf/PUC-Rio 
00083  * by means of the partnership with PETROBRAS/CENPES.
00084  *
00085  * \section author Author
00086  * \par
00087  * Basic Software Group @ Tecgraf/PUC-Rio
00088  * - Antonio Scuri scuri@tecgraf.puc-rio.br
00089  *
00090  * \section copyright Copyright Notice
00091 \verbatim
00092 
00093 ****************************************************************************
00094 * Copyright (C) 1994-2004 Tecgraf/PUC-Rio and PETROBRAS S/A.               *
00095 * All rights reserved.                                                     *
00096 *                                                                          *
00097 * Permission is hereby granted, free of charge, to any person obtaining    *
00098 * a copy of this software and associated documentation files (the          *
00099 * "Software"), to deal in the Software without restriction, including      *
00100 * without limitation the rights to use, copy, modify, merge, publish,      *
00101 * distribute, sublicense, and/or sell copies of the Software, and to       *
00102 * permit persons to whom the Software is furnished to do so, subject to    *
00103 * the following conditions:                                                *
00104 *                                                                          *
00105 * The above copyright notice and this permission notice shall be           *
00106 * included in all copies or substantial portions of the Software.          *
00107 *                                                                          *
00108 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,          *
00109 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF       *
00110 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
00111 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY     *
00112 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,     *
00113 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE        *
00114 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                   *
00115 ****************************************************************************
00116 \endverbatim
00117  */
00118 
00119 
00120 /** \defgroup imagerep Image Representation
00121  * \par
00122  * See \ref im.h
00123  */
00124 
00125 
00126 /** \defgroup file Image Storage
00127  * \par
00128  * See \ref im.h
00129  */
00130 
00131 
00132 /** \defgroup fileread Read Access
00133  * \par
00134  * See \ref im.h
00135  * \ingroup file */
00136 
00137 
00138 /** \defgroup filewrite Write Access
00139  * \par
00140  * See \ref im.h
00141  * \ingroup file */
00142 
00143 
00144 /** \defgroup format File Formats
00145  * \par
00146  * See \ref im.h
00147  *
00148  * Internal Predefined File Formats:
00149  * \li "BMP" - Windows Device Independent Bitmap
00150  * \li "PCX" - ZSoft Picture
00151  * \li "GIF" - Graphics Interchange Format
00152  * \li "TIFF" - Tagged Image File Format
00153  * \li "RAS" - Sun Raster File
00154  * \li "SGI" - Silicon Graphics Image File Format
00155  * \li "JPEG" - JPEG File Interchange Format
00156  * \li "LED" - IUP image in LED
00157  * \li "TGA" - Truevision Targa
00158  * \li "RAW" - RAW File
00159  * \li "PNM" - Netpbm Portable Image Map 
00160  * \li "ICO" - Windows Icon 
00161  * \li "PNG" - Portable Network Graphic Format 
00162  *
00163  * Other Supported File Formats:
00164  * \li "JP2" - JPEG-2000 JP2 File Format 
00165  * \li "AVI" - Windows Audio-Video Interleaved RIFF
00166  * \li "WMV" -  Windows Media Video Format
00167  *          
00168  * Some Known Compressions:
00169  * \li "NONE" - No Compression.
00170  * \li "RLE"  - Run Lenght Encoding.
00171  * \li "LZW"  - Lempel, Ziff and Welsh.
00172  * \li "JPEG" - Join Photographics Experts Group.
00173  * \li "DEFLATE" - LZ77 variation (ZIP)
00174  *          
00175  * \ingroup file */
00176 
00177  
00178 /* Library Names Convention
00179  *
00180  *   Global Functions and Types - "im[Object][Action]"  using first capitals (imFileOpen)
00181  *   Local Functions and Types  -  "i[Object][Action]"  using first capitals (iTIFFGetCompIndex)
00182  *   Local Static Variables - same as local functions and types (iFormatCount)
00183  *   Local Static Tables - same as local functions and types with "Table" suffix (iTIFFCompTable)
00184  *   Variables and Members - no prefix, all lower case (width)
00185  *   Defines and Enumerations - all capitals (IM_ERR_NONE)
00186  *
00187  */
00188 
00189 
00190 #endif
previous page start next page