summaryrefslogtreecommitdiffstats
path: root/conversion/hdf.hh
blob: 0546811805733d5db17948a5bb2275d9d9aa7dd0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
/*
* This file is part of rasdaman community.
*
* Rasdaman community is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Rasdaman community is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with rasdaman community.  If not, see <http://www.gnu.org/licenses/>.
*
* Copyright 2003, 2004, 2005, 2006, 2007, 2008, 2009 Peter Baumann /
rasdaman GmbH.
*
* For more information please see <http://www.rasdaman.org>
* or contact Peter Baumann via <baumann@rasdaman.com>.
/
/**
 * INCLUDE: hdf.hh
 *
 * MODULE:  conversion
 *
 * CLASSES: r_Conv_HDF
 *
 * COMMENTS:
 *
 * Provides interface to convert data to other formats.
 *
*/

#ifndef _R_CONV_HDF_HH_
#define _R_CONV_HDF_HH_

#include "conversion/convertor.hh"


//@ManMemo: Module {\bf conversion}

/*@Doc:
  HDF convertor class.

  Supported parameters are

  \begin{tabular}{lcl}
  comptype && string && the compression type to use (see below)\\
  quality && int && quality parameter for JPEG compression\\
  skiphuff && int && skipping parameter for Huffman coding\\
  \end{tabular}

  The compression type defaults to deflate but may be one of the
  following

  \begin{tabular}{ll}
  none && no compression\\
  rle && Run Length Coding\\
  huffman && Huffman coding\\
  deflate && ZIP deflate\\
  \end{tabular}

*/
class r_Conv_HDF : public r_Convertor
{
  public:
  /// constructor using an r_Type object. Exception if the type isn't atomic.
  r_Conv_HDF( const char *src, const r_Minterval &interv, const r_Type *tp) throw(r_Error);
  /// constructor using convert_type_e shortcut
  r_Conv_HDF( const char *src, const r_Minterval &interv, int tp ) throw(r_Error);
  /// destructor
  ~r_Conv_HDF( void );

  /// convert to HDF
  virtual r_convDesc &convertTo( const char *options=NULL ) throw(r_Error);
  /// convert from HDF
  virtual r_convDesc &convertFrom( const char *options=NULL ) throw(r_Error);
  /// cloning
  virtual r_Convertor *clone( void ) const;
  /// identification
  virtual const char *get_name( void ) const;
  virtual r_Data_Format get_data_format( void ) const;


  private:
  /// init HDF module
  void initHDF( void );
  /// translate an internal type into an HDF type and return the size.
  static int getHDFtype(int intType, int &size);
  /// translate an HDF type into an internal type and return the size
  static int getIntType(int hdfType, int &size);
  /// variables
  int datatype, datasize;
  /// parameters
  int skiphuff;
  int quality;
  char *compType;
  static const convert_string_t compNames[];
  static const int MaxSwapBufferSize;
};

#endif