Documentation

Online quick references

The output of the 'help commands (see below) and other useful quick-references are given here:

• e2d_help. Globals. Structures: e2d_view[i] , e2d_meta[i] , e2d_data[i] .
  
  
• s3d_help Globals. Structures: s3d_comp[i] , s3d_spec[i] .
  
  
• v3d_help. Globals.
  
  
• The source code files are readable and searchable with a browser; the code includes descriptions and comments:
  event2d.sl; source3d.sl; and v3d.sl

Getting command-line help

It is useful to know that, once hydra is running, typing v3d_help; s3d_help; or e2d_help; will output brief organized lists of their routines. Simple usage information on a routine can usually be had by typing the routine's name without arguments, e.g.:

hydra> e2d_load_data;
............................For grating data partordsrc = [part,order[,srcid]]
Usage: ................. e2d_load_data(FITSfile,ColX,ColY, [xyorigins], [partordsrc], [eminemax]);

The S-Lang 'apropos' and 'help' commands are also very useful, especially for ISIS and SLang commands, e.g.:
hydra> apropos rand

Found 5 function matches in namespace Global:
grand prand randomize
seed_random urand

Found 3 variable matches in namespace Global:
GSL_Rand_Type _gslrand_module_version _gslrand_module_version_string
hydra>

hydra> help plot
. . . [page of documentation with SEE ALSO 's too] . . .

Event-2D Future Enhancements

Here's a brief planed/wish-list improvements to Event-2D and Source-3D; see also the lists of ideas kept in the ChangeLog.txt file.

• Add s3d routines to calculate useful things from and about the model; e.g., electron density.
• Speed up the v3d Monte-Carlo event-generation routine(s) with custom C code.
• How to distribute work load over multi-processors?
• Add the ability to use XMM-RGS and Suzaku XIS datasets.
• Implement Voronoi tesselation gridding to bin the Data and Model events; generate chi2 statistic from this.
• Investigate some kind of parameter/fit management system to aid the user in interactive fitting of the many possible parameters and data selections.

Send comments to dd@space.mit.edu

above last updated 10/30/2012