scilab/modules/graphic_export/help/en_US/xs2ppm.xml

   1 <?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
   2 <!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
   3 <MAN>
   4   <LANGUAGE>eng</LANGUAGE>
   5   <TITLE>xs2ppm</TITLE>
   6   <TYPE>Scilab Function</TYPE>
   7   <DATE>$LastChangedDate: 2006-08-03 16:16:36 +0200 (jeu., 03 août 2006) $</DATE>
   8   <SHORT_DESCRIPTION name="xs2ppm"> send graphics to a file in PPM syntax</SHORT_DESCRIPTION>
   9   <CALLING_SEQUENCE>
  10     <CALLING_SEQUENCE_ITEM>xs2ppm(win_num,filen,[color])  </CALLING_SEQUENCE_ITEM>
  11   </CALLING_SEQUENCE>
  12   <PARAM>
  13     <PARAM_INDENT>
  14       <PARAM_ITEM>
  15         <PARAM_NAME>win_num</PARAM_NAME>
  16         <PARAM_DESCRIPTION>
  17           <SP>: integer scalar or vector .</SP>
  18         </PARAM_DESCRIPTION>
  19       </PARAM_ITEM>
  20       <PARAM_ITEM>
  21         <PARAM_NAME>filen</PARAM_NAME>
  22         <PARAM_DESCRIPTION>
  23           <SP>: string, file name.</SP>
  24         </PARAM_DESCRIPTION>
  25       </PARAM_ITEM>
  26       <PARAM_ITEM>
  27         <PARAM_NAME>color</PARAM_NAME>
  28         <PARAM_DESCRIPTION>
  29           <SP>: optional integer. 0 means black and white and 1 means color. The default value is to use a value compatible  with the screen status.</SP>
  30         </PARAM_DESCRIPTION>
  31       </PARAM_ITEM>
  32     </PARAM_INDENT>
  33   </PARAM>
  34   <DESCRIPTION>
  35     <P><VERB>xs2ppm</VERB> sends the recorded graphics of the
  36     window <VERB>win_num</VERB> in the file <VERB>filen</VERB> in PPM format.
  37     This function works only if the selected
  38     driver is <VERB>&quot;Rec&quot;</VERB> in the window
  39     <VERB>win_num</VERB> or if the window is in &quot;new style&quot;.</P>
  40   </DESCRIPTION>
  41   <EXAMPLE><![CDATA[
  42     scf(0)
  43     plot2d()
  44     xs2ppm(0,'foo.ppm')
  45   ]]></EXAMPLE>
  46
  47   <SEE_ALSO>
  48     <SEE_ALSO_ITEM>
  49       <LINK>xs2bmp</LINK>
  50         </SEE_ALSO_ITEM>
  51
  52         <SEE_ALSO_ITEM>
  53       <LINK>xs2gif</LINK>
  54         </SEE_ALSO_ITEM>
  55
  56         <SEE_ALSO_ITEM>
  57       <LINK>xs2jpg</LINK>
  58     </SEE_ALSO_ITEM>
  59
  60         <SEE_ALSO_ITEM>
  61       <LINK>xs2png</LINK>
  62         </SEE_ALSO_ITEM>
  63
  64         <SEE_ALSO_ITEM>
  65       <LINK>xs2eps</LINK>
  66     </SEE_ALSO_ITEM>
  67
  68         <SEE_ALSO_ITEM>
  69       <LINK>xs2pdf</LINK>
  70     </SEE_ALSO_ITEM>
  71
  72         <SEE_ALSO_ITEM>
  73       <LINK>xs2svg</LINK>
  74     </SEE_ALSO_ITEM>
  75
  76         <SEE_ALSO_ITEM>
  77       <LINK>xs2ps</LINK>
  78     </SEE_ALSO_ITEM>
  79
  80     <SEE_ALSO_ITEM>
  81       <LINK>xs2fig</LINK>
  82     </SEE_ALSO_ITEM>
  83
  84     <SEE_ALSO_ITEM>
  85       <LINK>xs2emf</LINK>
  86     </SEE_ALSO_ITEM>
  87   </SEE_ALSO>
  88 </MAN>