Scope
scope::FPGAResonanceScannerNI5771 Class Reference

#include <FPGAResonanceScanner_NI5771.h>

Inherits scope::FPGAInterface, and scope::FPGAIO5771.

Public Member Functions

 FPGAResonanceScannerNI5771 ()
 
 ~FPGAResonanceScannerNI5771 ()
 
void Initialize (parameters::InputsFPGA *_parameters) override
 
double SetPixeltime (const uint32_t &_area, const double &_pixeltime) override
 
double SetLinetime (const uint32_t &_area, const double &_linetime) override
 
void SetTriggering (const bool &_waitfortrigger) override
 
void SetContinuousAcquisition (const bool &_cont) override
 
void SetRequestedPixels (const uint32_t &_area, const uint32_t &_reqpixels) override
 
void StartAcquisition () override
 
void StopAcquisition () override
 
int32_t ReadPixels (DaqChunk &_chunk, const double &_timeout, bool &_timedout) override
 
void SetChannelProps ()
 
void CheckFPGADiagnosis ()
 
void ClearFIFOs ()
 
- Public Member Functions inherited from scope::FPGAInterface
virtual ~FPGAInterface ()
 
virtual void SetScannerdelay (const uint32_t &_scannerdelay)
 
FPGAStatusSafe CurrentStatus () const
 
- Public Member Functions inherited from scope::FPGAIO5771
 FPGAIO5771 (const uint32_t &_user_command_idle, const uint32_t &_pll_locked, const uint32_t &_configured, const uint32_t &_user_error, const uint32_t &_user_command_status, const uint32_t &_user_command_control, const uint32_t &_user_data_0_control, const uint32_t &_user_data_1_control, const uint32_t &_user_command_commit)
 
void SetClockSource (NiFpga_Session _session, const uint8_t &_clock_source=0)
 
bool CheckIOModule (NiFpga_Session _session)
 

Protected Attributes

parameters::InputsFPGAAnalogIntegratorparameters
 
std::array< NiFpga_AnalogIntegrator_NI5771_Resonance_TargetToHostFifoU32, 2 > fifos
 
- Protected Attributes inherited from scope::FPGAInterface
FPGAStatusSafe status
 
NiFpga_Session session
 
bool initialized
 
- Protected Attributes inherited from scope::FPGAIO5771
const uint32_t user_command_idle_indicator
 
const uint32_t pll_locked_indicator
 
const uint32_t configured_indicator
 
const uint32_t user_error_indicator
 
const uint32_t user_command_status_indicator
 
const uint32_t user_command_control
 
const uint32_t user_data_0_control
 
const uint32_t user_data_1_control
 
const uint32_t user_command_commit_control
 
FPGAStatusSafe iostatus
 

Additional Inherited Members

- Protected Member Functions inherited from scope::FPGAIO5771
void WaitForIdle (NiFpga_Session _session)
 

Detailed Description

Wraps an FPGA that does analog pixel integration (with the NI 5771 FlexRIO adapter module http://sine.ni.com/nips/cds/view/p/lang/en/nid/210735)

Definition at line 18 of file FPGAResonanceScanner_NI5771.h.

Constructor & Destructor Documentation

scope::FPGAResonanceScannerNI5771::FPGAResonanceScannerNI5771 ( )

Load the FPGA bitfile, set the IO module's onboard clock and initialize the acquisition.

Definition at line 9 of file FPGAResonanceScanner_NI5771.cpp.

scope::FPGAResonanceScannerNI5771::~FPGAResonanceScannerNI5771 ( )

Close FPGA session.

Definition at line 46 of file FPGAResonanceScanner_NI5771.cpp.

Member Function Documentation

void scope::FPGAResonanceScannerNI5771::Initialize ( parameters::InputsFPGA _parameters)
overridevirtual

Set initial parameters.

Derived classes override this and cast _parameters to the appropriate derived type. Derived functions should check if already initialized.

Reimplemented from scope::FPGAInterface.

Definition at line 52 of file FPGAResonanceScanner_NI5771.cpp.

double scope::FPGAResonanceScannerNI5771::SetPixeltime ( const uint32_t &  _area,
const double &  _pixeltime 
)
overridevirtual

Sets the time per pixel/dwell time (in seconds)

Parameters
[in]_areafor which area
[in]_pixeltimethe pixel dwell time in seconds
Returns
the actual pixel dwell time, can be different than requested due to finite clock rate

Reimplemented from scope::FPGAInterface.

Definition at line 67 of file FPGAResonanceScanner_NI5771.cpp.

double scope::FPGAResonanceScannerNI5771::SetLinetime ( const uint32_t &  _area,
const double &  _linetime 
)
overridevirtual

Sets the time per line (in seconds) for the generation of the line clock (if implemented)

Parameters
[in]_areafor which area
[in]_linetimethe line time in seconds
Returns
the actual line time, can be different than requested due to finite clock rate

Reimplemented from scope::FPGAInterface.

Definition at line 82 of file FPGAResonanceScanner_NI5771.cpp.

void scope::FPGAResonanceScannerNI5771::SetTriggering ( const bool &  _waitfortrigger)
overridevirtual

Sets if the FPGA should wait for a trigger before starting acquisition.

Parameters
[in]_waitfortriggertrue if wait for trigger

Reimplemented from scope::FPGAInterface.

Definition at line 97 of file FPGAResonanceScanner_NI5771.cpp.

void scope::FPGAResonanceScannerNI5771::SetContinuousAcquisition ( const bool &  _cont)
overridevirtual

Sets if the FPGA should acquire data continuously or acquire the number of pixels per channel set with SetRequestedPixels.

Parameters
[in]_contyes or no

Reimplemented from scope::FPGAInterface.

Definition at line 101 of file FPGAResonanceScanner_NI5771.cpp.

void scope::FPGAResonanceScannerNI5771::SetRequestedPixels ( const uint32_t &  _area,
const uint32_t &  _reqpixels 
)
overridevirtual

Sets the number of pixels per channel the FPGA should acquire, set to -1 for live scanning.

Parameters
[in]_areafor which area
[in]_reqpixelsnumber of pixels the FPGA should acquire before automatically stopping acquisition

Reimplemented from scope::FPGAInterface.

Definition at line 105 of file FPGAResonanceScanner_NI5771.cpp.

void scope::FPGAResonanceScannerNI5771::StartAcquisition ( )
overridevirtual

Starts the acquisition on the FPGA.

Reimplemented from scope::FPGAInterface.

Definition at line 109 of file FPGAResonanceScanner_NI5771.cpp.

void scope::FPGAResonanceScannerNI5771::StopAcquisition ( )
overridevirtual

Stops the acquisition on the FPGA.

Reimplemented from scope::FPGAInterface.

Definition at line 174 of file FPGAResonanceScanner_NI5771.cpp.

int32_t scope::FPGAResonanceScannerNI5771::ReadPixels ( DaqChunk _chunk,
const double &  _timeout,
bool &  _timedout 
)
overridevirtual

Read only pixels from the FPGA FIFO.

Parameters
[in,out]_chunkthe daq chunk to read into, inside _chunk is information about the area for wich to retrieve, the number of pixels per channel to read, and the number of channels
[in]_timeouttime out for reading in seconds
[out]_timedoutset to true if reading timed out
Returns
number of read pixels per channel or -1 on error
Precondition
_channels > 0 && _channels <= 2

Implements scope::FPGAInterface.

Definition at line 115 of file FPGAResonanceScanner_NI5771.cpp.

void scope::FPGAResonanceScannerNI5771::SetChannelProps ( )

Set channel properties as baseline and bitshift.

Definition at line 178 of file FPGAResonanceScanner_NI5771.cpp.

void scope::FPGAResonanceScannerNI5771::CheckFPGADiagnosis ( )

Checks the status of the FIFOs on the FPGA.

Definition at line 189 of file FPGAResonanceScanner_NI5771.cpp.

void scope::FPGAResonanceScannerNI5771::ClearFIFOs ( )

Clears the interloop and ToHost FIFOs.

Definition at line 205 of file FPGAResonanceScanner_NI5771.cpp.

Member Data Documentation

parameters::InputsFPGAAnalogIntegrator* scope::FPGAResonanceScannerNI5771::parameters
protected

the parameter set

Definition at line 24 of file FPGAResonanceScanner_NI5771.h.

std::array<NiFpga_AnalogIntegrator_NI5771_Resonance_TargetToHostFifoU32, 2> scope::FPGAResonanceScannerNI5771::fifos
protected

both fifos for both channels

Definition at line 27 of file FPGAResonanceScanner_NI5771.h.


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