/*-------------------------------------------------------------------- * * Copyright (c) 1991-2020 by the GMT Team (https://www.generic-mapping-tools.org/team.html) * See LICENSE.TXT file for copying and redistribution conditions. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation; version 3 or any later version. * * This program 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 Lesser General Public License for more details. * * Contact info: www.generic-mapping-tools.org *--------------------------------------------------------------------*/ /*! * \file gmt_gdalread.h * \brief Define structures to interface with gdalread|write */ #ifndef GMT_GDALREAD_H #define GMT_GDALREAD_H #include #include #include #include /*! Structure to control which options are transmitted to gmt_gdalwrite */ struct GMT_GDALWRITE_CTRL { char *driver; /* The GDAL diver name */ char *co_options; /* The GDAL -co options */ char *type; /* Data type */ char *command; /* command line */ char *title; char *remark; unsigned char *alpha; /* In case this is used to transmit an image that has a transparency layer */ void *data; /* To store the grid/image array */ char layout[4]; /* A 3 letter code specifying the image memory layout plus a A|a if alpha data in array */ int orig_type; /* Original grid data type. Typed as in to match the orig_datatype in GMT_GRID_HEADER */ int geog; int n_columns, n_rows; /* Number of columns & rows of the region to be saved */ int nXSizeFull; /* Total number of columns of the data array including padding */ int n_bands; int pad[4]; int flipud; int registration; /* Registration type. 0 -> grid registration; 1 -> pixel reg */ double ULx, ULy; /* x_min & y_max */ double x_inc, y_inc; /* Grid/Image increments */ double nan_value; /* unlike the nan_value in struct GMT_GRID_HEADER this one is of type double */ struct GW_C { /* Color map */ bool active; int n_colors; float *cpt; } C; struct GW_P { /* Proj4/WKT string */ bool active; char *ProjRefPROJ4; /* To store a referencing system string in PROJ.4 format */ char *ProjRefWKT; /* To store a referencing system string in WKT format */ int ProjRefEPSG; /* To store a referencing system EPSG code */ } P; struct GW_H { /* To store the GDAL dataset handle */ bool active; GDALDatasetH *hSrcDS; } H; }; /*! Structure to control which options are transmitted to gmt_gdalread */ struct GMT_GDALREAD_IN_CTRL { struct GD_B { /* Band selection */ bool active; char *bands; } B; struct GD_I { /* Interleaving by pixel (only for char data) */ bool active; } I; struct GD_L { /* Left-Right flip */ bool active; } L; struct GD_M { /* Metadata only */ bool active; } M; struct GD_O { /* Three chars code to specify the array layout in memory */ /* first char T(op)|B(ot), second R(ow)|C(ol), third P(ix)|L(ine)|S(equencial) */ char mem_layout[4]; } O; struct GD_N { /* For floats, replace this value by NaN */ float nan_value; } N; struct GD_P { /* Preview mode */ bool active; char *jump; } P; struct GD_p { /* Pad array in output */ bool active; int pad; } p; struct GD_W { /* Convert proj4 string into WKT */ bool active; } W; struct GD_R { /* Sub-region in referenced coords */ bool active; char *region; } R; struct GD_Z { /* Tell to store data in a complex array */ bool active; int complex_mode; /* 1|2 if complex array is to hold real (1) and imaginary (2) parts (0 = read as real only) */ } Z; struct GD_cp { /* Send in a pointer with allocated chars */ bool active; unsigned char *grd; } c_ptr; struct GD_fp { /* Send in a pointer with allocated floats */ bool active; gmt_grdfloat *grd; } f_ptr; struct GD_r { /* Sub-region in row/column coords */ bool active; char *region; } r; struct GD_reg { /* Registration type. Used only when sending a sub-region request. Than we need to know this */ double x_inc, y_inc; /* Grid increments */ int val; /* 0 [default] means grid registration, 1 -> pixel registration */ } registration; struct GD_hdr { /* Some fields of the header structure */ bool active; unsigned int mx, my; char side[1]; /* If array is going to pasted (grdpaste), tell in what side 'lrtb' */ int offset; } mini_hdr; OGRCoordinateTransformationH hCT_fwd; // TEMP TEMP TEMP. Only to quick try access GDAL coordinates transforms OGRCoordinateTransformationH hCT_inv; // TEMP TEMP TEMP. Only to quick try access GDAL coordinates transforms }; /*! Structure to hold metadata info in a per bands basis read */ struct GDAL_BAND_FNAMES { char *DataType; int XSize; int YSize; double nodata; double MinMax[2]; double ScaleOffset[2]; }; /*! Structure with the output data transmitted by gmt_gdalread */ struct GMT_GDALREAD_OUT_CTRL { /* active is true if the option has been activated */ struct UInt8 { /* Declare byte pointer */ bool active; unsigned char *data; } UInt8; struct UInt16 { /* Declare short int pointers */ bool active; unsigned short int *data; } UInt16; struct Int16 { /* Declare unsigned short int pointers */ bool active; short int *data; } Int16; struct UInt32 { /* Declare unsigned int pointers */ bool active; unsigned int *data; } UInt32; struct Int32 { /* Declare int pointers */ bool active; int *data; } Int32; struct Float { /* Declare float pointers */ bool active; #ifdef DOUBLE_PRECISION_GRID double *data; #else float *data; #endif } Float; struct Double { /* Declare double pointers */ bool active; double *data; } Double; double hdr[9]; double GeoTransform[6]; double nodata; char *ProjRefPROJ4; char *ProjRefWKT; const char *DriverShortName; const char *DriverLongName; const char *color_interp; int *ColorMap; int ProjRefEPSG; int nIndexedColors; /* Number of colors in a paletted image */ int RasterXsize; int RasterYsize; int RasterCount; /* Total number of bands in file */ int nActualBands; /* Number of bands that were actually sent back */ struct Corners { double LL[2], UL[2], UR[2], LR[2]; } Corners; struct GEOGCorners { double LL[2], UL[2], UR[2], LR[2]; } GEOGCorners; struct GDAL_BAND_FNAMES *band_field_names; }; struct OGR_FEATURES { int n_rows, n_cols, n_layers; /* n_rows, n_column, n_layers of the struct array */ int n_filled; /* Number of actually filled elements in the matrix */ int is3D; /* True when geometries have a z component */ unsigned int np; /* Number of data points in this feature */ int att_number; /* Feature's number of attributes */ int n_islands; /* Number of islands of a polygon (0 for non-polygon geometries) */ char *name, *wkt, *proj4; char *type; /* Geometry type. E.g. Point, Polygon or LineString */ char **att_names; /* Names of the attributes of a Feature */ char **att_values; /* Values of the attributes of a Feature as strings */ int *att_types; int *islands; /* Indexes of start&end of main polygon plus its interior rings (i.e. n_islands+1) */ double BoundingBox[6]; double *BBgeom; /* Not currently assigned (would be the BoundingBox of each individual geometry) */ double *x, *y, *z; }; struct GMT_GDALLIBRARIFIED_CTRL { char *fname_in; /* Input file name */ char *fname_out; /* Output file name */ char *opts; /* A string with GDAL options in GDAL syntax */ char *dem_method; /* The method name for gdaldem */ char *dem_cpt; /* A CPT name to use in gdaldem color-relief method */ struct GD_GL_M { /* If true, write grid with GMT */ bool write_gdal, read_gdal; } M; }; #endif /* GMT_GDALREAD_H */