Scope
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
scope::parameters::Inputs Class Referenceabstract

#include <IO.h>

Inherits scope::parameters::Base.

Inherited by scope::parameters::InputsDAQmx, and scope::parameters::InputsFPGA.

Public Member Functions

virtual std::unique_ptr< Inputs > Clone () const =0
 
virtual double MinimumPixeltime () const
 
virtual double MaximumPixeltime () const
 
virtual double CoercedPixeltime (const double &_pixeltime) const
 
void Load (const wptree &pt) override
 
void Save (wptree &pt) const override
 
void SetReadOnlyWhileScanning (const RunState &_runstate) override
 

Static Public Member Functions

static std::unique_ptr< Inputs > Factory (const InputsType &_type)
 

Public Attributes

ScopeNumber< uint32_t > channels
 
ScopeNumber< bool > oversampling
 
ScopeValue< Uint16Range > rangetype
 
ScopeNumber< uint32_t > preframelines
 

Additional Inherited Members

- Protected Attributes inherited from scope::parameters::Base
std::vector< boost::signals2::connection > connection_collector
 

Detailed Description

Parameters for pixel acquisition, base class.

Definition at line 18 of file IO.h.

Member Function Documentation

virtual std::unique_ptr<Inputs> scope::parameters::Inputs::Clone ( ) const
pure virtual

Clone method to clone into a pointer.

Has to be overriden in derived classes. There it can use the compiler generated copy constructor with e.g. InputsDAQmx(*this).

Implemented in scope::parameters::InputsFPGAResonanceScanner, scope::parameters::InputsFPGAAnalogIntegrator, scope::parameters::InputsFPGAAnalogDemultiplexer, scope::parameters::InputsFPGAIO5751, scope::parameters::InputsFPGAIO5771, scope::parameters::InputsFPGAPhotonCounter, scope::parameters::InputsFPGADigitalDemultiplexer, scope::parameters::InputsFPGAIO6587, scope::parameters::InputsFPGANoiseOutput, scope::parameters::InputsFPGA, and scope::parameters::InputsDAQmx.

std::unique_ptr< Inputs > scope::parameters::Inputs::Factory ( const InputsType &  _type)
static

Factory method to generate parameter sets for different scan types and put them into a ScannerVectorFrameBasic pointer.

Definition at line 38 of file IO.cpp.

virtual double scope::parameters::Inputs::MinimumPixeltime ( ) const
inlinevirtual
Returns
the minimum pixel dwell time (in microseconds), depending on max aggregate rate, number of channels, and sampling type

Reimplemented in scope::parameters::InputsFPGAIO5751, scope::parameters::InputsFPGAIO5771, scope::parameters::InputsFPGAIO6587, scope::parameters::InputsFPGA, and scope::parameters::InputsDAQmx.

Definition at line 43 of file IO.h.

virtual double scope::parameters::Inputs::MaximumPixeltime ( ) const
inlinevirtual
Returns
the maximum pixel dwell time (in microseconds)

Reimplemented in scope::parameters::InputsFPGAIO5751.

Definition at line 46 of file IO.h.

virtual double scope::parameters::Inputs::CoercedPixeltime ( const double &  _pixeltime) const
inlinevirtual
Returns
the _pixeltime coerced to the nearest value the device supports.

Reimplemented in scope::parameters::InputsFPGAIO5751, scope::parameters::InputsFPGAIO5771, scope::parameters::InputsFPGAIO6587, scope::parameters::InputsFPGA, and scope::parameters::InputsDAQmx.

Definition at line 49 of file IO.h.

void scope::parameters::Inputs::Load ( const wptree &  pt)
overridevirtual

load parameters from a boost::property_tree

Reimplemented from scope::parameters::Base.

Reimplemented in scope::parameters::InputsFPGAResonanceScanner, scope::parameters::InputsFPGAAnalogIntegrator, scope::parameters::InputsFPGAAnalogDemultiplexer, scope::parameters::InputsFPGAIO5751, scope::parameters::InputsFPGAIO5771, scope::parameters::InputsFPGAPhotonCounter, scope::parameters::InputsFPGADigitalDemultiplexer, scope::parameters::InputsFPGAIO6587, scope::parameters::InputsFPGA, and scope::parameters::InputsDAQmx.

Definition at line 21 of file IO.cpp.

void scope::parameters::Inputs::Save ( wptree &  pt) const
overridevirtual

save parameters into a boost:property_tree

Reimplemented from scope::parameters::Base.

Reimplemented in scope::parameters::InputsFPGAResonanceScanner, scope::parameters::InputsFPGAAnalogIntegrator, scope::parameters::InputsFPGAAnalogDemultiplexer, scope::parameters::InputsFPGAIO5751, scope::parameters::InputsFPGAIO5771, scope::parameters::InputsFPGAPhotonCounter, scope::parameters::InputsFPGADigitalDemultiplexer, scope::parameters::InputsFPGAIO6587, scope::parameters::InputsFPGA, and scope::parameters::InputsDAQmx.

Definition at line 28 of file IO.cpp.

void scope::parameters::Inputs::SetReadOnlyWhileScanning ( const RunState &  _runstate)
overridevirtual

set values that must not be changed to read-only during scanning.

True = readonly, false = read&write

Reimplemented from scope::parameters::Base.

Reimplemented in scope::parameters::InputsFPGAResonanceScanner, scope::parameters::InputsFPGAAnalogIntegrator, scope::parameters::InputsFPGAAnalogDemultiplexer, scope::parameters::InputsFPGAIO5751, scope::parameters::InputsFPGAIO5771, scope::parameters::InputsFPGAPhotonCounter, scope::parameters::InputsFPGADigitalDemultiplexer, scope::parameters::InputsFPGAIO6587, scope::parameters::InputsFPGA, and scope::parameters::InputsDAQmx.

Definition at line 35 of file IO.cpp.

Member Data Documentation

ScopeNumber<uint32_t> scope::parameters::Inputs::channels

number of channels to acquire

Definition at line 31 of file IO.h.

ScopeNumber<bool> scope::parameters::Inputs::oversampling

if yes acquisition with maximum rate allowed by device (1/MinimumPixelTime(), calculated from maxrateaggregate and samplingtype), output with pixel rate.

Does not make sense with daq_timing external!!

Definition at line 34 of file IO.h.

ScopeValue<Uint16Range> scope::parameters::Inputs::rangetype

which part of the uint16_t range is used for valid input signals

Definition at line 37 of file IO.h.

ScopeNumber<uint32_t> scope::parameters::Inputs::preframelines

number of lines to acquire before each frame, e.g.

to wait for the next sync from a resonance scanner (set to 0 usually, use 2 for a resonance scanner)

Definition at line 40 of file IO.h.

The documentation for this class was generated from the following files: