API Functions

This section lists the API functions.

Sample

These functions allow setting and getting the Sample properties.

Variable NFSetSample(Variable sampleId, String substrateType, String resistType, Variable resistThickness_nm)

Parameters
  • sampleId -

    Sample id

  • substrateType -

    Must be "Silicon" or "Other"

  • resistType -

    Must be "PPA", "Molecular Glass" or "Other"

  • resistThickness_nm -

    Resist thickness in nanometers

Variable NFGetSampleId()
String NFGetSampleSubstrateType()
String NFGetSampleResistType()
Variable NFGetSampleResistThickness()

Cantilever

These functions allow setting and getting the Cantilever properties.

Variable NFSetCantilever(Variable cantileverId, String cantileverType, Variable tipHeight_nm, Variable tipContactRadius_nm, Variable tipOpeningAngle)

Parameters
  • cantileverId -

    Cantilever id

  • cantileverType -

    Must be "standard"

  • tipHeight_nm -

    Tip height in nanometers

  • tipContactRadius_nm -

    Tip contact radius in nanometers

  • tipOpeningAngle -

    Tip opening angle

Variable NFGetCantileverId()
String NFGetCantileverType()
Variable NFGetCantileverTipHeight()
Variable NFGetCantileverTipContactRadius()
Variable NFGetCantileverTipOpeningAngle()

IV Curve

These functions allow setting and getting the IV Curve parameters.

String NFGetIVCurveStatus()
Variable NFSetIVCurveVoltages(String channel, Variable vMin, Variable vMax, Variable vStep)

Parameters
  • channel -

    Must be "W" for writer or "R" for reader

  • vMin -

    Minimum voltage

  • vMax -

    Maximum voltage

  • vStep -

    Voltage step

String NFGetIVCurveChannel()
Variable NFGetIVCurveMinV()
Variable NFGetIVCurveMaxV()
Variable NFGetIVCurveStepV()
Variable NFSetIVCurveHeight(Variable cantileverHeight_nm)

Parameters
  • cantileverHeight_nm -

    Cantilever height above sample surface in nanometers

Variable NFGetIVCurveHeight()
Variable NFSetIVCurveTempo(Variable iterTime_us)

Parameters
  • iterTime_us -

    Iteration time in microseconds

Variable NFGetIVCurveTempo()

Prep Sensors

These functions allow setting and getting the Cantilever Sensors parameters.

String NFGetPrepSensorsStatus()
Variable NFSetPrepSensorsReaderV(Variable readerVoltage)

Parameters
  • readerVoltage -

    Reader voltage

Variable NFSetPrepSensorsWriterV(Variable writerVoltage)

Parameters
  • writerVoltage -

    Writer voltage

Variable NFGetPrepSensorsReaderV()
Variable NFGetPrepSensorsWriterV()
Variable NFGetPrepSensorsReaderAmp1V()
Variable NFGetPrepSensorsReaderAmp2V()

Piezo Approach

These functions allow setting and getting the Piezo Approach parameters.

String NFGetApproachPiezoStatus()
Variable NFSetApproachPiezoRange(Variable min_um, Variable max_um, Variable step_nm)

Parameters
  • min_um -

    Starting extension in micrometers

  • max_um -

    Maximum extension in micrometers

  • step_nm -

    Step size in nanometers

Variable NFGetApproachPiezoMin()
Variable NFGetApproachPiezoMax()
Variable NFGetApproachPiezoStep()
Variable NFSetApproachPiezoTempo(Variable iterTime_us)

Parameters
  • iterTime_us -

    Iteration time in microseconds

Variable NFGetApproachPiezoTempo()

Image Importer

These functions allow setting and getting the Image Import parameters.

Variable NFOpenImage(String imageFile)

Parameters
  • imageFile -

    Path to image file

Variable NFLoadImageField(Variable fieldId)

Parameters
  • fieldId -

    Field id

Variable NFSetImageInvert(Variable invertImage)

Parameters
  • invertImage -

    Invert image

Variable NFGetImageInvert()
Variable NFSetImageFlip(Variable flipHorizontally, Variable flipVertically)

Parameters
  • flipHorizontally -

    Flip image horizontally

  • flipVertically -

    Flip image vertically

Variable NFGetImageFlipHorizontally()
Variable NFGetImageFlipVertically()
Variable NFSetImageRotate(Variable rotateImage, Variable rotationAngle)

Parameters
  • rotateImage -

    Rotate image

  • rotationAngle -

    Rotation angle in degrees

Variable NFGetImageRotate()
Variable NFGetImageRotationAngle()
Variable NFSetImageQuantize(Variable quantizeImage, Variable quantizationLevels)

Parameters
  • quantizeImage -

    Quantize image

  • quantizationLevels -

    Number of quantization levels

Variable NFGetImageQuantize()
Variable NFGetImageQuantizationLevels()
Variable NFSetImageRescale(Variable rescaleImage, Variable rescaleFactorX, Variable rescaleFactorY)

Parameters
  • rescaleImage -

    Rescale image

  • rescaleFactorX -

    Rescale factor in X

  • rescaleFactorY -

    Rescale factor in Y

Variable NFGetImageRescale()
Variable NFGetImageRescaleFactorX()
Variable NFGetImageRescaleFactorY()
Variable NFSetImageCrop(Variable cropImage, Variable originX, Variable originY, Variable dimX, Variable dimY)

Parameters
  • cropImage -

    Crop image

  • originX -

    X origin in pixels

  • originY -

    Y origin in pixels

  • dimX -

    X dimension in pixels

  • dimY -

    X dimension in pixels

Variable NFSetImageFieldSize(Variable stepX_nm, Variable stepY_nm)

Parameters
  • stepX_nm -

    X step size in nanometers

  • stepY_nm -

    Y step size in nanometers

Variable NFGetImageFieldStepX()
Variable NFGetImageFieldStepY()
Variable NFSetImageFieldOrientation(Variable rotationAngle)

Parameters
  • rotationAngle -

    Field orientation in degrees

Variable NFGetImageFieldOrientation()
Variable NFSetImageFieldDepths(Variable excludeWhitePixels, Variable depthMin, Variable depthMax)

Parameters
  • excludeWhitePixels -

    Exclude white pixels

  • depthMin -

    Minimum depth in nanometers

  • depthMax -

    Maximum depth in nanometers

Variable NFGetImageFieldExcludeWhite()
Variable NFGetImageFieldDepthMin()
Variable NFGetImageFieldDepthMax()
WAVE NFGetImageFieldRef()

GDS Importer

These functions allow setting and getting the GDS Import parameters.

Variable NFOpenGds(String gdsFile)

Parameters
  • gdsFile -

    Path to GDS file

Variable NFLoadGdsField(Variable fieldId)

Parameters
  • fieldId -

    Field id

Variable NFSetGdsFieldSize(Variable stepX_nm, Variable stepY_nm)

Parameters
  • stepX_nm -

    X step size in nanometers

  • stepY_nm -

    Y step size in nanometers

Variable NFGetGdsFieldStepX()
Variable NFGetGdsFieldStepY()
Variable NFSetGdsFieldOrientation(Variable rotationAngle)

Parameters
  • rotationAngle -

    Field orientation in degrees

Variable NFGetGdsFieldOrientation()
Variable NFSetGdsCrop(Variable cropGds, Variable roiOriginX_um, Variable roiOriginY_um, Variable roiSizeX_um, Variable roiSizeY_um)

Parameters
  • cropGds -

    Crop GDS

  • roiOriginX_um -

    X origin in um

  • roiOriginY_um -

    Y origin in um

  • roiSizeX_um -

    X size in um

  • roiSizeY_um -

    Y size in um

Variable NFGetGdsCrop()
Variable NFGetGdsRoiOriginX_um()
Variable NFGetGdsRoiOriginY_um()
Variable NFGetGdsRoiSizeX_um()
Variable NFGetGdsRoiSizeY_um()
Variable NFSetGdsFieldDepths(String layerDepths)

Parameters
  • layerDepths -

    Depth of each GDS layer in the format "{layerId: depth, ...}"

String NFGetGdsFieldDepths()
Variable NFGetGdsSizeX_um()
Variable NFGetGdsSizeY_um()
WAVE NFGetGdsFieldRef()

Layout

These functions allow getting the Layout parameters.

Variable NFGetFieldSizeX(Variable fieldId)

Parameters
  • fieldId -

    Field id

Variable NFGetFieldSizeY(Variable fieldId)

Parameters
  • fieldId -

    Field id

Variable NFGetFieldDimX(Variable fieldId)

Parameters
  • fieldId -

    Field id

Variable NFGetFieldDimY(Variable fieldId)

Parameters
  • fieldId -

    Field id

Variable NFGetFieldStepX(Variable fieldId)

Parameters
  • fieldId -

    Field id

Variable NFGetFieldStepY(Variable fieldId)

Parameters
  • fieldId -

    Field id

Variable NFGetFieldOrientation(Variable fieldId)

Parameters
  • fieldId -

    Field id

Variable NFGetFieldNumDepthLevels(Variable fieldId)

Parameters
  • fieldId -

    Field id

Variable NFGetNewFieldId()
Variable NFFieldExists(Variable fieldId)

Parameters
  • fieldId -

    Field id

Variable NFDeleteField(Variable fieldId)

Parameters
  • fieldId -

    Field id

Variable NFDeleteLayout()

Stage

These functions allow moving the Stage.

Variable NFMoveStageRelative(Variable offsetX, Variable offsetY, Variable offsetZ)

Parameters
  • offsetX -

    X offset in micrometers

  • offsetY -

    Y offset in micrometers

  • offsetZ -

    Z offset in micrometers

Variable NFMoveStageRelativeX(Variable offset)

Parameters
  • offset -

    X offset in micrometers

Variable NFMoveStageRelativeY(Variable offset)

Parameters
  • offset -

    Y offset in micrometers

Variable NFMoveStageRelativeZ(Variable offset)

Parameters
  • offset -

    Z offset in micrometers

Variable NFMoveStageAbsolute(Variable positionX, Variable positionY, Variable positionZ)

Parameters
  • positionX -

    X position in micrometers

  • positionY -

    Y position in micrometers

  • positionZ -

    Z position in micrometers

Variable NFMoveStageAbsoluteX(Variable position)

Parameters
  • position -

    X position in micrometers

Variable NFMoveStageAbsoluteY(Variable position)

Parameters
  • position -

    Y position in micrometers

Variable NFMoveStageAbsoluteZ(Variable position)

Parameters
  • position -

    Z position in micrometers

Variable NFGetStagePositionX()
Variable NFGetStagePositionY()
Variable NFGetStagePositionZ()

Session Manager

These functions allow setting and getting the session parameters. See Floorplan for details.

Variable NFGetSessionId()
Variable NFSetCLLMode(Variable sessionId, String sessionMode)

Parameters
  • sessionId -

    Session id

  • sessionMode -

    Must be "write-read" or "read-only"

String NFGetCLLMode(Variable sessionId)

Parameters
  • sessionId -

    Session id

Floorplan

These functions allow setting and getting the read and write field parameters. See Floorplan for details.

String NFGetFloorplanStatus(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFSetWriteField(Variable sessionId, Variable fieldId)

Parameters
  • sessionId -

    Session id

  • fieldId -

    Field id

Variable NFResetReadField(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFGetWriteFieldPixelSizeX(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFGetWriteFieldPixelSizeY(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFGetWriteFieldSizeX(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFGetWriteFieldSizeY(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFGetWriteFieldDimX(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFGetWriteFieldDimY(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFSetReadUpsampling(Variable sessionId, Variable readUpsamplingFactorX, Variable readUpsamplingFactorY)

Parameters
  • sessionId -

    Session id

  • readUpsamplingFactorX -

    Upsampling factor in X

  • readUpsamplingFactorY -

    Upsampling factor in Y

Variable NFGetReadUpsamplingX(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFGetReadUpsamplingY(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFSetReadMargins(Variable sessionId, Variable marginX, Variable marginY)

Parameters
  • sessionId -

    Session id

  • marginX -

    X margin in percent

  • marginY -

    Y margin in percent

Variable NFGetReadMarginX(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFGetReadMarginY(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFSetReadFieldPixelSize(Variable sessionId, Variable stepX_nm, Variable stepY_nm, Variable stepSizeLock)

Parameters
  • sessionId -

    Session id

  • stepX_nm -

    X step size in nanometers

  • stepY_nm -

    Y step size in nanometers

  • stepSizeLock -

    Enforce equal X and Y step size

Variable NFGetReadFieldPixelSizeX(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFGetReadFieldPixelSizeY(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFSetReadFieldSize(Variable sessionId, Variable sizeX_um, Variable sizeY_um)

Parameters
  • sessionId -

    Session id

  • sizeX_um -

    X size in micrometers

  • sizeY_um -

    Y size in micrometers

Variable NFGetReadFieldSizeX(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFGetReadFieldSizeY(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFGetReadFieldDimX(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFGetReadFieldDimY(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFSetReadFieldOrientation(Variable sessionId, Variable rotationAngle)

Parameters
  • sessionId -

    Session id

  • rotationAngle -

    Field orientation in degrees

Variable NFGetReadFieldOrientation(Variable sessionId)

Parameters
  • sessionId -

    Session id

WAVE NFGetReadFieldRef(Variable sessionId)

Parameters
  • sessionId -

    Session id

Scan Plan

These functions allow setting and getting the scan plan parameters. See Floorplan for details.

Variable NFSetPixelTiming(Variable sessionId, Variable pixelTime_us)

Parameters
  • sessionId -

    Session id

  • pixelTime_us -

    Pixel time in microseconds

Variable NFGetPixelTiming(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFSetTurnaroundFreq(Variable sessionId, Variable turnaroundFreq_Hz)

Parameters
  • sessionId -

    Session id

  • turnaroundFreq_Hz -

    Turnaround frequency in hertz

Variable NFGetTurnaroundFreq(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFSetPiezoOffset(Variable sessionId, Variable piezoOffsetX, Variable piezoOffsetY)

Parameters
  • sessionId -

    Session id

  • piezoOffsetX -

    X piezo offset in micrometers

  • piezoOffsetY -

    Y piezo offset in micrometers

Variable NFGetPiezoOffsetX(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFGetPiezoOffsetY(Variable sessionId)

Parameters
  • sessionId -

    Session id

Trajectory

These functions allow setting and getting the Trajectory parameters.

String NFGetTrajectoryStatus(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFSetTrajectoryNumIterations(Variable sessionId, Variable numIterationsX, Variable numIterationsY)

Parameters
  • sessionId -

    Session id

  • numIterationsX -

    Number of iterations in X

  • numIterationsY -

    Number of iterations in Y

Variable NFGetTrajectoryNumIterationsX(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFGetTrajectoryNumIterationsY(Variable sessionId)

Parameters
  • sessionId -

    Session id

Level Plane

These functions allow setting and getting the Level Plane parameters.

String NFGetLevelPlaneStatus(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFSetLevelPlaneHeight(Variable sessionId, Variable zPiezo_nm)

Parameters
  • sessionId -

    Session id

  • zPiezo_nm -

    Cantilever height above sample surface in nanometers

Variable NFGetLevelPlaneHeight(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFSetLevelPlaneNumIterations(Variable sessionId, Variable numIterations)

Parameters
  • sessionId -

    Session id

  • numIterations -

    Number of iterations

Variable NFGetLevelPlaneNumIterations(Variable sessionId)

Parameters
  • sessionId -

    Session id

CLL Forces

These functions allow setting and getting the CLL Forces parameters.

String NFGetCLLForcesStatus(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFSetCLLDFMode(Variable sessionId, Variable enableDepthFeedback)

Parameters
  • sessionId -

    Session id

  • enableDepthFeedback -

    Enable depth feedback

Variable NFGetCLLDFMode(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFSetCLLWriteForces(Variable sessionId, String initWriteForceMode, Variable vMin, Variable vMax)

Parameters
  • sessionId -

    Session id

  • initWriteForceMode -

    Must be "auto" or "linear"

  • vMin -

    Minimum voltage

  • vMax -

    Maximum voltage

Variable NFGetCLLWriteForceMinV(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFGetCLLWriteForceMaxV(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFSetDFMaskDilationIterations(Variable sessionId, Variable edgeDilationIterations)

Parameters
  • sessionId -

    Session id

  • edgeDilationIterations -

    Number of edge dilation iterations

Variable NFGetDFMaskDilationIterations(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFSetDFGetData(Variable sessionId, Variable getDepthFeedbackData)

Parameters
  • sessionId -

    Session id

  • getDepthFeedbackData -

    Get depth feedback data

Variable NFGetDFGetData(Variable sessionId)

Parameters
  • sessionId -

    Session id

Z Drift Correction

These functions allow setting and getting the Z Drift Correction parameters. See CLL Forces for details.

Variable NFSetZDriftCorrection(Variable sessionId, Variable enableZDriftCorrection)

Parameters
  • sessionId -

    Session id

  • enableZDriftCorrection -

    Enable Z drift correction

CLL Runtime

These functions allow setting and getting the CLL Runtime parameters.

String NFGetCLLRunTimeStatus(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFSetCLLForcePulse(Variable sessionId, Variable forcePulse_us)

Parameters
  • sessionId -

    Session id

  • forcePulse_us -

    Force pulse duration in microseconds

Variable NFGetCLLForcePulse(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFSetCLLPulsedHeatMode(Variable sessionId, Variable enablePulsedHeating)

Parameters
  • sessionId -

    Session id

  • enablePulsedHeating -

    Enable pulsed heating

Variable NFGetPulsedHeatMode(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFSetCLLHeatPulse(Variable sessionId, Variable heatPulse_us)

Parameters
  • sessionId -

    Session id

  • heatPulse_us -

    Heat pulse duration in microseconds

Variable NFGetCLLHeatPulse(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFSetCLLPreTensionForceV(Variable sessionId, Variable preTensionForce_v)

Parameters
  • sessionId -

    Session id

  • preTensionForce_v -

    Pre-tension force in volts

Variable NFGetCLLPreTensionForceV(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFSetCLLPreTensionPulseOff(Variable sessionId, Variable preTensionOff_us)

Parameters
  • sessionId -

    Session id

  • preTensionOff_us -

    Pre-tension force release duration in microseconds

Variable NFGetCLLPreTensionPulseOff(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFSetCLLReadForceV(Variable sessionId, Variable readForce_v)

Parameters
  • sessionId -

    Session id

  • readForce_v -

    Read force in volts

Variable NFGetCLLReadForceV(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFSetCLLScanHeights(Variable sessionId, Variable writeForward, Variable readForward, Variable readBackward)

Parameters
  • sessionId -

    Session id

  • writeForward -

    Write forward height in nanometers, can only be set in write-read mode

  • readForward -

    Read forward height in nanometers, can only be set in read-only mode

  • readBackward -

    Read backward height in nanometers

Variable NFGetCLLWriteForwardScanHeight(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFGetCLLReadForwardScanHeight(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFGetCLLReadBackwardScanHeight(Variable sessionId)

Parameters
  • sessionId -

    Session id

Variable NFSetReadCorrections(Variable sessionId, Variable enableTCCorrection, Variable enableRDCorrection)

Parameters
  • sessionId -

    Session id

  • enableTCCorrection -

    Enable thermal conductance correction

  • enableRDCorrection -

    Enable reader drift correction

CLL Offsets

These functions allow setting and getting the CLL offsets parameters. See CLL Runtime for details.

Variable NFSetCLLOffsetsEstimate()
Variable NFSetCLLOffsetsReadFwd(Variable sessionId, Variable readFwdOffsetX_nm, Variable readFwdOffsetY_nm)

Parameters
  • sessionId -

    Session id

  • readFwdOffsetX_nm -

    X read forward offset in nanometers

  • readFwdOffsetY_nm -

    Y read forward offset in nanometers

Variable NFSetCLLOffsetsReadBwd(Variable sessionId, Variable readBwdOffsetX_nm, Variable readBwdOffsetY_nm)

Parameters
  • sessionId -

    Session id

  • readBwdOffsetX_nm -

    X read backward offset in nanometers

  • readBwdOffsetY_nm -

    Y read backward offset in nanometers

Variable NFSetCLLOffsetsWriteFwd(Variable sessionId, Variable writeFwdOffsetX_nm, Variable writeFwdOffsetY_nm)

Parameters
  • sessionId -

    Session id

  • writeFwdOffsetX_nm -

    X write forward offset in nanometers

  • writeFwdOffsetY_nm -

    Y write forward offset in nanometers

Variable NFGetCLLReadFwdOffsetX(Variable sessionId)
Variable NFGetCLLReadFwdOffsetY(Variable sessionId)
Variable NFGetCLLReadBwdOffsetX(Variable sessionId)
Variable NFGetCLLReadBwdOffsetY(Variable sessionId)
Variable NFGetCLLWriteFwdOffsetX(Variable sessionId)
Variable NFGetCLLWriteFwdOffsetY(Variable sessionId)

Logs

These functions allow modifying the Logs.

Variable NFSetLoggerLevel(String logger, Variable loggerLevel)

Parameters
  • logger -

    Must be "NFMainLogger" or "NFConsoleLogger"

  • loggerLevel -

    Must be NF_LOGGER_LEVEL_DEBUG, NF_LOGGER_LEVEL_INFO, NF_LOGGER_LEVEL_WARNING, NF_LOGGER_LEVEL_ERROR, NF_LOGGER_LEVEL_CRITICAL or NF_LOGGER_LEVEL_OFF

Variable NFSaveLogger(String logger, String file)

Parameters
  • logger -

    Must be "NFMainLogger" or "NFConsoleLogger"

  • file -

    Path to file

Variable NFClearLogger(String logger)

Parameters
  • logger -

    Must be "NFMainLogger" or "NFConsoleLogger"

Variable NFLoggerIsEmpty(String logger)

Parameters
  • logger -

    Must be "NFMainLogger" or "NFConsoleLogger"

Variable NFLogDebug(String logger, String msg, String type)

Parameters
  • logger -

    Must be "NFMainLogger" or "NFConsoleLogger"

  • msg -

    Message

  • type -

    Must be "normal", "header", "input", "boldInput" or "output"

Variable NFLogInfo(String logger, String msg, String type)

Parameters
  • logger -

    Must be "NFMainLogger" or "NFConsoleLogger"

  • msg -

    Message

  • type -

    Must be "normal", "header", "input", "boldInput" or "output"

Variable NFLogWarning(String logger, String msg, String type)

Parameters
  • logger -

    Must be "NFMainLogger" or "NFConsoleLogger"

  • msg -

    Message

  • type -

    Must be "normal", "header", "input", "boldInput" or "output"

Variable NFLogError(String logger, String msg, String type)

Parameters
  • logger -

    Must be "NFMainLogger" or "NFConsoleLogger"

  • msg -

    Message

  • type -

    Must be "normal", "header", "input", "boldInput" or "output"

Variable NFLogCritical(String logger, String msg, String type)

Parameters
  • logger -

    Must be "NFMainLogger" or "NFConsoleLogger"

  • msg -

    Message

  • type -

    Must be "normal", "header", "input", "boldInput" or "output"

Lights

These functions allow controlling the Lights.

Variable NFSetMainLightOn(Variable red, Variable green, Variable blue)

Parameters
  • red -

    Brightness of red channel

  • green -

    Brightness of green channel

  • blue -

    Brightness of blue channel

Variable NFSetMainLightOff()
String NFGetMainLightStatus()
Variable NFSetMicroscopeLightOn(Variable red, Variable green, Variable blue)

Parameters
  • red -

    Brightness of red channel

  • green -

    Brightness of green channel

  • blue -

    Brightness of blue channel

Variable NFSetMicroscopeLightOff()
String NFGetMicroscopeLightStatus()

Valves

These functions allow controlling the Valves.

Variable NFSetValveAOn(Variable duration_s)

Parameters
  • duration_s -

    Duration for which to keep valve open in seconds

Variable NFSetValveAOff()
String NFGetValveAStatus()
Variable NFSetValveBOn(Variable duration_s)

Parameters
  • duration_s -

    Duration for which to keep valve open in seconds

Variable NFSetValveBOff()
String NFGetValveBStatus()

Electronics

These functions allow getting values from and setting values to the Electronics.

Variable NFSetElectronics(String mode, String channel, Variable voltage)

Parameters
  • mode -

    Must be "set" or "get"

  • channel -

    If mode is "set", must be "reader", "writer", "reader-offset", "force1", "force2", "x-piezo", "y-piezo" or "z-piezo". If mode is "get", must be "reader-amp1", "writer-amp1", "reader-amp2", "writer-amp2", "x-sensor", "y-sensor", "z-sensor" or "aux".

  • voltage -

    Voltage

Variable NFGetADCVoltage(String channel)

Parameters
  • channel -

    Must be "reader-amp1", "writer-amp1", "reader-amp2", "writer-amp2", "x-sensor", "y-sensor", "z-sensor" or "aux"

Variable NFSetElectronicsSwitch(String mode, String channel, String status)

Parameters
  • mode -

    Must be "set" or "get"

  • channel -

    Must be "reader", "writer", "writer-common", "force1" or "force2"

  • status -

    Must be "on" or "off"

String NFGetSwitchStatus(String channel)

Parameters
  • channel -

    Must be "reader", "writer", "writer-common", "force1" or "force2"

Wave Export

These functions allow exporting waves in various formats. See Graph Tools for details.

Variable NFSaveImageAsWSxM(WAVE image, String file)

Parameters
  • image -

    Reference to a 2D wave

  • file -

    Path to file

Variable NFSaveImageAsRawPng(WAVE image, String file)

Parameters
  • image -

    Reference to a 2D wave

  • file -

    Path to file

Variable NFSaveImageAsPngWithScaleAxis(WAVE image, String file)

Parameters
  • image -

    Reference to a 2D wave

  • file -

    Path to file

Variable NFSaveImageAsPngWithScaleBar(WAVE image, String file)

Parameters
  • image -

    Reference to a 2D wave

  • file -

    Path to file

File/Folder

These functions help managing files and folders.

String NFSelectFolder(String msg)

Parameters
  • msg -

    Message to show in selection dialog

String NFSelectFile(String msg, String fileFilter, Variable openFile)

Parameters
  • msg -

    Message to show in selection dialog

  • fileFilter -

    File filter in the format "Image Files (*.jpg, *.png):.jpg,.png;..."

  • openFile -

    Open file

Variable NFFolderExists(String folder)

Parameters
  • folder -

    Path to folder

Variable NFFileExists(String file)

Parameters
  • file -

    Path to file

DFR

These functions help managing Igor data folders.

DFR NFGetUserScriptDFR(String subdir)

Parameters
  • subdir -

    Name of user script subdirectory

Panels

These functions allow controlling the panels.

Variable NFUpdatePanels()