IntensityScans
IntensityScans.IntensityScan
— TypeInput: xyz: The handle of desired xyz stage scope: Handle of desired scope channel: This input decides which channel the scope will read from.
ps = initialize(PositionerSystem)
scope = initialize(Scope350MHz)
hydrophone = IntensityScan(xyz = ps, scope = scope, channel = 1, precapture_delay=0u"s")
IntensityScans.scan_x
— Methodscan_x(scanner, x_range, x_num_scans; kwargs..)
scan_y(scanner, y_range, y_num_scans; kwargs..)
scan_z(scanner, z_range, z_num_scans; kwargs..)
Move along a single axis and grab data based on a fixed increment
Arguments
scanner::IntensityScan
: the structure for all controller connections.x_range
: An array or tuple that contains the start and end point of the desired range in the x-direction. (Must be 1 or 2 elements long)x_num_scans::Int
: The number of points/scans the user desires to record along the x-axis.
Keywords
verbose
::Bool: Optional, defaults to: true
Returns
ScanData
Example
ps = initialize(PositionerSystem)
scope = initialize(AgilentDSOX4034A)
scanner = IntensityScan(
xyz = ps,
scope = scope,
channel = 1,
post_move_delay = 0ms,
precapture_delay = 0µs,
)
wave_x = scan_x(scanner, [-10mm, 10mm], 5)
IntensityScans.scan_xy
— Methodscan_xy(scanner, x_axis_range, x_axis_num_scans, y_axis_range, y_axis_num_scans; kwargs..)
scan_xz(scanner, x_axis_range, x_axis_num_scans, z_axis_range, z_axis_num_scans; kwargs..)
scan_yz(scanner, y_axis_range, y_axis_num_scans, z_axis_range, z_axis_num_scans; kwargs..)
This function grabs data along the xy-plane. It holds the y-position constant and moves along the x axis until it reaches the last x point and then changes the y-position and repeats. There are five mandatory inputs and one optional input that is used only when this function is called by other functions and the printed messages should be surpressed. The user usually doesn't have to use the variable called.
Arguments
scanner
: the structure for all controller connections.x_axis_range::Array
: An array that contains the start and end point of the desired range in the x-direction. (Must be 1 or 2 elements long)x_axis_num_scans::Int
: The number of points/scans the user desires to record along the x-axis.y_axis_range::Array
: Contains the start and end point of the desired range in the y-direction. (Must be 1 or 2 elements long)y_axis_num_scans::Int
: The number of points/scans the user desires to record along the y-axis.
Keywords
verbose
::Bool: Optional, defaults to: true
Returns
ScanData
Example
ps = initialize(PositionerSystem)
scope = initialize(AgilentDSOX4034A)
scanner = IntensityScan(
xyz = ps,
scope = scope,
channel = 1,
post_move_delay = 0ms,
precapture_delay = 0µs,
)
wave_xy = scan_xy(scanner, [-5mm, 5mm], 3, [-5mm, 5mm], 7)
IntensityScans.scan_xyz
— Method scan_xyz(scanner, x_axis_range, x_axis_num_scans, y_axis_range, y_axis_num_scans, z_axis_range, z_axis_num_scans; kwargs..)
This function grabs data along the xyz-axis. It holds the z-position constant and calls the scan_xy function. This function scans along the x axis until it reaches the last x point and then moves along the y axis and repeats the process. After completing the xy scan, the z-position is changed and then the process is repeated. There are five mantadory inputs and one optional input that is used only when this function is called by other functions and the printed messages should be surpressed. The user usually doesn't have to use the variable called.
Arguments
scanner
: the structure for all controller connections.x_axis_range::Array
: An array that contains the start and end point of the desired range in the x-direction. (Must be 1 or 2 elements long)x_axis_num_scans::Int
: The number of points/scans the user desires to record along the x-axis.y_axis_range::Array
: Contains the start and end point of the desired range in the y-direction. (Must be 1 or 2 elements long)y_axis_num_scans::Int
: The number of points/scans the user desires to record along the y-axis.z_axis_range::Array
: Contains the start and end point of the desired range in the z-direction. (Must be 1 or 2 elements long)z_axis_num_scans::Int
: The number of points/scans the user desires to record along the z-axis.
Keywords
verbose
::Bool: Optional, defaults to: true
Returns
ScanData
Example:
ps = initialize(PositionerSystem)
scope = initialize(AgilentDSOX4034A)
scanner = IntensityScan(
xyz = ps,
scope = scope,
channel = 1,
post_move_delay = 0ms,
precapture_delay = 0µs,
)
wave_xyz = scan_xyz(scanner, [-5mm, 5mm], 3, [-5mm, 5mm], 3, [-5mm, 5mm], 3)