0023912: TDataStd_ExtStringArray::Value() returns a copy of TCollection_ExtendedStrin...
[occt.git] / src / Image / Image.cdl
CommitLineData
b311480e 1-- Created on: 1993-07-27
2-- Created by: Jean Louis FRENKEL
3-- Copyright (c) 1993-1999 Matra Datavision
4-- Copyright (c) 1999-2012 OPEN CASCADE SAS
5--
6-- The content of this file is subject to the Open CASCADE Technology Public
7-- License Version 6.5 (the "License"). You may not use the content of this file
8-- except in compliance with the License. Please obtain a copy of the License
9-- at http://www.opencascade.org and read it completely before using this file.
10--
11-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13--
14-- The Original Code and all software distributed under the License is
15-- distributed on an "AS IS" basis, without warranty of any kind, and the
16-- Initial Developer hereby disclaims all such warranties, including without
17-- limitation, any warranties of merchantability, fitness for a particular
18-- purpose or non-infringement. Please see the License for the specific terms
19-- and conditions governing the rights and limitations under the License.
20
7fd59977 21
22package Image
23
24 ---Purpose: The package Image provide PseudoColorImage and ColorImage
25 -- definition and a set of key functions from the fields
26 -- of image.
27
28uses
29
30 TCollection,
31 TColStd,
32 Aspect,
33 Quantity,
34 gp,
35 MMgt
36
37is
38 ------------------------
39 ---Category: The classes
40 ------------------------
41
42 deferred class Image;
43
44 class PixelInterpolation;
45 class AveragePixelInterpolation;
46 class BalancedPixelInterpolation;
47 class PlanarPixelInterpolation;
48 class BilinearPixelInterpolation;
49 ---Purpose : Several methods to compute Pixel on non-integer Image
50 -- coordinate.
51
52 private generic class GPixelField;
53 ---Purpose : Generic Image definition .
54
55 deferred generic class GImage, PixelRow, PixelField;
56 ---Purpose : Generic Image definition .
57
58 deferred class DColorImage
59 instantiates GImage from Image (ColorPixel from Aspect);
60 ---Purpose : instantiates GImage for ColorImage definition .
61
62 deferred class DIndexedImage
63 instantiates GImage from Image (IndexPixel from Aspect);
64 ---Purpose : instantiates GImage for PseudoColorImage definition .
65
66 class PseudoColorImage;
67 ---Purpose : PseudoColorImage definition .
68
69 class ColorImage;
70 ---Purpose : ColorImage definition .
71
72 class Convertor;
73 ---Purpose: converts aPseudoColorImage to a ColorImage and vice-versa.
74
75 class ColorPixelMapHasher instantiates
76 MapHasher from TCollection( ColorPixel from Aspect );
77
78 class ColorPixelDataMap instantiates
79 DataMap from TCollection ( ColorPixel from Aspect,
80 Integer from Standard,
81 ColorPixelMapHasher from Image ) ;
82
83 class IndexPixelMapHasher instantiates
84 MapHasher from TCollection( IndexPixel from Aspect );
85
86 class LookupTable instantiates
87 DataMap from TCollection( IndexPixel from Aspect,
88 IndexPixel from Aspect,
89 IndexPixelMapHasher );
90
7fd59977 91 -----------------------------
92 ---Category: Imported types:
93 -----------------------------
94
95 imported PixelAddress;
692613e5 96 imported PixMap;
97 imported AlienPixMap;
98 imported PixMap_Handle;
99 imported AlienPixMap_Handle;
100 imported Diff;
7fd59977 101
102 -----------------------------
103 ---Category: The Enumerations
104 -----------------------------
105
106 enumeration FlipType is FT_HORIZONTAL,
107 FT_VERTICAL,
108 FT_MAINDIAGONAL,
109 FT_ANTIDIAGONAL,
110 FT_CENTER,
111 FT_90,
112 FT_180,
113 FT_270
114 end FlipType ;
115 ---Purpose: Type of orientation in a symmetry.
116 -- - FT_HORIZONTAL : symmetry with respect to an horizontal axis.
117 -- - FT_VERTICAL : symmetry with respect to a vertical axis.
118 -- - FT_MAINDIAGONAL : symmetry with respect to a
119 -- diagonal oriented at 45 degrees.
120 -- - FT_ANTIDIAGONAL : symmetry with respect to a
121 -- diagonal oriented at -45 degrees.
122 -- - FT_CENTER :
123 -- - FT_90 : rotation of 90 degrees.
124 -- - FT_180 : rotation of 180 degrees.
125 -- - FT_270 : rotation of -90 degrees.
126
127 enumeration DitheringMethod is DM_NearestColor,
128 DM_ErrorDiffusion
129 end DitheringMethod ;
130 ---Purpose: Type of dithering method.
131
132 enumeration TypeOfImage is TOI_ColorImage,
692613e5 133 TOI_PseudoColorImage
7fd59977 134 end TypeOfImage ;
135
136 Zoom ( aImage : mutable Image from Image ;
137 aInterpolation : PixelInterpolation from Image;
138 aCoefX,aCoefY : in Real from Standard ) ;
139 ---Purpose : Zoom an Image with a specific PixelInterpolation method.
140
141 Zoom ( aImage : mutable Image from Image ;
142 aCoefX,aCoefY : in Real from Standard ) ;
143 ---Purpose : Zoom an Image with the default PixelInterpolation method.
144
145 Rotate ( aImage : mutable Image from Image ;
146 aInterpolation : PixelInterpolation from Image;
147 aAngle : in PlaneAngle from Quantity ) ;
148 ---Purpose : Rotate an Image with a specific PixelInterpolation method.
149
150 Rotate ( aImage : mutable Image from Image ;
151 aAngle : in PlaneAngle from Quantity ) ;
152 ---Purpose : Rotate an Image with the default PixelInterpolation method.
153
154 Translate( aImage : mutable Image from Image ;
155 aInterpolation : PixelInterpolation from Image;
156 DX, DY : in Real from Standard ) ;
157 ---Purpose : Translate an Image with a specific PixelInterpolation
158 -- method.
159
160 Translate( aImage : mutable Image from Image ;
161 DX, DY : in Real from Standard ) ;
162 ---Purpose : Translate an Image with the default PixelInterpolation
163 -- method.
164
165 Affine( aImage : mutable Image from Image ;
166 aInterpolation : PixelInterpolation from Image;
167 Trsf : in GTrsf2d from gp ) ;
168 ---Purpose : General transformation of an Image with a specific
169 -- PixelInterpolation method.
170 -- Warning:
171 -- Raises an exception if the matrix of the transformation
172 -- is not inversible.
173
174
175 Affine( aImage : mutable Image from Image ;
176 Trsf : in GTrsf2d from gp ) ;
177 ---Purpose : General transformation of an Image with the default
178 -- PixelInterpolation method.
179 -- Warning:
180 -- Raises an exception if the matrix of the transformation
181 -- is not inversible.
182
183 Affine( aImage : mutable Image from Image ;
184 aInterpolation : PixelInterpolation from Image;
185 Trsf : in Trsf from gp ) ;
186 ---Purpose : General transformation of an Image with a specific
187 -- PixelInterpolation method.
188 -- Warning:
189 -- Raises an exception if the matrix of the transformation
190 -- is not inversible.
191
192
193 Affine( aImage : mutable Image from Image ;
194 Trsf : in Trsf from gp ) ;
195 ---Purpose : General transformation of an Image with the default
196 -- PixelInterpolation method.
197 -- Warning:
198 -- Raises an exception if the matrix of the transformation
199 -- is not inversible.
200
201end Image;