GIRAFFE Pipeline Reference Manual

gicube.h

00001 /* $Id: gicube.h,v 1.1 2007/05/02 11:27:31 rpalsa Exp $
00002  *
00003  * This file is part of the GIRAFFE Pipeline
00004  * Copyright (C) 2002-2007 European Southern Observatory
00005  *
00006  * This program is free software; you can redistribute it and/or modify
00007  * it under the terms of the GNU General Public License as published by
00008  * the Free Software Foundation; either version 2 of the License, or
00009  * (at your option) any later version.
00010  *
00011  * This program is distributed in the hope that it will be useful,
00012  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014  * GNU General Public License for more details.
00015  *
00016  * You should have received a copy of the GNU General Public License
00017  * along with this program; if not, write to the Free Software
00018  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00019  */
00020 
00021 /*
00022  * $Author: rpalsa $
00023  * $Date: 2007/05/02 11:27:31 $
00024  * $Revision: 1.1 $
00025  * $Name: giraffe-2_5_3 $
00026  */
00027 
00028 #ifndef GICUBE_H
00029 #define GICUBE_H
00030 
00031 
00032 #ifdef __cplusplus
00033 extern "C" {
00034 #endif
00035 
00036 
00037     typedef struct GiCube GiCube;
00038 
00039 
00040     GiCube* giraffe_cube_new(void);
00041     GiCube* giraffe_cube_create(cxsize width, cxsize height, cxsize depth,
00042                                 cxdouble* data);
00043     void giraffe_cube_delete(GiCube* self);
00044 
00045     cxsize giraffe_cube_get_width(const GiCube* self);
00046     cxsize giraffe_cube_get_height(const GiCube* self);
00047     cxsize giraffe_cube_get_depth(const GiCube* self);
00048 
00049     cxsize giraffe_cube_get_size(const GiCube* self);
00050     cxint giraffe_cube_set_size(GiCube* self, cxsize width, cxsize height,
00051                                 cxsize depth);
00052 
00053     cxdouble* giraffe_cube_get_data(const GiCube* self);
00054 
00055     cxint giraffe_cube_get_xaxis(const GiCube* self, cxdouble* start,
00056                                  cxdouble* step);
00057     cxint giraffe_cube_get_yaxis(const GiCube* self, cxdouble* start,
00058                                  cxdouble* step);
00059     cxint giraffe_cube_get_zaxis(const GiCube* self, cxdouble* start,
00060                                  cxdouble* step);
00061 
00062     cxint giraffe_cube_set_xaxis(GiCube* self, cxdouble start, cxdouble step);
00063     cxint giraffe_cube_set_yaxis(GiCube* self, cxdouble start, cxdouble step);
00064     cxint giraffe_cube_set_zaxis(GiCube* self, cxdouble start, cxdouble step);
00065 
00066     cxint giraffe_cube_save(const GiCube* self, cpl_propertylist* properties,
00067                             const cxchar* filename, cxcptr data);
00068 
00069 
00070 #ifdef __cplusplus
00071 }
00072 #endif
00073 
00074 #endif /* GICUBE_H */

This file is part of the GIRAFFE Pipeline Reference Manual 2.5.3.
Documentation copyright © 2002-2006 European Southern Observatory.
Generated on Fri Jul 18 09:49:45 2008 by doxygen 1.4.6 written by Dimitri van Heesch, © 1997-2004