GIRAFFE Pipeline Reference Manual

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

This file is part of the GIRAFFE Pipeline Reference Manual 2.18.0.
Documentation copyright © 2002-2006 European Southern Observatory.
Generated on Fri Feb 21 2025 02:35:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2004