GammaLib  2.1.0.dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GFitsImageByte.hpp
Go to the documentation of this file.
1 /***************************************************************************
2  * GFitsImageByte.hpp - FITS Byte image class *
3  * ----------------------------------------------------------------------- *
4  * copyright (C) 2010-2017 by Juergen Knoedlseder *
5  * ----------------------------------------------------------------------- *
6  * *
7  * This program is free software: you can redistribute it and/or modify *
8  * it under the terms of the GNU General Public License as published by *
9  * the Free Software Foundation, either version 3 of the License, or *
10  * (at your option) any later version. *
11  * *
12  * This program is distributed in the hope that it will be useful, *
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
15  * GNU General Public License for more details. *
16  * *
17  * You should have received a copy of the GNU General Public License *
18  * along with this program. If not, see <http://www.gnu.org/licenses/>. *
19  * *
20  ***************************************************************************/
21 /**
22  * @file GFitsImageByte.hpp
23  * @brief FITS Byte image class definition
24  * @author Juergen Knoedlseder
25  */
26 
27 #ifndef GFITSIMAGEBYTE_HPP
28 #define GFITSIMAGEBYTE_HPP
29 
30 /* __ Includes ___________________________________________________________ */
31 #include "GFitsImage.hpp"
32 
33 
34 /***********************************************************************//**
35  * @class GFitsImageByte
36  *
37  * @brief FITS Byte image class
38  ***************************************************************************/
39 class GFitsImageByte : public GFitsImage {
40 
41 public:
42  // Constructors and destructors
43  GFitsImageByte(void);
44  GFitsImageByte(const int& nx, const unsigned char* pixels = NULL);
45  GFitsImageByte(const int& nx, const int& ny, const unsigned char* pixels = NULL);
46  GFitsImageByte(const int& nx, const int& ny, const int& nz, const unsigned char* pixels = NULL);
47  GFitsImageByte(const int& nx, const int& ny, const int& nz, const int& nt, const unsigned char* pixels = NULL);
48  GFitsImageByte(const std::vector<int>& naxes, const unsigned char* pixels = NULL);
49  GFitsImageByte(const GFitsImage& image);
50  GFitsImageByte(const GFitsImageByte& image);
51  virtual ~GFitsImageByte(void);
52 
53  // Operators
54  GFitsImageByte& operator=(const GFitsImageByte& image);
55  unsigned char& operator()(const int& ix);
56  unsigned char& operator()(const int& ix, const int& iy);
57  unsigned char& operator()(const int& ix, const int& iy, const int& iz);
58  unsigned char& operator()(const int& ix, const int& iy, const int& iz, const int& it);
59  const unsigned char& operator()(const int& ix) const;
60  const unsigned char& operator()(const int& ix, const int& iy) const;
61  const unsigned char& operator()(const int& ix, const int& iy, const int& iz) const;
62  const unsigned char& operator()(const int& ix, const int& iy, const int& iz, const int& it) const;
63 
64  // Methods
65  void clear(void);
66  GFitsImageByte* clone(void) const;
67  std::string classname(void) const;
68  unsigned char& at(const int& ix);
69  unsigned char& at(const int& ix, const int& iy);
70  unsigned char& at(const int& ix, const int& iy, const int& iz);
71  unsigned char& at(const int& ix, const int& iy, const int& iz, const int& it);
72  const unsigned char& at(const int& ix) const;
73  const unsigned char& at(const int& ix, const int& iy) const;
74  const unsigned char& at(const int& ix, const int& iy, const int& iz) const;
75  const unsigned char& at(const int& ix, const int& iy, const int& iz, const int& it) const;
76  double pixel(const int& ix) const;
77  double pixel(const int& ix, const int& iy) const;
78  double pixel(const int& ix, const int& iy, const int& iz) const;
79  double pixel(const int& ix, const int& iy, const int& iz, const int& it) const;
80  void* pixels(void);
81  int type(void) const;
82 
83 private:
84  // Private methods
85  void init_members(void);
86  void copy_members(const GFitsImageByte& image);
87  void free_members(void);
88  void alloc_data(void);
89  void init_data(void);
90  void release_data(void);
91  void construct_data(const unsigned char* pixels);
92  void load_data(void) const;
93  void alloc_nulval(const void* value);
94  void* ptr_data(void) { return m_pixels; }
95  void* ptr_nulval(void) { return m_nulval; }
96 
97  // Private data area
98  unsigned char* m_pixels; //!< Pixels
99  unsigned char* m_nulval; //!< NULL value
100 };
101 
102 
103 /***********************************************************************//**
104  * @brief Return class name
105  *
106  * @return String containing the class name ("GFitsImageByte").
107  ***************************************************************************/
108 inline
109 std::string GFitsImageByte::classname(void) const
110 {
111  return ("GFitsImageByte");
112 }
113 
114 #endif /* GFITSIMAGEBYTE_HPP */
GFitsImage
Abstract FITS image base class.
Definition: GFitsImage.hpp:43
GFitsImageByte::alloc_data
void alloc_data(void)
Allocate data.
Definition: GFitsImageByte.cpp:837
GFitsImageByte::load_data
void load_data(void) const
Load data.
Definition: GFitsImageByte.cpp:926
GFitsImageByte::classname
std::string classname(void) const
Return class name.
Definition: GFitsImageByte.hpp:109
GFitsImageByte::copy_members
void copy_members(const GFitsImageByte &image)
Copy class members.
Definition: GFitsImageByte.cpp:784
GFitsImageByte::release_data
void release_data(void)
Release data.
Definition: GFitsImageByte.cpp:872
GFitsImageByte::operator=
GFitsImageByte & operator=(const GFitsImageByte &image)
Assignment operator.
Definition: GFitsImageByte.cpp:263
GFitsImage.hpp
Abstract FITS image base class definition.
GFitsImageByte::clear
void clear(void)
Clear instance.
Definition: GFitsImageByte.cpp:482
GFitsImageByte::construct_data
void construct_data(const unsigned char *pixels)
Construct data from array.
Definition: GFitsImageByte.cpp:894
GFitsImageByte::m_pixels
unsigned char * m_pixels
Pixels.
Definition: GFitsImageByte.hpp:98
GFitsImageByte::init_members
void init_members(void)
Initialise class members.
Definition: GFitsImageByte.cpp:764
GFitsImageByte::m_nulval
unsigned char * m_nulval
NULL value.
Definition: GFitsImageByte.hpp:99
GFitsImageByte::pixel
double pixel(const int &ix) const
Return value of image pixel.
Definition: GFitsImageByte.cpp:673
GFitsImageByte::pixels
void * pixels(void)
Return pointer to image pixel.
Definition: GFitsImageByte.cpp:735
GFitsImageByte::GFitsImageByte
GFitsImageByte(void)
Void constructor.
Definition: GFitsImageByte.cpp:55
GFitsImageByte::free_members
void free_members(void)
Delete class members.
Definition: GFitsImageByte.cpp:819
GFitsImage::naxes
int naxes(const int &axis) const
Return dimension of an image axis.
Definition: GFitsImage.cpp:344
GFitsImageByte::ptr_data
void * ptr_data(void)
Definition: GFitsImageByte.hpp:94
GFitsImageByte::at
unsigned char & at(const int &ix)
Image pixel access operator.
Definition: GFitsImageByte.cpp:521
GFitsImageByte::type
int type(void) const
Return image type.
Definition: GFitsImageByte.cpp:748
GFitsImageByte::clone
GFitsImageByte * clone(void) const
Clone FITS image.
Definition: GFitsImageByte.cpp:505
GFitsImageByte
FITS Byte image class.
Definition: GFitsImageByte.hpp:39
GFitsImageByte::init_data
void init_data(void)
Initialise data.
Definition: GFitsImageByte.cpp:855
GFitsImageByte::operator()
unsigned char & operator()(const int &ix)
Image pixel access operator.
Definition: GFitsImageByte.cpp:295
GFitsImageByte::~GFitsImageByte
virtual ~GFitsImageByte(void)
Destructor.
Definition: GFitsImageByte.cpp:241
GFitsImageByte::alloc_nulval
void alloc_nulval(const void *value)
Allocates nul value.
Definition: GFitsImageByte.cpp:943
GFitsImageByte::ptr_nulval
void * ptr_nulval(void)
Definition: GFitsImageByte.hpp:95