LinuxPops Flags Commands

Command Modifier Flags

Nearly every command in Linuxpos contains modifier flags. The flags modify the behaviour of the commands and allows flexibility.

To see what flags are present for a command just ask help: Example baseline fitting using the bshape command.

Linuxpops(C) >> 
Linuxpops(C) >> bshape /h
                                                                                
        Fit a Boxcar Smoothed Shape to data (with options)
        
        Mode: SPEC
        
        Usage: bshape [options]
        
        Pre-set bsmoothing = 0 for linear interpolations between baseline regions
        Pre-set bsmoothing = 1 for 'nfit' polynomial interpolations between baseline regions
        
        Pre-set bleadtrail = 0 for linear setting of the no-mans-land, leading and trailing regions
        Pre-set bleadtrail = 1 for polynomial setting of the no-mans-land, leading and trailing regions
        
        Pre-set nfit to set the order of polynomial fitting; Warning keep it small for best effects
        Pre-set nbshape to specify the number of channels to 'boxcar' inside baseline regions
        Pre-set nspline to specify the n-coefficient for the bspline function; if used.
        
        options are:
        
        /d  Duplicate the baseline models in Holder H8 ( & H9 if the /s flag passed)
        /s  perform a bspline(nspline) smoothing of baseline when done

        /h  help
        
        See Also: bset, baseline, nbaseset, bspline, gracefit
        See Variables:  bsmoothing, bleadtrail, nfit, nbshape, nspline
        
                                                                                
Linuxpops(C) >> 

All commands have their own internal help reply.

Common Flags

The following flags are common to all/most/some commands.

    /h      Print out Help
    /q      Quiet flag;  Most commands respect this
    /v      Sometimes commands will produce more verbose output with this set

    Color flags used for labels and things. Most commands that print on the plots respect these

    /Cbk
    /Crd
    /Cgr
    /Cyl
    /Cbl
    /Cmg
    /Ccy
    /Cwt

    Formatting flags for printouts:

    /log
    /hex
    /exp

Overloaded Flags

Normally, the order of flags after a command is not important. The source code for the command checks for the presence of a particular flag in the order of importance.

But, some of the more complicated commands such as otf and gmap have many options and soon we start to run out of flags. In those cases we used overloaded flags, in that, a particular flag may appears more that once in the command.

So, in order to allow this on these commands, the very first flag will become the 'key' action flag. Once this action flags has been handled, it is noted and removed from the flag-array and it's reference count is decremented; thus there can be additional flags of the same type.

For instance, gmap can use the /p flag multiple times. If it's the first flag, then gmap will plot the map, but if there are more /p flags in the same command, then that tells the plotting routine to make a PS file out of the plot. Another /p flags tells it to make a PS and a PNG file.

So far, only gmap and otf commands require the action flag to be first. Additional commands may come on-line in the future. It's easy to tell which commands as they will highlight a YELLOW CAUTION warning in the help for those commands.

Linuxpops(C) >> gmap /h

        Grid Map Frontend
        
        Mode: CONT
        
        Usage: gmap* [options]
        
        options are:
        
        /b Call: gmapmapbase, Remove Baseline from Gridded Map
        /c Call: gmapslice,   Cut a slice of map and display
        /d Call: gmapdive,    Plot Grid Map with varing dBs
        /e Call: gmapclear,   Clear out internal Gridmap data
        /f Call: gmapgauss,   Fit Gaussian to a Gridded Map Cente
        /g Call: gmapgrid,    Accumulate Selected CONTMAP Scans
        /l Call: gmaplimits,  Set / Reset Plotting Limits
        /p Call: gmapplot,    Plot 3D Gaussian Gridded Map
        /r Call: gmaprotate,  Rotate Gridmap and Snap images
        /s Call: gmapstats,   Display Stats of Grid Map
        /x Call: gmapgrab,    Force Gridmap Window to be Active
        
        /h  help
        
        gmap is a frontend to multiple grid mapping functions:
        
        See individual command help for their use.
        
        CAUTION: This command uses over-loaded flags; The above flags must be first
        
        See Also: gmapclear,  gmapdive,    gmapgauss,  gmapgrab,   gmapgrid,
                  gmaplimits, gmapmapbase, gmaprotate, gmappgauss, gmapplot,
                  gmapslice,  gmapstats
        
Linuxpops(C) >>