gnearch.h

Go to the documentation of this file.

/*
 * Support for replacing the PGPLOT graphics with gnuplot.
 * For the present, this is considered a second output path.
 */
#ifndef __gnearch_h__
#define __gnearch_h__
 
#if BIGGER
#include <math.h>
#define MAX_TXT 80
#endif /* BIGGER */
 
/* captures command-line options and gnuplot configuration options */
typedef struct gpconf {
#if BIGGER
    char *pdfile;                   /* [-d] pdf file if /pdf given */
    char *devp;                     /* [-d] dev name for pgplot */
    char *gcfile;                   /* gnuplot config filename */
    char *gplatt;                   /* gnuplot filename pattern */
    int patlen;                     /* strlen(gplatt) */
    int nprv;                       /* previous nout */
    int montage, density, npdfs;    /* make a montage w/ density */
    int gpdfs_alloc;                /* size of allocated gnupdfs */
    int nukegnu, nukedata;          /* unlink intermediates */
    char **gnupdfs;                 /* from npdfs output pdf files */
#endif /* BIGGER */
    int ncols, nrows, asqr;         /* [-g] cols x rows : asqr ; */
    int pplt, gplt;                 /* pgplot and gnuplot */
    /* if gcfile has any gsplot items, the next pointer is set to
     * a copy of what was correctly scanned by is_gsplot_option() */
    struct gsplot *gsp_gcfile;      /* any parsed gsplot options */
} gpconf;
 
#if BIGGER
/* captures the items used in the gnuplot graphic */
typedef struct gsplot {
    gpconf *gpcopy;                 /* convenience copy of ptr to gpconf */
    /* these three are in the same malloc blob */
    int fileno;                     /* counter for the filename */
    char *pfile;                    /* data file name */
    char *gfile;                    /* gnu cmd file name */
    char *gnpdf;                    /* resulting gnuplot pdf file */
    /* details for the gnu plot derived from search data */
    char *frname;                   /* fringe name */
    char label[MAX_TXT];            /* scan-time, timestamp, pol title */
    char srcsnr[MAX_TXT];           /* source and peak SNR subtitle */
    char *source;                   /* source */
    double snr;                     /* SNR */
    int numrates, numdelays;        /* count of rates and delays */
    char *rate_unit, *delay_unit;   /* ps/s and us for scaling of 1.0 */
    double rate_sf, delay_sf;       /* scale factors 1.0 and 1e3 */
    double ratesize, delaysize;     /* multipliers on screen dimensions */
    double min_rate, max_rate;      /* min and max rates (ps/s) */
    double min_delay, max_delay;    /* min and max delays (us) */
    double peak_rate, peak_delay;   /* peak of rate and delay */
    /* other details these two depend on data for peak snr */
    int cntr_specified;             /* if nonzero, these two were input */
    double cntr_lowest;             /* lowest value contour level */
    double cntr_increment;          /* increment on contour levels */
    char *colorbar_label;           /* label for the colorbar */
    /* other details come from defaults or config file */
    int isosamples;                 /* for smooth contours */
    int bsplineorder;               /* ditto */
    int dgrid3dalgorder;            /* algorithm order value */
    char *dgrid3dalgorithm;         /* dgrid3d algorithm name */
    char *palette_type;             /* rgbformulae, cubehelix, viridis */
    char *palette_options;          /* formulae or start/cycles/saturation */
    char *bgfieldname;              /* color name for snr<min background */
    /* various details for pdfcairo setup, &c. */
    double pdfsizeinch;             /* sets pdfcairo plot size */
    char *labelfont, *titlefont;    /* names of fonts */
    int labelfontsize;              /* in points */
    double titlefontscale;          /* multiplier on basic font size */
    double snrminfrac;              /* where to cut cbar at low end */
    double peakradius;              /* fraction of grid size */
    char *peakcolorname;            /* what color for this object */
    double peaktransparency;        /* how transparent to make it */
} gsplot;
 
/* functions in srch_montage.c */
extern void monty_runit(char *);
extern void search_montage(gpconf *);
 
/* functions in gnusrchplot.c */
extern void gnu_plot_doit(char *);
extern void save_gpdf(gsplot *);
extern void make_gnu_splot(gsplot *);
extern char *setup_gnu_filenames(int, gsplot *, gpconf *);
extern FILE *open_gdata_file(srchsum *, gpconf *, gsplot *);
extern void write_gplot_label(FILE *, fringesum *, gsplot *);
extern void write_gplot_info(FILE *, srchsum *, gsplot *);
extern void gnusrchplot(int, srchsum *, gpconf *);
 
/* functions in make_gnucmds.c, with templates in splotemp.h */
extern void set_contour_options(gsplot *);
extern void nuke_contour_options(gsplot *);
extern void show_gsplot_contours(FILE *);
extern void set_basic_contour_options(gsplot *);
extern void show_basic_contour_options(FILE *, gsplot *);
extern void set_colormap_palette(gsplot *);
extern void show_colormap_palette(FILE *, gsplot *);
extern void set_pdfcairo_options(gsplot *);
extern void show_pdfcairo_options(FILE *, gsplot *);
extern void set_rate_unit_sf(char *, gsplot *);
extern void set_delay_unit_sf(char *, gsplot *);
extern void set_gsplot_defaults(gsplot *);
extern void show_gsplot_defaults(FILE *);
extern int is_gsplot_option(char *, int, int, gpconf *);
extern void make_gnucmds(gsplot *);
 
/* functions in gnedits.c */
extern int gnuexists(char *, int *);
extern int create_gnuconf(char *, gpconf *);
extern int puke(FILE *, int, char *, char *, int);
extern int gnuparse(char *, gpconf *);
extern int gnuedits(char *, gpconf *);
 
/* functions in gnearch.c */
extern int gnuconfile(int, char *, gpconf *);
extern int gargparse(char *, gpconf *);
extern void gnufinish(gpconf *);
#endif /* BIGGER */
 
#endif /* __gnearch_h__ */
/*
 * eof vim:nospell
 */