WSxM_header.h File Reference

#include <cstdio>
#include <glib-2.0/glib.h>

Go to the source code of this file.

Classes

struct  typeHeader
struct  FileIdStruc

Defines

#define WSXM_MAXCHARS   1000
#define IMAGE_HEADER_VERSION   "1.0 (April 2000)"
#define IMAGE_HEADER_SIZE_TEXT   "Image header size: "
#define IMAGE_HEADER_END_TEXT   "Header end"
#define TEXT_COPYRIGHT_NANOTEC   "WSxM file copyright Nanotec Electronica\n"
#define STM_IMAGE_FILE_ID   "SxM Image file\n"
#define CITS_IMAGE_FILE_ID   "CITS Image file\n"
#define IMAGE_HEADER_GENERAL_INFO   "General Info"
#define IMAGE_HEADER_GENERAL_INFO_NUM_COLUMNS   "Number of columns"
#define IMAGE_HEADER_GENERAL_INFO_NUM_ROWS   "Number of rows"
#define IMAGE_HEADER_GENERAL_INFO_Z_AMPLITUDE   "Z Amplitude"
#define IMAGE_HEADER_GENERAL_INFO_ACQ_CHANNEL   "Acquisition channel"
#define IMAGE_HEADER_GENERAL_INFO_HEAD_TYPE   "Head type"
#define IMAGE_HEADER_GENERAL_INFO_POINTS_PER_IV   "Number of points per IV"
#define IMAGE_HEADER_GENERAL_INFO_I_AMPLITUDE   "Current Amplitude"
#define IMAGE_HEADER_GENERAL_INFO_LINES   "Number of lines"
#define IMAGE_HEADER_GENERAL_INFO_POINTS   "Number of points"
#define IMAGE_HEADER_GENERAL_INFO_X_TEXT   "X axis text"
#define IMAGE_HEADER_GENERAL_INFO_X_UNIT   "X axis unit"
#define IMAGE_HEADER_GENERAL_INFO_Y_TEXT   "Y axis text"
#define IMAGE_HEADER_GENERAL_INFO_Y_UNIT   "Y axis unit"
#define IMAGE_HEADER_MISC_INFO   "Miscellaneous"
#define IMAGE_HEADER_MISC_INFO_MAXIMUM   "Maximum"
#define IMAGE_HEADER_MISC_INFO_MINIMUM   "Minimum"
#define IMAGE_HEADER_MISC_INFO_COMMENTS   "Comments"
#define IMAGE_HEADER_MISC_INFO_VERSION   "Version"
#define IMAGE_HEADER_MISC_INFO_FIRST   "First Forward"
#define IMAGE_HEADER_CONTROL   "Control"
#define IMAGE_HEADER_CONTROL_X_AMPLITUDE   "X Amplitude"
#define IMAGE_HEADER_CONTROL_Y_AMPLITUDE   "Y Amplitude"
#define IMAGE_HEADER_CONTROL_SET_POINT   "Set point"
#define IMAGE_HEADER_CONTROL_Z_GAIN   "Z Gain"
#define IMAGE_HEADER_CONTROL_BIAS   "Topography Bias"
#define IMAGE_HEADER_CONTROL_X_FREQUENCY   "X-Frequency"
#define IMAGE_HEADER_CONTROL_X_OFFSET   "X Offset"
#define IMAGE_HEADER_CONTROL_Y_OFFSET   "Y Offset"
#define IMAGE_HEADER_CONTROL_ROTATION   "Rotation"
#define IMAGE_HEADER_CONTROL_SCAN_DIRECTION   "Direction"
#define IMAGE_HEADER_HEADS   "Head Settings"
#define IMAGE_HEADER_HEADS_X_CALIBRATION   "X Calibration"
#define IMAGE_HEADER_HEADS_Y_CALIBRATION   "Y Calibration"
#define IMAGE_HEADER_HEADS_Z_CALIBRATION   "Z Calibration"
#define IMAGE_HEADER_HEADS_PREAMP_GAIN   "Preamp Gain"
#define IMAGE_HEADER_CURRENTIMAGE   "Current images bias list"
#define IMAGE_HEADER_CURRENTIMAGE_IMAGE   "Image"
#define IMAGE_HEADER_MAXMINSLIST   "maxmins list"

Typedefs

typedef typeHeader WSxM_HEADER

Functions

void HeaderInit (WSxM_HEADER *pHeader)
int HeaderRead (WSxM_HEADER *pHeader, FILE *pFile)
int HeaderWrite (WSxM_HEADER *pHeader, FILE *pFile)
int HeaderWrite (WSxM_HEADER *pHeader, FILE *pFile, gchar *gType)
double HeaderGetAsNumber (WSxM_HEADER *pHeader, char *szTitle, char *szLabel)
int HeaderGetAsString (WSxM_HEADER *pHeader, char *szTitle, char *szLabel, char *szValue)
void HeaderReadTitle (char *szLine, char *szTitle)
void HeaderReadLabel (char *szLine, char *szLabel)
void HeaderReadValue (char *szLine, char *szValue)
void HeaderSetAsFloating (WSxM_HEADER *pHeader, char *szTitle, char *szLabel, double lfValue)
void HeaderSetAsInt (WSxM_HEADER *pHeader, char *szTitle, char *szLabel, int iValue)
void HeaderSetAsString (WSxM_HEADER *pHeader, char *szTitle, char *szLabel, char *szValue)
void HeaderDestroy (WSxM_HEADER *pHeader)
int HeaderReadLine (WSxM_HEADER *pHeader, FILE *pFile)
int HeaderGetSize (WSxM_HEADER *pHeader)
int HeaderAddValue (WSxM_HEADER *pHeader, char *szTitle, char *szLabel, char *szValue)
void RemoveLeftAndRightWhitesFromString (char *szString)
void ReplaceStringInString (char *szDest, const char *szOld, const char *szNew)

Variables

FileIdStruc FileId []


Define Documentation

#define CITS_IMAGE_FILE_ID   "CITS Image file\n"
 

Definition at line 25 of file WSxM_header.h.

#define IMAGE_HEADER_CONTROL   "Control"
 

Definition at line 52 of file WSxM_header.h.

#define IMAGE_HEADER_CONTROL_BIAS   "Topography Bias"
 

Definition at line 57 of file WSxM_header.h.

#define IMAGE_HEADER_CONTROL_ROTATION   "Rotation"
 

Definition at line 61 of file WSxM_header.h.

#define IMAGE_HEADER_CONTROL_SCAN_DIRECTION   "Direction"
 

Definition at line 62 of file WSxM_header.h.

#define IMAGE_HEADER_CONTROL_SET_POINT   "Set point"
 

Definition at line 55 of file WSxM_header.h.

#define IMAGE_HEADER_CONTROL_X_AMPLITUDE   "X Amplitude"
 

Definition at line 53 of file WSxM_header.h.

#define IMAGE_HEADER_CONTROL_X_FREQUENCY   "X-Frequency"
 

Definition at line 58 of file WSxM_header.h.

#define IMAGE_HEADER_CONTROL_X_OFFSET   "X Offset"
 

Definition at line 59 of file WSxM_header.h.

#define IMAGE_HEADER_CONTROL_Y_AMPLITUDE   "Y Amplitude"
 

Definition at line 54 of file WSxM_header.h.

#define IMAGE_HEADER_CONTROL_Y_OFFSET   "Y Offset"
 

Definition at line 60 of file WSxM_header.h.

#define IMAGE_HEADER_CONTROL_Z_GAIN   "Z Gain"
 

Definition at line 56 of file WSxM_header.h.

#define IMAGE_HEADER_CURRENTIMAGE   "Current images bias list"
 

Definition at line 70 of file WSxM_header.h.

#define IMAGE_HEADER_CURRENTIMAGE_IMAGE   "Image"
 

Definition at line 71 of file WSxM_header.h.

#define IMAGE_HEADER_END_TEXT   "Header end"
 

Definition at line 20 of file WSxM_header.h.

#define IMAGE_HEADER_GENERAL_INFO   "General Info"
 

Definition at line 27 of file WSxM_header.h.

#define IMAGE_HEADER_GENERAL_INFO_ACQ_CHANNEL   "Acquisition channel"
 

Definition at line 31 of file WSxM_header.h.

#define IMAGE_HEADER_GENERAL_INFO_HEAD_TYPE   "Head type"
 

Definition at line 32 of file WSxM_header.h.

#define IMAGE_HEADER_GENERAL_INFO_I_AMPLITUDE   "Current Amplitude"
 

Definition at line 35 of file WSxM_header.h.

#define IMAGE_HEADER_GENERAL_INFO_LINES   "Number of lines"
 

Definition at line 37 of file WSxM_header.h.

Referenced by writeIVs().

#define IMAGE_HEADER_GENERAL_INFO_NUM_COLUMNS   "Number of columns"
 

Definition at line 28 of file WSxM_header.h.

#define IMAGE_HEADER_GENERAL_INFO_NUM_ROWS   "Number of rows"
 

Definition at line 29 of file WSxM_header.h.

#define IMAGE_HEADER_GENERAL_INFO_POINTS   "Number of points"
 

Definition at line 38 of file WSxM_header.h.

Referenced by writeIVs().

#define IMAGE_HEADER_GENERAL_INFO_POINTS_PER_IV   "Number of points per IV"
 

Definition at line 34 of file WSxM_header.h.

#define IMAGE_HEADER_GENERAL_INFO_X_TEXT   "X axis text"
 

Definition at line 39 of file WSxM_header.h.

Referenced by writeIVs().

#define IMAGE_HEADER_GENERAL_INFO_X_UNIT   "X axis unit"
 

Definition at line 40 of file WSxM_header.h.

Referenced by writeIVs().

#define IMAGE_HEADER_GENERAL_INFO_Y_TEXT   "Y axis text"
 

Definition at line 41 of file WSxM_header.h.

Referenced by writeIVs().

#define IMAGE_HEADER_GENERAL_INFO_Y_UNIT   "Y axis unit"
 

Definition at line 42 of file WSxM_header.h.

Referenced by writeIVs().

#define IMAGE_HEADER_GENERAL_INFO_Z_AMPLITUDE   "Z Amplitude"
 

Definition at line 30 of file WSxM_header.h.

#define IMAGE_HEADER_HEADS   "Head Settings"
 

Definition at line 64 of file WSxM_header.h.

#define IMAGE_HEADER_HEADS_PREAMP_GAIN   "Preamp Gain"
 

Definition at line 68 of file WSxM_header.h.

#define IMAGE_HEADER_HEADS_X_CALIBRATION   "X Calibration"
 

Definition at line 65 of file WSxM_header.h.

#define IMAGE_HEADER_HEADS_Y_CALIBRATION   "Y Calibration"
 

Definition at line 66 of file WSxM_header.h.

#define IMAGE_HEADER_HEADS_Z_CALIBRATION   "Z Calibration"
 

Definition at line 67 of file WSxM_header.h.

#define IMAGE_HEADER_MAXMINSLIST   "maxmins list"
 

Definition at line 72 of file WSxM_header.h.

#define IMAGE_HEADER_MISC_INFO   "Miscellaneous"
 

Definition at line 44 of file WSxM_header.h.

#define IMAGE_HEADER_MISC_INFO_COMMENTS   "Comments"
 

Definition at line 47 of file WSxM_header.h.

#define IMAGE_HEADER_MISC_INFO_FIRST   "First Forward"
 

Definition at line 50 of file WSxM_header.h.

Referenced by writeIVs().

#define IMAGE_HEADER_MISC_INFO_MAXIMUM   "Maximum"
 

Definition at line 45 of file WSxM_header.h.

#define IMAGE_HEADER_MISC_INFO_MINIMUM   "Minimum"
 

Definition at line 46 of file WSxM_header.h.

#define IMAGE_HEADER_MISC_INFO_VERSION   "Version"
 

Definition at line 48 of file WSxM_header.h.

#define IMAGE_HEADER_SIZE_TEXT   "Image header size: "
 

Definition at line 19 of file WSxM_header.h.

#define IMAGE_HEADER_VERSION   "1.0 (April 2000)"
 

Definition at line 18 of file WSxM_header.h.

#define STM_IMAGE_FILE_ID   "SxM Image file\n"
 

Definition at line 24 of file WSxM_header.h.

#define TEXT_COPYRIGHT_NANOTEC   "WSxM file copyright Nanotec Electronica\n"
 

Definition at line 21 of file WSxM_header.h.

#define WSXM_MAXCHARS   1000
 

Definition at line 15 of file WSxM_header.h.


Typedef Documentation

typedef struct typeHeader WSxM_HEADER
 


Function Documentation

int HeaderAddValue WSxM_HEADER pHeader,
char *  szTitle,
char *  szLabel,
char *  szValue
 

Definition at line 713 of file WSxM_header.C.

References typeHeader::iNumFields, typeHeader::tszLabels, typeHeader::tszTitles, and typeHeader::tszValues.

void HeaderDestroy WSxM_HEADER pHeader  ) 
 

Definition at line 508 of file WSxM_header.C.

References typeHeader::iNumFields, typeHeader::tszLabels, typeHeader::tszTitles, and typeHeader::tszValues.

double HeaderGetAsNumber WSxM_HEADER pHeader,
char *  szTitle,
char *  szLabel
 

Definition at line 213 of file WSxM_header.C.

References HeaderGetAsString(), and WSXM_MAXCHARS.

int HeaderGetAsString WSxM_HEADER pHeader,
char *  szTitle,
char *  szLabel,
char *  szValue
 

Definition at line 244 of file WSxM_header.C.

References typeHeader::iNumFields, typeHeader::tszLabels, and typeHeader::tszTitles.

int HeaderGetSize WSxM_HEADER pHeader  ) 
 

Definition at line 638 of file WSxM_header.C.

References IMAGE_HEADER_SIZE_TEXT, typeHeader::iNumFields, STM_IMAGE_FILE_ID, TEXT_COPYRIGHT_NANOTEC, typeHeader::tszTitles, and WSXM_MAXCHARS.

void HeaderInit WSxM_HEADER pHeader  ) 
 

Definition at line 33 of file WSxM_header.C.

References typeHeader::iNumFields, typeHeader::tszLabels, typeHeader::tszTitles, and typeHeader::tszValues.

int HeaderRead WSxM_HEADER pHeader,
FILE *  pFile
 

Definition at line 66 of file WSxM_header.C.

References HeaderReadLine(), and typeHeader::iNumFields.

void HeaderReadLabel char *  szLine,
char *  szLabel
 

Definition at line 331 of file WSxM_header.C.

int HeaderReadLine WSxM_HEADER pHeader,
FILE *  pFile
 

Definition at line 558 of file WSxM_header.C.

References HeaderAddValue(), HeaderReadLabel(), HeaderReadTitle(), HeaderReadValue(), IMAGE_HEADER_END_TEXT, RemoveLeftAndRightWhitesFromString(), ReplaceStringInString(), and WSXM_MAXCHARS.

void HeaderReadTitle char *  szLine,
char *  szTitle
 

Definition at line 289 of file WSxM_header.C.

void HeaderReadValue char *  szLine,
char *  szValue
 

Definition at line 372 of file WSxM_header.C.

void HeaderSetAsFloating WSxM_HEADER pHeader,
char *  szTitle,
char *  szLabel,
double  lfValue
 

Definition at line 418 of file WSxM_header.C.

References HeaderSetAsString(), and WSXM_MAXCHARS.

void HeaderSetAsInt WSxM_HEADER pHeader,
char *  szTitle,
char *  szLabel,
int  iValue
 

Definition at line 447 of file WSxM_header.C.

References HeaderSetAsString(), and WSXM_MAXCHARS.

void HeaderSetAsString WSxM_HEADER pHeader,
char *  szTitle,
char *  szLabel,
char *  szValue
 

Definition at line 476 of file WSxM_header.C.

References typeHeader::iNumFields, typeHeader::tszLabels, typeHeader::tszTitles, and typeHeader::tszValues.

int HeaderWrite WSxM_HEADER pHeader,
FILE *  pFile,
gchar *  gType
 

Definition at line 221 of file WSxM_header.C.

References FileId, typeHeader::iNumFields, typeHeader::tszLabels, typeHeader::tszTitles, typeHeader::tszValues, and WSXM_MAXCHARS.

int HeaderWrite WSxM_HEADER pHeader,
FILE *  pFile
 

Definition at line 110 of file WSxM_header.C.

References typeHeader::iNumFields, typeHeader::tszLabels, typeHeader::tszTitles, typeHeader::tszValues, and WSXM_MAXCHARS.

void RemoveLeftAndRightWhitesFromString char *  szString  ) 
 

Definition at line 775 of file WSxM_header.C.

References WSXM_MAXCHARS.

void ReplaceStringInString char *  szDest,
const char *  szOld,
const char *  szNew
 

Definition at line 823 of file WSxM_header.C.

References WSXM_MAXCHARS.


Variable Documentation

FileIdStruc FileId[]
 

Definition at line 33 of file WSxM_header.C.

Referenced by HeaderWrite(), and main().


Generated on Sat Apr 1 09:04:52 2006 for GXSM by  doxygen 1.4.6