imagery.h

Go to the documentation of this file.

#ifndef GRASS_IMAGERY_H
#define GRASS_IMAGERY_H

#include <grass/gis.h>
#include <grass/raster.h>

/* File/directory name lengths */
#define INAME_LEN GNAME_MAX     /* coupled to raster map name length */

struct Ref_Color
{
    unsigned char *table;       /* color table for min-max values */
    unsigned char *index;       /* data translation index */
    unsigned char *buf; /* data buffer for reading color file */
    int fd;                     /* for image i/o */
    CELL min, max;              /* min,max CELL values */
    int n;                      /* index into Ref_Files */
};

struct Ref_Files
{
    char name[INAME_LEN];       /* length is not in sync with other definitions */
    char mapset[INAME_LEN];
};

struct Ref
{
    int nfiles;
    struct Ref_Files *file;
    struct Ref_Color red, grn, blu;
};

struct Tape_Info
{
    char title[75];
    char id[2][75];
    char desc[5][75];
};

struct Control_Points
{
    int count;
    double *e1;
    double *n1;
    double *z1;
    double *e2;
    double *n2;
    double *z2;
    int *status;
};

struct One_Sig
{
    char desc[100];     /* name of target class */
    int npoints;        /* cell count used to determine class parameters */
    double *mean;               /* one mean for each band */
    double **var;               /* covariance band-band   */
    int status;         /* may be used to 'delete' a signature */
    float r, g, b;              /* color */
    int have_color;
};

struct Signature
{
    int nbands;         /* band (imagery group member) count */
    char **semantic_labels;    /* list of semantic labels */
    int nsigs;          /* signature count */
    char title[100];    /* not used? */
    struct One_Sig *sig;    /* array of one signature per class */
};

struct SubSig
{
    double N;
    double pi;
    double *means;
    double **R;
    double **Rinv;
    double cnst;
    int used;
};

struct ClassData
{
    int npixels;
    int count;
    double **x;         /* pixel list: x[npixels][nbands] */
    double **p;         /* prob        p[npixels][subclasses] */
};

struct ClassSig
{
    long classnum;      /* c_cat */
    char *title;        /* from Rast_get_c_cat */
    int used;
    int type;           /* always is SIGNATURE_TYPE_MIXED ? */
    int nsubclasses;    /* SubSig item count */
    struct SubSig *SubSig;
    struct ClassData ClassData; /* used for SubSig calculation only */
};

struct SigSet
{
    int nbands;
    char **semantic_labels;    /* list of semantic labels [nbands]char* */
    int nclasses;       /* ClassSig item count */
    char *title;
    struct ClassSig *ClassSig;
};

/* IClass */

/*! Holds statistical values for creating histograms and raster maps for one class.

  One class is represented by one category (cat).
*/
typedef struct
{
    int cat;                /*!< class */
    const char *name;       /*!< signature description (class name) */
    const char *color;      /*!< class color (RRR:GGG:BBB)*/
    int nbands;             /*!< number of bands */
    
    int ncells;             /*!< number of cells in training areas */

    int *band_min;          /*!< minimum value for each band */
    int *band_max;          /*!< maximum value for each band */
    float *band_sum;        /*!< sum of values for each band */
    float *band_mean;       /*!< mean of values for each band */
    float *band_stddev;     /*!< standard deviation for each band */

    float **band_product;   /*!< sum of products of cell category values of 2 bands */
    int **band_histo;       /*!< number of cells for cell category value (0-256) for each band */

    int *band_range_min;    /*!< min range of values to create raster map */
    int *band_range_max;    /*!< max range of values to create raster map */
    float nstd;             /*!< multiplier of standard deviation */

    
} IClass_statistics;

/* wx.iscatt backend */

#define SC_SCATT_DATA          0 
#define SC_SCATT_CONDITIONS    1

/*! Holds list of all categories. 
    It can contain selected areas for scatter plots (SC_SCATT_CONDITIONS type) 
    or computed scatter plots (SC_SCATT_DATA type).
*/
struct scCats 
{
    int type;        /*!< SC_SCATT_DATA -> computed scatter plots, SC_SCATT_CONDITIONS -> 
                          set conditions for scatter plots to be computed */

    int n_cats;      /*!< number of allocated categories */
    
    int n_bands;     /*!< number of analyzed bands */
    int n_scatts;    /*!< number of possible scattter plots, which can be created from bands */

    int   n_a_cats;  /*!< number of used/active categories */
    int * cats_ids;  /*!< (cat_idx->cat_id) array index is internal idx (position in cats_arr) 
                          and id is saved in it's position*/
    int * cats_idxs; /*!< (cat_id->cat_idx) array index is id and internal idx is saved 
                           in it's position*/

    struct scScatts ** cats_arr; /*!< array of pointers to struct scScatts */
};


/*! Holds list of all scatter plots, which belongs to category. 
*/
struct scScatts
{
    int n_a_scatts;     /*!< number of used/active scatter plots*/
    
    int * scatts_bands; /*!< array of bands, which represents the scatter plots, 
                             every scatter plot has assigned two bads
                             (size of the array is n_a_scatts * 2 -> idx*2)*/
    int * scatt_idxs;   /*!< (scatt_id->scatt_idx) internal idx of the scatter plot 
                             (position in scatts_arr)*/

    struct scdScattData ** scatts_arr; /*!< array of pointers to scdScattData */
};

/*! Holds scatter plot data.
*/
struct scdScattData
{
    int n_vals; /*!< Number of values in scatter plot 
                     (length of b_conds_arr or scatt_vals_arr arrays). */

    unsigned char  * b_conds_arr; /*!< array of selected areas 
                                      (used for SC_SCATT_CONDITIONS type) otherwise NULL */
    unsigned int  * scatt_vals_arr; /*!< array of computed areas 
                                        (used for SC_SCATT_DATA type) otherwise NULL */
};

/*! Supported signature file types.
 *  Remember to adjust I_SIGFILE_TYPE_COUNT on a change
 */
typedef enum
{
    I_SIGFILE_TYPE_SIG,       /*! Signature files used by i.maxlik */
    I_SIGFILE_TYPE_SIGSET,    /*! Signature files used by i.smap */

} I_SIGFILE_TYPE;

#define SIGNATURE_TYPE_MIXED 1  /* Unused? */
#define I_SIGFILE_TYPE_COUNT 2  /*! Total count of supported signature file types */


#define GROUPFILE "CURGROUP"
#define SUBGROUPFILE "CURSUBGROUP"

#include <grass/defs/imagery.h>

#endif