NF XOP Functions

TODO


nf_layout_add_field(p)
nf_layout_remove_field(fieldIndex)
nf_layout_set_params(p)

nf_iv_curve_set(p)
nf_iv_curve_perform(timeout)
nf_iv_curve_cancel()
nf_iv_curve_progress()

NF XOP Piezo Approach

Structure NFApproachPiezoParams

uint32 version String channel float appliedVMin float appliedVMax float appliedVStep uint32 iterTime_us

EndStructure

nf_approach_piezo_set(NFApproachPiezoParams p)

This function performs the atomic operation of piezo approach. It returns the err status.

NFApproachPiezoParams

Parameters timeout=t If t=0, the call is synchronous, and it returns when the atomic operation finishes. If t>0, the call is asynchronous, and it returns immediately after launching the atomic operation.
nf_approach_piezo_perform(timeout)
This function performs the atomic operation of piezo approach. It returns the err status.

Parameters timeout=t If t=0, the call is synchronous, and it returns when the atomic operation finishes. If t>0, the call is asynchronous, and it returns immediately after launching the atomic operation.

nf_approach_piezo_cancel(timeout)

This function cancels the atomic operation of piezo approach. It returns the err status.

Parameters timeout=t If t=0, the call is synchronous, and it returns when the atomic operation finishes. If t>0, the call is asynchronous, and it returns immediately after launching the atomic operation.

nf_approach_piezo_progress(timeout)

This function gets the status of the atomic operation of piezo approach. It returns the err status. Parameters timeout=t If t=0, the call is synchronous, and it returns when the atomic operation finishes. If t>0, the call is asynchronous, and it returns immediately after launching the atomic operation.


nf_set_cantilever_height(zPiezoHeight_nm)

NF XOP Force Approach

Structure NFApproachForceParams

uint32 version String channel float appliedVMin float appliedVMax float appliedVStep uint32 iterTime_us uint32 numHeights uint32 numTemperatures float heights[NMAX_APF_HEIGHTS] float temperatures[NMAX_APF_TEMPERATURES] uint32 resetPreviousResults

EndStructure

nf_approach_force_set(NFApproachForceParams p)

This function performs the atomic operation of Force Approach. It returns the err status. NFApproachForceParams

Parameters timeout=t If t=0, the call is synchronous, and it returns when the atomic operation finishes. If t>0, the call is asynchronous, and it returns immediately after launching the atomic operation.

nf_approach_force_perform(timeout)

This function performs the atomic operation of Force Approach. It returns the err status.

Parameters timeout=t If t=0, the call is synchronous, and it returns when the atomic operation finishes. If t>0, the call is asynchronous, and it returns immediately after launching the atomic operation.

nf_approach_force_cancel(timeout)

This function cancels the atomic operation of Force Approach. It returns the err status. Parameters timeout=t If t=0, the call is synchronous, and it returns when the atomic operation finishes. If t>0, the call is asynchronous, and it returns immediately after launching the atomic operation.

nf_approach_force_progress(timeout)

This function gets the status of the atomic operation of Force Approach. It returns the err status. Parameters timeout=t If t=0, the call is synchronous, and it returns when the atomic operation finishes. If t>0, the call is asynchronous, and it returns immediately after launching the atomic operation.

nf_approach_force_plot(zDist, temperature)

NF XOP Cantilever

nf_reader_voltage_set(readerVoltage)
nf_writer_voltage_set(writerVoltage)
nf_reader_temperature_set(readerTemperature)
nf_writer_temperature_set(writerTemperature)
nf_reader_target_offset_set(readerTargetOffset)
nf_prep_sensors_perform(timeout)
nf_prep_sensors_cancel()
nf_prep_sensors_progress()

NF XOP Session Manager

nf_cll_set_mode(cllMode)
nf_cll_update_stage()

NF XOP Floorplan

nf_cll_set_piezo_offset(p)
nf_cll_set_write_fwd_field(p)
nf_cll_set_read_fwd_field(p)
nf_cll_set_read_bwd_field(p)

NF XOP Tilt Calibration

nf_level_plane_set(p)
nf_level_plane_perform(timeout)
nf_level_plane_cancel()
nf_level_plane_progress()

NF XOP X-Y-Piezo Calibration

nf_trajectory_set(p)
nf_trajectory_perform(timeout)
nf_trajectory_cancel()
nf_trajectory_progress()

NF XOP CLL Runtime

nf_cll_runtime_set(p)
nf_cll_runtime_perform(timeout)
nf_cll_runtime_cancel()
nf_cll_runtime_progress()

NF XOP Electronics

nf_electronics_set(p)
nf_electronics_perform(timeout)
nf_electronics_cancel()
nf_electronics_progress()

NF XOP Peripherals

nf_peripherals_set(p)
nf_peripherals_perform(timeout)
nf_peripherals_cancel()
nf_peripherals_progress()

NF XOP Stage

nf_as_set_position(p)
nf_as_move_relative(p)
nf_as_find_reference(p)
nf_as_move_absolute(p)
nf_as_cancel()
nf_as_setup(p)
nf_as_open()
nf_as_close()
nf_as_calibrate()
nf_as_park()

NF XOP Microscope

nf_ic_open()
nf_ic_live()
nf_ic_snapshot()
nf_ic_close()

NF XOP USB Monitor

nf_usb_buffer_load()
nf_usb_open()
nf_usb_close()
nf_usb_flush()
nf_usb_scan()

NF XOP Miscellaneous

nf_image_flatten(p)
nf_wave_export_WSxM(p)

NF XOP CUSTOM ERRORS

nf_status()

These codes give the err status.