ImportExport Class Reference

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Collection of static support functions for export and import of data fields. More...

Static Public Member Functions
static void	ExportASCII (ComplexAmplitude ca, ASCIIParam param)
	Exports given globally polarized ComplexAmplitude to text file. Note that only a real component of complex amplitude is stored. For complete export of complex amplitude use ExportPTF.
static void	ExportBitmap (ComplexAmplitude complexAmplitude, string fileName, ColorMapping colorMapping)
	Exports the given ComplexAmplitude as Bitmap with given ColorMapping.
static ComplexAmplitude	ImportASCII (ASCIIParam importASCIIParam)
	Imports an ASCII file into an ComplexAmplitude.
static ComplexAmplitude	ImportASCII (ASCIIParam importASCIIParam, AdditionalCAImportParams additionalParams)
	Imports an ASCII file into an ComplexAmplitude.
static ComplexField	ImportASCII (string fileName, char columnSeparator=' ', char decimalSeparator='.', PrecisionMode precisionMode=PrecisionMode.Double)
	Imports an ASCII file into a ComplexField.
static ComplexAmplitude	ImportBitmapQuantizedHeightProfile (string fileName, double heightIncrement, bool invert, bool importGDSII, SamplingParameters samplingForGDSII)
	Imports a quantized bitmap into a ComplexAmplitude representing the height profile.
static ComplexAmplitude	ImportBitmapQuantizedHeightProfile (string[] fileNames, double heightIncrement, int numberOfLayers, bool invert, bool importGDSII, SamplingParameters samplingForGDSII)
	Imports a quantized bitmap into a ComplexAmplitude representing the height profile.

Static Public Attributes
const string	SamplingDistanceStringInHeader
	String to indicate the sampling distance information in the text file header.
const string	WavelengthStringInHeader
	String to indicate the wavelength information in the text file header.

Detailed Description

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Collection of static support functions for export and import of data fields.

Member Function Documentation

ExportASCII()

static void ExportASCII ( ComplexAmplitude ca, ASCIIParam param )

static

Exports given globally polarized ComplexAmplitude to text file. Note that only a real component of complex amplitude is stored. For complete export of complex amplitude use ExportPTF.

Parameters

ca	ComplexAmplitude to be exported.
param	Additional parameters for export.

ExportBitmap()

static void ExportBitmap ( ComplexAmplitude complexAmplitude, string fileName, ColorMapping colorMapping )

static

Exports the given ComplexAmplitude as Bitmap with given ColorMapping.

Parameters

complexAmplitude	ComplexAmplitude to be exported.
colorMapping	ColorMapping to be applied.
fileName	Filename of exported image.

ImportASCII() [1/3]

static ComplexAmplitude ImportASCII ( ASCIIParam importASCIIParam )

static

Imports an ASCII file into an ComplexAmplitude.

Parameters

importASCIIParam

Contains all necessary parameters to import.

Returns

Imported ComplexAmplitude.

ImportASCII() [2/3]

static ComplexAmplitude ImportASCII ( ASCIIParam importASCIIParam, AdditionalCAImportParams additionalParams )

static

Imports an ASCII file into an ComplexAmplitude.

Parameters

importASCIIParam	Contains all necessary parameters to import.
additionalParams	Additional parameters for interpretation of imported data.

Returns

Imported ComplexAmplitude.

ImportASCII() [3/3]

static ComplexField ImportASCII ( string fileName, char columnSeparator = ' ', char decimalSeparator = '.', PrecisionMode precisionMode = PrecisionMode::Double )

static

Imports an ASCII file into a ComplexField.

Parameters

fileName	The name of the file to import.
columnSeparator	Optional parameter giving the column separator. Default value is a space.
decimalSeparator	Optional parameter giving the decimal parameter. Default value is a dot.
precisionMode	Optional parameter giving the precision mode of the imported field. Default is double precision.

Returns

The imported data as a ComplexField.

ImportBitmapQuantizedHeightProfile() [1/2]

static ComplexAmplitude ImportBitmapQuantizedHeightProfile ( string fileName, double heightIncrement, bool invert, bool importGDSII, SamplingParameters samplingForGDSII )

static

Imports a quantized bitmap into a ComplexAmplitude representing the height profile.

Parameters

fileName	Name of the file.
heightIncrement	Needs number of quantization levels for proper calculation of phase
invert	if set to true invert the layers.
importGDSII	if set to true import GDSII.
samplingForGDSII	The sampling parameters imported from the XML file. Used to ease the GDSII import.

Returns

The imported ComplexAmplitude.

ImportBitmapQuantizedHeightProfile() [2/2]

static ComplexAmplitude ImportBitmapQuantizedHeightProfile ( string[] fileNames, double heightIncrement, int numberOfLayers, bool invert, bool importGDSII, SamplingParameters samplingForGDSII )

static

Imports a quantized bitmap into a ComplexAmplitude representing the height profile.

Parameters

fileNames	array of file names
heightIncrement	Needs number of quantization levels for proper calculation of phase
numberOfLayers	The number of layers.
invert	if set to true invert the layers.
importGDSII	if set to true import GDSII.
samplingForGDSII	The sampling parameters imported from the XML file. Used to ease the GDSII import.

Returns

The imported ComplexAmplitude.