createc.CreatecWin32¶

class createc.CreatecWin32¶

The Createc wrapper class.

The remote operation from http://spm-wiki.createc.de already provides lots of methods, this class is just a wrapper so many more custom methods can be added.

__init__()¶

Initiator for CreatecWin32 class.

Return type:: CreatecWin32

Methods

`__init__`()	Initiator for CreatecWin32 class.
`do_scan_01`()	Do the scan, and return the .dat file name with full path
`is_active`()	To check if the STM software is still listening to python
`pre_scan_config`([chmode, rotation, ddeltaX, ...])	Parameters configuration before scanning an image.
`ramp_bias_mV`(end_bias_mV[, speed])	Ramp bias from current value to another value
`ramp_current_pA`(end_FBLogIset[, speed])	Ramp current to the target value
`scan_varying_size`([chmod])	Not in use.

Attributes

`angle`	return the scan rotation angle in deg
`bias_mV`	Return the bias in mV
`current_pA`	Return current in pA
`duration`	Duration of a scan in seconds :returns: time_to_wait :rtype: int
`imgX_size_bits`	Image X size in bits
`img_dDeltaX_bits`	Image dDeltaX in bits
`nom_size`	Get the nominal size of the image in Angstrom
`offset`	Return offset relatvie to the whole scan range in angstrom
`preampgain`	Pre amplifier gain
`xPiezoConst`	Get the X Piezo Constant
`yPiezoConst`	Get the Y Piezo Constant
`zPiezoConst`	Get the Z Piezo Constant

property angle¶

return the scan rotation angle in deg

Returns:: angle
Return type:: float

property bias_mV¶

Return the bias in mV

Returns:: bias
Return type:: str

property current_pA¶

Return current in pA

Returns:: current
Return type:: str

do_scan_01()¶

Do the scan, and return the .dat file name with full path

Not recommended to use because scanwaitfinished will freeze the STM software

property duration: int¶: Duration of a scan in seconds :returns: time_to_wait :rtype: int

property imgX_size_bits: int¶

Image X size in bits

Returns:: bits – integer bits
Return type:: int

property img_dDeltaX_bits: int¶

Image dDeltaX in bits

Returns:: bits – integer bits
Return type:: int

is_active()¶

To check if the STM software is still listening to python

Returns:: is_active
Return type:: Boolean

property nom_size¶

Get the nominal size of the image in Angstrom

Returns:: nominal_size
Return type:: XY2D

property offset¶

Return offset relatvie to the whole scan range in angstrom

Returns:: offset
Return type:: XY2D

Parameters configuration before scanning an image.

Parameters:

chmode (int) – constant height mode, int 0 or 1, which means false or true
rotation (float) – angle in degree -360 ~ 360
ddeltaX (int) – scan speed, int, usually 16, 32, 64 …
deltaX_dac (int) – scan size, usually take 32, 64, 128…
deltaY_dac (int) – scan size, usually take 32, 64, 128…
channels_code (int) – 3 for const current mode, see online manual for more detail
ch_zoff (float) – const height mode z offset in angstrom
ch_bias (gloat) – const height mode bias in mV

Returns:

None

Return type:

None

property preampgain¶

Pre amplifier gain

Returns:: gain
Return type:: int

ramp_bias_mV(end_bias_mV: float, speed: int = 100)¶

Ramp bias from current value to another value

Parameters:

end_bias_mV (float) – target bias in mV
speed (int) – speed is actually steps, it can be any integer larger than 0. 1 means directly stepping to the final value, it is default to 100.

Returns:

None

Return type:

None

ramp_current_pA(end_FBLogIset: float, speed: int = 100)¶

Ramp current to the target value

Parameters:

end_FBLogIset (float) – end_current in pA
speed (int) – speed is actually steps, it can be any integer larger than 0. 1 means directly stepping to the final value, it is default to 100.

Returns:

None

Return type:

None

scan_varying_size(chmod=0)¶: Not in use.

property xPiezoConst¶

Get the X Piezo Constant

Returns:: xPiezoConst
Return type:: float

property yPiezoConst¶

Get the Y Piezo Constant

Returns:: yPiezoConst
Return type:: float

property zPiezoConst¶

Get the Z Piezo Constant

Returns:: zPiezoConst
Return type:: float