GIRAFFE Pipeline Reference Manual

giimage.h
1 /* $Id$
2  *
3  * This file is part of the GIRAFFE Pipeline
4  * Copyright (C) 2002-2006 European Southern Observatory
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
21 /*
22  * $Author$
23  * $Date$
24  * $Revision$
25  * $Name$
26  */
27 
28 #ifndef GIIMAGE_H
29 #define GIIMAGE_H
30 
31 #include <cxtypes.h>
32 #include <cxstring.h>
33 
34 #include <cpl_macros.h>
35 #include <cpl_type.h>
36 #include <cpl_image.h>
37 #include <cpl_propertylist.h>
38 #include <cpl_frameset.h>
39 
40 #include <giutils.h>
41 
42 
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46 
47 typedef struct GiImage GiImage;
48 
49 
50 GiImage *giraffe_image_new(cpl_type type);
51 GiImage *giraffe_image_create(cpl_type type, cxint nx, cxint ny);
52 GiImage *giraffe_image_duplicate(const GiImage *image);
53 void giraffe_image_delete(GiImage *self);
54 
55 cpl_image *giraffe_image_get(const GiImage *self);
56 cxint giraffe_image_set(GiImage *self, cpl_image *image);
57 
58 cpl_propertylist *giraffe_image_get_properties(const GiImage *self);
59 cxint giraffe_image_set_properties(GiImage *self,
60  cpl_propertylist *properties);
61 
62 cxint giraffe_image_copy_matrix(GiImage *self, cpl_matrix *matrix);
63 
64 cxint giraffe_image_load_pixels(GiImage *self, const cxchar *filename,
65  cxint position, cxint plane);
66 cxint giraffe_image_load_properties(GiImage *self, const cxchar *filename,
67  cxint position);
68 
69 cxint giraffe_image_load(GiImage *self, const cxchar *filename,
70  cxint position);
71 cxint giraffe_image_save(GiImage *self, const cxchar *filename);
72 
73 
74 cxint giraffe_image_paste(GiImage *self, const GiImage *image, cxint x,
75  cxint y, cxbool clip);
76 
77 void giraffe_image_print(GiImage *self);
78 
79 cxint giraffe_image_add_info(GiImage *, const GiRecipeInfo *,
80  const cpl_frameset *);
81 
82 #ifdef __cplusplus
83 }
84 #endif
85 
86 #endif /* GIIMAGE_H */
void giraffe_image_print(GiImage *self)
Prints status information about a Giraffe image.
Definition: giimage.c:749
cxint giraffe_image_add_info(GiImage *, const GiRecipeInfo *, const cpl_frameset *)
Add additional frame information to an image.
Definition: giimage.c:781
cxint giraffe_image_set(GiImage *self, cpl_image *image)
Sets the image data.
Definition: giimage.c:252
cxint giraffe_image_paste(GiImage *self, const GiImage *image, cxint x, cxint y, cxbool clip)
Paste an image into another at a given position.
Definition: giimage.c:661
cxint giraffe_image_load_pixels(GiImage *self, const cxchar *filename, cxint position, cxint plane)
Gets image data from a file.
Definition: giimage.c:459
cxint giraffe_image_load(GiImage *self, const cxchar *filename, cxint position)
Gets image data and properties from a file.
Definition: giimage.c:544
cxint giraffe_image_save(GiImage *self, const cxchar *filename)
Write a Giraffe image to a file.
Definition: giimage.c:578
void giraffe_image_delete(GiImage *self)
Destroys an image.
Definition: giimage.c:189
GiImage * giraffe_image_duplicate(const GiImage *image)
Creates a copy of an image.
Definition: giimage.c:147
GiImage * giraffe_image_new(cpl_type type)
Creates an empty image container.
Definition: giimage.c:73
GiImage * giraffe_image_create(cpl_type type, cxint nx, cxint ny)
Creates an image container of a given type.
Definition: giimage.c:103
cpl_image * giraffe_image_get(const GiImage *self)
Gets the image data.
Definition: giimage.c:226
cxint giraffe_image_set_properties(GiImage *self, cpl_propertylist *properties)
Attaches a property list to an image.
Definition: giimage.c:320
cxint giraffe_image_load_properties(GiImage *self, const cxchar *filename, cxint position)
Gets image properties from a file.
Definition: giimage.c:496
cxint giraffe_image_copy_matrix(GiImage *self, cpl_matrix *matrix)
Copies matrix elements into an image.
Definition: giimage.c:353
cpl_propertylist * giraffe_image_get_properties(const GiImage *self)
Get the properties of an image.
Definition: giimage.c:290

This file is part of the GIRAFFE Pipeline Reference Manual 2.14.
Documentation copyright © 2002-2006 European Southern Observatory.
Generated on Wed Mar 11 2015 13:19:41 by doxygen 1.8.9.1 written by Dimitri van Heesch, © 1997-2004