[python source code]

scan

The scan commands module.

These commands are used in the following models: SS3706A

THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.

Please report an issue if one is found.

Attributes and Functions 
- scan.abort()
- scan.add()
- scan.addimagestep()
- scan.addwrite()
- scan.background()
- scan.bypass
- scan.create()
- scan.execute()
- scan.list()
- scan.measurecount
- scan.mode
- scan.nobufferbackground()
- scan.nobufferexecute()
- scan.reset()
- scan.scancount
- scan.state()
- scan.stepcount
- scan.trigger.arm.clear()
- scan.trigger.arm.set()
- scan.trigger.arm.stimulus
- scan.trigger.channel.clear()
- scan.trigger.channel.set()
- scan.trigger.channel.stimulus
- scan.trigger.clear()
- scan.trigger.measure.clear()
- scan.trigger.measure.set()
- scan.trigger.measure.stimulus
- scan.trigger.sequence.clear()
- scan.trigger.sequence.set()
- scan.trigger.sequence.stimulus

Scan

Bases: BaseTSPCmd

The scan command tree.

Properties and methods
  • .abort(): The scan.abort() function.
  • .add(): The scan.add() function.
  • .addimagestep(): The scan.addimagestep() function.
  • .addwrite(): The scan.addwrite() function.
  • .background(): The scan.background() function.
  • .bypass: The scan.bypass attribute.
  • .create(): The scan.create() function.
  • .execute(): The scan.execute() function.
  • .list(): The scan.list() function.
  • .measurecount: The scan.measurecount attribute.
  • .mode: The scan.mode attribute.
  • .nobufferbackground(): The scan.nobufferbackground() function.
  • .nobufferexecute(): The scan.nobufferexecute() function.
  • .reset(): The scan.reset() function.
  • .scancount: The scan.scancount attribute.
  • .state(): The scan.state() function.
  • .stepcount: The scan.stepcount attribute.
  • .trigger: The scan.trigger command tree.

bypass property writable 

bypass: str

Access the scan.bypass attribute.

Description
  • This attribute indicates whether the first channel of the scan waits for the channel stimulus event to be satisfied before closing.
Usage
  • Accessing this property will send the print(scan.bypass) query.
  • Setting this property to a value will send the scan.bypass = value command.
TSP Syntax 
- scan.bypass = value
- print(scan.bypass)
Raises:

measurecount property writable 

measurecount: str

Access the scan.measurecount attribute.

Description
  • This attribute sets the number of iterations performed when a scanning measurement is requested.
Usage
  • Accessing this property will send the print(scan.measurecount) query.
  • Setting this property to a value will send the scan.measurecount = value command.
TSP Syntax 
- scan.measurecount = value
- print(scan.measurecount)
Info
  • count, the count value being used or read; valid range is 1 to 450000.
Raises:

mode property writable 

mode: str

Access the scan.mode attribute.

Description
  • This attribute sets the relay action when the scan starts.
Usage
  • Accessing this property will send the print(scan.mode) query.
  • Setting this property to a value will send the scan.mode = value command.
TSP Syntax 
- scan.mode = value
- print(scan.mode)
Raises:

scancount property writable 

scancount: str

Access the scan.scancount attribute.

Description
  • This attribute sets the number of times the scan is repeated.
Usage
  • Accessing this property will send the print(scan.scancount) query.
  • Setting this property to a value will send the scan.scancount = value command.
TSP Syntax 
- scan.scancount = value
- print(scan.scancount)
Raises:

stepcount property 

stepcount: str

Access the scan.stepcount attribute.

Description
  • This attribute returns the number of steps in the present scan.
Usage
  • Accessing this property will send the print(scan.stepcount) query.
TSP Syntax 
- print(scan.stepcount)
Raises:

trigger property 

trigger: ScanTrigger

Return the scan.trigger command tree.

Sub-properties and sub-methods
  • .arm: The scan.trigger.arm command tree.
  • .channel: The scan.trigger.channel command tree.
  • .clear(): The scan.trigger.clear() function.
  • .measure: The scan.trigger.measure command tree.
  • .sequence: The scan.trigger.sequence command tree.

abort 

abort() -> None

Run the scan.abort() function.

Description
  • This function aborts a running background scan.
TSP Syntax 
- scan.abort()
Raises:

add 

add(channel_list: str, width: str | None = None) -> None

Run the scan.add() function.

Description
  • This function adds channels to the scan list.
TSP Syntax 
- scan.add()
Parameters:
  • channel_list (str) –

    String specifying channels to add using normal channel list syntax.

  • width (optional, default: None ) –

    Value that specifies the width of the channel read to use with items in channelList.
Raises:

addimagestep 

addimagestep(channel_list: str, dmm_config: str | None = None) -> None

Run the scan.addimagestep() function.

Description
  • This function allows you to include multiple channels in a single scan step.
TSP Syntax 
- scan.addimagestep()
Parameters:
  • channel_list (str) –

    String specifying a list of channels.

  • dmm_config (optional, default: None ) –

    String specifying a DMM configuration.
Raises:

addwrite 

addwrite(channel_list: str, write_value: str, width: str | None = None) -> None

Run the scan.addwrite() function.

Description
  • This function writes a specified value to a channel at the added step in the scan.
TSP Syntax 
- scan.addwrite()
Parameters:
  • channel_list (str) –

    String specifying channels to add using normal channel list syntax.

  • write_value (str) –

    The value to write to the channel for this scan step.

  • width (optional, default: None ) –

    Specifies the width of the channel write to use with items in channelList.
Raises:

background 

background(buffer_var: str | None = None) -> str

Run the scan.background() function.

Description
  • This function starts a scan and runs the scan in the background.
TSP Syntax 
- scan.background()
Parameters:
  • buffer_var (optional, default: None ) –

    The reading buffer used during scanning to store the readings; if a buffer is not specified, no readings are stored during the scan.
Returns:
  • str –

    The result of the function call.
Raises:

create 

create(channel_list: str, dmm_config: str | None = None) -> None

Run the scan.create() function.

Description
  • This function deletes the existing scan list and creates a new list of channels and channel patterns to scan.
TSP Syntax 
- scan.create()
Parameters:
  • channel_list (str) –

    String specifying channels to add.

  • dmm_config (optional, default: None ) –

    The DMM configuration to use with items in the channelList.
Raises:

execute 

execute(buffer_var: str | None = None) -> str

Run the scan.execute() function.

Description
  • This function starts the scan immediately in the foreground with a configured scan list.
TSP Syntax 
- scan.execute()
Parameters:
  • buffer_var (optional, default: None ) –

    A reading buffer used during scanning to store the readings; if a buffer is not specified, no readings are stored during the scan.
Returns:
  • str –

    The result of the function call.
Raises:

list 

list() -> str

Run the scan.list() function.

Description
  • This function queries the active scan list.
TSP Syntax 
- scan.list()
Returns:
  • str –

    The result of the function call.
Raises:

nobufferbackground 

nobufferbackground() -> str

Run the scan.nobufferbackground() function.

Description
  • This function starts a scan in background mode and specifies that no reading buffer is used during scanning.
TSP Syntax 
- scan.nobufferbackground()
Returns:
  • str –

    The result of the function call.
Raises:

nobufferexecute 

nobufferexecute() -> None

Run the scan.nobufferexecute() function.

Description
  • This function starts a scan immediately and specifies that no reading buffer is used during scanning.
TSP Syntax 
- scan.nobufferexecute()
Raises:

reset 

reset() -> None

Run the scan.reset() function.

Description
  • This function resets the trigger model and scan list settings to their factory default settings.
TSP Syntax 
- scan.reset()
Raises:

state 

state() -> str

Run the scan.state() function.

Description
  • This function provides the present state of a running background scan.
TSP Syntax 
- scan.state()
Returns:
  • str –

    The result of the function call.
Raises:

ScanTrigger

Bases: BaseTSPCmd

The scan.trigger command tree.

Properties and methods
  • .arm: The scan.trigger.arm command tree.
  • .channel: The scan.trigger.channel command tree.
  • .clear(): The scan.trigger.clear() function.
  • .measure: The scan.trigger.measure command tree.
  • .sequence: The scan.trigger.sequence command tree.

arm property 

arm: ScanTriggerArm

Return the scan.trigger.arm command tree.

Sub-properties and sub-methods
  • .clear(): The scan.trigger.arm.clear() function.
  • .set(): The scan.trigger.arm.set() function.
  • .stimulus: The scan.trigger.arm.stimulus attribute.

channel property 

channel: ScanTriggerChannel

Return the scan.trigger.channel command tree.

Sub-properties and sub-methods
  • .clear(): The scan.trigger.channel.clear() function.
  • .set(): The scan.trigger.channel.set() function.
  • .stimulus: The scan.trigger.channel.stimulus attribute.

measure property 

measure: ScanTriggerMeasure

Return the scan.trigger.measure command tree.

Sub-properties and sub-methods
  • .clear(): The scan.trigger.measure.clear() function.
  • .set(): The scan.trigger.measure.set() function.
  • .stimulus: The scan.trigger.measure.stimulus attribute.

sequence property 

sequence: ScanTriggerSequence

Return the scan.trigger.sequence command tree.

Sub-properties and sub-methods
  • .clear(): The scan.trigger.sequence.clear() function.
  • .set(): The scan.trigger.sequence.set() function.
  • .stimulus: The scan.trigger.sequence.stimulus attribute.

clear 

clear() -> None

Run the scan.trigger.clear() function.

Description
  • This function clears the trigger model.
TSP Syntax 
- scan.trigger.clear()
Raises:

ScanTriggerArm

Bases: BaseTSPCmd

The scan.trigger.arm command tree.

Properties and methods
  • .clear(): The scan.trigger.arm.clear() function.
  • .set(): The scan.trigger.arm.set() function.
  • .stimulus: The scan.trigger.arm.stimulus attribute.

stimulus property writable 

stimulus: str

Access the scan.trigger.arm.stimulus attribute.

Description
  • This attribute determines which event starts the scan.
Usage
  • Accessing this property will send the print(scan.trigger.arm.stimulus) query.
  • Setting this property to a value will send the scan.trigger.arm.stimulus = value command.
TSP Syntax 
- scan.trigger.arm.stimulus = value
- print(scan.trigger.arm.stimulus)
Raises:

clear 

clear() -> None

Run the scan.trigger.arm.clear() function.

Description
  • This function clears the arm event detector.
TSP Syntax 
- scan.trigger.arm.clear()
Raises:

set_ 

set_() -> None

Run the scan.trigger.arm.set() function.

Description
  • This function sets the arm event detector to the detected state.
TSP Syntax 
- scan.trigger.arm.set()
Raises:

ScanTriggerChannel

Bases: BaseTSPCmd

The scan.trigger.channel command tree.

Properties and methods
  • .clear(): The scan.trigger.channel.clear() function.
  • .set(): The scan.trigger.channel.set() function.
  • .stimulus: The scan.trigger.channel.stimulus attribute.

stimulus property writable 

stimulus: str

Access the scan.trigger.channel.stimulus attribute.

Description
  • This attribute determines which trigger events cause the channel actions to occur.
Usage
  • Accessing this property will send the print(scan.trigger.channel.stimulus) query.
  • Setting this property to a value will send the scan.trigger.channel.stimulus = value command.
TSP Syntax 
- scan.trigger.channel.stimulus = value
- print(scan.trigger.channel.stimulus)
Raises:

clear 

clear() -> None

Run the scan.trigger.channel.clear() function.

Description
  • This function clears the channel event detector.
TSP Syntax 
- scan.trigger.channel.clear()
Raises:

set_ 

set_() -> None

Run the scan.trigger.channel.set() function.

Description
  • This function sets the channel event detector to the detected state.
TSP Syntax 
- scan.trigger.channel.set()
Raises:

ScanTriggerMeasure

Bases: BaseTSPCmd

The scan.trigger.measure command tree.

Properties and methods
  • .clear(): The scan.trigger.measure.clear() function.
  • .set(): The scan.trigger.measure.set() function.
  • .stimulus: The scan.trigger.measure.stimulus attribute.

stimulus property writable 

stimulus: str

Access the scan.trigger.measure.stimulus attribute.

Description
  • This attribute selects the trigger stimulus of the event detector trigger.
Usage
  • Accessing this property will send the print(scan.trigger.measure.stimulus) query.
  • Setting this property to a value will send the scan.trigger.measure.stimulus = value command.
TSP Syntax 
- scan.trigger.measure.stimulus = value
- print(scan.trigger.measure.stimulus)
Raises:

clear 

clear() -> None

Run the scan.trigger.measure.clear() function.

Description
  • This function clears the measure event detector.
TSP Syntax 
- scan.trigger.measure.clear()
Raises:

set_ 

set_() -> None

Run the scan.trigger.measure.set() function.

Description
  • This function sets the measurement event detector to the detected state.
TSP Syntax 
- scan.trigger.measure.set()
Raises:

ScanTriggerSequence

Bases: BaseTSPCmd

The scan.trigger.sequence command tree.

Properties and methods
  • .clear(): The scan.trigger.sequence.clear() function.
  • .set(): The scan.trigger.sequence.set() function.
  • .stimulus: The scan.trigger.sequence.stimulus attribute.

stimulus property writable 

stimulus: str

Access the scan.trigger.sequence.stimulus attribute.

Description
  • This attribute selects the trigger stimulus for the sequence event detector.
Usage
  • Accessing this property will send the print(scan.trigger.sequence.stimulus) query.
  • Setting this property to a value will send the scan.trigger.sequence.stimulus = value command.
TSP Syntax 
- scan.trigger.sequence.stimulus = value
- print(scan.trigger.sequence.stimulus)
Raises:

clear 

clear() -> None

Run the scan.trigger.sequence.clear() function.

Description
  • This function clears the sequence event detector.
TSP Syntax 
- scan.trigger.sequence.clear()
Raises:

set_ 

set_() -> None

Run the scan.trigger.sequence.set() function.

Description
  • This function sets the sequence even detector to the detected state.
TSP Syntax 
- scan.trigger.sequence.set()
Raises: