0022627: Change OCCT memory management defaults
[occt.git] / src / Image / Image.cdl
CommitLineData
7fd59977 1-- File: Image.cdl
2-- Created: Tue Jul 27 18:51:28 1993
3-- Author: Jean Louis FRENKEL
4-- <jlf@sparc3>
5---Copyright: Matra Datavision 1993
6
7package Image
8
9 ---Purpose: The package Image provide PseudoColorImage and ColorImage
10 -- definition and a set of key functions from the fields
11 -- of image.
12
13uses
14
15 TCollection,
16 TColStd,
17 Aspect,
18 Quantity,
19 gp,
20 MMgt
21
22is
23 ------------------------
24 ---Category: The classes
25 ------------------------
26
27 deferred class Image;
28
29 class PixelInterpolation;
30 class AveragePixelInterpolation;
31 class BalancedPixelInterpolation;
32 class PlanarPixelInterpolation;
33 class BilinearPixelInterpolation;
34 ---Purpose : Several methods to compute Pixel on non-integer Image
35 -- coordinate.
36
37 private generic class GPixelField;
38 ---Purpose : Generic Image definition .
39
40 deferred generic class GImage, PixelRow, PixelField;
41 ---Purpose : Generic Image definition .
42
43 deferred class DColorImage
44 instantiates GImage from Image (ColorPixel from Aspect);
45 ---Purpose : instantiates GImage for ColorImage definition .
46
47 deferred class DIndexedImage
48 instantiates GImage from Image (IndexPixel from Aspect);
49 ---Purpose : instantiates GImage for PseudoColorImage definition .
50
51 class PseudoColorImage;
52 ---Purpose : PseudoColorImage definition .
53
54 class ColorImage;
55 ---Purpose : ColorImage definition .
56
57 class Convertor;
58 ---Purpose: converts aPseudoColorImage to a ColorImage and vice-versa.
59
60 class ColorPixelMapHasher instantiates
61 MapHasher from TCollection( ColorPixel from Aspect );
62
63 class ColorPixelDataMap instantiates
64 DataMap from TCollection ( ColorPixel from Aspect,
65 Integer from Standard,
66 ColorPixelMapHasher from Image ) ;
67
68 class IndexPixelMapHasher instantiates
69 MapHasher from TCollection( IndexPixel from Aspect );
70
71 class LookupTable instantiates
72 DataMap from TCollection( IndexPixel from Aspect,
73 IndexPixel from Aspect,
74 IndexPixelMapHasher );
75
76 class PixMap;
77 ---Purpose: Aspect_PixMap implementation.
78
79 -----------------------------
80 ---Category: Imported types:
81 -----------------------------
82
83 imported PixelAddress;
84
85 imported HPrivateImage;
86
87 imported CRawBufferData;
88
89 -----------------------------
90 ---Category: The Enumerations
91 -----------------------------
92
93 enumeration FlipType is FT_HORIZONTAL,
94 FT_VERTICAL,
95 FT_MAINDIAGONAL,
96 FT_ANTIDIAGONAL,
97 FT_CENTER,
98 FT_90,
99 FT_180,
100 FT_270
101 end FlipType ;
102 ---Purpose: Type of orientation in a symmetry.
103 -- - FT_HORIZONTAL : symmetry with respect to an horizontal axis.
104 -- - FT_VERTICAL : symmetry with respect to a vertical axis.
105 -- - FT_MAINDIAGONAL : symmetry with respect to a
106 -- diagonal oriented at 45 degrees.
107 -- - FT_ANTIDIAGONAL : symmetry with respect to a
108 -- diagonal oriented at -45 degrees.
109 -- - FT_CENTER :
110 -- - FT_90 : rotation of 90 degrees.
111 -- - FT_180 : rotation of 180 degrees.
112 -- - FT_270 : rotation of -90 degrees.
113
114 enumeration DitheringMethod is DM_NearestColor,
115 DM_ErrorDiffusion
116 end DitheringMethod ;
117 ---Purpose: Type of dithering method.
118
119 enumeration TypeOfImage is TOI_ColorImage,
120 TOI_PseudoColorImage,
121 TOI_RGB,
122 TOI_RGBA,
123 TOI_RGBF,
124 TOI_RGBAF,
125 TOI_FLOAT
126 end TypeOfImage ;
127
128 Zoom ( aImage : mutable Image from Image ;
129 aInterpolation : PixelInterpolation from Image;
130 aCoefX,aCoefY : in Real from Standard ) ;
131 ---Purpose : Zoom an Image with a specific PixelInterpolation method.
132
133 Zoom ( aImage : mutable Image from Image ;
134 aCoefX,aCoefY : in Real from Standard ) ;
135 ---Purpose : Zoom an Image with the default PixelInterpolation method.
136
137 Rotate ( aImage : mutable Image from Image ;
138 aInterpolation : PixelInterpolation from Image;
139 aAngle : in PlaneAngle from Quantity ) ;
140 ---Purpose : Rotate an Image with a specific PixelInterpolation method.
141
142 Rotate ( aImage : mutable Image from Image ;
143 aAngle : in PlaneAngle from Quantity ) ;
144 ---Purpose : Rotate an Image with the default PixelInterpolation method.
145
146 Translate( aImage : mutable Image from Image ;
147 aInterpolation : PixelInterpolation from Image;
148 DX, DY : in Real from Standard ) ;
149 ---Purpose : Translate an Image with a specific PixelInterpolation
150 -- method.
151
152 Translate( aImage : mutable Image from Image ;
153 DX, DY : in Real from Standard ) ;
154 ---Purpose : Translate an Image with the default PixelInterpolation
155 -- method.
156
157 Affine( aImage : mutable Image from Image ;
158 aInterpolation : PixelInterpolation from Image;
159 Trsf : in GTrsf2d from gp ) ;
160 ---Purpose : General transformation of an Image with a specific
161 -- PixelInterpolation method.
162 -- Warning:
163 -- Raises an exception if the matrix of the transformation
164 -- is not inversible.
165
166
167 Affine( aImage : mutable Image from Image ;
168 Trsf : in GTrsf2d from gp ) ;
169 ---Purpose : General transformation of an Image with the default
170 -- PixelInterpolation method.
171 -- Warning:
172 -- Raises an exception if the matrix of the transformation
173 -- is not inversible.
174
175 Affine( aImage : mutable Image from Image ;
176 aInterpolation : PixelInterpolation from Image;
177 Trsf : in Trsf from gp ) ;
178 ---Purpose : General transformation of an Image with a specific
179 -- PixelInterpolation method.
180 -- Warning:
181 -- Raises an exception if the matrix of the transformation
182 -- is not inversible.
183
184
185 Affine( aImage : mutable Image from Image ;
186 Trsf : in Trsf from gp ) ;
187 ---Purpose : General transformation of an Image with the default
188 -- PixelInterpolation method.
189 -- Warning:
190 -- Raises an exception if the matrix of the transformation
191 -- is not inversible.
192
193end Image;