Resource: out_file

The out_file resource is a program specific output file setting and describes what the format of the output file will be as well as the naming convention of the file.  The output formats are specific to each program but most use (refer the program reference for program specific values):

• wxp[:tag] - WXP ASCII file format (file name tag can appended)
• wxpb[:tag] - WXP binary file format (grids only)
• cdf[:tag] - NetCDF file format
• gif:filename -- output plot to GIF file (image_path prepended, filename can be tag)
• tag -- name convention tag (output to WXP ASCII file)
• filename -- output filename (used if tag is not found)

The output file naming convention is based on program defaults and doesn't need to be specified unless you are wanting a different naming convention.  If a file type is specified, the type is appended to the tag: sfc_cvt_wxp and  sfc_cvt_cdf which can be used to denote specific file name conventions for each file type:

   sfc_cvt_wxp     %C/%h%m%d%y_sao.wxp
   sfc_cvt_cdf     %C/%h%m%d%y_sao.nc

File Name Conventions

The output filename is based on a default or specified file name convention.  The filename can be explicitly defined in the out_file resource (using wildcards, see below) or left as a tag in which the filename convention is resolved in the name convention file.

• name convention tag - this specifies to use a name convention defined in the name convention file (see name_conv resource).  This tag uniquely specifies a complete name convention:
  
     sfc_cvt   %C/%y%m%d%h_sao.wxp
  
  The tag is sfc_cvt and that would be listed in the resource.
  
• full name convention - this specifies the full name convention.  Using the above example, "%C/%y%m%d%h_sao.wxp"  would be specified with the out_file resource.  You will notice the name convention wildcard characters:

  Wildcards	Description
  PATHS
  %F	file_path resource
  %D	data_path resource
  %C	con_path resource
  %G	grid_path resource
  %R	raw_path resource
  %I	image_path resource
  %W	watch_path resource
  DATE
  %Y	Current year (1900-)
  %y	Current year (00-99)
  %B	Current month (JAN-DEC)
  %b	Current month (jan-dec)
  %m	Current month (01-12)
  %j	Current Julian day (0-365)
  %d	Current day (01-31)
  %h	Current hour (00-23)
  %n	Current minute (00-59)
  PRESET VALUES
  %r	region
  %l	vertical level
  %f	forecast time
  %v	variable
  %x	model
  %p	program name
  %i	loop/frame index
  %e	tag extension

  Most of these are preset by the program and the out_file resource just takes advantage of these values in generating a file name based on time and type of plot.

• filename - the actual filename can be specified with any of the above wildcard characters if needed.

Examples

   -of=sfc_cvt

The output would be a WXP ASCII converted file using sfc_cvt as the file name tag.  If this tag is not in the name convention file, it will be used as a filename.

   -of=wxp

This specifies just the output file type.  This is normally associated with a default file name tag such as sfc_cvt_wxp.

   -of=cdf,sfc_cvt or -of=cdf:sfc_cvt

This specifies both the output file type and the file name tag.

   -of=gif:output.gif

This specifies that the program will generate a GIF file named output.gif from the completed plot. The image_path resource is prepended to the filename unless the filename is a full path. Also, wildcard characters can be used.

Last updated July 30, 1998