mddtypes.hh

Go to the documentation of this file.

/*
* 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: mddtypes.hh
 *
 * MODULE:  raslib
 *
 * PURPOSE:
 *      The file cotains MDD type definitions.
 *
 * COMMENTS:
 * - always append new data formats to remain compatible with earlier compiled code
 *
 */
 
#ifndef _D_MDDTYPES_
#define _D_MDDTYPES_
 
#include <iosfwd>
#include <cstdint>
 
using r_Bytes = size_t;
 
using r_Ptr = std::ptrdiff_t;
 
using r_Area = std::uint64_t;
 
using r_Range = std::int64_t;
 
using r_Dimension = std::uint32_t;
 
enum r_Data_Format
{
    r_Array,
    r_TIFF,
    r_JPEG,
    r_JP2,
    r_HDF,
    r_NETCDF,
    r_CSV,
    r_JSON,
    r_PNG,
    r_ZLib,
    r_Auto_Compression,
    r_BMP,
    r_RLE,
    r_Wavelet_Haar,
    r_Wavelet_Daubechies,
    r_Sep_ZLib,
    r_Sep_RLE,
    r_Wavelet_Daub6,
    r_Wavelet_Daub8,
    r_Wavelet_Daub10,
    r_Wavelet_Daub12,
    r_Wavelet_Daub14,
    r_Wavelet_Daub16,
    r_Wavelet_Daub18,
    r_Wavelet_Daub20,
    r_Wavelet_Least8,
    r_Wavelet_Least10,
    r_Wavelet_Least12,
    r_Wavelet_Least14,
    r_Wavelet_Least16,
    r_Wavelet_Least18,
    r_Wavelet_Least20,
    r_Wavelet_Coiflet6,
    r_Wavelet_Coiflet12,
    r_Wavelet_Coiflet18,
    r_Wavelet_Coiflet24,
    r_Wavelet_Coiflet30,
    r_Wavelet_QHaar,
    r_PPM,
    r_DEM,
    r_Pack_Bits,
    r_ECW,
    r_TMC,
    r_NITF,
    r_GRIB,
    r_GDAL,
    r_GDAL_OGR,
    r_Data_Format_NUMBER
};
 
//@ManMemo: Module: <b>raslib</b>
extern const char *format_name_array;
extern const char *format_name_tiff;
extern const char *format_name_jpeg;
extern const char *format_name_jp2;
extern const char *format_name_hdf;
extern const char *format_name_netcdf;
extern const char *format_name_csv;
extern const char *format_name_json;
extern const char *format_name_png;
extern const char *format_name_zlib;
extern const char *format_name_auto_compression;
extern const char *format_name_bmp;
extern const char *format_name_ppm;
extern const char *format_name_rle;
extern const char *format_name_wavelet_haar;
extern const char *format_name_wavelet_daubechies;
extern const char *format_name_sep_zlib;
extern const char *format_name_sep_rle;
extern const char *format_name_wavelet_daub6;
extern const char *format_name_wavelet_daub8;
extern const char *format_name_wavelet_daub10;
extern const char *format_name_wavelet_daub12;
extern const char *format_name_wavelet_daub14;
extern const char *format_name_wavelet_daub16;
extern const char *format_name_wavelet_daub18;
extern const char *format_name_wavelet_daub20;
extern const char *format_name_wavelet_least8;
extern const char *format_name_wavelet_least10;
extern const char *format_name_wavelet_least12;
extern const char *format_name_wavelet_least14;
extern const char *format_name_wavelet_least16;
extern const char *format_name_wavelet_least18;
extern const char *format_name_wavelet_least20;
extern const char *format_name_wavelet_coiflet6;
extern const char *format_name_wavelet_coiflet12;
extern const char *format_name_wavelet_coiflet18;
extern const char *format_name_wavelet_coiflet24;
extern const char *format_name_wavelet_coiflet30;
extern const char *format_name_dem;
extern const char *format_name_pack_bits;
extern const char *format_name_wavelet_qhaar;
extern const char *format_name_tmc;
extern const char *format_name_nitf;
extern const char *format_name_grib;
extern const char *format_name_gdal;
 
extern const char *all_data_format_names[r_Data_Format_NUMBER];
 
//@ManMemo: Module: <b>raslib</b>
const char *get_name_from_data_format(r_Data_Format fmt);
 
//@ManMemo: Module: <b>raslib</b>
r_Data_Format get_data_format_from_name(const char *name);
 
//@ManMemo: Module: <b>raslib</b>
extern std::ostream &operator<<(std::ostream &s, const r_Data_Format &d);
 
enum r_Scale_Function
{
    r_SubSampling,
    r_BitAggregation,
    r_Scale_Function_NUMBER
};
 
extern const char *scale_function_name_subsampling;
extern const char *scale_function_name_bitaggregation;
 
extern const char *all_scale_function_names[r_Scale_Function_NUMBER];
 
//@ManMemo: Module: <b>raslib</b>
const char *get_name_from_scale_function(r_Scale_Function func);
 
//@ManMemo: Module: <b>raslib</b>
r_Scale_Function get_scale_function_from_name(const char *name);
 
//@ManMemo: Module: <b>raslib</b>
extern std::ostream &operator<<(std::ostream &s, const r_Scale_Function &d);
 
enum r_Index_Type
{
    r_Invalid_Index = -1,
    r_Auto_Index = 0,
    r_Directory_Index = 1,
    r_Reg_Directory_Index = 2,
    r_RPlus_Tree_Index = 3,
    r_Reg_RPlus_Tree_Index = 4,
    r_Tile_Container_Index = 5,
    r_Reg_Computed_Index = 6,
    r_Index_Type_NUMBER = 7
};
 
extern std::ostream &operator<<(std::ostream &in, r_Index_Type type);
 
//@ManMemo: Module: <b>raslib</b>
extern const char *index_name_auto;
extern const char *index_name_directory;
extern const char *index_name_regdirectory;
extern const char *index_name_rplustree;
extern const char *index_name_regrplustree;
extern const char *index_name_tilecontainer;
extern const char *index_name_regcomputed;
 
extern const char *all_index_type_names[r_Index_Type_NUMBER];
 
//@ManMemo: Module: <b>raslib</b>
const char *get_name_from_index_type(r_Index_Type it);
 
//@ManMemo: Module: <b>raslib</b>
r_Index_Type get_index_type_from_name(const char *name);
 
enum r_Tiling_Scheme
{
    r_NoTiling = 0,
    r_RegularTiling = 1,
    r_StatisticalTiling = 2,
    r_InterestTiling = 3,
    r_AlignedTiling = 4,
    r_DirectionalTiling = 5,
    r_SizeTiling = 6,
    r_Tiling_Scheme_NUMBER = 7
};
 
//@ManMemo: Module: <b>raslib</b>
extern const char *tiling_name_notiling;
extern const char *tiling_name_regulartiling;
extern const char *tiling_name_statisticaltiling;
extern const char *tiling_name_interesttiling;
extern const char *tiling_name_alignedtiling;
extern const char *tiling_name_directionaltiling;
extern const char *tiling_name_sizetiling;
 
extern const char *all_tiling_scheme_names[r_Tiling_Scheme_NUMBER];
 
//@ManMemo: Module: <b>raslib</b>
const char *get_name_from_tiling_scheme(r_Tiling_Scheme ts);
 
//@ManMemo: Module: <b>raslib</b>
r_Tiling_Scheme get_tiling_scheme_from_name(const char *name);
 
//@ManMemo: Module: <b>raslib</b>
extern std::ostream &operator<<(std::ostream &in, r_Tiling_Scheme type);
 
enum r_Clustering_Scheme
{
    r_Insertion_Order_Clustering = 1,
    r_Coords_Order_Clustering = 2,
    r_Index_Cluster_Clustering = 3,
    r_Based_Cluster_Stat_Clustering = 4
};
extern std::ostream &operator<<(std::ostream &in, r_Clustering_Scheme type);
 
enum class r_Band_Linearization : std::int8_t
{
    PixelInterleaved = 0,
    ChannelInterleaved = 1
};
extern std::ostream &operator<<(std::ostream &in, r_Band_Linearization type);
 
enum class r_Cell_Linearization : std::int8_t
{
    ColumnMajor = 0,
    RowMajor = 1,
};
extern std::ostream &operator<<(std::ostream &in, r_Cell_Linearization type);
 
struct r_Tile_Structure
{
    r_Tile_Structure() noexcept {}
    r_Tile_Structure(r_Data_Format f, r_Band_Linearization b, r_Cell_Linearization c)
        : dataFormat{f}, bandLinearization{b}, cellLinearization{c} {}
 
    r_Data_Format dataFormat{r_Array};
    r_Band_Linearization bandLinearization{r_Band_Linearization::PixelInterleaved};
    r_Cell_Linearization cellLinearization{r_Cell_Linearization::ColumnMajor};
};
 
#endif