Manuals >Reference >IC-CAP Functions
Print version of this Book (PDF file)
prevnext

HPTFTCV_model_cgd

This function is obsolete.

Agilent A-Si:H TFT Gate to Drain Capacitance model. Calculates Cgd from voltages.

Input Arguments:

 

   Data Sets:

Drain V, Gate V, Source V

Output:

Gate to Drain C

Automatic Invocation:

None

HPTFTCV_model_cgs

This function is obsolete.

Agilent A-Si:H TFT Gate to Source Capacitance model. Calculates Cgs from voltages.

Input Arguments:

 

   Data Sets:

Drain V, Gate V, Source V

Output:

Gate to Source C

Automatic Invocation:

None

HPTFTDC_model_id

This function is obsolete.

Agilent A-Si:H TFT DC model. Calculates Id from voltages.

Input Arguments:

 

   Data Sets:

Drain V, Gate V, Source V

Output:

Drain I

Automatic Invocation:

None

HPTFTDC_lin

This function is obsolete.

Standard extraction for the Agilent a-Si TFT model. Extracts linear region parameters using Id versus Vg measured on a-Si TFT device.

Input Arguments:

 

   Data Sets:

Drain V, Gate V, Source V, Drain I

Output:

None

Extracts:

VTO, UO, PHI, THETA, NFS, GO

Automatic Invocation:

By Extract menu function

HPTFTDC_sat

This function is obsolete.

Standard extraction for the Agilent A-Si:H TFT model. Extracts saturation region parameters using Id versus Vd measured on a-Si:H TFT device.

Input Arguments:

 

   Data Sets:

Drain V, Gate V, Source V, Drain I

Output:

None

Extracts:

VMAX, ETA

Automatic Invocation:

By Extract menu function

i cdb_add_comment

Writes an arbitrary comment string to the opened file.

Syntax

x=icdb_add_comment(strVal)

Where

strVal

is an arbitrary string.

The return value (x) is undefined.

i cdb_close

Closes a file that has been opened with icdb_open.

Syntax

x=icdb_close()

Where

The return value (x) is not defined.

i cdb_export_data

Exports the measured or simulated data from the specified setup to the opened file. Header information containing current information about the values of the registered sweep parameters is automatically appended to the file.

Syntax

x=icdb_export_data(setupName,dataType)

Where

setupName

is a string giving a proper path to the setup that contains data to export.

dataType

exports simulated data if dataType is "S". Exports measured data for any other value, but "M" recommended.

The return value (x) is undefined.

i cdb_get_sweep_value

Returns the current value of the specified user sweep at any point in the export loop.

Syntax

curVal=icdb_get_sweep_value(index,swpName)

Where

index

is the point number requested

swpName

is the name of the registered sweep

i cdb_open

Opens a file for exporting measured data in IC-CAP's data management file format (.mdm).

Syntax

x=icdb_open(filename)

Where

filename

is a string pointing at the MDM file to be opened.

The return value (x) is not defined.

i cdb_register_con_sweep

Creates a CON type sweep of an arbitrary parameter in the exported file. Intended primarily to create sweeps of parameters that cannot be swept during a measurement. Returns the total number of points in all the registered sweeps.

Syntax

numPts=icdb_register_con_sweep(conValue,swpName)

Where

conValue

is the constant value to use for this con sweep

swpName

is the name of the 'User Input' as it will appear in the MDM file, or how it will be referenced when reading the MDM back in

i cdb_register_lin_sweep

Creates a LIN type sweep of an arbitrary parameter in the exported file. Intended primarily to create sweeps of parameters that cannot be swept during a measurement. Returns the total number of points in all the registered sweeps.

Syntax

numPts=icdb_register_lin_sweep(swpOrder,start,stop,
numSwpPts,swpName)

Where

swpOrder

is the sweep order for the registered sweep

start

is the start value for the linear sweep

stop

is the stopping value for the linear sweep

numSwpPts

is the number of points for this sweep

swpName

is the name of the 'User Input' as it will appear in the MDM file, or how it will be referenced when reading the MDM back in

i cdb_register_list_sweep

Creates a LIST type sweep of an arbitrary parameter in the exported file. Intended primarily to create sweeps of parameters that cannot be swept during a measurement. Returns the total number of points in all the registered sweeps.

Syntax

numPts=icdb_register_list_sweep(swpOrder,swpName,
arrayName)

Where

swpOrder

is the sweep order for the registered sweep

swpName

is the name of the 'User Input' as it will appear in the MDM file, or how it will be referenced when reading the MDM back in

arrayName

is a string naming a variable in a Variable table that has been set to an ICCAP_ARRAY[]. This array declares the points that will be used for the list sweep.

icdb_register_lsync_sweep

Creates an LSYNC type sweep of an arbitrary parameter in the exported file. Intended primarily to create sweeps of parameters that cannot be swept during a measurement. Returns the total number of points in all registered sweeps.

Syntax

numPts=icdb_register_lsync_sweep(swpName,masterSweepName, arrayName)

Where

swpName

is the name of the 'User Input' as it will appear in the MDM file, or how it will be referenced when reading the MDM back in.

masterSweepName

is the name of a previously registered sweep to which this sweep will be synchronized.

arrayName

is a string naming a variable in a Variable table that has been set to an ICCAP_ARRAY[]. This array declares the points that will be used for the list sweep. This array should have the same number of points as the already registered Master Sweep.

i cdbf_add_comment

Writes an arbitrary comment string to the opened file.

Syntax

x=icdbf_add_comment(fNum,strVal)

Where

fNum

is the number returned from an icdbf_open() call.

strVal

is an arbitrary string.

The return value (x) is undefined.

i cdbf_close

Closes a file that has been opened with icdbf_open.

Syntax

x=icdbf_close(fNum)

Where

fNum

is the number returned from an icdbf_open() call.

The return value (x) is not defined.

i cdbf_export_data

Exports the measured or simulated data from the specified setup to the opened file. Header information containing current information about the values of the registered sweep parameters is automatically appended to the file.

Syntax

x=icdbf_export_data(fNum,setupName,dataType)

Where

fNum

is the number returned from an icdbf_open() call.

setupName

is a string giving a proper path to the setup that contains data to export.

dataType

exports simulated data if dataType is "S". Exports measured data for any other value, but "M" recommended.

The return value (x) is undefined.

i cdbf_get_sweep_value

Returns the current value of the specified user sweep at any point in the export loop.

Syntax

curVal=icdbf_get_sweep_value(fNum,index,swpName)

Where

fNum

is the number returned from an icdbf_open() call.

index

is the point number requested

swpName

is the name of the registered sweep

i cdbf_open

Opens a file for exporting measured data in IC-CAP's data management file format (.mdm).

Syntax

fNum=icdbf_open(filename)

Where

filename

is a string pointing at the MDM file to be opened.

The return value (fNum) is a unique number associated with this file. This number is valid during the current run of PEL or until icdbf_close is called.

i cdbf_register_con_sweep

Creates a CON type sweep of an arbitrary parameter in the exported file. Intended primarily to create sweeps of parameters that cannot be swept during a measurement. Returns the total number of points in all the registered sweeps.

Syntax

numPts=icdbf_register_lin_sweep(fNum,conValue,swpName)

Where

fNum

is the number returned from an icdbf_open() call.

conValue

is the constant value to use for this con sweep

swpName

is the name of the 'User Input' as it will appear in the MDM file, or how it will be referenced when reading the MDM back in

icdbf_register_lin_sweep

Creates a LIN type sweep of an arbitrary parameter in the exported file. Intended primarily to create sweeps of parameters that cannot be swept during a measurement. Returns the total number of points in all the registered sweeps.

Syntax

numPts=icdbf_register_lin_sweep(fNum,swpOrder,start,stop,
numSwpPts,swpName)

Where

fNum

is the number returned from an icdbf_open() call.

swpOrder

is the sweep order for the registered sweep

start

is the start value for the linear sweep

stop

is the stopping value for the linear sweep

numSwpPts

is the number of points for this sweep

swpName

is the name of the 'User Input' as it will appear in the MDM file, or how it will be referenced when reading the MDM back in

i cdbf_register_list_sweep

Creates a LIST type sweep of an arbitrary parameter in the exported file. Intended primarily to create sweeps of parameters that cannot be swept during a measurement. Returns the total number of points in all the registered sweeps.

Syntax

numPts=icdbf_register_list_sweep(fNum,swpOrder,swpName,arrayName)

Where

fNum

is the number returned from an icdbf_open() call.

swpOrder

is the sweep order for the registered sweep

swpName

is the name of the 'User Input' as it will appear in the MDM file, or how it will be referenced when reading the MDM back in

arrayName

is a string naming a variable in a Variable table that has been set to an ICCAP_ARRAY[]. This array declares the points that will be used for the list sweep.

icdbf_register_lsync_sweep

Creates an LSYNC type sweep of an arbitrary parameter in the exported file. Intended primarily to create sweeps of parameters that cannot be swept during a measurement. Returns the total number of points in all the registered sweeps.

Syntax

numPts=icdbf_register_lsync_sweep(fNum,swpName, masterSweepName,arrayName)

Where

fNum

is the number returned from an icdbf_open() call.

swpName

is the name of the 'User Input' as it will appear in the MDM file, or how it will be referenced when reading the MDM back in.

masterSweepName

is the name of a previously registered sweep to which this sweep will be synchronized.

arrayName

is a string naming a variable in a Variable table that has been set to an ICCAP_ARRAY[]. This array declares the points that will be used for the list sweep. This array should have the same number of points as the already registered Master Sweep.

ICMSarray

Returns an array result from an IC-CAP Macro algorithm to the IC-MS result array during test execution. This function is used internally by IC-MS and should never be called directly by the user.

Input Arguments:

 

   Data Sets:

Array Result

   Reals or Integers:

Array Size, Result Data Index

Output:

None

Automatic Invocation:

None

ICMSchar

Returns a single character result from an IC-CAP Macro algorithm to the IC-MS result array during test execution. This function is used internally by IC-MS and should never be called directly by the user.

Input Arguments:

 

   Reals or Integers:

Result Data Index

   Strings/Pars/Vars:

Character Result

Output:

None

Automatic Invocation:

None

ICMSint

Returns an integer result from an IC-CAP Macro algorithm to the IC-MS result array during test execution. This function is used internally by IC-MS and should never be called directly by the user.

Input Arguments:

 

   Reals or Integers:

Integer Result, Result Data Index

Output:

None

Automatic Invocation:

None

ICMSpin

Used in an IC-CAP Macro to determine the matrix connections of the device under test. ICMSpin returns the matrix pin number that corresponds to a specified terminal index on the device. This function only returns valid data when IC-MS test execution is running. Refer to the IC-MS User's Manual for more information on using ICMSpin.

Input Arguments:

 

   Reals or Integers:

Terminal Index

Output:

Matrix pin number corresponding to the specified device terminal index

Automatic Invocation:

None

Example PEL Statement:

pin_num = ICMSpin(1)
ICMSreal

Returns a floating point result from an IC-CAP Macro algorithm to the IC-MS result array during test execution. This function is used internally by IC-MS and should never be called directly by the user.

Input Arguments:

 

   Reals or Integers:

Real Result, Result Data Index

Output:

None

Automatic Invocation:

None

ICMSstr

Returns a character string result from an IC-CAP Macro algorithm to the IC-MS result array during test execution. This function is used internally by IC-MS and should never be called directly by the user.

Input Arguments:

 

   Result Data Index:

String Result

Output:

None

Automatic Invocation:

None

icstat_activate

Activates a deactivated row or column in the PARAMETERS spreadsheet.

Synopsis:

icstat_activate(<Number>, <Mode>)

Arguments:

 

   Number:

Row or column number to be activated

   Mode:

"ROW" or "COLUMN"

Example:

retVal = icstat_activate(4, "ROW")
return
icstat_analysis

Emulates the Analysis command on the Analysis menu. This function generates the "active data" that is, data devoid of the attribute, deactivated, filtered and constant values column. Displays the results in the ANALYSIS spreadsheet.

Synopsis:

icstat_analysis()

Arguments:

NONE

Example:

retVal = icstat_analysis()
return
icstat_attribute_2_parameter

Changes the Attribute column to a Parameters column in the PARAMETERS spreadsheet.

Synopsis:

icstat_attribute_2_parameter (<Number>)

Arguments:

Number: attribute column number to be changed to parameter type

Example:

retVal = icstat_attribute_2_parameter(4)
return
icstat_clear

Clears rows or columns in the PARAMETERS spreadsheet.

Synopsis:

icstat_clear(<Start>, <Number>, <Mode>)

Arguments:

 

   Start Row/Column number

Row or column from which to clear

   Number of rows/columns

Number of rows/columns to be cleared

Mode:

"ROW" or "COLUMN"

Example (clears 4 rows from the 4th row onward):

retVal = icstat_clear(4, 4, "ROW")
return
icstat_close_sdf_file

Closes the SDF file.

Synopsis:

icstat_close_sdf_file(<Filename>)

Arguments:

 

   Filename:

Name of the SDF file to close.

Example:

retVal = icstat_close_sdf_file ("/tmp/examples/icstat/bsim3.sdf")
return
icstat_correlation

Emulates the Correlation command on the Analysis menu. This function generates the correlation matrix from the data in the PARAMETERS spreadsheet. Displays the results in the CORRELATION spreadsheet.

Synopsis:

icstat_correlation()

Argument:

NONE

Example:

retVal = icstat_correlation()
return
icstat_deactivate

Deactivates an activated row or column in the PARAMETERS spreadsheet.

Synopsis:

icstat_deactivate(<Number>, <Mode>)

Input Arguments:

 

   Number:

Row or column number to be deactivated

   Mode:

"ROW" or "COLUMN"

Example:

retVal = icstat_deactivate(4, "ROW")
return
icstat_delete

Deletes rows or columns in the PARAMETERS spreadsheet.

Synopsis:

icstat_delete(<Start>, <Number>, <Mode>)

Arguments:

 

   Start Row/Column number

Row or column from which to delete

   Number of rows/columns

Number of rows/columns to be deleted

Mode:

"ROW" or "COLUMN"

Example (deletes 4 rows from the 4th row onward):

retVal = icstat_delete(4, 4, "ROW")
return
icstat_equations

Emulates the Equations command on the Analysis menu. This function either generates the equations from the factors or the parameters. The results are displayed in the respective spreadsheets: FACTOR EQUATIONS or PARAMETER EQUATIONS.

Synopsis:

icstat_equations(<Type>)

Arguments:

 

   Type:

Either FACTORS or DOMINANT

Example:

retVal = icstat_equations("FACTORS")
return
icstat_exit

Exits the Statistical Analysis program.

Synopsis:

icstat_exit()

Arguments:

None

Example:

retVal = icstat_exit()
return
icstat_factor_analysis

Emulates the Factor Analysis command on the Analysis menu. This function performs the factor analysis. The results are displayed in the FACTOR LOADINGS and PARAMETER VARIANCE spreadsheets.

Synopsis:

icstat_factor_analysis(<Number-of-factors>, <Method-index>, <Rotation-Index>, <Maximum Iterations>, <Maximum Steps>, <Convergence Iteration>, <Convergence - 2nd derivative>

Arguments:

 

   Number of factors:

Number of factors

   Method Index:

0 = Principal Component
1 = Principal Factor
2 = Unweighted Least Squares

Rotation Index:

0 = Varimax
1 = Quartimax
2 = Equamax
3 = None

Maximum Iterations:

Maximum number of iterations
(default = 30)

Maximum Steps:

Maximum number of steps
(default = 8)

Convergence Iteration:

Convergence criterion iterations
(default = 0.0001)

Convergence
   2nd derivative


Convergence criterion
2nd derivative (default = 0.1)

Example:

retVal = icstat_factor_analysis(8, 0, 0, 30, 8, 0.0001,
                                0.1)
return
icstat_from_partable

Updates the PARAMETERS spreadsheet with values from the Parameters table. If a particular spreadsheet parameter is not found in the Parameters table or the Parameters table parameter is not found in the spreadsheet, then the value is not updated.

Synopsis:

icstat_from_partable(<Number>, <Path>, <From Parameter Table>)

Arguments:

 

   Row Number:

Row number to get the data from

   Path:

The name of the model or DUT from which you want to get parameters. Specify <"model_name"> to get parameters from the Model Parameters table; specify <"model_name/DUT_name"> to get parameters from the DUT Parameters table.
(To specify the current DUT, "." is sufficient.)

   From:

Specify 1 of the following parameter tables from which to get the data: "MODEL PARAMETERS", "DUT PARAMETERS"
If left blank, "MODEL PARAMETERS" is used.

Example:

retVal = icstat_from_partable(2, "/CGaas1", "MODEL 
                              PARAMETERS")
return
icstat_get_attribute_columns

Returns an array of attribute column numbers in the PARAMETERS spreadsheet.

Synopsis:

icstat_get_attribute_columns(<input-array>)

Arguments:

 

   Input:

Array containing the values to be returned

Example:

arrSize = icstat_num_attributes()
          complex colArr[arrSize]
retArr = icstat_get_attribute_columns(colArr)
PRINT retArr
icstat_get_cell

Returns the values in the cell. If the cell contains text, a 0 is returned. Note: To get cells with text, use the icstat_get_text_cell function. To get values from a large number of cells, use icstat_get_column or icstat_get_row.

Synopsis:

icstat_get_cell(<row-number>, <column-number>, <Spreadsheet-name>)

Arguments:

 

   Row Number:

Integer

   Column Number:

Integer

   Spreadsheet Name:

One of the Spreadsheet Names

Spreadsheet Names:

PARAMETERS, ANALYSIS, STATSUMM, CORRELATION, FACTOR LOADINGS, PARAMETER VARIANCE, FACTOR EQUATIONS, PARAMETER EQUATIONS, PARAMETRIC, NON PARAMETRIC

Example:

rCell = icstat_get_cell(8, 8, "PARAMETERS")
PRINT rCell
return
icstat_get_column

Returns the values in the column. If the cell contains text, a 0 is returned. Typically the first column for any spreadsheet is of string type. For the PARAMETERS spreadsheet, the values returned include the deactivated and filtered cells.

Synopsis:

icstat_get_column(<Input-array>,
<Column number>, <Spreadsheet Name>)

Arguments:

 

   Input:

Array for the returned value

   Column Number:

Integer

   Spreadsheet Name:

One of the Spreadsheet Names

Spreadsheet Names:

PARAMETERS, ANALYSIS, STATSUMM, CORRELATION, FACTOR LOADINGS, PARAMETER VARIANCE, FACTOR EQUATIONS, PARAMETER EQUATIONS, PARAMETRIC, NON PARAMETRIC

Example:

arrSize = icstat_num_rows("PARAMETERS")
          complex colArr[arrSize]
retArr = icstat_get_column(colArr, 7, "PARAMETERS")
PRINT retArr
icstat_get_deactivated

Returns an array of deactivated rows or columns in the PARAMETERS spreadsheet.

Synopsis:

icstat_get_deactivated(<input-array>, <Mode>)

Arguments:

 

   Input:

Array containing the values to be returned

   Mode:

"ROW" or "COLUMN"

  

Example:

arrSize = icstat_num_deactivated("ROW")
          complex rowArr[arrSize]
retArr = icstat_get_deactivated(rowArr, "ROW")
PRINT retArr
icstat_get_filtered_rows

Returns an array of filtered rows in the PARAMETERS spreadsheet.

Synopsis:

icstat_get_filtered_rows (<input-array>)

Arguments:

 

   Input:

Array containing the values to be returned

Example:

arrSize = icstat_num_filtered()
          complex rowArr[arrSize]
retArr = icstat_get_filtered_rows(rowArr)
PRINT retArr
icstat_get_row

Returns the values in the row. If any cells contain text, a 0 is returned. Typically the first column for any spreadsheet contain labels, that is, text. For the PARAMETERS spreadsheet, the first several columns could be attribute parameters that is, text. The function excludes the cells in these columns, and returns only real values.

Synopsis:

icstat_get_row(<Input-array>, <Number>, <Spreadsheet Name>)

Arguments:

 

   Input:

Array for the returned value

   Row Number

Integer

   Spreadsheet Name:

One of the Spreadsheet Names

Spreadsheet Names:

PARAMETERS, ANALYSIS, STATSUMM, CORRELATION, FACTOR LOADINGS, PARAMETER VARIANCE, FACTOR EQUATIONS, PARAMETER EQUATIONS, PARAMETRIC, NON PARAMETRIC

  

Example:

iNumAttribs = icstat_num_attributes()
iNumCols = icstat_num_columns("PARAMETERS")
iNumCells = iNumCols - iNumAttribs
            complex rowArr[iNumCells]
retArr = icstat_get_row(rowArr, 4, "PARAMETERS")
PRINT retArr
icstat_get_text_cell

Gets the text in the specified cell and sets the referenced variable with the text.

Synopsis:

icstat_get_text_cell(<Row-Number>, <Column-Number>, <Spreadsheet Name>, <Variable Name>)

Arguments:

 

   Row Number

Integer

   Column Number:

Integer

   Spreadsheet Name:

One of the Spreadsheet Names

   Variable Name:

Variable name from the variable table

Spreadsheet Names:

PARAMETERS, ANALYSIS, STATSUMM, CORRELATION, FACTOR LOADINGS, PARAMETER VARIANCE, FACTOR EQUATIONS, PARAMETER EQUATIONS, PARAMETRIC, NON PARAMETRIC

Example:

sString = "Hi, I am a string" 
dummy = icstat_set_text_cell(2, 1, sString)
dummy = icstat_get_text_cell(2, 2, "PARAMETERS", "CELLVAL")
PRINT CELLVAL
return
icstat_insert

Insert rows or columns in the PARAMETERS spreadsheet.

Synopsis:

icstat_insert(<Start>, <Number>, <Mode>)

Arguments:

 

Start Row/Column number

Row or column from which to insert

Number of rows/columns

Number of rows/columns to be inserted

Mode

"ROW" or "COLUMN"

Example (inserts 4 rows from the 4th row onward):

retVal = icstat_insert(4, 4, "ROW")
return
icstat_nonparametric_models

Emulates the non-parametric analysis function.

Synopsis:

icstat_nonparametric_models(<Boundary Points>, <% Enclosed>, <Diversity Oversampling>, <Density Estimator %>, <Distance Metric>)

Arguments:

 

   Number of Boundary
      Points:

Number of boundary models (integer)

   Percent Enclosed:

Integer

   Diversity Oversampling:

Real number

   Density Estimator %:

Integer

   Distance Metric:

"EUCLIDEAN" or "L_1" or "L_INFINITY"

Example:

retVal = icstat_open()
retVal = icstat_open_sdf_file
         ("/tmp/examples/icstat/bsim3.sdf")
retVal = icstat_nonparametric_models(8, 80, 2, 98, "EUCLIDEAN")
return

prevnext