PyJEM.edm¶
Created on Tue Oct 26 15:16:38 2021
@author: EM
- PyJEM.edm.set_ip(val)¶
Set the IP address used by this package.
- Parameters:
val (str) – IP address.
- Return type:
None
Examples
>>> set_ip("127.0.0.1")
- PyJEM.edm.set_port(val)¶
Set the port number used by this package.
- Parameters:
val (int) – Port number.
- Return type:
None
Warning
Please do not use this except for JEOL service staff.
Examples
>>> set_ip("127.0.0.1")
- PyJEM.edm.get_config()¶
Get this package connection settings.
- Returns:
Service configuration dictionary.
- Return type:
dict
- PyJEM.edm.check_connection(timeout=3.0)¶
Check whether the target service is running.
- Parameters:
timeout (float) – timout in seconds for the connection check. Default is 3.0 seconds.
- Returns:
True if the target service is running. False if the service is not running or the IP address or port number may be incorrect.
- Return type:
bool
Examples
>>> check_connection() True
- PyJEM.edm.get_id_settings(id_number)¶
- Summary:
Get the settings saved at ID=id_number
user publish id range is 100-199.
- Args:
id_number:
- Return:
duty_percent, frequency_hz
- Parameters:
id_number (int)
- PyJEM.edm.set_use_id(id_number)¶
- Summary:
Set the ID. Will change the pulse frequency and duty cycle to match memory settings. id_number=0 will turn off the modulation
- Args:
id_number: new ID number 0, 1, 2, … 9
user publish id range is 100-199.
- Parameters:
id_number (int)
- PyJEM.edm.get_use_id()¶
- Summary:
Get the ID. Return value of -1 means the current settings are not saved at any memory location. Return value of 0 means the modulation is disabled.
user publish id range is 100-199.
- PyJEM.edm.set_beam_blank(blank_setting)¶
- Summary:
Set the ForceBlank setting.
- Args:
blank_setting: If true, the beam is blanked regardless of other settings.
- PyJEM.edm.get_beam_blank()¶
- Summary:
Get the ForceBlank setting
- Return:
If true, the beam is blanked regardless of other settings.
- PyJEM.edm.set_frequency_hz(frequency_hz)¶
- Summary:
Set the repetition rate in Hz effective immediately. Does not affect any of the saved settings.
- Args:
frequency_hz: frequency in hz
- PyJEM.edm.get_frequency_hz()¶
- Summary:
Get the current pulse frequency
- Return:
frequency in hz
- PyJEM.edm.set_duty_percent(duty_percent)¶
- Summary:
Set the duty cycle in percentage effective immediately. Does not affect any of the saved settings.
- Args:
duty_percent: duty cycle from 0 to 100
- PyJEM.edm.get_duty_percent()¶
- Summary:
Get the current duty cycle in percent
- Return:
duty percentage
- PyJEM.edm.get_b1_enable()¶
- Summary:
Get enable/disable of BNC TTL input B1 on the signal combiner. Beam is blanked when an enabled input is active, regardless of other inputs or settings. A physical switch on the signal combiner selects the polarity of each input (active high vs active low).
- Return: bool
true/false
- PyJEM.edm.set_b1_enable(flag)¶
- Summary:
Enables BNC TTL input B2 on the signal combiner. Beam is blanked when an enabled input is active, regardless of other inputs or settings. A physical switch on the signal combiner selects the polarity of each input (active high vs active low).
- Args: bool
True/False
- PyJEM.edm.get_b2_enable()¶
- Summary:
Get enable/disable of BNC TTL input B2 on the signal combiner. Beam is blanked when an enabled input is active, regardless of other inputs or settings. A physical switch on the signal combiner selects the polarity of each input (active high vs active low).
- Return: bool
True/False
- PyJEM.edm.set_b2_enable(flag)¶
- Summary:
Enables BNC TTL input B2 on the signal combiner. Beam is blanked when an enabled input is active, regardless of other inputs or settings. A physical switch on the signal combiner selects the polarity of each input (active high vs active low).
- Args: bool
True/False
- PyJEM.edm.get_b3_enable()¶
- Summary:
Get enable/disable of BNC TTL input B3 on the signal combiner. Beam is blanked when an enabled input is active, regardless of other inputs or settings. A physical switch on the signal combiner selects the polarity of each input (active high vs active low).
- Return: bool
True/False
- PyJEM.edm.set_b3_enable(flag)¶
- Summary:
Enables BNC TTL input B3 on the signal combiner. Beam is blanked when an enabled input is active, regardless of other inputs or settings. A physical switch on the signal combiner selects the polarity of each input (active high vs active low).
- Args: bool
True/False
- PyJEM.edm.get_enable_modulation()¶
- Summary:
When true, PWM is enabled in the Signal Combiner. When the electron beam is unblanked, its time-averaged intensity may be reduced.
When false, PWM is disabled in the Signal Combiner.
The behavior of ForceBlank and the TTL inputs B1, B2, and B3 are not affected by the EnableModulation value.
- Return: bool
true/false
- PyJEM.edm.set_enable_modulation(flag)¶
- Summary:
Enables PWM on the signal combiner. When true, PWM is enabled in the Signal Combiner. When the electron beam is unblanked, its time-averaged intensity may be reduced.
When false, PWM is disabled in the Signal Combiner.
The behavior of ForceBlank and the TTL inputs B1, B2, and B3 are not affected by the EnableModulation value.
- Args: bool
true/false