Sophie

Sophie

distrib > Fedora > 13 > i386 > by-pkgid > 5764c67416561ab82b35afcf9c650e17 > files > 676

GMT-doc-4.5.2-1.fc13.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">

<!--Converted with LaTeX2HTML 2002-2-1 (1.71)
original version by:  Nikos Drakos, CBLU, University of Leeds
* revised and updated by:  Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
  Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>O.2 Label Attributes</TITLE>
<META NAME="description" CONTENT="O.2 Label Attributes">
<META NAME="keywords" CONTENT="GMT_Docs">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">

<META NAME="Generator" CONTENT="LaTeX2HTML v2002-2-1">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">

<LINK REL="STYLESHEET" HREF="GMT_Docs.css">

<LINK REL="next" HREF="node241.html">
<LINK REL="previous" HREF="node239.html">
<LINK REL="up" HREF="node238.html">
<LINK REL="next" HREF="node241.html">
</HEAD>

<BODY  bgcolor="#ffffff">
<!--Navigation Panel-->
<A NAME="tex2html6054"
  HREF="node241.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> 
<A NAME="tex2html6048"
  HREF="node238.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> 
<A NAME="tex2html6042"
  HREF="node239.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A> 
<A NAME="tex2html6050"
  HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A> 
<A NAME="tex2html6052"
  HREF="node255.html">
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A> 
<BR>
<B> Next:</B> <A NAME="tex2html6055"
  HREF="node241.html">O.3 Examples of Contour</A>
<B> Up:</B> <A NAME="tex2html6049"
  HREF="node238.html">O. Annotation of Contours</A>
<B> Previous:</B> <A NAME="tex2html6043"
  HREF="node239.html">O.1 Label Placement</A>
 &nbsp; <B>  <A NAME="tex2html6051"
  HREF="node1.html">Contents</A></B> 
 &nbsp; <B>  <A NAME="tex2html6053"
  HREF="node255.html">Index</A></B> 
<BR>
<BR>
<!--End of Navigation Panel-->

<H1><A NAME="SECTION003220000000000000000">
O.2 Label Attributes</A>
</H1>
Determining where to place labels is half the battle.  The other half is to specify exactly
what are the attributes of the labels.  It turns out that there are quite a few possible
attributes that we may want to control, hence understanding how to specify these attributes
becomes important.  In the contouring programs, one or more attributes may be appended to the
<B>-A</B> option using the format +<I>code</I>[<I>args</I>] for each attribute, whereas for the line
plotting programs these attributes are appended to the <B>-Sq</B> option following a colon (:)
that separates the label codes from the placement algorithm.  Several of the attributes do not
apply to contours so we start off with listing those that apply universally.  These codes are:
<DL>
<DT><STRONG>+a:</STRONG></DT>
<DD>Controls the angle of the label relative to the angle of the line.  Append <B>n</B>
for normal to the line, give a fixed <I>angle</I> measured counter-clockwise relative to the
horizontal. or append <B>p</B> for parallel to the line [Default].  If using <A NAME="tex2html1904"
  HREF="../man/grdcontour.html"><I><B>grdcontour</B></I></A><A NAME="32883"></A>
the latter option you may further append <B>u</B> or <B>d</B> to get annotations whose upper edge
always face the next higher or lower contour line.
</DD>
<DT><STRONG>+c:</STRONG></DT>
<DD>Surrounding each label is an imaginary label ``textbox'' which defines a region in
which no segment lines should be visible.  The initial box provides an exact fit to the enclosed
text but clearance may be extended in both the horizontal and vertical directions (relative to the label
baseline) by the given amounts.  If these should be different amounts please separate them by
a slash; otherwise the single value applies to both directions.  Append the distance units of
your choice (<B>c<IMG
 WIDTH="8" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
 SRC="img12.png"
 ALT="$\vert$">i<IMG
 WIDTH="8" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
 SRC="img12.png"
 ALT="$\vert$">m<IMG
 WIDTH="8" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
 SRC="img12.png"
 ALT="$\vert$">p</B>), or give % to indicate that the clearance should be this
fixed percentage of the label font size in use.  The default is 15%.
</DD>
<DT><STRONG>+d:</STRONG></DT>
<DD>Debug mode.  This is useful when testing contour placement as it will draw the normally
invisible helper lines and points in the label placement algorithms above.
</DD>
<DT><STRONG>+f:</STRONG></DT>
<DD>Specifies the desired label font.  See <A NAME="tex2html1905"
  HREF="../man/pstext.html"><I><B>pstext</B></I></A><A NAME="32888"></A> for font names or numbers.  The
default font is given by <B>ANNOT_FONT_PRIMARY</B>.
</DD>
<DT><STRONG>+g:</STRONG></DT>
<DD>Selects opaque rather than the default transparent textboxes.  You may optionally append
the color you want to fill the label boxes; the default is the same as <B>PAGE_COLOR</B>.
</DD>
<DT><STRONG>+j:</STRONG></DT>
<DD>Selects the justification of the label relative to the placement points determined
above.  Normally this is center/mid justified (<B>CM</B> in <A NAME="tex2html1906"
  HREF="../man/pstext.html"><I><B>pstext</B></I></A><A NAME="32893"></A> justification parlance) and
this is indeed the default setting.  Override by using this option and append another justification
key code from [<B>L<IMG
 WIDTH="8" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
 SRC="img12.png"
 ALT="$\vert$">C<IMG
 WIDTH="8" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
 SRC="img12.png"
 ALT="$\vert$">R</B>][<B>B<IMG
 WIDTH="8" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
 SRC="img12.png"
 ALT="$\vert$">M<IMG
 WIDTH="8" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
 SRC="img12.png"
 ALT="$\vert$">T</B>].  Note for curved text (<B>+v</B>) only vertical
justification will be affected.
</DD>
<DT><STRONG>+k:</STRONG></DT>
<DD>Sets the color of the text labels, which otherwise defaults to that given by <B>COLOR_BACKGROUND</B>.
</DD>
<DT><STRONG>+o:</STRONG></DT>
<DD>Request a rounded, rectangular label box shape; the default is rectangular.  This is only
manifested if the box is filled or outlined, neither of which is implied by this option alone (see <B>+g</B>
and <B>+p</B>).  As this option only applies to straight text, it is ignored if <B>+v</B> is given.
</DD>
<DT><STRONG>+p:</STRONG></DT>
<DD>Selects the drawing of the label box outline; append your preferred <I>pen</I> unless you
want the default <A NAME="tex2html1907"
  HREF="http://gmt.soest.hawaii.edu"><B>GMT</B></A> pen [0.25p,black].
</DD>
<DT><STRONG>+r:</STRONG></DT>
<DD>Do not place labels at points along the line whose local radius of curvature falls below
the given threshold value.  Append the radius unit of your choice (<B>c<IMG
 WIDTH="8" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
 SRC="img12.png"
 ALT="$\vert$">i<IMG
 WIDTH="8" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
 SRC="img12.png"
 ALT="$\vert$">m<IMG
 WIDTH="8" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
 SRC="img12.png"
 ALT="$\vert$">p</B>) [Default is 0].
</DD>
<DT><STRONG>+s:</STRONG></DT>
<DD>Change the font size of the labels, which by default is 9 points.
</DD>
<DT><STRONG>+u:</STRONG></DT>
<DD>Append the chosen <I>unit</I> to the label.  Normally a space will separate the label
and the unit.  If you want to close this gap, append a <I>unit</I> that begins with a hyphen (-).
If you are contouring with <A NAME="tex2html1908"
  HREF="../man/grdcontour.html"><I><B>grdcontour</B></I></A><A NAME="32901"></A> and you specify this option without appending a unit, the unit will be taken from the
<IMG
 WIDTH="10" HEIGHT="29" ALIGN="MIDDLE" BORDER="0"
 SRC="img20.png"
 ALT="$z$">-unit attribute of the grid header.
</DD>
<DT><STRONG>+v:</STRONG></DT>
<DD>Place curved labels that follow the wiggles of the line segments.  This is especially
useful if the labels are long relative to the length-scale of the wiggles.  The default places labels
on an invisible straight line at the angle determined.
</DD>
<DT><STRONG>+w:</STRONG></DT>
<DD>The angle of the line at the point of straight label placement is calculated by a least-squares
fit to the <I>width</I> closest points.  If not specified, <I>width</I> defaults to 10.
</DD>
<DT><STRONG>+=:</STRONG></DT>
<DD>Similar in most regards to <B>+u</B> but applies instead to a label <I>prefix</I> which
you must append.
</DD>
</DL>
For contours, the label will be the value of the contour (possibly modified by <B>+u</B> or <B>+=</B>).
However, for quoted lines other options apply:
<DL>
<DT><STRONG>+l:</STRONG></DT>
<DD>Append a fixed <I>label</I> that will be placed at all label locations.  If the label contains
spaces you must place it inside matching quotes.
</DD>
<DT><STRONG>+L:</STRONG></DT>
<DD>Append a code <I>flag</I> that will determine the label.  Available codes are:
<DL>
<DT><STRONG>+Lh:</STRONG></DT>
<DD>Take the label from the current multi-segment header (hence it is assumed that the
input line segments are given in the multi-segment file format; if not we pick the single label
from the file's header record).  We first scan the header for an embedded
<B>-L</B><I>label</I> option; if none is found we instead use the first word following the segment marker [<IMG
 WIDTH="16" HEIGHT="29" ALIGN="MIDDLE" BORDER="0"
 SRC="img11.png"
 ALT="$&gt;$">].
</DD>
<DT><STRONG>+Ld:</STRONG></DT>
<DD>Take the Cartesian plot distances along the line as the label; append <B>c<IMG
 WIDTH="8" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
 SRC="img12.png"
 ALT="$\vert$">i<IMG
 WIDTH="8" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
 SRC="img12.png"
 ALT="$\vert$">m<IMG
 WIDTH="8" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
 SRC="img12.png"
 ALT="$\vert$">p</B>
as the unit [Default is <B>MEASURE_UNIT</B>].  The label will be formatted according to the <B>D_FORMAT</B>
string, <I>unless</I> label placement was determined from map distances along the segment lines, in which
case we determine the appropriate format from the distance value itself. 
</DD>
<DT><STRONG>+LD:</STRONG></DT>
<DD>Calculate actual Earth surface distances and use the distance at the label placement point as
the label; append <B>d<IMG
 WIDTH="8" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
 SRC="img12.png"
 ALT="$\vert$">e<IMG
 WIDTH="8" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
 SRC="img12.png"
 ALT="$\vert$">k<IMG
 WIDTH="8" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
 SRC="img12.png"
 ALT="$\vert$">m<IMG
 WIDTH="8" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
 SRC="img12.png"
 ALT="$\vert$">n</B> to specify the unit [If not given we default to <B>d</B>egrees,
<I>unless</I> label placement was determined from map distances along the segment lines, in which case we
use the same unit specified for that algorithm].  Requires a map projection to be used.
</DD>
<DT><STRONG>+Lf:</STRONG></DT>
<DD>Use all text after the 2nd column in the fixed label location file <I>fix.d</I> as labels.
This choice obviously requires the fixed label location algorithm (code <B>f</B>) to be in effect.
</DD>
<DT><STRONG>+Ln:</STRONG></DT>
<DD>Use the running number of the current multi-segment as label.
</DD>
<DT><STRONG>+LN:</STRONG></DT>
<DD>Use a slash-separated combination of the current file number and the current multi-segment number as label.
</DD>
<DT><STRONG>+Lx:</STRONG></DT>
<DD>As <B>h</B> but use the multi-segment headers in the <I>cross.d</I> file instead.
This choice obviously requires the crossing segments location algorithm (code <B>x<IMG
 WIDTH="8" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
 SRC="img12.png"
 ALT="$\vert$">X</B>) to be in effect.
</DD>
</DL>
</DD>
</DL>

<P>
<HR>
<!--Navigation Panel-->
<A NAME="tex2html6054"
  HREF="node241.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> 
<A NAME="tex2html6048"
  HREF="node238.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> 
<A NAME="tex2html6042"
  HREF="node239.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A> 
<A NAME="tex2html6050"
  HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A> 
<A NAME="tex2html6052"
  HREF="node255.html">
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A> 
<BR>
<B> Next:</B> <A NAME="tex2html6055"
  HREF="node241.html">O.3 Examples of Contour</A>
<B> Up:</B> <A NAME="tex2html6049"
  HREF="node238.html">O. Annotation of Contours</A>
<B> Previous:</B> <A NAME="tex2html6043"
  HREF="node239.html">O.1 Label Placement</A>
 &nbsp; <B>  <A NAME="tex2html6051"
  HREF="node1.html">Contents</A></B> 
 &nbsp; <B>  <A NAME="tex2html6053"
  HREF="node255.html">Index</A></B> 
<!--End of Navigation Panel-->
<ADDRESS>
Paul Wessel
2010-01-14
</ADDRESS>
</BODY>
</HTML>