Table Of Contents

Previous topic

Instrument

Next topic

Region

Probe

Conditions describing the type and conditions of the analytical probe used to collect the data.

Constants

Gun types

pyhmsa.spec.condition.probe.GUN_TYPE_W_FILAMENT
pyhmsa.spec.condition.probe.GUN_TYPE_LAB6
pyhmsa.spec.condition.probe.GUN_TYPE_COLD_FEG
pyhmsa.spec.condition.probe.GUN_TYPE_SCHOTTKY_FEG

Lens modes

pyhmsa.spec.condition.probe.LENS_MODE_IMAGE
pyhmsa.spec.condition.probe.LENS_MODE_DIFFR
pyhmsa.spec.condition.probe.LENS_MODE_SCIMG
pyhmsa.spec.condition.probe.LENS_MODE_SCDIF

Classes

class pyhmsa.spec.condition.probe.ProbeEM(beam_voltage, beam_current=None, gun_type=None, emission_current=None, filament_current=None, extractor_bias=None, beam_diameter=None, chamber_pressure=None, gun_pressure=None, scan_magnification=None, working_distance=None)

Describes the electron column conditions of the transmission electron microscope used to collect a HMSA dataset.

Parameters:
  • beam_voltage – beam voltage (required)
  • beam_current – beam current (optional)
  • gun_type – type of gun (optional)
  • emission_current – emission current (optional)
  • filament_current – filament current (optional)
  • extractor_bias – extractor bias (optional)
  • beam_diameter – beam diameter (optional)
  • chamber_pressure – chamber pressure (optional)
  • gun_pressure – gun pressure (optional)
  • scan_magnification – scan magnification (optional)
  • working_distance – working distance (optional)
CLASS = 'EM'
TEMPLATE = 'Probe'
beam_current

beam current

beam_diameter

beam diameter

beam_voltage

beam voltage

chamber_pressure

chamber pressure

emission_current

emission current

extractor_bias

extractor bias

filament_current

filament current

get_beam_current(instance)
get_beam_diameter(instance)
get_beam_voltage(instance)
get_chamber_pressure(instance)
get_emission_current(instance)
get_extractor_bias(instance)
get_filament_current(instance)
get_gun_pressure(instance)
get_gun_type(instance)
get_scan_magnification(instance)
get_working_distance(instance)
gun_pressure

gun pressure

gun_type

type of gun

scan_magnification

scan magnficiation

set_beam_current(instance, value, unit=None)
set_beam_diameter(instance, value, unit=None)
set_beam_voltage(instance, value, unit=None)
set_chamber_pressure(instance, value, unit=None)
set_emission_current(instance, value, unit=None)
set_extractor_bias(instance, value, unit=None)
set_filament_current(instance, value, unit=None)
set_gun_pressure(instance, value, unit=None)
set_gun_type(instance, value)
set_scan_magnification(instance, value, unit=None)
set_working_distance(instance, value, unit=None)
working_distance

working_distance

class pyhmsa.spec.condition.probe.ProbeTEM(beam_voltage, lens_mode, beam_current=None, gun_type=None, emission_current=None, filament_current=None, extractor_bias=None, beam_diameter=None, chamber_pressure=None, gun_pressure=None, scan_magnification=None, working_distance=None, camera_magnification=None, convergence_angle=None)

Describes the electron column conditions of the transmission electron microscope used to collect a HMSA dataset.

Parameters:
  • beam_voltage – beam voltage (required)
  • lens_mode – lens mode (required)
  • beam_current – beam current (optional)
  • gun_type – gun type (optional)
  • emission_current – emission current (optional)
  • filament_current – filament current (optional)
  • extractor_bias – extractor bias (optional)
  • beam_diameter – beam diameter (optional)
  • chamber_pressure – chamber pressure (optional)
  • gun_pressure – gun pressure (optional)
  • scan_magnification – scan magnification (optional)
  • working_distance – working distance (optional)
  • camera_magnification – camera magnification (optional)
  • convergence_angle – semi-angle of incident beam (optional)
CLASS = 'TEM'
TEMPLATE = 'Probe'
beam_current

beam current

beam_diameter

beam diameter

beam_voltage

beam voltage

camera_magnification

camera magnification

chamber_pressure

chamber pressure

convergence_angle

semi-angle of incident beam

emission_current

emission current

extractor_bias

extractor bias

filament_current

filament current

get_beam_current(instance)
get_beam_diameter(instance)
get_beam_voltage(instance)
get_camera_magnification(instance)
get_chamber_pressure(instance)
get_convergence_angle(instance)
get_emission_current(instance)
get_extractor_bias(instance)
get_filament_current(instance)
get_gun_pressure(instance)
get_gun_type(instance)
get_lens_mode(instance)
get_scan_magnification(instance)
get_working_distance(instance)
gun_pressure

gun pressure

gun_type

type of gun

lens_mode

lens mode

scan_magnification

scan magnficiation

set_beam_current(instance, value, unit=None)
set_beam_diameter(instance, value, unit=None)
set_beam_voltage(instance, value, unit=None)
set_camera_magnification(instance, value, unit=None)
set_chamber_pressure(instance, value, unit=None)
set_convergence_angle(instance, value, unit=None)
set_emission_current(instance, value, unit=None)
set_extractor_bias(instance, value, unit=None)
set_filament_current(instance, value, unit=None)
set_gun_pressure(instance, value, unit=None)
set_gun_type(instance, value)
set_lens_mode(instance, value)
set_scan_magnification(instance, value, unit=None)
set_working_distance(instance, value, unit=None)
working_distance

working_distance