User Tools

Site Tools


jvs:fscan:manual:chapter4

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
jvs:fscan:manual:chapter4 [2011/08/22 15:25]
voyvodic
jvs:fscan:manual:chapter4 [2023/02/23 18:43] (current)
Line 1: Line 1:
 **fScan Reference Manual, Chapter 4 (Variables): Contents ** **fScan Reference Manual, Chapter 4 (Variables): Contents **
  
-===== fScan internal variables -- Summary List =====+===== fScan internal variables =====
  
-|[[jvs:fscan:manual:chapter4:quitstr|quitStr]]| Interactive commands to execute at [[jvs:fscan:manual:chapter3:winkeys:quit|quit]] command| +fScan supports several different types of internal variables. Values of some variables are global -- they do not change when you move from one active window to another.  Other variables are workspace or data set specific -- their values will change depending on which window is currently active. 
-|[[jvs:fscan:manual:chapter4:peekstr|peekStr]]| Interactive commands to execute at fScan start-up | + 
-|[[jvs:fscan:manual:chapter4:thiswin|thiswin]]| The name of the current window| +  * [[jvs:fscan:manual:chapter4:global|Global variables]] 
-|[[jvs:fscan:manual:chapter4:prevwin|prevwin]]| The name of the previous window| +  * [[jvs:fscan:manual:chapter4:uservarbs|User-defined variables]] 
-|[[jvs:fscan:manual:chapter4:thispdigm|thispdigm]]| The name of the current pdigm file| +  [[jvs:fscan:manual:chapter4:datasetvarbs|Data-set variables]] 
-|[[jvs:fscan:manual:chapter4:thisevents|thisevents]]| The name of the current events| +  [[jvs:fscan:manual:chapter4:datasetstrings|Data-set string variables]] 
-|[[jvs:fscan:manual:chapter4:subjectname|subjectname]]| The name of the current subject| +  [[jvs:fscan:manual:chapter4:datasetarrays|Data-set array variables]] 
-|[[jvs:fscan:manual:chapter4:subjectdir|subjectdir]]| The name of the current subject directory| + 
-|[[jvs:fscan:manual:chapter4:fscandir|fscandir]]| The name of the fScan home directory| +==== Accessing data variables ==== 
-|[[jvs:fscan:manual:chapter4:curdir|curdir]]| The current working directory|+In general, data variable values can be accessed by specifying the name of the variable, preceded by the '$' character (or '_' character to make command-line scripting easier).  To get the status of a variable, substitute '?' for '$'; the status is -1 if the named variable is not defined, it is 0 if it is defined but empty, and it is a positive value (the size of the variable) if it is defined and not empty. 
 + 
 +Variable operators               
 +  * $varbname - the value of the named variable (_varbname works the same) 
 +  * ?varbname - the status of the named variable (0=undefined, 1=defined) 
 + 
 +For example:\\ 
 +  * -echo Window$thiswin WorkSpace $wsnum         ; display name and workspace of current active window 
 +  * -echo Varb?curdir ?thiswin ?myvarb            ; test whether these variables are defined 
 + 
 +The '$' character is also used to identify fScan special functions of the form$funcname(). Examples are: 
 +  * $exists(filename) - does the named file exist (0=no, 1=regular file, 2=directory)? 
 +  * $filepath(filename) - return the full path to the named file 
 +  * $relpath(filename) - return the relative path (from $curdir
 +  * $date(filename) - return a string containing the file modification date (yyyymmddhhmmss) 
 +  * $age(filename) - return the age of the named file in seconds 
 + 
 +  * tables 
 +    * listitem 
 +    * listflag
  
-|thiswin|prevwin|thispdigm|thisevents|listitem|listflag|wspace|wspacedir|  
-|lastref|imageref|taskbarcolor|thismap|lastmap|sample|subjectname|subjectdir| 
-|fscandir|curdir|port|querystatus|plotwin|imagewin|alignref|exists| 
-|filepath|relpath|computer|hostname|user| | | | 
  
-|acquiret|age|byteorder|centerx|centery|centerz|colormap|colortype| 
-|comment|compression|datafile|dataname|dataorder|datastem|datatype|descr| 
-|diffusiontype|diffweighting|dimgapt|dimgapx|dimgapy|dimgapz|discard|disdaqs| 
-|displayscale|endofhdr|examid|examnum|file0index2|firstslice|firstsliceras|flipangle| 
-|flipx|flipy|flipz|fmtflag|fmtversion|fovx|fovy|freqdir| 
-|glossaryname|hdr2file|hdr2offset|hdr2size|hdr2type|headersize|highthresh|history| 
-|imageignore|inputfile|institution|investigator|ionum|lastslice|lastsliceras|lowthresh| 
-|magneticfield|maptype|maskbits|matx|maty|name|namefmt|nechos| 
-|nex|normalx|normaly|normalz|nrecs|nshots|numimgfiles|nvalues| 
-|nzeros|operator|orientation|origdimt|origdimz|origt|origx|origy| 
-|origz|outputfile|paramfile|pixtype|protocol|pulseseq|radiologist|rasflag| 
-|recoffset|recsize|relofft|reloffz|runnum|scandate|scanner|scantime| 
-|seriesnum|sex|showcolor|slicetiming|source|studyid|subtype|surfscale| 
-|taskdescr|[[Tasknames|taskname]]|tasktiming|tdim|te|tgap|threshflag|ti| 
-|tiltx|tilty|tiltz|totaltime|tr|tres|unitst|unitsx| 
-|unitsy|unitsz|unknownhdr|valuescale|vmax|vmaxneg|vmean|vmin| 
-|vminpos|vstdev|warpmap|weight|winhgt|winnum|winwid|winx| 
-|winy|xdim|xres|ydim|yres|zdim|zgap|zres| 
  
 **See Also:**\\ **See Also:**\\
 +[[jvs:fscan:manual:chapter2:set|Set]], [[jvs:fscan:manual:chapter2:if|If]], and [[jvs:fscan:manual:chapter2:echo|Echo]] commands.\\
 [[jvs:fscan|fScan Home]], [[jvs:fscan|fScan Home]],
 [[jvs:fscan:manual|fScan Manual]], [[jvs:fscan:manual|fScan Manual]],
 [[jvs:fscan:manual:help|Manual Help]] [[jvs:fscan:manual:help|Manual Help]]
  
jvs/fscan/manual/chapter4.1314026721.txt.gz · Last modified: 2014/08/04 16:03 (external edit)