Subsections


5. Reference Manual

5.1 gi_graphicsio.c

Function: findMappingFile 

   void findMappingFile(FileInfoPtr thisFile)
Arguments:
#1 thisFile FileInfoPtr 
    *
    *	findMappingFile(thisFile) look for acq data mapping file
    *	(internal use only)
    *


Function: createfile 

   long createfile_(char *fileName, long fileType, long errorLevel,
   		 FileInfoPtr *theNewFile)
Arguments:
#1 *fileName char
#2 fileType long
#3 errorLevel long
#4 *theNewFile FileInfoPtr 
    *
    *	createfile_   create and open a new file
    *
    *	INPUTS: fileName    name of file to be created
    *	    	fileType    type of file (data or geometry)
    *	    	errorLevel  boolean TRUE= report errors FALSE = don't report
    *	    	    	    errors, just return errors
    *
    *	OUTPUTS:theNewFile  file info pointer (used for all subsequent
    *	    	    	    references to the file)
    *	    	result	    function result


Function: closefile 

   long closefile_(FileInfoPtr thisFile)
Arguments:
#1 thisFile FileInfoPtr 
    *
    *	closefile_  politely close an open file
    *
    *	INPUT:	fileFile    the file info pointer
    *
    *	OUTPUT: result	    function result
    *


Function: openaccess 

   long openaccess_(long tapeNumber, char *filePrefix, int tapeType, 
   		 long errorLevel, FileInfoPtr *theAccess)
Arguments:
#1 tapeNumber long
#2 *filePrefix char
#3 tapeType int
#4 errorLevel long
#5 *theAccess FileInfoPtr 
    *
    *	openaccess_ open access to raw or pak files (without an actual 
    *                                                   data file) 
    *
    *	INPUTS:	tapeNumber  number of "tape" to be accessed
    *              tapeType    type of "tape" to be accessed (enum extFile)
    *	    	errorLevel  set error reporting level (see createfile_)
    *
    *	OUTPUTS:theExistingFile	file info pointer for this access (used for
    *	    	    	    	all subsequent references to this access)
    *	    	result	    	function result
    *


Function: setmappingfile 

   long setmappingfile_(FileInfoPtr thisFile, char* theMapToUse)
Arguments:
#1 thisFile FileInfoPtr
#2 theMapToUse char* 
    *
    *	setmappingfile_	set the lead mapping file for acq data
    *
    *	INPUTS: thisFile    file info pointer
    *		theMapToUse the file name (with path) to use for mapping 
    *                          the data will override the default file if 
    *                          present 
    *
    *	OUTPUT: result	    function result
    *


Function: getmappingfiles 

   long getmappingfiles_(FileInfoPtr thisFile, char* theDefaultMap, 
   		      char* theMapInUse)
Arguments:
#1 thisFile FileInfoPtr
#2 theDefaultMap char*
#3 theMapInUse char* 
    *
    *	getmappingfiles_    set the lead mapping file for acq data
    *
    *	INPUTS:	    thisFile    file info pointer
    *
    *	OUTPUTS:    result	    function result
    *		    theDefaultMap   the lead mapping file found with acq files
    *				    (if any) 
    *				    (zero length string returned if map not
    *				    found) 
    *                  theMapInUse	    the lead mapping file set by
    *				    setmappingfile_ (if any)  
    *				    (zero length string returned if map not
    *				    set)


Function: openfile 

   long openfile_(char* fileName, long errorLevel, FileInfoPtr* theExistingFile)
Arguments:
#1 fileName char*
#2 errorLevel long
#3 theExistingFile FileInfoPtr* 
    *
    *	openfile_ open an existing file for read only access
    *
    *	INPUTS:	fileName    name of file to be opened
    *	    	errorLevel  set error reporting level (see createfile_)
    *
    *	OUTPUTS:theExistingFile	file info pointer for the file (used for
    *	    	    	    	all subsequent references to the file)
    *	    	result	    	function result
    *


Function: openfilerewrite 

   long openfilerewrite_(char* fileName, long errorLevel, 
   		      FileInfoPtr* theExistingFile)
Arguments:
#1 fileName char*
#2 errorLevel long
#3 theExistingFile FileInfoPtr* 
    *
    *	openfilerewrite_ open an existing file for read and write acces
    *
    *	INPUTS:	fileName    name of file to be opened
    *	    	errorLevel  set error reporting level (see createfile_)
    *
    *	OUTPUTS:theExistingFile	file info pointer for the file (used for
    *	    	    	    	all subsequent references to the file)
    *	    	result	    	function result
    *


Function: getfileinfo 

   long getfileinfo_(FileInfoPtr thisFile, long* fileType, long* numberOfSurfaces,
   		 long* numberOfBoundSurfaces, long* numberOfTimeSeriesBlocks,
   		  CBoolean* preferedSettingsBlock)
Arguments:
#1 thisFile FileInfoPtr
#2 fileType long*
#3 numberOfSurfaces long*
#4 numberOfBoundSurfaces long*
#5 numberOfTimeSeriesBlocks long*
#6 preferedSettingsBlock CBoolean* 
    *
    *	getfileinfo_   get basic information about file contents
    *
    *	INPUTS:	thisFile    file info pointer
    * 
    *	OUTPUTS:fileType    	    	    file type (data or geometry)
    *	    	numberOfSurfaces    	    number of data or geometry surfaces
    *	    	    	    	    	    contained in the file
    *	    	numberOfBounding Surfaces   number of bounding surfaces
    *	    	numberOfTimeSeriesBlocks    number of time series blocks
    *	    	preferedSettingsBlock	    boolean TRUE prefered settings
    *	    	    	    	    	    block contained in the file
    *	    	result	    	    	    function result
    *


Function: setexpid 

   long setexpid_(FileInfoPtr thisFile, char* theExp)
Arguments:
#1 thisFile FileInfoPtr
#2 theExp char* 
    *
    *	setexpid_   set the experiment ID string
    *
    *	INPUTS:	thisFile    file info pointer
    *	    	theExp	    experiment ID string (79 chars max + null = 80)
    *
    *	OUTPUT:	result	    function result
    *


Function: getexpid 

   long getexpid_(FileInfoPtr thisFile, char* theExp)
Arguments:
#1 thisFile FileInfoPtr
#2 theExp char* 
    *
    *	getexpid_  get the experiment ID from the file
    *
    *	INPUT:	thisFile    file info pointer
    *
    *	OUTPUTS:theExp	    experiment ID string (79 chars max + null = 80)
    *	    	result	    function result
    *


Function: settext 

   long settext_(FileInfoPtr thisFile, char* theText)
Arguments:
#1 thisFile FileInfoPtr
#2 theText char* 
    *
    *	settext_  set the free form text block
    *
    *	INPUTS:	thisFile    file info pointer
    *	    	theText	    free form text (255 chars max + null = 256)
    *
    *	OUTPUT:	result	    function result
    *


Function: gettext 

    long gettext_(FileInfoPtr thisFile, char* theText)
Arguments:
#1 thisFile FileInfoPtr
#2 theText char* 
    *
    *	gettext_  get the free form text block
    *
    *	INPUT:	thisFile    file info pointer
    *
    *	OUTPUTS:theText	    free form text string (255 chars max + null=256)
    *	    	result	    function result
    *


Function: setauditstring 

   long setauditstring_(FileInfoPtr thisFile, char* theString)
Arguments:
#1 thisFile FileInfoPtr
#2 theString char* 
    *
    *	setauditstring_  set the dymanic size audit string
    *
    *	INPUT:	thisFile    file info pointer
    *
    *	OUTPUTS: result	    function result
    *


Function: getauditstringlength 

   long getauditstringlength_(FileInfoPtr thisFile, long* theLength)
Arguments:
#1 thisFile FileInfoPtr
#2 theLength long* 
    *
    *	getauditstringlength_  get the length of the audit string
    *
    *	INPUT:	thisFile    file info pointer
    *
    *	OUTPUTS:theLength   length of the audit string
    *		result	    function result
    *


Function: getauditstring 

   long getauditstring_(FileInfoPtr thisFile, long maxLength, char* theString)
Arguments:
#1 thisFile FileInfoPtr
#2 maxLength long
#3 theString char* 
    *
    *	getauditstring_  get the audit string
    *
    *	INPUT:	thisFile    file info pointer
    *		maxLength   maximum length the caller can swallow
    *
    *	OUTPUTS:theString   the audit string
    *		result	    function result
    *


5.2 gi_surfaces.c

Function: setsurfaceindex 

   long setsurfaceindex_(FileInfoPtr thisFile, long theSurfaceIndex)
Arguments:
#1 thisFile FileInfoPtr
#2 theSurfaceIndex long 
    *
    *	setsurfaceindex_  specify surface for subsequent accesses
    *
    *	INPUTS:	thisFile    	    file info pointer
    *	    	theSurfaceIndex	    the desired surface
    * 
    *	OUTPUT:	result	    	    function result
    *


Function: getsurfaceindex 

   long getsurfaceindex_(FileInfoPtr thisFile, long* theSurface)
Arguments:
#1 thisFile FileInfoPtr
#2 theSurface long* 
    *
    *	getsurfaceindex_ get the current surface index
    *
    *	INPUT:	thisFile    file info pointer
    *
    *	OUTPUTS:theSurface  the current surface index
    *	    	result	    function result
    *


Function: setsurfacename 

   long setsurfacename_(FileInfoPtr thisFile, char *theName)
Arguments:
#1 thisFile FileInfoPtr
#2 *theName char 
    *
    *	setsurfacename_ set a name for the current surface
    *
    *	INPUTS:	thisFile    file info pointer
    *	    	theName	    name string (79 chars max + null = 80)
    *
    *	OUTPUT: result	    function result
    *


Function: getsurfacename 

   long getsurfacename_(FileInfoPtr thisFile, char *theName)
Arguments:
#1 thisFile FileInfoPtr
#2 *theName char 
    *
    *	getsurfacename_   get name of current surface
    *
    *	INPUT:	thisFile    file info pointer
    *
    *	OUTPUTS:theName	    surface name string (79 chars max + null = 80)
    *	    	result	    function result
    *


Function: setsurfacetype 

   long setsurfacetype_(FileInfoPtr thisFile, long theType)
Arguments:
#1 thisFile FileInfoPtr
#2 theType long 
    *
    *	setsurfacetype_  set surface type
    *
    *	INPUTS:	thisFile    file info pointer
    *	    	theType surface type (see graphicsio.h for definitions)
    *
    *	OUTPUT:	result	    function result
    *


Function: getsurfacetype 

   long getsurfacetype_(FileInfoPtr thisFile, long *theType)
Arguments:
#1 thisFile FileInfoPtr
#2 *theType long 
    *
    *	getsurfacetype_  set the surface type
    *
    *	INPUT:	thisFile    file info pointer
    *
    *	OUTPUTS:theType	    the surface type (see graphicsio.h for definitions)
    *	    	result	    function result
    *


5.3 gi_nodes.c

Function: getnodeinfo 

   long getnodeinfo_(FileInfoPtr thisFile, long *numberOfNodes,
   		  long *numberOfScalarValues, long *numberOfVectorValues,
   		  long *numberOfTensorValues)
Arguments:
#1 thisFile FileInfoPtr
#2 *numberOfNodes long
#3 *numberOfScalarValues long
#4 *numberOfVectorValues long
#5 *numberOfTensorValues long 
    *
    *	getnodeinfo_ get information about nodes on the current surface
    *
    *	INPUT:	thisFile    	    	file info pointer
    *
    *	OUTPUTS:numberOfNodes	    	number of nodes on this surface
    *	    	numberOfScalarValues	number of scalar values
    *	    	numberOfVectorValues	number of vector values
    *	    	numberOfTensorValues	number of tensor values
    *	    	result	    	    	function result
    *


Function: getnodes 

   long getnodes_(FileInfoPtr thisFile, NodePtr theNodeData)
Arguments:
#1 thisFile FileInfoPtr
#2 theNodeData NodePtr 
    *
    *	getnodes_  get the node values from the current surface
    *
    *	INPUT:	thisFile    	file info pointer
    *
    *	OUTPUTS:theNodeData 	the node values
    *	    	result	    	function result
    *


Function: setnodescalars 

   long setnodescalars_(FileInfoPtr thisFile, long theType,
   		     long numberOfScalars, ScalarPtr theScalarData)
Arguments:
#1 thisFile FileInfoPtr
#2 theType long
#3 numberOfScalars long
#4 theScalarData ScalarPtr 
    *
    *	setnodescalars_  set a set of scalars for the current surface
    *
    *	INPUTS:	thisFile    	    file info pointer
    *	    	theType	    	    scalar type (see graphicsio.h 
    *	    	    	    	    for definitions)
    *	    	numberOfScalars	    number of scalars (must match number of
    *	    	    	    	    nodes)
    *	    	theScalarData	    the scalar data
    *
    *	OUTPUT: result	    function result
    *


Function: getnodescalartypes 

   long getnodescalartypes_(FileInfoPtr thisFile, long *theTypes)
Arguments:
#1 thisFile FileInfoPtr
#2 *theTypes long 
    *
    *	getnodescalartypes_  get the type of each set of scalar values
    *	    	    	     for the current surface
    *
    *	INPUT:	thisFile    file info pointer
    *
    *	OUTPUTS:theTypes    an array of types (must be large enough to
    *	    	    	    accomodate the number of scalar values)
    *	    	result	    function result
    *


Function: getnodescalars 

   long getnodescalars_(FileInfoPtr thisFile, long scalarIndex,
   		     long *theType, ScalarPtr theScalarData)
Arguments:
#1 thisFile FileInfoPtr
#2 scalarIndex long
#3 *theType long
#4 theScalarData ScalarPtr 
    *
    *	getnodescalars_ get a selected set of node scalar values
    *
    *	INPUTS:	thisFile    	file info pointer
    *	    	scalarIndex 	index of desired scalar value set
    *
    *	OUTPUTS: theType    	the type of this set of node scalars
    *	    	 theScalarData	the scalar values
    *	    	 result	    	function result
    *


Function: setnodevectors 

   long setnodevectors_(FileInfoPtr thisFile, long theType,
   		     long numberOfVectors, VectorPtr theVectorData)
Arguments:
#1 thisFile FileInfoPtr
#2 theType long
#3 numberOfVectors long
#4 theVectorData VectorPtr 
    *
    *	setnodevectors_ set a set of node vectors for the current surface
    *
    *	INPUTS:	thisFile    	file info pointer
    *	    	theType	    	vector value type (see graphicsio.h for
    *	    	    	    	definitions)
    *	    	numberOfVectors	number of vectors (must match number of
    *	    	    	    	nodes)
    *	    	theVectorData	the vector data
    *
    *	OUTPUT:	result	    	function result
    *


Function: getnodevectortypes 

   long getnodevectortypes_(FileInfoPtr thisFile, long *theTypes)
Arguments:
#1 thisFile FileInfoPtr
#2 *theTypes long 
    *
    *	getnodevectortypes_ This routine returns the types of node
    *	    	    	    vector values that are associated with
    *	    	    	    the current node set
    *
    *	    INPUTS: thisFile	file info pointer
    *	    	    theTypes	a pointer an array of longs
    *
    *	    OUTPUTS:theType 	fills in the array of longs with types
    *	    	    result  	function result


Function: getnodevectors 

   long getnodevectors_(FileInfoPtr thisFile, long vectorIndex,
   		     long *theType, VectorPtr theVectorData)
Arguments:
#1 thisFile FileInfoPtr
#2 vectorIndex long
#3 *theType long
#4 theVectorData VectorPtr 
    *
    *	getnodevectors_ get a set of node vectors for the current surface
    *
    *	INPUTS:	thisFile    	file info pointer
    *	    	vectorIndex 	the index of the desired vector set
    *
    *	OUTPUT:	theType	    	the type of this vector set
    *	    	theVectorData	the vector values for this set
    *	    	result	    	function result
    *


Function: setnodetensors 

   long setnodetensors_(FileInfoPtr thisFile, long theType, long theDimension,
   		     long numberOfTensors, TensorPtr theTensorData)
Arguments:
#1 thisFile FileInfoPtr
#2 theType long
#3 theDimension long
#4 numberOfTensors long
#5 theTensorData TensorPtr 
    *
    *	setnodetensors_
    *


Function: getnodetensortypes 

   long getnodetensortypes_(FileInfoPtr thisFile, long *theTypes, 
   			 long *theDimensions)
Arguments:
#1 thisFile FileInfoPtr
#2 *theTypes long
#3 *theDimensions long 
    *
    *	getnodetensortypes_
    *


Function: getnodetensors 

   long getnodetensors_(FileInfoPtr thisFile, long tensorIndex, long *theDimension,
   		     long *theType, TensorPtr theTensorData)
Arguments:
#1 thisFile FileInfoPtr
#2 tensorIndex long
#3 *theDimension long
#4 *theType long
#5 theTensorData TensorPtr 
    *
    *	getnodetensors_
    *


5.4 gi_elements.c

Function: getelementinfo 

   long getelementinfo_(FileInfoPtr thisFile, long *numberOfElements,
   		  long *elementSize, long *numberOfScalarValues, 
   		  long *numberOfVectorValues, long *numberOfTensorValues)
Arguments:
#1 thisFile FileInfoPtr
#2 *numberOfElements long
#3 *elementSize long
#4 *numberOfScalarValues long
#5 *numberOfVectorValues long
#6 *numberOfTensorValues long 
    *
    *	getelementinfo_ get information about the nodes on the current surface
    *
    *	INPUT:	thisFile    	    	file info pointer
    *
    *	OUTPUTS:numberOfElements    	number of elements
    *	    	elementSize 	    	size of elements
    *	    	numberOfScalarValues	number of scalar values
    *	    	numberOfVectorValues	number of vector values
    *	    	numberOfTensorValues	number of tensor values
    *	    	result	    	    	function result
    *


Function: getelements 

   long getelements_(FileInfoPtr thisFile, long *theElements)
Arguments:
#1 thisFile FileInfoPtr
#2 *theElements long 
    *
    *	getelements_ get the elements for the current surface
    *
    *	INPUT:	thisFile    file info pointer
    *
    *	OUTPUTS:theElements the element data
    *	    	result	    function result
    *


Function: setelementscalars 

   long setelementscalars_(FileInfoPtr thisFile, long theType,
   		     long numberOfScalars, ScalarPtr theScalarData)
Arguments:
#1 thisFile FileInfoPtr
#2 theType long
#3 numberOfScalars long
#4 theScalarData ScalarPtr 
    *
    *	setelementscalars_
    *


Function: getelementscalartypes 

   long getelementscalartypes_(FileInfoPtr thisFile, long *theTypes)
Arguments:
#1 thisFile FileInfoPtr
#2 *theTypes long 
    *
    *	getelementscalartypes_
    *


Function: getelementscalars 

   long getelementscalars_(FileInfoPtr thisFile, long scalarIndex,
   		     long *theType, ScalarPtr theScalarData)
Arguments:
#1 thisFile FileInfoPtr
#2 scalarIndex long
#3 *theType long
#4 theScalarData ScalarPtr 
    *
    *	getelementscalars_
    *


Function: setelementvectors 

   long setelementvectors_(FileInfoPtr thisFile, long theType,
   		     long numberOfVectors, VectorPtr theVectorData)
Arguments:
#1 thisFile FileInfoPtr
#2 theType long
#3 numberOfVectors long
#4 theVectorData VectorPtr 
    *
    *	setelementvectors_
    *


Function: getelementvectortypes 

   long getelementvectortypes_(FileInfoPtr thisFile, long *theTypes)
Arguments:
#1 thisFile FileInfoPtr
#2 *theTypes long 
    *
    *	getelementvectortypes_
    *


Function: getelementvectors 

   long getelementvectors_(FileInfoPtr thisFile, long vectorIndex,
   		     long *theType, VectorPtr theVectorData)
Arguments:
#1 thisFile FileInfoPtr
#2 vectorIndex long
#3 *theType long
#4 theVectorData VectorPtr 
    *
    *	getelementvectors_
    *


Function: setelementtensors 

   long setelementtensors_(FileInfoPtr thisFile, long theType, long theDimension,
   		     long numberOfTensors, TensorPtr theTensorData)
Arguments:
#1 thisFile FileInfoPtr
#2 theType long
#3 theDimension long
#4 numberOfTensors long
#5 theTensorData TensorPtr 
    *
    *	setelementtensors_
    *


Function: getelementtensortypes 

   long getelementtensortypes_(FileInfoPtr thisFile, long *theTypes, 
   			 long *theDimensions)
Arguments:
#1 thisFile FileInfoPtr
#2 *theTypes long
#3 *theDimensions long 
    *
    *	getelementtensortypes_
    *


Function: getelementtensors 

   long getelementtensors_(FileInfoPtr thisFile, long tensorIndex,
   			long *theDimension, long *theType, 
   			TensorPtr theTensorData)
Arguments:
#1 thisFile FileInfoPtr
#2 tensorIndex long
#3 *theDimension long
#4 *theType long
#5 theTensorData TensorPtr 
    *
    *	getelementtensors_
    *


5.5 gi_timeseries.c

Function: readtimeseriesheader 

   long readtimeseriesheader(FileInfoPtr thisFile, TimeSeriesHeaderPtr theHeader)
Arguments:
#1 thisFile FileInfoPtr
#2 theHeader TimeSeriesHeaderPtr 
    *
    *	readtimeseriesheader (internal use only)
    *


Function: writetimeseriesheader 

   long writetimeseriesheader(FileInfoPtr thisFile, TimeSeriesHeaderPtr theHeader)
Arguments:
#1 thisFile FileInfoPtr
#2 theHeader TimeSeriesHeaderPtr 
    *
    *	writetimeseriesheader (internal use only)
    *


Function: settimeseriesdatapath 

   long settimeseriesdatapath_(FileInfoPtr thisFile, char *thePath)
Arguments:
#1 thisFile FileInfoPtr
#2 *thePath char 
    *
    *	settimeseriesdatapath
    *


Function: settimeseriesindex 

   long settimeseriesindex_(FileInfoPtr thisFile, long theIndex)
Arguments:
#1 thisFile FileInfoPtr
#2 theIndex long 
    *
    *	settimeseriesindex
    *


Function: gettimeseriesindex 

   long gettimeseriesindex_(FileInfoPtr thisFile, long *theIndex)
Arguments:
#1 thisFile FileInfoPtr
#2 *theIndex long 
    *
    *	gettimeseriesindex
    *


Function: settimeseriesgeomfile 

   long settimeseriesgeomfile_(FileInfoPtr thisFile, char *theFile)
Arguments:
#1 thisFile FileInfoPtr
#2 *theFile char 
    *
    *	settimeseriesgeomfile
    *


Function: gettimeseriesgeomfile 

   long gettimeseriesgeomfile_(FileInfoPtr thisFile, char *theFile)
Arguments:
#1 thisFile FileInfoPtr
#2 *theFile char 
    *
    *	gettimeseriesgeomfile
    *


Function: settimeseriesfile 

   long settimeseriesfile_(FileInfoPtr thisFile, char *theFile)
Arguments:
#1 thisFile FileInfoPtr
#2 *theFile char 
    *
    *	settimeseriesfile
    *


Function: gettimeseriesfile 

   long gettimeseriesfile_(FileInfoPtr thisFile, char *theFile)
Arguments:
#1 thisFile FileInfoPtr
#2 *theFile char 
    *
    *	gettimeseriesfile
    *


Function: settimeseriesspecs 

   long settimeseriesspecs_(FileInfoPtr thisFile, long numberOfChannels,
   		    long numberOfFrames)
Arguments:
#1 thisFile FileInfoPtr
#2 numberOfChannels long
#3 numberOfFrames long 
    *
    *	settimeseriesspecs
    *


Function: gettimeseriesspecs 

   long gettimeseriesspecs_(FileInfoPtr thisFile, long *numberOfChannels,
   		    long *numberOfFrames)
Arguments:
#1 thisFile FileInfoPtr
#2 *numberOfChannels long
#3 *numberOfFrames long 
    *
    *	gettimeseriesspecs
    *


Function: settimeserieslabel 

   long settimeserieslabel_(FileInfoPtr thisFile, char *theLabel)
Arguments:
#1 thisFile FileInfoPtr
#2 *theLabel char 
    *
    *	settimeserieslabel
    *


Function: gettimeserieslabel 

   long gettimeserieslabel_(FileInfoPtr thisFile, char *theLabel)
Arguments:
#1 thisFile FileInfoPtr
#2 *theLabel char 
    *
    *	gettimeserieslabel
    *


Function: settimeseriesformat 

   long settimeseriesformat_(FileInfoPtr thisFile, long theFormat)
Arguments:
#1 thisFile FileInfoPtr
#2 theFormat long 
    *
    *	settimeseriesformat
    *


Function: gettimeseriesformat 

   long gettimeseriesformat_(FileInfoPtr thisFile, long* theFormat)
Arguments:
#1 thisFile FileInfoPtr
#2 theFormat long* 
    *
    *	gettimeseriesformat
    *


Function: settimeseriesassoc 

   long settimeseriesassoc_(FileInfoPtr thisFile, long theAssociation)
Arguments:
#1 thisFile FileInfoPtr
#2 theAssociation long 
    *
    *	settimeseriesassoc
    *


Function: gettimeseriesassoc 

   long gettimeseriesassoc_(FileInfoPtr thisFile, long* theAssociation)
Arguments:
#1 thisFile FileInfoPtr
#2 theAssociation long* 
    *
    *	gettimeseriesassoc
    *


Function: settimeseriesunits 

   long settimeseriesunits_(FileInfoPtr thisFile, long theUnits)
Arguments:
#1 thisFile FileInfoPtr
#2 theUnits long 
    *
    *	settimeseriesunits
    *


Function: gettimeseriesunits 

   long gettimeseriesunits_(FileInfoPtr thisFile, long* theUnits)
Arguments:
#1 thisFile FileInfoPtr
#2 theUnits long* 
    *
    *	gettimeseriesunits
    *


Function: settimeseriessurface 

   long settimeseriessurface_(FileInfoPtr thisFile, long theSurface)
Arguments:
#1 thisFile FileInfoPtr
#2 theSurface long 
    *
    *	settimeseriessurface
    *


Function: gettimeseriessurface 

   long gettimeseriessurface_(FileInfoPtr thisFile, long* theSurface)
Arguments:
#1 thisFile FileInfoPtr
#2 theSurface long* 
    *
    *	gettimeseriessurface
    *


Function: settimeseriesassociation 

   long settimeseriesassociation_(FileInfoPtr thisFile, long theAssociation)
Arguments:
#1 thisFile FileInfoPtr
#2 theAssociation long 
    *
    *	settimeseriesassociation
    *


Function: gettimeseriesassociation 

   long gettimeseriesassociation_(FileInfoPtr thisFile, long* theAssociation)
Arguments:
#1 thisFile FileInfoPtr
#2 theAssociation long* 
    *
    *	gettimeseriesassociation
    *


Function: setnumcorrectedleads 

   long setnumcorrectedleads_(FileInfoPtr thisFile, long numberOfCorrectedLeads)
Arguments:
#1 thisFile FileInfoPtr
#2 numberOfCorrectedLeads long 
    *
    *	setnumcorrectedleads
    *


Function: getnumcorrectedleads 

   long getnumcorrectedleads_(FileInfoPtr thisFile, long* theNumber)
Arguments:
#1 thisFile FileInfoPtr
#2 theNumber long* 
    *
    *	getnumcorrectedleads
    *


Function: setqsttimes 

   long setqsttimes_(FileInfoPtr thisFile, long qtime, long stime, long ttime)
Arguments:
#1 thisFile FileInfoPtr
#2 qtime long
#3 stime long
#4 ttime long 
    *
    *	setqsttimes
    *


Function: getqsttimes 

   long getqsttimes_(FileInfoPtr thisFile, long *qtime, long *stime, long *ttime)
Arguments:
#1 thisFile FileInfoPtr
#2 *qtime long
#3 *stime long
#4 *ttime long 
    *
    *	getqsttimes
    *


Function: setextendedfiducials 

   long setextendedfiducials_(FileInfoPtr thisFile, long ponset, long poffset,
   	    	    	    long rpeak, long tpeak)
Arguments:
#1 thisFile FileInfoPtr
#2 ponset long
#3 poffset long
#4 rpeak long
#5 tpeak long 
    *
    *	setextendedfiducials
    *


Function: getextendedfiducials 

   long getextendedfiducials_(FileInfoPtr thisFile, long *ponset, long *poffset,
   	    	    	    long *rpeak, long *tpeak)
Arguments:
#1 thisFile FileInfoPtr
#2 *ponset long
#3 *poffset long
#4 *rpeak long
#5 *tpeak long 
    *
    *	getextendedfiducials
    *


Function: checkextendedfiducials 

   long checkextendedfiducials_(FileInfoPtr thisFile, CBoolean *available)
Arguments:
#1 thisFile FileInfoPtr
#2 *available CBoolean 
    *
    *	checkextendedfiducials
    *


Function: settimeseriesdata 

   long settimeseriesdata_(FileInfoPtr thisFile, float *theData)
Arguments:
#1 thisFile FileInfoPtr
#2 *theData float 
    *
    *	settimeseriesdata
    *


Function: setsometimeseriesdata 

   long setsometimeseriesdata_(FileInfoPtr thisFile, void *theData, long numberOfFrames,
   			    int storageFormat)
Arguments:
#1 thisFile FileInfoPtr
#2 *theData void
#3 numberOfFrames long
#4 storageFormat int 
    *
    *	setsometimeseriesdata
    *


Function: getselectedtimeserieschannel 

   long getselectedtimeserieschannel_(FileInfoPtr thisFile, 
   				   long selectedChannel, long startingFrame,
   				   long *numberOfFrames, void *theLead, 
   				   int returnedFormat)
Arguments:
#1 thisFile FileInfoPtr
#2 selectedChannel long
#3 startingFrame long
#4 *numberOfFrames long
#5 *theLead void
#6 returnedFormat int 
    *
    *	getselectedtimeserieschannel
    *


Function: getselectedtimeseriesdata 

   long getselectedtimeseriesdata_(FileInfoPtr thisFile, long startingFrame,
   				long *numberOfFrames, void *theData, 
   				int returnedFormat)
Arguments:
#1 thisFile FileInfoPtr
#2 startingFrame long
#3 *numberOfFrames long
#4 *theData void
#5 returnedFormat int 
    *
    *	getselectedtimeseriesdata
    *


Function: gettimeseriesdata 

   long gettimeseriesdata_(FileInfoPtr thisFile, float *theData)
Arguments:
#1 thisFile FileInfoPtr
#2 *theData float 
    *
    *	gettimeseriesdata
    *


Function: setcorrectedleads 

   long setcorrectedleads_(FileInfoPtr thisFile, long *theLeads)
Arguments:
#1 thisFile FileInfoPtr
#2 *theLeads long 
    *
    *	setcorrectedleads
    *


Function: getcorrectedleads 

   long getcorrectedleads_(FileInfoPtr thisFile, long *theLeads)
Arguments:
#1 thisFile FileInfoPtr
#2 *theLeads long 
    *
    *	getcorrectedleads
    *


Function: setpowercurve 

   long setpowercurve_(FileInfoPtr thisFile, float *powerCurveData)
Arguments:
#1 thisFile FileInfoPtr
#2 *powerCurveData float 
    *
    *	setpowercurve
    *


Function: getpowercurve 

   long getpowercurve_(FileInfoPtr thisFile, float *powerCurveData)
Arguments:
#1 thisFile FileInfoPtr
#2 *powerCurveData float 
    *
    *	getpowercurve
    *


5.6 gi_leadfiducials.c

Function: setleadfiducials 

   long setleadfiducials_(FileInfoPtr thisFile, char* theLabel,
   		      short fidDescSize, short* fidDesc, float* theFids, short* theTypes)
Arguments:
#1 thisFile FileInfoPtr
#2 theLabel char*
#3 fidDescSize short
#4 fidDesc short*
#5 theFids float*
#6 theTypes short* 
    *
    *      setleadfiducials
    *
    *      This routine writes a set of lead by lead fiducials to the file
    *
    *


Function: getleadfiducialcount 

   long getleadfiducialcount_(FileInfoPtr thisFile, long* howMany)
Arguments:
#1 thisFile FileInfoPtr
#2 howMany long* 
    *
    *	getleadfiducialcount      
    *


Function: getleadfiducialinfo 

   long getleadfiducialinfo_(FileInfoPtr thisFile, FidInfoPtr theInfo)
Arguments:
#1 thisFile FileInfoPtr
#2 theInfo FidInfoPtr 
    *
    *	getleadfiducialinfo
    *


Function: getleadfiducials 

   long getleadfiducials_(FileInfoPtr thisFile, short index, short* fidDesc,
   		       float* theFids, short* theTypes)
Arguments:
#1 thisFile FileInfoPtr
#2 index short
#3 fidDesc short*
#4 theFids float*
#5 theTypes short* 
    *
    *      getleadfiducials
    *


5.7 gi_utilities.c

Function: convertFloat 

   void convertFloat(float* theData, long howMany, CBoolean toUnix)
Arguments:
#1 theData float*
#2 howMany long
#3 toUnix CBoolean 
    *
    *	convertFloat
    *


Function: convertLong 

   void convertLong(long* theData, long howMany)
Arguments:
#1 theData long*
#2 howMany long 
    *
    *	convertLong
    *


Function: convertShort 

   void convertShort(short* theData, long howMany)
Arguments:
#1 theData short*
#2 howMany long 
    *
    *	convertShort
    *


Function: readpakheader 

   long readpakheader(FileInfoPtr thisFile, PakHeaderPtr thisHeader)
Arguments:
#1 thisFile FileInfoPtr
#2 thisHeader PakHeaderPtr 
    *
    *	readpakheader
    *


Function: readacqheader 

   long readacqheader(FileInfoPtr thisFile, AcqHeaderPtr thisHeader)
Arguments:
#1 thisFile FileInfoPtr
#2 thisHeader AcqHeaderPtr 
    *
    *	readacqheader
    *


Function: readrawheader 

   long readrawheader(FileInfoPtr thisFile, RawHeaderPtr thisHeader, 
   		   CBoolean *superHeader)
Arguments:
#1 thisFile FileInfoPtr
#2 thisHeader RawHeaderPtr
#3 *superHeader CBoolean 
    *
    *	readrawheader
    *


Function: getmapinfo 

   int* getmapinfo(char* filename, int* numberofchannels)
Arguments:
#1 filename char*
#2 numberofchannels int* 
    *
    *	int* getmapinfo(char* filename, int* numberofchannels) 
    *	(for internal use only)
    *	get the info from a mapping file (for acq data)
    *
    *	filename: name of mapping file
    *      numberofchannels: number of channels in mapping file
    *
    *	returns: a pointer to a malloc'ed buffer holding the mapping info


5.8 gi_rewrites.c

Function: initrewrite 

   long initrewrite(rewriteQueuePtr *thisQueue)
Arguments:
#1 *thisQueue rewriteQueuePtr 
    ******************************************************************************
    
   	File Rewrite Routines - The following routines are all involved in 
   	rewriting files, usually during editing.
    
   *******************************************************************************
   ******************************************************************************/
    
   
   /****
    *
    *	initrewrite()
    *


Function: addrewriterequest 

   long addrewriterequest(rewriteQueuePtr thisQueue, rewriteRequestPtr thisRequest)
Arguments:
#1 thisQueue rewriteQueuePtr
#2 thisRequest rewriteRequestPtr 
    *
    *	addrewriterequest()
    *


Function: addnewrequest 

   long addnewrequest(rewriteQueuePtr thisQueue, rewriteRequestPtr thisRequest)
Arguments:
#1 thisQueue rewriteQueuePtr
#2 thisRequest rewriteRequestPtr 
    *
    *	addnewrequest()
    *


Function: rewritefile 

   long rewritefile(rewriteQueuePtr thisQueue, char *oldFileName, char *newFileName)
Arguments:
#1 thisQueue rewriteQueuePtr
#2 *oldFileName char
#3 *newFileName char 
    *
    *	rewritefile
    *


Function: searchList 

   rewriteRequestPtr searchList(queuedRewriteRequestPtr theRewriteQueue, 
   			     long theDataType, long whichSurface, 
   			     long whichOne)
Arguments:
#1 theRewriteQueue queuedRewriteRequestPtr
#2 theDataType long
#3 whichSurface long
#4 whichOne long 
    *
    *	searchList
    *



Rob Macleod 2004-10-20