Menu
▾
▴
[Nsclspectcl-cvscommits] SpecTcl/doc/Commands project.htm,NONE,5.1 categories.htm,5.2,5.3
|
From: Ron F. <ro...@us...> - 2005-06-22 19:44:05
|
Update of /cvsroot/nsclspectcl/SpecTcl/doc/Commands In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv31407/doc/Commands Modified Files: categories.htm Added Files: project.htm Log Message: Add documentation for the project command Index: categories.htm =================================================================== RCS file: /cvsroot/nsclspectcl/SpecTcl/doc/Commands/categories.htm,v retrieving revision 5.2 retrieving revision 5.3 diff -C2 -d -r5.2 -r5.3 *** categories.htm 3 Jun 2005 15:19:56 -0000 5.2 --- categories.htm 22 Jun 2005 19:43:55 -0000 5.3 *************** *** 235,238 **** --- 235,243 ---- <td width="86%">Zeros the contents of a set of spectra.</td> </tr> + <tr> + <td> <a href="project.htm"> project</a> </td> + <td> Create a spectrum that is a projection of an existing 2-d + spectrum </td> + </tr> <tr> <td width="14%"><a href="spectrum.htm">spectrum</a></td> *************** *** 471,474 **** --- 476,485 ---- formatted parameter list.</td> </tr> + <tr> + <td> <a href="project.htm"> project</a> </td> + <td> Create a spectrum that is a projection of an existing 2-d + spectrum </td> + </tr> + <tr> <tr> <td width="12%"><a href="pseudo.htm">pseudo</a></td> --- NEW FILE: project.htm --- <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=windows-1252"> <meta name="GENERATOR" content="Microsoft FrontPage 4.0"> <meta name="ProgId" content="FrontPage.Editor.Document"> <title>Folds</title> </head> <body> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr> <th width="9%" nowrap><a href="http://www.nscl.msu.edu"><img src="../images/nscl_logo_small.gif" alt="nscl_logo_small.gif (2463 bytes)" width="63" height="52"></a></th> <td width="79%"> <h1>project - SpecTcl Command</h1> </td> <td width="12%"><a href="index.htm"><img src="../images/HH00706_.jpg" alt="HH00706_.jpg (6530 bytes)" width="192" height="84"></a></td> </tr> </table> <p><a href="index.htm" name="Top">SpecTcl Home</a> <a href="general_information.htm">General Information</a> <a href="users_guide.htm">User Guide</a> <a href="programmers_guide.htm">Programmer's Guide</a> <a href="obtaining_and_installing.htm">Obtaining and Installing</a></p> <h2>Syntax</h2> <p> project [-[no]snapshot] sourcespec newspec x|y [contourname] </p> <p><a href="#Top">Top</a></p> <h2>Synopsis</h2> <p>Creates projections of 2d and gamma 2d spectra..</p> <ul> <li>-[no]snapshot controls whether or not the resulting spectrum will be incremented as a result of further event analysis. If -snapshot, the spectrum will remain static. If -nosnapshot or if the switch is omitted, SpecTcl will continue to increment the spectrum. See the Detailed Description below for information about conditions and foldings that might be applied to the projection.</li> <li>sourcespec is the name of a 2-d or gamma 2-d spectrum whose projection will be taken.</li> <li>newspec is the name of the new spectrum generated by the project command. This spectrum must not exist.</li> <li>x|y The projection direction. x means that for each x, the projection is done by summing channels for that x along the y direction. Similarly, y meanns that for each y, the projection is done by summing channels for that y along the x direction.</li> <li>contourname If present, this is the name of a contour (if 2-d spectrum) or gamma contour (if 2-d gamma). The contour must include all parameters in the source spectrum. Only the region inside the contour is projected in the specified direction.</li> </ul> <p><a href="#Top">Top</a></p> <h2>Detailed Description</h2> <a href="#Top">Top</a></p> <p>Projections create new 1-d or 1-d gamma spectra (called the target spectrum) from existing 2-d or 2-d gamma spectrum (called the source spectrum) by taking a projection (possibily limited by a region of interest specified by a contour or gamma contour) in either the X or Y direction. There are two specific cases to consider. <ul> <li> Projections of ordinary 2-d spectra. </li> <li> Projection of gamma 2-d spectra. </li> </ul> <h3>Projections of ordinary 2-d spectra</h3> <P>The result of projecting an ordinary 2-d spectrum is an ordinary 1-d spectrum. If the <tt>-snapshot</tt> switch is supplied, this spectrum will be frozen. </P> <P>The target spectrum may automatically have gates applied to it. Gates will only be applied to targets that are not snapshot spectra. The intent of these gates is to ensure that the target spectrum increments in such a way that it remains a faithful projection of the source spectrum.</P> <P> Automatic gating is as follows: <UL> <LI>If the source spectrum is ungated, and the projection is not via a contour, the target spectrum is gated with a "TRUE" gate (is ungated).</LI> <LI>If the source spectrum is gated, and the projection is not via a contour, the target spectrum is gated with the same gate as the source spectrum.</LI> <LI>If the source spectrum is not gated, and the projection is via a contour, the projection contour gates the target spectrum.</LI> <LI>If the source spectrum is gated, and the projection is via a contour, a gate is created that is the AND of these two gates and applied to the target spectrum. This AND gate will be named: __PROJECTIONGATE__<em>roi</em>__AND__<em>sourcegate</em>__ where <em>roi</em> is the projection contour and <em>sourcegate</em> is the name of the gate on the source spectrum.</LI> </UL> <P>Suppose, for example, we have a spectrum named pid_gamma which is gated on a gamma slice named <em>511kev</em>, and that the X axis of this spectrum is an energy, while the Y is e.g. a de. Suppose this spectrum has a contour drawn on it (not applied to it) named 6Li. The command: <pre> project pid_gamma 6Li511kev x 6Li </pre> Produces a new spectrum named 6Li511kev which is gated on the and of 6Li and 511Kev. The spectrum is initially filled with the projection of pid_gamma in the x direction within the region of interest defined by the contour 6Li. The and gate created is named __PROJECTION_6Li__AND__511Kev__ <h3>Projections of gamma 2-d spectra </h3> <P>The target spectrum of a projection of a 2d gamma spectrum is a 1d gamma spectrum. If the <tt>-snapshot</tt> switch is supplied, the target is frozen. <P>The target spectrum may have gates and folds automatically applied to it. These gates and folds, in general, will not result in a continued faithful projection as the target spectrum increments, as the increments of gamma spectra are correlated within the sets of parameters gates and folds. <P>If the source spectrrum has a fold applied to it, the same fold will be applied to the target spectrum. Gates are applied to the target spectrum in the same way they are applied to ordinary 2-d projection targets. <hr> <p>Last Modified: <!--webbot bot="Timestamp" s-type="EDITED" s-format="%B %d, %Y" startspan -->May 27, 2005<!--webbot bot="Timestamp" endspan i-checksum="30351" --> by: <a href="mailto:fo...@ns...">fo...@ns...</a><br> <font size="2">© Copyright NSCL 2005, All rights reserved</font></p> </body> </html> |