LALMathematica.h File Reference

Prototypes
void	LALMath3DPlot (LALStatus *status, Math3DPointList *first, INT4 *ntiles, REAL4 *pointSize)
	This function is for plotting 3D template banks by creating a MATHEMATICA notebook. More...
void	LALMathNDPlot (LALStatus *stat, MathNDPointList *first, INT4 *ntiles, REAL4 *pointSize)
	This function is for plotting N-Dimensional template banks by creating a MATHEMATICA notebook. More...

Go to the source code of this file.

Data Structures
struct	Math3DPointList
	This type is used by LALMath3DPlot.c as an input structure to plot 3-dimensional template banks. More...
struct	MathNDPointList
	This type is similar to Math3DPointList except the coordinates are stored as data in the REAL4Vector coordinates. More...

Macros
Error Codes
#define	LALMATHEMATICAH_ENULL   1
	NULL pointer to a LALMathematica.h input structure. More...
#define	LALMATHEMATICAH_EFILE   2
	Could not open file to write a Mathematica Notebook. More...
#define	LALMATHEMATICAH_EVAL   3
	Invalid parameter value. More...
Macros
See the source file LALMath3DPlot.c for an example of how to use these macros to generate a MATHEMATICA notebook in your own program. NOTEBOOK Denotes the beginning and ending of the notebook file. A BEG_NOTEBOOK tag must start the file and an END_NOTEBOOK tag must end it. TITLE Placing an fprint(nb, "Your Title") between BEG and END tags will place a title font cell in the notebook. GROUP Cells placed in between these tags will be grouped together SECTION Same as title except the text printed will be in section font. Subsequent input and text cells following the END_SECTIONCELL tag will be grouped with that section until a new BEG_SECTIONCELL tag is encountered. INPUT provides cells to input MATHEMATICA commands. TEXT provides cells to input plain text. Notice that the file pointer must be named "nb" in order to use the macros defined in this header. When grouping several cell objects together the last object in the list should have an underscored END tag instead of an END tag without an underscore. Although the notebook will compile (usually) if you use the tags without an ending underscore, the dangling comma is taken as a null member of the list of grouped cells. Therefore, when you view the notebook in MATHEMATICA you may see the word "NULL" printed on a line. That is an indication that you should use the underscore version of the tag which preceeded the "NULL" statement.
#define	BEG_NOTEBOOK   fprintf(nb, "Notebook[{\n")
#define	END_NOTEBOOK   fprintf(nb, "}]\n")
#define	BEG_TITLECELL   fprintf(nb, "Cell[\"")
#define	END_TITLECELL   fprintf(nb, "\", \"Title\"],\n")
#define	END_TITLECELL_   fprintf(nb, "\", \"Title\"]\n")
#define	BEG_GROUPCELL   fprintf(nb, "Cell[CellGroupData[{\n")
#define	END_GROUPCELLC   fprintf(nb, "}, Closed ]],\n")
#define	END_GROUPCELLC_   fprintf(nb, "}, Closed ]]\n")
#define	BEG_SECTIONCELL   fprintf(nb, "Cell[\"")
#define	END_SECTIONCELL   fprintf(nb, "\", \"Section\"],\n")
#define	END_SECTIONCELL_   fprintf(nb, "\", \"Section\"]\n")
#define	BEG_INPUTCELL   fprintf(nb, "Cell[BoxData[\\‍(")
#define	END_INPUTCELL   fprintf(nb, "\\‍)], \"Input\"],\n")
#define	END_INPUTCELL_   fprintf(nb, "\\‍)], \"Input\"]\n")
#define	BEG_TEXTCELL   fprintf(nb, "Cell[\"\<")
#define	END_TEXTCELL   fprintf(nb, "\>\", \"Text\"],\n")
#define	END_TEXTCELL_   fprintf(nb, "\>\", \"Text\"]\n")