Difference between revisions of "IXTrunfile"

From LIBISIS
Jump to navigation Jump to search
m
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
The IXTrunfie object contains the instrument information and instrument data together with other optional information about the users and sample measured.  It is generally populated by the [[Homer and mgenie style functions]] as well as the [[Scripting Homer Functions]].
+
The IXTrunfie object contains the instrument information and instrument data together with other optional information about the users and sample measured.  It is generally populated by the [[Homer and mgenie style functions]] as well as the [[Scripting Homer Functions]]. This object is very similar to [[IXTdataset_2d]] and many of the same operations exist for it, including all the [[Plot Commands#Two Dimensional Plots|two dimensional plot commands]].
 +
 
 +
==Structure==
  
 
The elements of the object are as follows:
 
The elements of the object are as follows:
  
−
{| border ="1" cellpadding="2"
+
{| {{Tablestyle}}
−
|+ '''IXTrunfile definition'''
+
|-
−
!width="10%"|Element  
+
! {{Headcellstyle}} | Element
−
!width="20%"|Type  
+
!{{Headcellstyle}} | Type
−
!width="70%"|Brief Description
+
! {{Headcellstyle}} | Description
 +
|-
 +
|'''base'''
 +
| [[IXTbase]]]
 +
| internal use
 
|-
 
|-
−
|  title || char || Title of runfile
+
|  '''title'''
 +
| char
 +
| Title of runfile
 
|-
 
|-
−
| start_time || char || time of start of run
+
| '''start_time'''
 +
| char
 +
| time of start of run
 
|-
 
|-
−
| end_time || char || time of end of run
+
|''' end_time'''
 +
| char
 +
| time of end of run
 
|-
 
|-
−
| run_number || int || number of run
+
| '''run_number'''
 +
| int  
 +
| number of run
 
|-
 
|-
−
| total_charge || real || <math>\mu</math>Amp Hrs for run
+
| '''total_charge'''
 +
| real
 +
| <math>\mu</math>Amp Hrs for run
 
|-
 
|-
−
| total_raw_frames || int ||  total frames in run
+
| '''total_raw_frames'''
 +
| int  
 +
|  total frames in run
 
|-
 
|-
−
| total_good_frames || int || total good frames in run
+
| '''total_good_frames'''
 +
| int
 +
| total good frames in run
 
|-
 
|-
−
| program_name || [[IXThistory]] || the full path of prgram creating object
+
| '''program_name'''
 +
| [[IXThistory]]
 +
| the full path of prgram creating object
 
|-
 
|-
−
| command_line || [[IXThistory]] || the command line syntax of function calling the object
+
| '''command_line'''
 +
| [[IXThistory]]
 +
| the command line syntax of function calling the object
 
|-
 
|-
−
|  users (:)   || [[IXTuser]] (allocatable) || list of users
+
|  '''users (:) '''
 +
| [[IXTuser]] (allocatable)
 +
| list of users
 
|-
 
|-
−
|  sample   || [[IXTsample]] || sample being measured
+
|  '''sample'''
 +
| [[IXTsample]]
 +
| sample being measured
 
|-
 
|-
−
| inst   || [[IXTinstrument]] || description of instrument
+
| '''inst'''
 +
| [[IXTinstrument]]
 +
| description of instrument
 
|-
 
|-
−
| det_data   || [[IXTdata]] || detector datasets and mapping information
+
| '''det_data'''
 +
| [[IXTdata]]
 +
| detector datasets and mapping information
 
|-
 
|-
−
| mon_data   || [[IXTdata]] || monitor datasets and mapping information
+
| '''mon_data'''
 +
| [[IXTdata]]
 +
| monitor datasets and mapping information
 
|-
 
|-
−
| peaks   || [[IXTpeaks]] ||  description of monitor peaks for get_ei
+
| '''peaks'''
 +
| [[IXTpeaks]]
 +
|  description of monitor peaks for get_ei
 
|}
 
|}
  
  
  
−
-------
+
==F90 syntax==
−
F90 syntax
+
 
−
-------
+
 
 
<pre>
 
<pre>
 
use IXMrunfile
 
use IXMrunfile
Line 52: Line 88:
 
</pre>
 
</pre>
  
−
-------
+
 
 +
==Operations==
  
 
The following operations may be performed on this data type:
 
The following operations may be performed on this data type:
−
*[General Operations]
+
*[[General Operations]]
−
*[Special Subroutines]
+
*[[Special Subroutines]]
 +
 
 +
===Class Specific Operations===
 +
population routines:
 +
 
 +
*[[IXFpopulate_mon_runfile]]
 +
*[[IXFpopulate_det_runfile]]
 +
*[[IXFpopulate_runfile]]
 +
 
 +
 
 +
transformations:
 +
 
 +
*[[IXFrebin_runfile]]
 +
*[[IXFbackground_runfile]]
 +
*[[IXFremap_runfile]]
 +
*[[IXFunits_runfile]]
 +
 
 +
 
 +
normalisation routines
 +
 
 +
*[[IXFsolid_runfile]]
 +
*[[IXFmon_norm_runfile]]
 +
*[[IXFpeak_norm_runfile]]
 +
*[[IXFeffic_norm_runfile]]
 +
 
 +
 
 +
other
  
−
Class Specific Operations
+
*[[IXFgetei_runfile]]
−
--population routines
+
*[[IXFgeteival_runfile]]
−
*[IXFpopulate_mon_runfile]
+
*[[IXFgetmondata_runfile]]
−
*[IXFpopulate_det_runfile]
+
*[[IXFgetdetdata_runfile]]
−
*[IXFpopulate_runfile]
 
−
--transformations
 
−
*[IXFrebin_runfile]
 
−
*[IXFbackground_runfile]
 
−
*[IXFremap_runfile]
 
−
*[IXFunits_runfile]
 
−
--normalisation routines
 
−
*[IXFsolid_runfile]
 
−
*[IXFmon_norm_runfile]
 
−
*[IXFpeak_norm_runfile]
 
−
*[IXFeffic_norm_runfile]
 
−
--other
 
−
*[IXFgetei_runfile]
 
−
*[IXFgeteival_runfile]
 
−
*[IXFgetmondata_runfile]
 
−
*[IXFgetdetdata_runfile]
 

Latest revision as of 14:19, 4 August 2008

The IXTrunfie object contains the instrument information and instrument data together with other optional information about the users and sample measured. It is generally populated by the Homer and mgenie style functions as well as the Scripting Homer Functions. This object is very similar to IXTdataset_2d and many of the same operations exist for it, including all the two dimensional plot commands.

Structure

The elements of the object are as follows:

Element Type Description
base IXTbase] internal use
title char Title of runfile
start_time char time of start of run
end_time char time of end of run
run_number int number of run
total_charge real <math>\mu</math>Amp Hrs for run
total_raw_frames int total frames in run
total_good_frames int total good frames in run
program_name IXThistory the full path of prgram creating object
command_line IXThistory the command line syntax of function calling the object
users (:) IXTuser (allocatable) list of users
sample IXTsample sample being measured
inst IXTinstrument description of instrument
det_data IXTdata detector datasets and mapping information
mon_data IXTdata monitor datasets and mapping information
peaks IXTpeaks description of monitor peaks for get_ei


F90 syntax

use IXMrunfile

type(IXTrunfile)::runfile
type(IXTstatus):: status


Operations

The following operations may be performed on this data type:

Class Specific Operations

population routines:


transformations:


normalisation routines


other

Retrieved from "http://libisis.org/index.php?title=IXTrunfile&oldid=2583"