Python Reference

class vortex.Logger
class vortex.Range
contains(self: vortex.Range, arg0: float)bool
copy(self: vortex.Range)vortex.Range
property length
property max
property min
static symmetric(arg0: float)vortex.Range
vortex.get_console_logger(name: str, level: int = 2)vortex.Logger
vortex.get_python_logger(name: str, scope: str = 'vortex')vortex.Logger
class vortex.acquire.AlazarAcquisition
property config
initialize(self: vortex.acquire.AlazarAcquisition, arg0: vortex.acquire.AlazarConfig)None
next(*args, **kwargs)

Overloaded function.

  1. next(self: vortex.acquire.AlazarAcquisition, buffer: vortex::cpu_view_t<int>) -> int

  2. next(self: vortex.acquire.AlazarAcquisition, id: int, buffer: vortex::cpu_view_t<int>) -> int

next_async(*args, **kwargs)

Overloaded function.

  1. next_async(self: vortex.acquire.AlazarAcquisition, buffer: vortex::cpu_view_t<int>, callback: Callable[[int, std::exception_ptr], None]) -> None

  2. next_async(self: vortex.acquire.AlazarAcquisition, id: int, buffer: vortex::cpu_view_t<int>, callback: Callable[[int, std::exception_ptr], None]) -> None

prepare(self: vortex.acquire.AlazarAcquisition)None
property running
start(self: vortex.acquire.AlazarAcquisition)None
stop(self: vortex.acquire.AlazarAcquisition)None
class vortex.acquire.AlazarConfig
property acquire_timeout
property bytes_per_multisample
property channel_mask
property channels_per_sample
property clock
copy(self: vortex.acquire.AlazarConfig)vortex.acquire.AlazarConfig
property device
property inputs
property options
property recommended_minimum_records_per_block
property records_per_block
property resampling
property samples_per_record
property samples_per_second
property samples_per_second_is_known
property shape
property stop_on_error
property trigger
validate(self: vortex.acquire.AlazarConfig)None
class vortex.acquire.AlazarConfigDevice
property board_index
copy(self: vortex.acquire.AlazarConfigDevice)vortex.acquire.AlazarConfigDevice
property system_index
class vortex.acquire.AlazarFFTAcquisition
property config
initialize(self: vortex.acquire.AlazarFFTAcquisition, arg0: vortex.acquire.AlazarFFTConfig)None
next(*args, **kwargs)

Overloaded function.

  1. next(self: vortex.acquire.AlazarFFTAcquisition, buffer: vortex::cpu_view_t<int>) -> int

  2. next(self: vortex.acquire.AlazarFFTAcquisition, id: int, buffer: vortex::cpu_view_t<int>) -> int

next_async(*args, **kwargs)

Overloaded function.

  1. next_async(self: vortex.acquire.AlazarFFTAcquisition, buffer: vortex::cpu_view_t<int>, callback: Callable[[int, std::exception_ptr], None]) -> None

  2. next_async(self: vortex.acquire.AlazarFFTAcquisition, id: int, buffer: vortex::cpu_view_t<int>, callback: Callable[[int, std::exception_ptr], None]) -> None

prepare(self: vortex.acquire.AlazarFFTAcquisition)None
property running
start(self: vortex.acquire.AlazarFFTAcquisition)None
stop(self: vortex.acquire.AlazarFFTAcquisition)None
class vortex.acquire.AlazarFFTConfig
property acquire_timeout
property ascans_per_block
property background
property bytes_per_multisample
property channel_mask
property channels_per_sample
property clock
copy(self: vortex.acquire.AlazarFFTConfig)vortex.acquire.AlazarFFTConfig
property device
property fft_length
property include_time_domain
property inputs
property options
property recommended_minimum_records_per_block
property records_per_block
property resampling
property samples_per_ascan
property samples_per_record
property samples_per_second
property samples_per_second_is_known
property shape
property spectral_filter
property stop_on_error
property trigger
validate(self: vortex.acquire.AlazarFFTConfig)None
class vortex.acquire.AuxIOClockOut
copy(self: vortex.acquire.AuxIOClockOut)vortex.acquire.AuxIOClockOut
class vortex.acquire.AuxIOPacerOut
copy(self: vortex.acquire.AuxIOPacerOut)vortex.acquire.AuxIOPacerOut
property divider
class vortex.acquire.AuxIOTriggerOut
copy(self: vortex.acquire.AuxIOTriggerOut)vortex.acquire.AuxIOTriggerOut
class vortex.acquire.DualExternalTrigger
property coupling
property delay_samples
property initial_slope
property level_ratios
property range_millivolts
class vortex.acquire.ExternalClock
copy(self: vortex.acquire.ExternalClock)vortex.acquire.ExternalClock
property coupling
property dual
property edge
property level_ratio
class vortex.acquire.FileAcquisition
property config
initialize(self: vortex.acquire.FileAcquisition, arg0: vortex::acquire::file_config_t)None
next(self: vortex.acquire.FileAcquisition, buffer: vortex::cpu_view_t<int>, id: int = 0)int
prepare(self: vortex.acquire.FileAcquisition)None
start(self: vortex.acquire.FileAcquisition)None
stop(self: vortex.acquire.FileAcquisition)None
class vortex.acquire.FileAcquisitionConfig
property channels_per_sample
property loop
property path
property records_per_block
property samples_per_record
property shape
class vortex.acquire.Input
property bytes_per_sample
property channel
copy(self: vortex.acquire.Input)vortex.acquire.Input
property coupling
property impedance_ohms
property range_millivolts
class vortex.acquire.InternalClock
copy(self: vortex.acquire.InternalClock)vortex.acquire.InternalClock
property samples_per_second
class vortex.acquire.NullAcquisition
property config
initialize(self: vortex.acquire.NullAcquisition, arg0: vortex::acquire::null_config_t)None
next(self: vortex.acquire.NullAcquisition, buffer: vortex::cpu_view_t<int>, id: int = 0)int
prepare(self: vortex.acquire.NullAcquisition)None
start(self: vortex.acquire.NullAcquisition)None
stop(self: vortex.acquire.NullAcquisition)None
class vortex.acquire.NullAcquisitionConfig
property channels_per_sample
property records_per_block
property samples_per_record
property shape
class vortex.acquire.OCTIgnoreBadClock
property bad_seconds
copy(self: vortex.acquire.OCTIgnoreBadClock)vortex.acquire.OCTIgnoreBadClock
property good_seconds
class vortex.acquire.SingleExternalTrigger
property coupling
property delay_samples
property level_ratio
property range_millivolts
property slope
class vortex.acquire.VectorInput
append(self: vortex.acquire.VectorInput, x: vortex::acquire::input_t)None

Add an item to the end of the list

clear(self: vortex.acquire.VectorInput)None

Clear the contents

count(self: vortex.acquire.VectorInput, x: vortex::acquire::input_t)int

Return the number of times x appears in the list

extend(*args, **kwargs)

Overloaded function.

  1. extend(self: vortex.acquire.VectorInput, L: vortex.acquire.VectorInput) -> None

Extend the list by appending all the items in the given list

  1. extend(self: vortex.acquire.VectorInput, L: Iterable) -> None

Extend the list by appending all the items in the given list

insert(self: vortex.acquire.VectorInput, i: int, x: vortex::acquire::input_t)None

Insert an item at a given position.

pop(*args, **kwargs)

Overloaded function.

  1. pop(self: vortex.acquire.VectorInput) -> vortex::acquire::input_t

Remove and return the last item

  1. pop(self: vortex.acquire.VectorInput, i: int) -> vortex::acquire::input_t

Remove and return the item at index i

remove(self: vortex.acquire.VectorInput, x: vortex::acquire::input_t)None

Remove the first item from the list whose value is x. It is an error if there is no such item.

class vortex.acquire.VectorOption
append(self: vortex.acquire.VectorOption, x: Union[vortex::acquire::option::auxio_trigger_out_t, vortex::acquire::option::auxio_clock_out_t, vortex::acquire::option::auxio_pacer_out_t, vortex::acquire::option::oct_ignore_bad_clock_t])None

Add an item to the end of the list

clear(self: vortex.acquire.VectorOption)None

Clear the contents

count(self: vortex.acquire.VectorOption, x: Union[vortex::acquire::option::auxio_trigger_out_t, vortex::acquire::option::auxio_clock_out_t, vortex::acquire::option::auxio_pacer_out_t, vortex::acquire::option::oct_ignore_bad_clock_t])int

Return the number of times x appears in the list

extend(*args, **kwargs)

Overloaded function.

  1. extend(self: vortex.acquire.VectorOption, L: vortex.acquire.VectorOption) -> None

Extend the list by appending all the items in the given list

  1. extend(self: vortex.acquire.VectorOption, L: Iterable) -> None

Extend the list by appending all the items in the given list

insert(self: vortex.acquire.VectorOption, i: int, x: Union[vortex::acquire::option::auxio_trigger_out_t, vortex::acquire::option::auxio_clock_out_t, vortex::acquire::option::auxio_pacer_out_t, vortex::acquire::option::oct_ignore_bad_clock_t])None

Insert an item at a given position.

pop(*args, **kwargs)

Overloaded function.

  1. pop(self: vortex.acquire.VectorOption) -> Union[vortex::acquire::option::auxio_trigger_out_t, vortex::acquire::option::auxio_clock_out_t, vortex::acquire::option::auxio_pacer_out_t, vortex::acquire::option::oct_ignore_bad_clock_t]

Remove and return the last item

  1. pop(self: vortex.acquire.VectorOption, i: int) -> Union[vortex::acquire::option::auxio_trigger_out_t, vortex::acquire::option::auxio_clock_out_t, vortex::acquire::option::auxio_pacer_out_t, vortex::acquire::option::oct_ignore_bad_clock_t]

Remove and return the item at index i

remove(self: vortex.acquire.VectorOption, x: Union[vortex::acquire::option::auxio_trigger_out_t, vortex::acquire::option::auxio_clock_out_t, vortex::acquire::option::auxio_pacer_out_t, vortex::acquire::option::oct_ignore_bad_clock_t])None

Remove the first item from the list whose value is x. It is an error if there is no such item.

class vortex.engine.AscanHDF5StackEndpoint
property aggregate_segment_callback
property event_callback
property executor
property scan_callback
property segment_callback
property storage
property update_callback
property volume_callback
class vortex.engine.AscanStackEndpoint
property aggregate_segment_callback
property event_callback
property executor
property scan_callback
property segment_callback
property storage
property update_callback
property volume_callback
class vortex.engine.AscanStreamEndpoint
property storage
class vortex.engine.Block
class StreamIndex

Members:

GalvoTarget

SampleTarget

GalvoActual

SampleActual

Strobes

GalvoActual = <StreamIndex.GalvoActual: 2>
GalvoTarget = <StreamIndex.GalvoTarget: 0>
SampleActual = <StreamIndex.SampleActual: 3>
SampleTarget = <StreamIndex.SampleTarget: 1>
Strobes = <StreamIndex.Strobes: 4>
property name
property value
property galvo_actual
property galvo_target
property id
property length
property markers
property sample
property sample_actual
property sample_target
property strobes
property timestamp
class vortex.engine.BroctStorageEndpoint
property aggregate_segment_callback
property event_callback
property executor
property scan_callback
property segment_callback
property storage
property update_callback
property volume_callback
class vortex.engine.BufferStrategy

Members:

Block

Segment

Volume

Block = <BufferStrategy.Block: 0>
Segment = <BufferStrategy.Segment: 1>
Volume = <BufferStrategy.Volume: 2>
property name
property value
class vortex.engine.Engine
class Event

Members:

Launch

Start

Run

Stop

Complete

Shutdown

Exit

Error

Abort

Abort = <Event.Abort: 8>
Complete = <Event.Complete: 4>
Error = <Event.Error: 7>
Exit = <Event.Exit: 6>
Launch = <Event.Launch: 0>
Run = <Event.Run: 2>
Shutdown = <Event.Shutdown: 5>
Start = <Event.Start: 1>
Stop = <Event.Stop: 3>
property name
property value
class JobTiming
property acquire
property create
property format
property process
property recycle
property scan
property service
class SessionStatus
property allocated
property available
property dispatched
property inflight
property limit
property progress
property utilization
property config
property done
property event_callback
initialize(self: vortex.engine.Engine, arg0: vortex.engine.EngineConfig)None
property job_callback
prepare(self: vortex.engine.Engine)None
property scan_queue
start(self: vortex.engine.Engine)None
status(self: vortex.engine.Engine)vortex.engine.EngineStatus
stop(self: vortex.engine.Engine)None
wait(self: vortex.engine.Engine)None
wait_for(self: vortex.engine.Engine, arg0: float)bool
class vortex.engine.EngineConfig
add_acquisition(self: vortex.engine.EngineConfig, acquisition: object, processors: sequence, preload: bool = True, master: bool = True)None
add_formatter(self: vortex.engine.EngineConfig, arg0: object, arg1: sequence)None
add_io(self: vortex.engine.EngineConfig, io: object, preload: bool = True, master: bool = False, lead_samples: int = 0)None
add_processor(self: vortex.engine.EngineConfig, arg0: object, arg1: sequence)None
property blocks_to_acquire
property blocks_to_allocate
copy(self: vortex.engine.EngineConfig)vortex.engine.EngineConfig
property galvo_input_channels
property galvo_output_channels
property post_scan_records
property preload_count
property records_per_block
property scanner_warp
validate(self: vortex.engine.EngineConfig)None
class vortex.engine.EngineStatus
property active
property block_utilization
copy(self: vortex.engine.EngineStatus)vortex.engine.EngineStatus
property dispatch_completion
property dispatched_blocks
property inflight_blocks
class vortex.engine.MarkerLogStorage
property storage
class vortex.engine.NullEndpoint
class vortex.engine.PositionDeviceTensorEndpointFloat32
property aggregate_segment_callback
property event_callback
property executor
property scan_callback
property segment_callback
property stream
property tensor
property update_callback
property volume_callback
class vortex.engine.PositionDeviceTensorEndpointInt8
property aggregate_segment_callback
property event_callback
property executor
property scan_callback
property segment_callback
property stream
property tensor
property update_callback
property volume_callback
class vortex.engine.PositionDeviceTensorEndpointUInt16
property aggregate_segment_callback
property event_callback
property executor
property scan_callback
property segment_callback
property stream
property tensor
property update_callback
property volume_callback
class vortex.engine.RadialDeviceTensorEndpointFloat32
property aggregate_segment_callback
property event_callback
property executor
property scan_callback
property segment_callback
property stream
property tensor
property update_callback
property volume_callback
class vortex.engine.RadialDeviceTensorEndpointInt8
property aggregate_segment_callback
property event_callback
property executor
property scan_callback
property segment_callback
property stream
property tensor
property update_callback
property volume_callback
class vortex.engine.RadialDeviceTensorEndpointUInt16
property aggregate_segment_callback
property event_callback
property executor
property scan_callback
property segment_callback
property stream
property tensor
property update_callback
property volume_callback
class vortex.engine.ScanQueue
class Event

Members:

Start

Finish

Interrupt

Abort

Abort = <Event.Abort: 3>
Finish = <Event.Finish: 1>
Interrupt = <Event.Interrupt: 2>
Start = <Event.Start: 0>
property name
property value
class OnlineScanQueue
append(*args, **kwargs)

Overloaded function.

  1. append(self: vortex.engine.ScanQueue.OnlineScanQueue, scan: vortex.scan.RasterScan, callback: Callable[[int, vortex::engine::scan_queue_t<double,vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> >::event_t], None] = None, marker: vortex.marker.ScanBoundary = ScanBoundary(sample=0, sequence=0, volume_count_hint=0, flags=Flags(value=0xffffffffffffffff))) -> None

  2. append(self: vortex.engine.ScanQueue.OnlineScanQueue, scan: vortex.scan.RadialScan, callback: Callable[[int, vortex::engine::scan_queue_t<double,vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> >::event_t], None] = None, marker: vortex.marker.ScanBoundary = ScanBoundary(sample=0, sequence=0, volume_count_hint=0, flags=Flags(value=0xffffffffffffffff))) -> None

  3. append(self: vortex.engine.ScanQueue.OnlineScanQueue, scan: vortex.scan.FreeformScan, callback: Callable[[int, vortex::engine::scan_queue_t<double,vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> >::event_t], None] = None, marker: vortex.marker.ScanBoundary = ScanBoundary(sample=0, sequence=0, volume_count_hint=0, flags=Flags(value=0xffffffffffffffff))) -> None

append(*args, **kwargs)

Overloaded function.

  1. append(self: vortex.engine.ScanQueue, scan: vortex.scan.RasterScan, callback: Callable[[int, vortex::engine::scan_queue_t<double,vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> >::event_t], None] = None, marker: vortex.marker.ScanBoundary = ScanBoundary(sample=0, sequence=0, volume_count_hint=0, flags=Flags(value=0xffffffffffffffff))) -> None

  2. append(self: vortex.engine.ScanQueue, scan: vortex.scan.RepeatedRasterScan, callback: Callable[[int, vortex::engine::scan_queue_t<double,vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> >::event_t], None] = None, marker: vortex.marker.ScanBoundary = ScanBoundary(sample=0, sequence=0, volume_count_hint=0, flags=Flags(value=0xffffffffffffffff))) -> None

  3. append(self: vortex.engine.ScanQueue, scan: vortex.scan.RadialScan, callback: Callable[[int, vortex::engine::scan_queue_t<double,vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> >::event_t], None] = None, marker: vortex.marker.ScanBoundary = ScanBoundary(sample=0, sequence=0, volume_count_hint=0, flags=Flags(value=0xffffffffffffffff))) -> None

  4. append(self: vortex.engine.ScanQueue, scan: vortex.scan.RepeatedRadialScan, callback: Callable[[int, vortex::engine::scan_queue_t<double,vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> >::event_t], None] = None, marker: vortex.marker.ScanBoundary = ScanBoundary(sample=0, sequence=0, volume_count_hint=0, flags=Flags(value=0xffffffffffffffff))) -> None

  5. append(self: vortex.engine.ScanQueue, scan: vortex.scan.SpiralScan, callback: Callable[[int, vortex::engine::scan_queue_t<double,vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> >::event_t], None] = None, marker: vortex.marker.ScanBoundary = ScanBoundary(sample=0, sequence=0, volume_count_hint=0, flags=Flags(value=0xffffffffffffffff))) -> None

  6. append(self: vortex.engine.ScanQueue, scan: vortex.scan.FreeformScan, callback: Callable[[int, vortex::engine::scan_queue_t<double,vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> >::event_t], None] = None, marker: vortex.marker.ScanBoundary = ScanBoundary(sample=0, sequence=0, volume_count_hint=0, flags=Flags(value=0xffffffffffffffff))) -> None

clear(self: vortex.engine.ScanQueue)None
property empty_callback
generate(self: vortex.engine.ScanQueue, markers: vortex.marker.MarkerList, buffer: vortex::cpu_view_t<float>, zero_order_hold: bool = True)Tuple[int, int]
interrupt(*args, **kwargs)

Overloaded function.

  1. interrupt(self: vortex.engine.ScanQueue, scan: vortex.scan.RasterScan, callback: Callable[[int, vortex::engine::scan_queue_t<double,vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> >::event_t], None] = None, marker: vortex.marker.ScanBoundary = ScanBoundary(sample=0, sequence=0, volume_count_hint=0, flags=Flags(value=0xffffffffffffffff))) -> None

  2. interrupt(self: vortex.engine.ScanQueue, scan: vortex.scan.RepeatedRasterScan, callback: Callable[[int, vortex::engine::scan_queue_t<double,vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> >::event_t], None] = None, marker: vortex.marker.ScanBoundary = ScanBoundary(sample=0, sequence=0, volume_count_hint=0, flags=Flags(value=0xffffffffffffffff))) -> None

  3. interrupt(self: vortex.engine.ScanQueue, scan: vortex.scan.RadialScan, callback: Callable[[int, vortex::engine::scan_queue_t<double,vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> >::event_t], None] = None, marker: vortex.marker.ScanBoundary = ScanBoundary(sample=0, sequence=0, volume_count_hint=0, flags=Flags(value=0xffffffffffffffff))) -> None

  4. interrupt(self: vortex.engine.ScanQueue, scan: vortex.scan.RepeatedRadialScan, callback: Callable[[int, vortex::engine::scan_queue_t<double,vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> >::event_t], None] = None, marker: vortex.marker.ScanBoundary = ScanBoundary(sample=0, sequence=0, volume_count_hint=0, flags=Flags(value=0xffffffffffffffff))) -> None

  5. interrupt(self: vortex.engine.ScanQueue, scan: vortex.scan.SpiralScan, callback: Callable[[int, vortex::engine::scan_queue_t<double,vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> >::event_t], None] = None, marker: vortex.marker.ScanBoundary = ScanBoundary(sample=0, sequence=0, volume_count_hint=0, flags=Flags(value=0xffffffffffffffff))) -> None

  6. interrupt(self: vortex.engine.ScanQueue, scan: vortex.scan.FreeformScan, callback: Callable[[int, vortex::engine::scan_queue_t<double,vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> >::event_t], None] = None, marker: vortex.marker.ScanBoundary = ScanBoundary(sample=0, sequence=0, volume_count_hint=0, flags=Flags(value=0xffffffffffffffff))) -> None

reset(*args, **kwargs)

Overloaded function.

  1. reset(self: vortex.engine.ScanQueue) -> None

  2. reset(self: vortex.engine.ScanQueue, sample: int, position: numpy.ndarray[numpy.float64], velocity: numpy.ndarray[numpy.float64]) -> None

class vortex.engine.Source
property clock_edges_seconds
property clock_rising_edges_per_trigger
copy(self: vortex.engine.Source)vortex.engine.Source
property duty_cycle
property has_clock
property imaging_depth_meters
property triggers_per_second
class vortex.engine.SpectraHDF5StackEndpoint
property aggregate_segment_callback
property event_callback
property executor
property scan_callback
property segment_callback
property storage
property update_callback
property volume_callback
class vortex.engine.SpectraStackEndpoint
property aggregate_segment_callback
property event_callback
property executor
property scan_callback
property segment_callback
property storage
property update_callback
property volume_callback
class vortex.engine.SpectraStreamEndpoint
property storage
class vortex.engine.StackDeviceTensorEndpointFloat32
property aggregate_segment_callback
property event_callback
property executor
property scan_callback
property segment_callback
property stream
property tensor
property update_callback
property volume_callback
class vortex.engine.StackDeviceTensorEndpointInt8
property aggregate_segment_callback
property event_callback
property executor
property scan_callback
property segment_callback
property stream
property tensor
property update_callback
property volume_callback
class vortex.engine.StackDeviceTensorEndpointUInt16
property aggregate_segment_callback
property event_callback
property executor
property scan_callback
property segment_callback
property stream
property tensor
property update_callback
property volume_callback
class vortex.engine.StackHostTensorEndpointFloat32
property aggregate_segment_callback
property event_callback
property executor
property scan_callback
property segment_callback
property stream
property tensor
property update_callback
property volume_callback
class vortex.engine.StackHostTensorEndpointInt8
property aggregate_segment_callback
property event_callback
property executor
property scan_callback
property segment_callback
property stream
property tensor
property update_callback
property volume_callback
class vortex.engine.StackHostTensorEndpointUInt16
property aggregate_segment_callback
property event_callback
property executor
property scan_callback
property segment_callback
property stream
property tensor
property update_callback
property volume_callback
class vortex.engine.StackTensorEndpointFloat32
property aggregate_segment_callback
property event_callback
property executor
property scan_callback
property segment_callback
property tensor
property update_callback
property volume_callback
class vortex.engine.StackTensorEndpointInt8
property aggregate_segment_callback
property event_callback
property executor
property scan_callback
property segment_callback
property tensor
property update_callback
property volume_callback
class vortex.engine.StackTensorEndpointUInt16
property aggregate_segment_callback
property event_callback
property executor
property scan_callback
property segment_callback
property tensor
property update_callback
property volume_callback
class vortex.engine.StreamDumpStorage
property storage
vortex.engine.acquire_alazar_clock(*args, **kwargs)

Overloaded function.

  1. acquire_alazar_clock(arg0: vortex::engine::source_t<double>, arg1: vortex.acquire.AlazarConfig, arg2: vortex.driver.alazar.Channel) -> Tuple[int, numpy.ndarray[numpy.uint16]]

  2. acquire_alazar_clock(arg0: vortex::engine::source_t<double>, arg1: vortex.acquire.AlazarConfig, arg2: vortex.driver.alazar.Channel, arg3: vortex.Logger) -> Tuple[int, numpy.ndarray[numpy.uint16]]

vortex.engine.compute_resampling(*args, **kwargs)

Overloaded function.

  1. compute_resampling(arg0: vortex::engine::source_t<double>, arg1: int, arg2: int) -> numpy.ndarray[numpy.float64]

  2. compute_resampling(arg0: vortex::engine::source_t<double>, arg1: int, arg2: int, arg3: int) -> numpy.ndarray[numpy.float64]

vortex.engine.cycle(arg0: sequence)vortex::engine::engine_config_t<vortex::engine::block_t<unsigned short,signed char,double,unsigned long>,vortex::scan::warp_t<vortex::scan::warp::none_t,vortex::scan::warp::angular_t,vortex::scan::warp::telecentric_t> >::cycle_t
vortex.engine.dispersion_phasor(arg0: int, arg1: List[float[2]])numpy.ndarray[numpy.complex128]
vortex.engine.divide(arg0: sequence)vortex::engine::engine_config_t<vortex::engine::block_t<unsigned short,signed char,double,unsigned long>,vortex::scan::warp_t<vortex::scan::warp::none_t,vortex::scan::warp::angular_t,vortex::scan::warp::telecentric_t> >::divide_t
vortex.engine.find_rising_edges(*args, **kwargs)

Overloaded function.

  1. find_rising_edges(arg0: numpy.ndarray[numpy.float64], arg1: int) -> numpy.ndarray[numpy.float64]

  2. find_rising_edges(arg0: numpy.ndarray[numpy.float64], arg1: int, arg2: int) -> numpy.ndarray[numpy.float64]

  3. find_rising_edges(arg0: numpy.ndarray[numpy.float64], arg1: int) -> numpy.ndarray[numpy.float64]

  4. find_rising_edges(arg0: numpy.ndarray[numpy.float64], arg1: int, arg2: int) -> numpy.ndarray[numpy.float64]

class vortex.format.BroctFormatExecutor
class vortex.format.Copy
property block_offset
property buffer_record
property buffer_segment
property count
property reverse
class vortex.format.FinishScan
property sample
property scan_index
class vortex.format.FinishSegment
property sample
property scan_index
property segment_index_buffer
property volume_index
class vortex.format.FinishVolume
property sample
property scan_index
property volume_index
class vortex.format.FormatPlan
append(self: vortex.format.FormatPlan, x: Union[vortex.format.Copy, vortex.format.Resize, vortex.format.FinishSegment, vortex.format.FinishVolume, vortex.format.FinishScan, vortex::format::action::event])None

Add an item to the end of the list

clear(self: vortex.format.FormatPlan)None

Clear the contents

count(self: vortex.format.FormatPlan, x: Union[vortex.format.Copy, vortex.format.Resize, vortex.format.FinishSegment, vortex.format.FinishVolume, vortex.format.FinishScan, vortex::format::action::event])int

Return the number of times x appears in the list

extend(*args, **kwargs)

Overloaded function.

  1. extend(self: vortex.format.FormatPlan, L: vortex.format.FormatPlan) -> None

Extend the list by appending all the items in the given list

  1. extend(self: vortex.format.FormatPlan, L: Iterable) -> None

Extend the list by appending all the items in the given list

insert(self: vortex.format.FormatPlan, i: int, x: Union[vortex.format.Copy, vortex.format.Resize, vortex.format.FinishSegment, vortex.format.FinishVolume, vortex.format.FinishScan, vortex::format::action::event])None

Insert an item at a given position.

pop(*args, **kwargs)

Overloaded function.

  1. pop(self: vortex.format.FormatPlan) -> Union[vortex.format.Copy, vortex.format.Resize, vortex.format.FinishSegment, vortex.format.FinishVolume, vortex.format.FinishScan, vortex::format::action::event]

Remove and return the last item

  1. pop(self: vortex.format.FormatPlan, i: int) -> Union[vortex.format.Copy, vortex.format.Resize, vortex.format.FinishSegment, vortex.format.FinishVolume, vortex.format.FinishScan, vortex::format::action::event]

Remove and return the item at index i

remove(self: vortex.format.FormatPlan, x: Union[vortex.format.Copy, vortex.format.Resize, vortex.format.FinishSegment, vortex.format.FinishVolume, vortex.format.FinishScan, vortex::format::action::event])None

Remove the first item from the list whose value is x. It is an error if there is no such item.

class vortex.format.FormatPlanner
property config
initialize(self: vortex.format.FormatPlanner, arg0: vortex.format.FormatPlannerConfig)None
property records_per_segment
reset(self: vortex.format.FormatPlanner)None
property segments_per_volume
class vortex.format.FormatPlannerConfig
property adapt_shape
copy(self: vortex.format.FormatPlannerConfig)vortex.format.FormatPlannerConfig
property mask
property records_per_segment
property segments_per_volume
property shape
property strip_inactive
class vortex.format.LinearTransform
copy(self: vortex.format.LinearTransform)vortex.format.LinearTransform
property offset
property scale
class vortex.format.NullSlice
copy(self: vortex.format.NullSlice)vortex.format.NullSlice
class vortex.format.NullTransform
copy(self: vortex.format.NullTransform)vortex.format.NullTransform
class vortex.format.PositionFormatExecutor
property config
format(*args, **kwargs)

Overloaded function.

  1. format(self: vortex.format.PositionFormatExecutor, volume_buffer: vortex::cuda::cuda_view_t<int>, sample_target: vortex::cuda::cuda_view_t<float>, sample_actual: vortex::cuda::cuda_view_t<float>, segment_buffer: vortex::cuda::cuda_view_t<int>, segment_index: int, record_index: int = 0, reverse: bool = False) -> None

  2. format(self: vortex.format.PositionFormatExecutor, volume_buffer: vortex::cuda::cuda_view_t<int>, sample_target: vortex::cuda::cuda_view_t<float>, sample_actual: vortex::cuda::cuda_view_t<float>, segment_buffer: vortex::cuda::cuda_view_t<float>, segment_index: int, record_index: int = 0, reverse: bool = False) -> None

initialize(self: vortex.format.PositionFormatExecutor, arg0: vortex.format.PositionFormatExecutorConfig)None
class vortex.format.PositionFormatExecutorConfig
property channels
copy(self: vortex.format.PositionFormatExecutorConfig)vortex.format.PositionFormatExecutorConfig
property erase_after_volume
property sample_slice
property sample_transform
set(self: vortex.format.PositionFormatExecutorConfig, pitch: List[float[2]] = [1.0, 1.0], offset: List[float[2]] = [0.0, 0.0], angle: float = 0)None
property transform
property use_target_position
class vortex.format.RadialFormatExecutor
property config
format(*args, **kwargs)

Overloaded function.

  1. format(self: vortex.format.RadialFormatExecutor, volume_buffer: vortex::cuda::cuda_view_t<int>, segment_buffer: vortex::cuda::cuda_view_t<int>, segment_index: int, record_index: int = 0, reverse: bool = False) -> None

  2. format(self: vortex.format.RadialFormatExecutor, volume_buffer: vortex::cuda::cuda_view_t<int>, segment_buffer: vortex::cuda::cuda_view_t<float>, segment_index: int, record_index: int = 0, reverse: bool = False) -> None

initialize(self: vortex.format.RadialFormatExecutor, arg0: vortex.format.RadialFormatExecutorConfig)None
class vortex.format.RadialFormatExecutorConfig
property angular_extent
copy(self: vortex.format.RadialFormatExecutorConfig)vortex.format.RadialFormatExecutorConfig
property erase_after_volume
property radial_extent
property radial_records_per_segment
property radial_segments_per_volume
property radial_shape
property sample_slice
property sample_transform
property segment_rt_extent
property volume_xy_extent
property x_extent
property y_extent
class vortex.format.Resize
property records_per_segment
property segments_per_volume
property shape
class vortex.format.SimpleSlice
copy(self: vortex.format.SimpleSlice)vortex.format.SimpleSlice
count(self: vortex.format.SimpleSlice)int
property start
property step
property stop
class vortex.format.StackFormatExecutor
property config
initialize(self: vortex.format.StackFormatExecutor, arg0: vortex.format.StackFormatExecutorConfig)None
class vortex.format.StackFormatExecutorConfig
copy(self: vortex.format.StackFormatExecutorConfig)vortex.format.StackFormatExecutorConfig
property erase_after_volume
property sample_slice
property sample_transform
class vortex.io.AnalogVoltageInput
property channel
copy(self: vortex.io.AnalogVoltageInput)vortex.io.AnalogVoltageInput
property limits
property logical_units_per_physical_unit
property port_name
property stream
property terminal
class vortex.io.AnalogVoltageOutput
property channel
copy(self: vortex.io.AnalogVoltageOutput)vortex.io.AnalogVoltageOutput
property limits
property logical_units_per_physical_unit
property port_name
property stream
class vortex.io.DAQmxConfig
property blocks_to_buffer
property channels
property clock
copy(self: vortex.io.DAQmxConfig)vortex.io.DAQmxConfig
property name
property readwrite_timeout
property samples_per_block
property samples_per_second
property stop_on_error
validate(self: vortex.io.DAQmxConfig)None
class vortex.io.DAQmxConfigClock
copy(self: vortex.io.DAQmxConfigClock)vortex.io.DAQmxConfigClock
property divisor
property edge
property source
class vortex.io.DAQmxIO
property config
initialize(self: vortex.io.DAQmxIO, arg0: vortex.io.DAQmxConfig)None
prepare(self: vortex.io.DAQmxIO)None
property running
start(self: vortex.io.DAQmxIO)None
stop(self: vortex.io.DAQmxIO)None
class vortex.io.DigitalInput
property channel
copy(self: vortex.io.DigitalInput)vortex.io.DigitalInput
property line_name
max_bits = 32
property stream
class vortex.io.DigitalOutput
property channel
copy(self: vortex.io.DigitalOutput)vortex.io.DigitalOutput
property line_name
max_bits = 32
property stream
class vortex.io.NullConfig
copy(self: vortex.io.NullConfig)vortex.io.NullConfig
validate(self: vortex.io.NullConfig)None
class vortex.io.NullIO
property config
initialize(self: vortex.io.NullIO, arg0: vortex.io.NullConfig)None
prepare(self: vortex.io.NullIO)None
start(self: vortex.io.NullIO)None
stop(self: vortex.io.NullIO)None
class vortex.io.VectorChannel
append(self: vortex.io.VectorChannel, x: Union[vortex::io::channel::analog_voltage_input_t, vortex::io::channel::analog_voltage_output_t, vortex::io::channel::digital_input_t, vortex::io::channel::digital_output_t])None

Add an item to the end of the list

clear(self: vortex.io.VectorChannel)None

Clear the contents

count(self: vortex.io.VectorChannel, x: Union[vortex::io::channel::analog_voltage_input_t, vortex::io::channel::analog_voltage_output_t, vortex::io::channel::digital_input_t, vortex::io::channel::digital_output_t])int

Return the number of times x appears in the list

extend(*args, **kwargs)

Overloaded function.

  1. extend(self: vortex.io.VectorChannel, L: vortex.io.VectorChannel) -> None

Extend the list by appending all the items in the given list

  1. extend(self: vortex.io.VectorChannel, L: Iterable) -> None

Extend the list by appending all the items in the given list

insert(self: vortex.io.VectorChannel, i: int, x: Union[vortex::io::channel::analog_voltage_input_t, vortex::io::channel::analog_voltage_output_t, vortex::io::channel::digital_input_t, vortex::io::channel::digital_output_t])None

Insert an item at a given position.

pop(*args, **kwargs)

Overloaded function.

  1. pop(self: vortex.io.VectorChannel) -> Union[vortex::io::channel::analog_voltage_input_t, vortex::io::channel::analog_voltage_output_t, vortex::io::channel::digital_input_t, vortex::io::channel::digital_output_t]

Remove and return the last item

  1. pop(self: vortex.io.VectorChannel, i: int) -> Union[vortex::io::channel::analog_voltage_input_t, vortex::io::channel::analog_voltage_output_t, vortex::io::channel::digital_input_t, vortex::io::channel::digital_output_t]

Remove and return the item at index i

remove(self: vortex.io.VectorChannel, x: Union[vortex::io::channel::analog_voltage_input_t, vortex::io::channel::analog_voltage_output_t, vortex::io::channel::digital_input_t, vortex::io::channel::digital_output_t])None

Remove the first item from the list whose value is x. It is an error if there is no such item.

class vortex.marker.ActiveLines
property sample
class vortex.marker.Event
property id
property sample
class vortex.marker.Flags
static all()vortex.marker.Flags
clear(*args, **kwargs)

Overloaded function.

  1. clear(self: vortex.marker.Flags) -> None

Clears all bits

  1. clear(self: vortex.marker.Flags, arg0: int) -> None

Clears indicated bit

copy(self: vortex.marker.Flags)vortex.marker.Flags
property max_unique
static none()vortex.marker.Flags
set(*args, **kwargs)

Overloaded function.

  1. set(self: vortex.marker.Flags) -> None

Sets all bits

  1. set(self: vortex.marker.Flags, arg0: int) -> None

Sets indicated bit

property value
class vortex.marker.FlagsList
append(self: vortex.marker.FlagsList, x: vortex.marker.Flags)None

Add an item to the end of the list

clear(self: vortex.marker.FlagsList)None

Clear the contents

count(self: vortex.marker.FlagsList, x: vortex.marker.Flags)int

Return the number of times x appears in the list

extend(*args, **kwargs)

Overloaded function.

  1. extend(self: vortex.marker.FlagsList, L: vortex.marker.FlagsList) -> None

Extend the list by appending all the items in the given list

  1. extend(self: vortex.marker.FlagsList, L: Iterable) -> None

Extend the list by appending all the items in the given list

insert(self: vortex.marker.FlagsList, i: int, x: vortex.marker.Flags)None

Insert an item at a given position.

pop(*args, **kwargs)

Overloaded function.

  1. pop(self: vortex.marker.FlagsList) -> vortex.marker.Flags

Remove and return the last item

  1. pop(self: vortex.marker.FlagsList, i: int) -> vortex.marker.Flags

Remove and return the item at index i

remove(self: vortex.marker.FlagsList, x: vortex.marker.Flags)None

Remove the first item from the list whose value is x. It is an error if there is no such item.

class vortex.marker.InactiveLines
property sample
class vortex.marker.MarkerList
append(self: vortex.marker.MarkerList, x: Union[vortex.marker.ScanBoundary, vortex.marker.VolumeBoundary, vortex.marker.SegmentBoundary, vortex.marker.ActiveLines, vortex.marker.InactiveLines, vortex.marker.Event])None

Add an item to the end of the list

clear(self: vortex.marker.MarkerList)None

Clear the contents

count(self: vortex.marker.MarkerList, x: Union[vortex.marker.ScanBoundary, vortex.marker.VolumeBoundary, vortex.marker.SegmentBoundary, vortex.marker.ActiveLines, vortex.marker.InactiveLines, vortex.marker.Event])int

Return the number of times x appears in the list

extend(*args, **kwargs)

Overloaded function.

  1. extend(self: vortex.marker.MarkerList, L: vortex.marker.MarkerList) -> None

Extend the list by appending all the items in the given list

  1. extend(self: vortex.marker.MarkerList, L: Iterable) -> None

Extend the list by appending all the items in the given list

insert(self: vortex.marker.MarkerList, i: int, x: Union[vortex.marker.ScanBoundary, vortex.marker.VolumeBoundary, vortex.marker.SegmentBoundary, vortex.marker.ActiveLines, vortex.marker.InactiveLines, vortex.marker.Event])None

Insert an item at a given position.

pop(*args, **kwargs)

Overloaded function.

  1. pop(self: vortex.marker.MarkerList) -> Union[vortex.marker.ScanBoundary, vortex.marker.VolumeBoundary, vortex.marker.SegmentBoundary, vortex.marker.ActiveLines, vortex.marker.InactiveLines, vortex.marker.Event]

Remove and return the last item

  1. pop(self: vortex.marker.MarkerList, i: int) -> Union[vortex.marker.ScanBoundary, vortex.marker.VolumeBoundary, vortex.marker.SegmentBoundary, vortex.marker.ActiveLines, vortex.marker.InactiveLines, vortex.marker.Event]

Remove and return the item at index i

remove(self: vortex.marker.MarkerList, x: Union[vortex.marker.ScanBoundary, vortex.marker.VolumeBoundary, vortex.marker.SegmentBoundary, vortex.marker.ActiveLines, vortex.marker.InactiveLines, vortex.marker.Event])None

Remove the first item from the list whose value is x. It is an error if there is no such item.

class vortex.marker.ScanBoundary
property flags
property sample
property sequence
property volume_count_hint
class vortex.marker.SegmentBoundary
property flags
property index_in_volume
property record_count_hint
property reversed
property sample
property sequence
class vortex.marker.VolumeBoundary
property flags
property index_in_scan
property reversed
property sample
property segment_count_hint
property sequence
class vortex.memory.CpuTensorFloat32
clear(self: vortex.memory.CpuTensorFloat32)None
property count
property data
property dimension
property dtype
resize(self: vortex.memory.CpuTensorFloat32, shape: List[int])None
property shape
shrink(self: vortex.memory.CpuTensorFloat32)None
property size_in_bytes
property stride
property stride_in_bytes
property underlying_size_in_bytes
property valid
class vortex.memory.CpuTensorFloat64
clear(self: vortex.memory.CpuTensorFloat64)None
property count
property data
property dimension
property dtype
resize(self: vortex.memory.CpuTensorFloat64, shape: List[int])None
property shape
shrink(self: vortex.memory.CpuTensorFloat64)None
property size_in_bytes
property stride
property stride_in_bytes
property underlying_size_in_bytes
property valid
class vortex.memory.CpuTensorInt8
clear(self: vortex.memory.CpuTensorInt8)None
property count
property data
property dimension
property dtype
resize(self: vortex.memory.CpuTensorInt8, shape: List[int])None
property shape
shrink(self: vortex.memory.CpuTensorInt8)None
property size_in_bytes
property stride
property stride_in_bytes
property underlying_size_in_bytes
property valid
class vortex.memory.CpuTensorUInt16
clear(self: vortex.memory.CpuTensorUInt16)None
property count
property data
property dimension
property dtype
resize(self: vortex.memory.CpuTensorUInt16, shape: List[int])None
property shape
shrink(self: vortex.memory.CpuTensorUInt16)None
property size_in_bytes
property stride
property stride_in_bytes
property underlying_size_in_bytes
property valid
class vortex.memory.CudaDeviceTensorFloat32
clear(self: vortex.memory.CudaDeviceTensorFloat32)None
property count
property data
property device
property dimension
property dtype
resize(self: vortex.memory.CudaDeviceTensorFloat32, shape: List[int])None
property shape
shrink(self: vortex.memory.CudaDeviceTensorFloat32)None
property size_in_bytes
property stride
property stride_in_bytes
property underlying_size_in_bytes
property valid
class vortex.memory.CudaDeviceTensorFloat64
clear(self: vortex.memory.CudaDeviceTensorFloat64)None
property count
property data
property device
property dimension
property dtype
resize(self: vortex.memory.CudaDeviceTensorFloat64, shape: List[int])None
property shape
shrink(self: vortex.memory.CudaDeviceTensorFloat64)None
property size_in_bytes
property stride
property stride_in_bytes
property underlying_size_in_bytes
property valid
class vortex.memory.CudaDeviceTensorInt8
clear(self: vortex.memory.CudaDeviceTensorInt8)None
property count
property data
property device
property dimension
property dtype
resize(self: vortex.memory.CudaDeviceTensorInt8, shape: List[int])None
property shape
shrink(self: vortex.memory.CudaDeviceTensorInt8)None
property size_in_bytes
property stride
property stride_in_bytes
property underlying_size_in_bytes
property valid
class vortex.memory.CudaDeviceTensorUInt16
clear(self: vortex.memory.CudaDeviceTensorUInt16)None
property count
property data
property device
property dimension
property dtype
resize(self: vortex.memory.CudaDeviceTensorUInt16, shape: List[int])None
property shape
shrink(self: vortex.memory.CudaDeviceTensorUInt16)None
property size_in_bytes
property stride
property stride_in_bytes
property underlying_size_in_bytes
property valid
class vortex.memory.CudaHostTensorFloat32
clear(self: vortex.memory.CudaHostTensorFloat32)None
property count
property data
property dimension
property dtype
resize(self: vortex.memory.CudaHostTensorFloat32, shape: List[int])None
property shape
shrink(self: vortex.memory.CudaHostTensorFloat32)None
property size_in_bytes
property stride
property stride_in_bytes
property underlying_size_in_bytes
property valid
class vortex.memory.CudaHostTensorFloat64
clear(self: vortex.memory.CudaHostTensorFloat64)None
property count
property data
property dimension
property dtype
resize(self: vortex.memory.CudaHostTensorFloat64, shape: List[int])None
property shape
shrink(self: vortex.memory.CudaHostTensorFloat64)None
property size_in_bytes
property stride
property stride_in_bytes
property underlying_size_in_bytes
property valid
class vortex.memory.CudaHostTensorInt8
clear(self: vortex.memory.CudaHostTensorInt8)None
property count
property data
property dimension
property dtype
resize(self: vortex.memory.CudaHostTensorInt8, shape: List[int])None
property shape
shrink(self: vortex.memory.CudaHostTensorInt8)None
property size_in_bytes
property stride
property stride_in_bytes
property underlying_size_in_bytes
property valid
class vortex.memory.CudaHostTensorUInt16
clear(self: vortex.memory.CudaHostTensorUInt16)None
property count
property data
property dimension
property dtype
resize(self: vortex.memory.CudaHostTensorUInt16, shape: List[int])None
property shape
shrink(self: vortex.memory.CudaHostTensorUInt16)None
property size_in_bytes
property stride
property stride_in_bytes
property underlying_size_in_bytes
property valid
class vortex.process.CUDAProcessor
change(self: vortex.process.CUDAProcessor, arg0: vortex.process.CUDAProcessorConfig)None
property config
initialize(self: vortex.process.CUDAProcessor, arg0: vortex.process.CUDAProcessorConfig)None
next(self: vortex.process.CUDAProcessor, input_buffer: vortex::cuda::cuda_view_t<int>, output_buffer: vortex::cuda::cuda_view_t<int>, append_history: bool = True)None
class vortex.process.CUDAProcessorConfig
property ascans_per_block
property average_window
property channel
copy(self: vortex.process.CUDAProcessorConfig)vortex.process.CUDAProcessorConfig
property device
property enable_ifft
property enable_log10
property input_shape
property output_shape
property records_per_block
property resampling_samples
property samples_per_ascan
property samples_per_record
property slots
property spectral_filter
validate(self: vortex.process.CUDAProcessorConfig)None
class vortex.process.CopyProcessor
change(self: vortex.process.CopyProcessor, arg0: vortex.process.CopyProcessorConfig)None
property config
initialize(self: vortex.process.CopyProcessor, arg0: vortex.process.CopyProcessorConfig)None
next(self: vortex.process.CopyProcessor, input_buffer: vortex::cpu_view_t<int>, output_buffer: vortex::cpu_view_t<int>)None
class vortex.process.CopyProcessorConfig
property ascans_per_block
property channel
copy(self: vortex.process.CopyProcessorConfig)vortex.process.CopyProcessorConfig
property input_shape
property output_shape
property records_per_block
property sample_slice
property sample_transform
property samples_per_ascan
property samples_per_record
property slots
class vortex.process.NullProcessor
property config
initialize(self: vortex.process.NullProcessor, arg0: vortex.process.NullProcessorConfig)None
class vortex.process.NullProcessorConfig
property ascans_per_block
property average_window
property channel
copy(self: vortex.process.NullProcessorConfig)vortex.process.NullProcessorConfig
property enable_ifft
property enable_log10
property input_shape
property output_shape
property records_per_block
property resampling_samples
property samples_per_ascan
property samples_per_record
property spectral_filter
class vortex.scan.FreeformScan
change(*args, **kwargs)

Overloaded function.

  1. change(self: vortex.scan.FreeformScan, config: vortex::scan::detail::patterned_config_factory_t<double,vortex::scan::null_waypoints_t<double>,vortex::scan::manual_pattern_t<double,vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> > >, restart: bool = False) -> None

  2. change(self: vortex.scan.FreeformScan, arg0: vortex::scan::detail::patterned_config_factory_t<double,vortex::scan::null_waypoints_t<double>,vortex::scan::manual_pattern_t<double,vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> > >, arg1: bool, arg2: int) -> None

property config
initialize(self: vortex.scan.FreeformScan, arg0: vortex::scan::detail::patterned_config_factory_t<double, vortex::scan::null_waypoints_t<double>, vortex::scan::manual_pattern_t<double, vortex::marker::marker_t<vortex::marker::scan_boundary, vortex::marker::volume_boundary, vortex::marker::segment_boundary, vortex::marker::active_lines, vortex::marker::inactive_lines, vortex::marker::event> > >)None
next(*args, **kwargs)

Overloaded function.

  1. next(self: vortex.scan.FreeformScan, buffer: vortex::cpu_view_t<float>) -> Tuple[int, vortex.marker.MarkerList]

  2. next(self: vortex.scan.FreeformScan, markers: vortex.marker.MarkerList, buffer: vortex::cpu_view_t<float>) -> int

prepare(*args, **kwargs)

Overloaded function.

  1. prepare(self: vortex.scan.FreeformScan) -> None

  2. prepare(self: vortex.scan.FreeformScan, count: int) -> None

restart(*args, **kwargs)

Overloaded function.

  1. restart(self: vortex.scan.FreeformScan) -> None

  2. restart(self: vortex.scan.FreeformScan, sample: int, position: numpy.ndarray[numpy.float64], velocity: numpy.ndarray[numpy.float64], include_start: bool) -> None

scan_buffer(self: vortex.scan.FreeformScan)numpy.ndarray[numpy.float64]
scan_markers(self: vortex.scan.FreeformScan)vortex.marker.MarkerList
scan_segments(self: vortex.scan.FreeformScan)List[vortex.scan.Segment]
class vortex.scan.FreeformScanConfig
property bypass_limits_check
property channels_per_sample
property consolidate
copy(self: vortex.scan.FreeformScanConfig)vortex.scan.FreeformScanConfig
property limits
property loop
property pattern
property samples_per_second
property sampling_interval
to_segments(self: vortex.scan.FreeformScanConfig)List[vortex.scan.Segment]
class vortex.scan.Limits
property acceleration
copy(self: vortex.scan.Limits)vortex.scan.Limits
property position
property velocity
class vortex.scan.RadialScan
change(*args, **kwargs)

Overloaded function.

  1. change(self: vortex.scan.RadialScan, config: vortex::scan::detail::patterned_config_factory_t<double,vortex::scan::radial_waypoints_t<double,vortex::scan::warp_t<vortex::scan::warp::none_t,vortex::scan::warp::angular_t,vortex::scan::warp::telecentric_t> >,vortex::scan::sequential_pattern_t<vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> > >, restart: bool = False) -> None

  2. change(self: vortex.scan.RadialScan, arg0: vortex::scan::detail::patterned_config_factory_t<double,vortex::scan::radial_waypoints_t<double,vortex::scan::warp_t<vortex::scan::warp::none_t,vortex::scan::warp::angular_t,vortex::scan::warp::telecentric_t> >,vortex::scan::sequential_pattern_t<vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> > >, arg1: bool, arg2: int) -> None

property config
initialize(self: vortex.scan.RadialScan, arg0: vortex::scan::detail::patterned_config_factory_t<double, vortex::scan::radial_waypoints_t<double, vortex::scan::warp_t<vortex::scan::warp::none_t, vortex::scan::warp::angular_t, vortex::scan::warp::telecentric_t> >, vortex::scan::sequential_pattern_t<vortex::marker::marker_t<vortex::marker::scan_boundary, vortex::marker::volume_boundary, vortex::marker::segment_boundary, vortex::marker::active_lines, vortex::marker::inactive_lines, vortex::marker::event> > >)None
next(*args, **kwargs)

Overloaded function.

  1. next(self: vortex.scan.RadialScan, buffer: vortex::cpu_view_t<float>) -> Tuple[int, vortex.marker.MarkerList]

  2. next(self: vortex.scan.RadialScan, markers: vortex.marker.MarkerList, buffer: vortex::cpu_view_t<float>) -> int

prepare(*args, **kwargs)

Overloaded function.

  1. prepare(self: vortex.scan.RadialScan) -> None

  2. prepare(self: vortex.scan.RadialScan, count: int) -> None

restart(*args, **kwargs)

Overloaded function.

  1. restart(self: vortex.scan.RadialScan) -> None

  2. restart(self: vortex.scan.RadialScan, sample: int, position: numpy.ndarray[numpy.float64], velocity: numpy.ndarray[numpy.float64], include_start: bool) -> None

scan_buffer(self: vortex.scan.RadialScan)numpy.ndarray[numpy.float64]
scan_markers(self: vortex.scan.RadialScan)vortex.marker.MarkerList
scan_segments(self: vortex.scan.RadialScan)List[vortex.scan.Segment]
class vortex.scan.RadialScanConfig
property angle
property ascans_per_bscan
property bidirectional_segments
property bidirectional_volumes
property bscan_extent
property bscans_per_volume
property bypass_limits_check
property channels_per_sample
property consolidate
copy(*args, **kwargs)

Overloaded function.

  1. copy(self: vortex.scan.RadialScanConfig) -> vortex.scan.RadialScanConfig

  2. copy(self: vortex.scan.RadialScanConfig) -> vortex.scan.RadialScanConfig

property extents
property flags
property limits
property loop
property offset
property samples_per_second
property samples_per_segment
property sampling_interval
property segment_extent
property segments_per_volume
set_aiming(self: vortex.scan.RadialScanConfig)None
set_evenly_spaced(self: vortex.scan.RadialScanConfig, arg0: int)None
set_half_evenly_spaced(self: vortex.scan.RadialScanConfig, arg0: int)None
property shape
to_pattern(*args, **kwargs)

Overloaded function.

  1. to_pattern(self: vortex.scan.RadialScanConfig, arg0: numpy.ndarray[numpy.float64]) -> List[vortex.scan.Segment]

  2. to_pattern(self: vortex.scan.RadialScanConfig, arg0: List[numpy.ndarray[numpy.float64]]) -> List[vortex.scan.Segment]

to_segments(self: vortex.scan.RadialScanConfig)List[vortex.scan.Segment]
to_waypoints(self: vortex.scan.RadialScanConfig)numpy.ndarray[numpy.float64]
property volume_extent
property warp
class vortex.scan.RadialWaypoints
property angle
property ascans_per_bscan
property bscan_extent
property bscans_per_volume
property extents
property offset
property samples_per_segment
property segment_extent
property segments_per_volume
set_aiming(self: vortex.scan.RadialWaypoints)None
set_evenly_spaced(self: vortex.scan.RadialWaypoints, arg0: int)None
set_half_evenly_spaced(self: vortex.scan.RadialWaypoints, arg0: int)None
property shape
to_waypoints(self: vortex.scan.RadialWaypoints)numpy.ndarray[numpy.float64]
property volume_extent
property warp
class vortex.scan.RasterScan
change(*args, **kwargs)

Overloaded function.

  1. change(self: vortex.scan.RasterScan, config: vortex::scan::detail::patterned_config_factory_t<double,vortex::scan::raster_waypoints_t<double,vortex::scan::warp_t<vortex::scan::warp::none_t,vortex::scan::warp::angular_t,vortex::scan::warp::telecentric_t> >,vortex::scan::sequential_pattern_t<vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> > >, restart: bool = False) -> None

  2. change(self: vortex.scan.RasterScan, arg0: vortex::scan::detail::patterned_config_factory_t<double,vortex::scan::raster_waypoints_t<double,vortex::scan::warp_t<vortex::scan::warp::none_t,vortex::scan::warp::angular_t,vortex::scan::warp::telecentric_t> >,vortex::scan::sequential_pattern_t<vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> > >, arg1: bool, arg2: int) -> None

property config
initialize(self: vortex.scan.RasterScan, arg0: vortex::scan::detail::patterned_config_factory_t<double, vortex::scan::raster_waypoints_t<double, vortex::scan::warp_t<vortex::scan::warp::none_t, vortex::scan::warp::angular_t, vortex::scan::warp::telecentric_t> >, vortex::scan::sequential_pattern_t<vortex::marker::marker_t<vortex::marker::scan_boundary, vortex::marker::volume_boundary, vortex::marker::segment_boundary, vortex::marker::active_lines, vortex::marker::inactive_lines, vortex::marker::event> > >)None
next(*args, **kwargs)

Overloaded function.

  1. next(self: vortex.scan.RasterScan, buffer: vortex::cpu_view_t<float>) -> Tuple[int, vortex.marker.MarkerList]

  2. next(self: vortex.scan.RasterScan, markers: vortex.marker.MarkerList, buffer: vortex::cpu_view_t<float>) -> int

prepare(*args, **kwargs)

Overloaded function.

  1. prepare(self: vortex.scan.RasterScan) -> None

  2. prepare(self: vortex.scan.RasterScan, count: int) -> None

restart(*args, **kwargs)

Overloaded function.

  1. restart(self: vortex.scan.RasterScan) -> None

  2. restart(self: vortex.scan.RasterScan, sample: int, position: numpy.ndarray[numpy.float64], velocity: numpy.ndarray[numpy.float64], include_start: bool) -> None

scan_buffer(self: vortex.scan.RasterScan)numpy.ndarray[numpy.float64]
scan_markers(self: vortex.scan.RasterScan)vortex.marker.MarkerList
scan_segments(self: vortex.scan.RasterScan)List[vortex.scan.Segment]
class vortex.scan.RasterScanConfig
property angle
property ascans_per_bscan
property bidirectional_segments
property bidirectional_volumes
property bscan_extent
property bscans_per_volume
property bypass_limits_check
property channels_per_sample
property consolidate
copy(*args, **kwargs)

Overloaded function.

  1. copy(self: vortex.scan.RasterScanConfig) -> vortex.scan.RasterScanConfig

  2. copy(self: vortex.scan.RasterScanConfig) -> vortex.scan.RasterScanConfig

property extents
property flags
property limits
property loop
property offset
property samples_per_second
property samples_per_segment
property sampling_interval
property segment_extent
property segments_per_volume
property shape
to_pattern(*args, **kwargs)

Overloaded function.

  1. to_pattern(self: vortex.scan.RasterScanConfig, arg0: numpy.ndarray[numpy.float64]) -> List[vortex.scan.Segment]

  2. to_pattern(self: vortex.scan.RasterScanConfig, arg0: List[numpy.ndarray[numpy.float64]]) -> List[vortex.scan.Segment]

to_segments(self: vortex.scan.RasterScanConfig)List[vortex.scan.Segment]
to_waypoints(self: vortex.scan.RasterScanConfig)numpy.ndarray[numpy.float64]
property volume_extent
property warp
class vortex.scan.RasterWaypoints
property angle
property ascans_per_bscan
property bscan_extent
property bscans_per_volume
property extents
property offset
property samples_per_segment
property segment_extent
property segments_per_volume
property shape
to_waypoints(self: vortex.scan.RasterWaypoints)numpy.ndarray[numpy.float64]
property volume_extent
property warp
class vortex.scan.RepeatFlags
copy(self: vortex.scan.RepeatFlags)vortex.scan.RepeatFlags
property flags
class vortex.scan.RepeatPack
copy(self: vortex.scan.RepeatPack)vortex.scan.RepeatPack
property flags
class vortex.scan.RepeatedPattern
property bidirectional_segments
copy(self: vortex.scan.RepeatedPattern)vortex.scan.RepeatedPattern
property repeat_count
property repeat_period
property repeat_strategy
to_pattern(*args, **kwargs)

Overloaded function.

  1. to_pattern(self: vortex.scan.RepeatedPattern, arg0: numpy.ndarray[numpy.float64]) -> List[vortex.scan.Segment]

  2. to_pattern(self: vortex.scan.RepeatedPattern, arg0: List[numpy.ndarray[numpy.float64]]) -> List[vortex.scan.Segment]

class vortex.scan.RepeatedRadialScan
change(*args, **kwargs)

Overloaded function.

  1. change(self: vortex.scan.RepeatedRadialScan, config: vortex::scan::detail::patterned_config_factory_t<double,vortex::scan::radial_waypoints_t<double,vortex::scan::warp_t<vortex::scan::warp::none_t,vortex::scan::warp::angular_t,vortex::scan::warp::telecentric_t> >,vortex::scan::repeated_pattern_t<vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> > >, restart: bool = False) -> None

  2. change(self: vortex.scan.RepeatedRadialScan, arg0: vortex::scan::detail::patterned_config_factory_t<double,vortex::scan::radial_waypoints_t<double,vortex::scan::warp_t<vortex::scan::warp::none_t,vortex::scan::warp::angular_t,vortex::scan::warp::telecentric_t> >,vortex::scan::repeated_pattern_t<vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> > >, arg1: bool, arg2: int) -> None

property config
initialize(self: vortex.scan.RepeatedRadialScan, arg0: vortex::scan::detail::patterned_config_factory_t<double, vortex::scan::radial_waypoints_t<double, vortex::scan::warp_t<vortex::scan::warp::none_t, vortex::scan::warp::angular_t, vortex::scan::warp::telecentric_t> >, vortex::scan::repeated_pattern_t<vortex::marker::marker_t<vortex::marker::scan_boundary, vortex::marker::volume_boundary, vortex::marker::segment_boundary, vortex::marker::active_lines, vortex::marker::inactive_lines, vortex::marker::event> > >)None
next(*args, **kwargs)

Overloaded function.

  1. next(self: vortex.scan.RepeatedRadialScan, buffer: vortex::cpu_view_t<float>) -> Tuple[int, vortex.marker.MarkerList]

  2. next(self: vortex.scan.RepeatedRadialScan, markers: vortex.marker.MarkerList, buffer: vortex::cpu_view_t<float>) -> int

prepare(*args, **kwargs)

Overloaded function.

  1. prepare(self: vortex.scan.RepeatedRadialScan) -> None

  2. prepare(self: vortex.scan.RepeatedRadialScan, count: int) -> None

restart(*args, **kwargs)

Overloaded function.

  1. restart(self: vortex.scan.RepeatedRadialScan) -> None

  2. restart(self: vortex.scan.RepeatedRadialScan, sample: int, position: numpy.ndarray[numpy.float64], velocity: numpy.ndarray[numpy.float64], include_start: bool) -> None

scan_buffer(self: vortex.scan.RepeatedRadialScan)numpy.ndarray[numpy.float64]
scan_markers(self: vortex.scan.RepeatedRadialScan)vortex.marker.MarkerList
scan_segments(self: vortex.scan.RepeatedRadialScan)List[vortex.scan.Segment]
class vortex.scan.RepeatedRadialScanConfig
property angle
property ascans_per_bscan
property bidirectional_segments
property bscan_extent
property bscans_per_volume
property bypass_limits_check
property channels_per_sample
property consolidate
copy(*args, **kwargs)

Overloaded function.

  1. copy(self: vortex.scan.RepeatedRadialScanConfig) -> vortex.scan.RepeatedRadialScanConfig

  2. copy(self: vortex.scan.RepeatedRadialScanConfig) -> vortex.scan.RepeatedRadialScanConfig

property extents
property limits
property loop
property offset
property repeat_count
property repeat_period
property repeat_strategy
property samples_per_second
property samples_per_segment
property sampling_interval
property segment_extent
property segments_per_volume
set_aiming(self: vortex.scan.RepeatedRadialScanConfig)None
set_evenly_spaced(self: vortex.scan.RepeatedRadialScanConfig, arg0: int)None
set_half_evenly_spaced(self: vortex.scan.RepeatedRadialScanConfig, arg0: int)None
property shape
to_pattern(*args, **kwargs)

Overloaded function.

  1. to_pattern(self: vortex.scan.RepeatedRadialScanConfig, arg0: numpy.ndarray[numpy.float64]) -> List[vortex.scan.Segment]

  2. to_pattern(self: vortex.scan.RepeatedRadialScanConfig, arg0: List[numpy.ndarray[numpy.float64]]) -> List[vortex.scan.Segment]

to_segments(self: vortex.scan.RepeatedRadialScanConfig)List[vortex.scan.Segment]
to_waypoints(self: vortex.scan.RepeatedRadialScanConfig)numpy.ndarray[numpy.float64]
property volume_extent
property warp
class vortex.scan.RepeatedRasterScan
change(*args, **kwargs)

Overloaded function.

  1. change(self: vortex.scan.RepeatedRasterScan, config: vortex::scan::detail::patterned_config_factory_t<double,vortex::scan::raster_waypoints_t<double,vortex::scan::warp_t<vortex::scan::warp::none_t,vortex::scan::warp::angular_t,vortex::scan::warp::telecentric_t> >,vortex::scan::repeated_pattern_t<vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> > >, restart: bool = False) -> None

  2. change(self: vortex.scan.RepeatedRasterScan, arg0: vortex::scan::detail::patterned_config_factory_t<double,vortex::scan::raster_waypoints_t<double,vortex::scan::warp_t<vortex::scan::warp::none_t,vortex::scan::warp::angular_t,vortex::scan::warp::telecentric_t> >,vortex::scan::repeated_pattern_t<vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> > >, arg1: bool, arg2: int) -> None

property config
initialize(self: vortex.scan.RepeatedRasterScan, arg0: vortex::scan::detail::patterned_config_factory_t<double, vortex::scan::raster_waypoints_t<double, vortex::scan::warp_t<vortex::scan::warp::none_t, vortex::scan::warp::angular_t, vortex::scan::warp::telecentric_t> >, vortex::scan::repeated_pattern_t<vortex::marker::marker_t<vortex::marker::scan_boundary, vortex::marker::volume_boundary, vortex::marker::segment_boundary, vortex::marker::active_lines, vortex::marker::inactive_lines, vortex::marker::event> > >)None
next(*args, **kwargs)

Overloaded function.

  1. next(self: vortex.scan.RepeatedRasterScan, buffer: vortex::cpu_view_t<float>) -> Tuple[int, vortex.marker.MarkerList]

  2. next(self: vortex.scan.RepeatedRasterScan, markers: vortex.marker.MarkerList, buffer: vortex::cpu_view_t<float>) -> int

prepare(*args, **kwargs)

Overloaded function.

  1. prepare(self: vortex.scan.RepeatedRasterScan) -> None

  2. prepare(self: vortex.scan.RepeatedRasterScan, count: int) -> None

restart(*args, **kwargs)

Overloaded function.

  1. restart(self: vortex.scan.RepeatedRasterScan) -> None

  2. restart(self: vortex.scan.RepeatedRasterScan, sample: int, position: numpy.ndarray[numpy.float64], velocity: numpy.ndarray[numpy.float64], include_start: bool) -> None

scan_buffer(self: vortex.scan.RepeatedRasterScan)numpy.ndarray[numpy.float64]
scan_markers(self: vortex.scan.RepeatedRasterScan)vortex.marker.MarkerList
scan_segments(self: vortex.scan.RepeatedRasterScan)List[vortex.scan.Segment]
class vortex.scan.RepeatedRasterScanConfig
property angle
property ascans_per_bscan
property bidirectional_segments
property bscan_extent
property bscans_per_volume
property bypass_limits_check
property channels_per_sample
property consolidate
copy(*args, **kwargs)

Overloaded function.

  1. copy(self: vortex.scan.RepeatedRasterScanConfig) -> vortex.scan.RepeatedRasterScanConfig

  2. copy(self: vortex.scan.RepeatedRasterScanConfig) -> vortex.scan.RepeatedRasterScanConfig

property extents
property limits
property loop
property offset
property repeat_count
property repeat_period
property repeat_strategy
property samples_per_second
property samples_per_segment
property sampling_interval
property segment_extent
property segments_per_volume
property shape
to_pattern(*args, **kwargs)

Overloaded function.

  1. to_pattern(self: vortex.scan.RepeatedRasterScanConfig, arg0: numpy.ndarray[numpy.float64]) -> List[vortex.scan.Segment]

  2. to_pattern(self: vortex.scan.RepeatedRasterScanConfig, arg0: List[numpy.ndarray[numpy.float64]]) -> List[vortex.scan.Segment]

to_segments(self: vortex.scan.RepeatedRasterScanConfig)List[vortex.scan.Segment]
to_waypoints(self: vortex.scan.RepeatedRasterScanConfig)numpy.ndarray[numpy.float64]
property volume_extent
property warp
class vortex.scan.Segment
copy(self: vortex.scan.Segment)vortex.scan.Segment
property entry_position
entry_velocity(self: vortex.scan.Segment, arg0: int)numpy.ndarray[numpy.float64]
property exit_position
exit_velocity(self: vortex.scan.Segment, arg0: int)numpy.ndarray[numpy.float64]
property markers
property position
class vortex.scan.SegmentList
append(self: List[vortex.scan.Segment], x: vortex.scan.Segment)None

Add an item to the end of the list

clear(self: List[vortex.scan.Segment])None

Clear the contents

extend(*args, **kwargs)

Overloaded function.

  1. extend(self: List[vortex.scan.Segment], L: List[vortex.scan.Segment]) -> None

Extend the list by appending all the items in the given list

  1. extend(self: List[vortex.scan.Segment], L: Iterable) -> None

Extend the list by appending all the items in the given list

insert(self: List[vortex.scan.Segment], i: int, x: vortex.scan.Segment)None

Insert an item at a given position.

pop(*args, **kwargs)

Overloaded function.

  1. pop(self: List[vortex.scan.Segment]) -> vortex.scan.Segment

Remove and return the last item

  1. pop(self: List[vortex.scan.Segment], i: int) -> vortex.scan.Segment

Remove and return the item at index i

class vortex.scan.SequentialPattern
property bidirectional_segments
property bidirectional_volumes
copy(self: vortex.scan.SequentialPattern)vortex.scan.SequentialPattern
property flags
to_pattern(*args, **kwargs)

Overloaded function.

  1. to_pattern(self: vortex.scan.SequentialPattern, arg0: numpy.ndarray[numpy.float64]) -> List[vortex.scan.Segment]

  2. to_pattern(self: vortex.scan.SequentialPattern, arg0: List[numpy.ndarray[numpy.float64]]) -> List[vortex.scan.Segment]

class vortex.scan.SpiralScan
change(*args, **kwargs)

Overloaded function.

  1. change(self: vortex.scan.SpiralScan, config: vortex::scan::detail::patterned_config_factory_t<double,vortex::scan::spiral_waypoints_t<double,vortex::scan::warp_t<vortex::scan::warp::none_t,vortex::scan::warp::angular_t,vortex::scan::warp::telecentric_t> >,vortex::scan::sequential_pattern_t<vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> > >, restart: bool = False) -> None

  2. change(self: vortex.scan.SpiralScan, arg0: vortex::scan::detail::patterned_config_factory_t<double,vortex::scan::spiral_waypoints_t<double,vortex::scan::warp_t<vortex::scan::warp::none_t,vortex::scan::warp::angular_t,vortex::scan::warp::telecentric_t> >,vortex::scan::sequential_pattern_t<vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event> > >, arg1: bool, arg2: int) -> None

property config
initialize(self: vortex.scan.SpiralScan, arg0: vortex::scan::detail::patterned_config_factory_t<double, vortex::scan::spiral_waypoints_t<double, vortex::scan::warp_t<vortex::scan::warp::none_t, vortex::scan::warp::angular_t, vortex::scan::warp::telecentric_t> >, vortex::scan::sequential_pattern_t<vortex::marker::marker_t<vortex::marker::scan_boundary, vortex::marker::volume_boundary, vortex::marker::segment_boundary, vortex::marker::active_lines, vortex::marker::inactive_lines, vortex::marker::event> > >)None
next(*args, **kwargs)

Overloaded function.

  1. next(self: vortex.scan.SpiralScan, buffer: vortex::cpu_view_t<float>) -> Tuple[int, vortex.marker.MarkerList]

  2. next(self: vortex.scan.SpiralScan, markers: vortex.marker.MarkerList, buffer: vortex::cpu_view_t<float>) -> int

prepare(*args, **kwargs)

Overloaded function.

  1. prepare(self: vortex.scan.SpiralScan) -> None

  2. prepare(self: vortex.scan.SpiralScan, count: int) -> None

restart(*args, **kwargs)

Overloaded function.

  1. restart(self: vortex.scan.SpiralScan) -> None

  2. restart(self: vortex.scan.SpiralScan, sample: int, position: numpy.ndarray[numpy.float64], velocity: numpy.ndarray[numpy.float64], include_start: bool) -> None

scan_buffer(self: vortex.scan.SpiralScan)numpy.ndarray[numpy.float64]
scan_markers(self: vortex.scan.SpiralScan)vortex.marker.MarkerList
scan_segments(self: vortex.scan.SpiralScan)List[vortex.scan.Segment]
class vortex.scan.SpiralScanConfig
property amplitude
property angle
property ascans_per_bscan
property bidirectional_segments
property bidirectional_volumes
property bscan_extent
property bscans_per_volume
property bypass_limits_check
property cav_omega
property channels_per_sample
property clv_velocity
property consolidate
copy(*args, **kwargs)

Overloaded function.

  1. copy(self: vortex.scan.SpiralScanConfig) -> vortex.scan.SpiralScanConfig

  2. copy(self: vortex.scan.SpiralScanConfig) -> vortex.scan.SpiralScanConfig

property delta_t
property extents
property flags
property limits
property loop
property offset
property pitch
property r_transition
property samples_per_second
property samples_per_segment
property sampling_interval
property segment_extent
property segments_per_volume
set_hybrid_spiral(self: vortex.scan.SpiralScanConfig, arg0: float, arg1: float, arg2: float, arg3: float, arg4: int)None
property shape
property t_end
property t_transition
to_pattern(*args, **kwargs)

Overloaded function.

  1. to_pattern(self: vortex.scan.SpiralScanConfig, arg0: numpy.ndarray[numpy.float64]) -> List[vortex.scan.Segment]

  2. to_pattern(self: vortex.scan.SpiralScanConfig, arg0: List[numpy.ndarray[numpy.float64]]) -> List[vortex.scan.Segment]

to_segments(self: vortex.scan.SpiralScanConfig)List[vortex.scan.Segment]
to_waypoints(self: vortex.scan.SpiralScanConfig)numpy.ndarray[numpy.float64]
property volume_extent
property warp
class vortex.scan.SpiralWaypoints
property amplitude
property angle
property ascans_per_bscan
property bscan_extent
property bscans_per_volume
property cav_omega
property clv_velocity
property delta_t
property extents
property offset
property pitch
property r_transition
property samples_per_segment
property segment_extent
property segments_per_volume
set_hybrid_spiral(self: vortex.scan.SpiralWaypoints, arg0: float, arg1: float, arg2: float, arg3: float, arg4: int)None
property shape
property t_end
property t_transition
to_waypoints(self: vortex.scan.SpiralWaypoints)numpy.ndarray[numpy.float64]
property volume_extent
property warp
class vortex.storage.BroctScan

Members:

rectangular

bscan

aiming

mscan

radial

ascan

speckle

mixed

xfast_yfast

xfast_yfast_speckle

spiral

aiming = <BroctScan.aiming: 2>
ascan = <BroctScan.ascan: 5>
bscan = <BroctScan.bscan: 1>
mixed = <BroctScan.mixed: 7>
mscan = <BroctScan.mscan: 3>
property name
radial = <BroctScan.radial: 4>
rectangular = <BroctScan.rectangular: 0>
speckle = <BroctScan.speckle: 6>
spiral = <BroctScan.spiral: 10>
property value
xfast_yfast = <BroctScan.xfast_yfast: 8>
xfast_yfast_speckle = <BroctScan.xfast_yfast_speckle: 9>
class vortex.storage.BroctStorage
advance_volume(self: vortex.storage.BroctStorage, allocate: bool = True)None
close(self: vortex.storage.BroctStorage)None
property config
open(self: vortex.storage.BroctStorage, arg0: vortex::storage::broct_storage_config_t)None
seek(self: vortex.storage.BroctStorage, arg0: int, arg1: int)None
write_bscan(self: vortex.storage.BroctStorage, index: int, data: vortex::detail::cpu_view_t<signed char const >)None
write_multi_bscan(self: vortex.storage.BroctStorage, index: int, data: vortex::detail::cpu_view_t<signed char const >)None
write_volume(self: vortex.storage.BroctStorage, data: vortex::detail::cpu_view_t<signed char const >)None
class vortex.storage.BroctStorageConfig
property ascans_per_bscan
property broct_bscan_shape
property broct_volume_shape
property bscans_per_volume
property buffering
copy(self: vortex.storage.BroctStorageConfig)vortex.storage.BroctStorageConfig
property dimensions
property notes
property path
property samples_per_ascan
property scan_type
property shape
class vortex.storage.HDF5StackConfig
property ascans_per_bscan
property bscan_shape
property bscans_per_volume
property channels_per_sample
property compression_level
copy(self: vortex.storage.HDF5StackConfig)vortex.storage.HDF5StackConfig
property header
property path
property samples_per_ascan
property shape
property volume_shape
class vortex.storage.HDF5StackHeader

Members:

Empty

MATLAB

Empty = <HDF5StackHeader.Empty: 0>
MATLAB = <HDF5StackHeader.MATLAB: 1>
property name
property value
class vortex.storage.HDF5StackInt8
advance_volume(self: vortex.storage.HDF5StackInt8, allocate: bool = True)None
close(self: vortex.storage.HDF5StackInt8)None
property config
open(self: vortex.storage.HDF5StackInt8, arg0: vortex.storage.HDF5StackConfig)None
property ready
class vortex.storage.HDF5StackUInt16
advance_volume(self: vortex.storage.HDF5StackUInt16, allocate: bool = True)None
close(self: vortex.storage.HDF5StackUInt16)None
property config
open(self: vortex.storage.HDF5StackUInt16, arg0: vortex.storage.HDF5StackConfig)None
property ready
class vortex.storage.MarkerLog
close(self: vortex.storage.MarkerLog)None
property config
open(self: vortex.storage.MarkerLog, arg0: vortex::storage::marker_log_config_t)None
write(self: vortex.storage.MarkerLog, arg0: List[vortex::marker::marker_t<vortex::marker::scan_boundary,vortex::marker::volume_boundary,vortex::marker::segment_boundary,vortex::marker::active_lines,vortex::marker::inactive_lines,vortex::marker::event>])None
class vortex.storage.MarkerLogConfig
property binary
property buffering
copy(self: vortex.storage.MarkerLogConfig)vortex.storage.MarkerLogConfig
property path
class vortex.storage.SimpleStackConfig
property ascans_per_bscan
property bscan_shape
property bscans_per_volume
property buffering
copy(self: vortex.storage.SimpleStackConfig)vortex.storage.SimpleStackConfig
property header
property path
property samples_per_ascan
property shape
property volume_shape
class vortex.storage.SimpleStackHeader

Members:

Empty

Raw

NumPy

MATLAB

Empty = <SimpleStackHeader.Empty: 0>
MATLAB = <SimpleStackHeader.MATLAB: 3>
NumPy = <SimpleStackHeader.NumPy: 2>
Raw = <SimpleStackHeader.Raw: 1>
property name
property value
class vortex.storage.SimpleStackInt8
advance_volume(self: vortex.storage.SimpleStackInt8, allocate: bool = True)None
close(self: vortex.storage.SimpleStackInt8)None
property config
open(self: vortex.storage.SimpleStackInt8, arg0: vortex.storage.SimpleStackConfig)None
property ready
seek(self: vortex.storage.SimpleStackInt8, arg0: int, arg1: int)None
class vortex.storage.SimpleStackUInt16
advance_volume(self: vortex.storage.SimpleStackUInt16, allocate: bool = True)None
close(self: vortex.storage.SimpleStackUInt16)None
property config
open(self: vortex.storage.SimpleStackUInt16, arg0: vortex.storage.SimpleStackConfig)None
property ready
seek(self: vortex.storage.SimpleStackUInt16, arg0: int, arg1: int)None
class vortex.storage.SimpleStreamConfig
property buffering
copy(self: vortex.storage.SimpleStreamConfig)vortex.storage.SimpleStreamConfig
property header
property path
class vortex.storage.SimpleStreamHeader

Members:

Empty

Raw

Empty = <SimpleStreamHeader.Empty: 0>
Raw = <SimpleStreamHeader.Raw: 1>
property name
property value
class vortex.storage.SimpleStreamInt8
close(self: vortex.storage.SimpleStreamInt8)None
property config
open(self: vortex.storage.SimpleStreamInt8, arg0: vortex.storage.SimpleStreamConfig)None
property ready
class vortex.storage.SimpleStreamUInt16
close(self: vortex.storage.SimpleStreamUInt16)None
property config
open(self: vortex.storage.SimpleStreamUInt16, arg0: vortex.storage.SimpleStreamConfig)None
property ready
class vortex.storage.StreamDump
close(self: vortex.storage.StreamDump)None
property config
open(self: vortex.storage.StreamDump, arg0: vortex::storage::stream_dump_config_t)None
property ready
class vortex.storage.StreamDumpConfig
property buffering
copy(self: vortex.storage.StreamDumpConfig)vortex.storage.StreamDumpConfig
property divisor
property path
property stream