Acquisition
Namespace: Endorphin.Instrument.PicoTech.PicoScope5000
Nested types and modules
| Type | Description |
| AcquisitionHandle | Represents a handle to a streaming acquisition which has been started on a PicoScope 3000 series device. This can be used to stop the acquisition manually and/or wait for it to finish. Returned by start functions |
Functions and values
| Function or value | Description |
doNothing
Signature: Async<unit>
|
Starts a streaming acquisition. If the ability to abort the acquisition via a cancellation token is required, then start the acquisition using startWithCancellationToken instead. Returns a handle which can be used to stop the acquisition manually or wait for it to finish asynchronously. |
prepare picoscope _arg1
Signature: picoscope:PicoScope5000 -> _arg1:Parameters -> Acquisition
|
Prepare to run an acquisition using the supplied parameters |
start acquisition
Signature: acquisition:Acquisition -> AcquisitionHandle
|
|
startAsChild acquisition
Signature: acquisition:Acquisition -> Async<AcquisitionHandle>
|
Starts a streaming acquisition as a child (sharing the same cancellation token) to the current asynchronous workflow. To ensure that the acquisition is stopped cleanly, no other cancellation compensations should be registered with this cancellation token which will post commands to the PicoScope. Returns a handle which can be used to stop the acquisition manually or wait for it to finish asynchronously. |
startWithCancellationToken (...)
Signature: acquisition:Acquisition -> triggerWorkflow:Async<unit> -> cancellationToken:CancellationToken -> AcquisitionHandle
|
Runs an acquisition with the given cancellation token. If the token is cancelled, then acquisition will be aborted. To ensure that the acquisition is stopped cleanly, no other cancellation compensations should be registered with this cancellation token which will post commands to the PicoScope. Returns a handle which can be used to stop the acquisition manually or wait for it to finish asynchronously. |
startWithTrigger acquisition trigger
Signature: acquisition:Acquisition -> trigger:Async<unit> -> AcquisitionHandle
|
|
startWithTriggerAsChild (...)
Signature: acquisition:Acquisition -> trigger:Async<unit> -> Async<AcquisitionHandle>
|
|
status acquisition
Signature: acquisition:Acquisition -> IObservable<AcquisitionStatus>
|
Supplies notifications of changes in the acquisition status |
stop acquisitionHandle
Signature: acquisitionHandle:AcquisitionHandle -> unit
|
Manually stops the streaming acquisition associated with the given handle. |
stopAndFinish acquisitionHandle
Signature: acquisitionHandle:AcquisitionHandle -> Async<AcquisitionResult>
|
Manually stops the streaming acquisition associated with the given handle and asynchronously waits for it to finish. |
waitToFinish acquisitionHandle
Signature: acquisitionHandle:AcquisitionHandle -> Async<AcquisitionResult>
|
Asynchronously waits for the acquisition associated with the given handle to finish and returns the result. |
waitToStart acquisition
Signature: acquisition:Acquisition -> Async<unit>
|
Asynchronously waits for streaming to being. |
