#include <Framescan.h>

Inherits scope::parameters::ScannerVectorFrameBasic.

Classes
class	Preset

Public Member Functions
std::vector< boost::signals2::connection >	ConnectCopyTrigger (signalchange_t::slot_type _slot) override

void	ConnectRateUpdate (signalchange_t::slot_type _slot) override

void	ConnectMicronPerPixelUpdate (signalchange_t::slot_type _slot) override

void	ConnectOnlineUpdate (signalchange_t::slot_type _slot) override

uint32_t	XTurnPixels () const

uint32_t	XTotalPixels () const override

uint32_t	YCutoffLines () const

uint32_t	YScanLines () const

uint32_t	YRetraceLines () const

uint32_t	YTotalLines () const override

uint32_t	TotalPixels () const override

uint32_t	TotalPixelsOneFrame () const override

void	Load (const wptree &pt) override

void	Save (wptree &pt) const override

void	SetReadOnlyWhileScanning (const RunState &_runstate) override

std::unique_ptr< ScannerVectorFrameBasic::Preset >	MakePreset () const override

void	SaveToPreset (const std::wstring &_name, const Daq &_daq) override

void	LoadFromPreset (const std::wstring &_name, Daq &_daq) override

Public Member Functions inherited from scope::parameters::ScannerVectorFrameBasic
virtual void	ConnectResolutionUpdate (signalchange_t::slot_type _slot)

virtual void	ConnectResolutionChange (signalchange_t::slot_type _slot)

virtual uint32_t	XImagePixels () const

virtual uint32_t	YImageLines () const

virtual void	DeletePreset (const std::wstring &_name)

virtual void	CoerceOffset ()

Static Public Member Functions
static std::unique_ptr< ScannerVectorFrameBasic >	Create ()

static std::unique_ptr< ScannerVectorFrameBasic >	Create (const ScannerVectorFrameBiDi &_o)

Static Public Member Functions inherited from scope::parameters::ScannerVectorFrameBasic
static std::unique_ptr< ScannerVectorFrameBasic >	Create ()

static std::unique_ptr< ScannerVectorFrameBasic >	Create (const ScannerVectorFrameBasic &_o)

static std::unique_ptr< ScannerVectorFrameBasic >	Factory (const ScannerVectorType &_type, const ScannerVectorFrameBasic *const _o=nullptr)

Public Attributes
ScopeNumber< double >	xturnfraction

ScopeNumber< double >	ycutoff

ScopeNumber< double >	yretrace

Public Attributes inherited from scope::parameters::ScannerVectorFrameBasic
std::vector< std::shared_ptr< Preset > >	presets

ScopeNumber< uint32_t >	xres

ScopeNumber< uint32_t >	yres

ScopeNumber< double >	xaspectratio

ScopeNumber< double >	yaspectratio

ScopeNumber< bool >	squarepixels

ScopeNumber< double >	zoom

ScopeNumber< double >	xoffset

ScopeNumber< double >	yoffset

ScopeNumber< double >	fastz

ScopeNumber< double >	pockels

ScopeNumber< double >	xrotation

ScopeNumber< double >	yrotation

Additional Inherited Members
Protected Types inherited from scope::parameters::ScannerVector
typedef boost::signals2::signal< void()>	signalchange_t

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

Detailed Description

Parameters for a ScannerVectorFrameBiDi.

Definition at line 306 of file Framescan.h.

Member Function Documentation

static std::unique_ptr<ScannerVectorFrameBasic> scope::parameters::ScannerVectorFrameBiDi::Create ( )

inlinestatic

Create function for factory.

Definition at line 332 of file Framescan.h.

static std::unique_ptr<ScannerVectorFrameBasic> scope::parameters::ScannerVectorFrameBiDi::Create ( const ScannerVectorFrameBiDi & _o )

inlinestatic

Create copy function for factory.

Definition at line 335 of file Framescan.h.

std::vector< boost::signals2::connection > scope::parameters::ScannerVectorFrameBiDi::ConnectCopyTrigger ( signalchange_t::slot_type _slot )

overridevirtual

Connect a slot that is called if some member parameter changes, this can be used to copy certain changes in a master area to its slave areas.

Except changes in parameters that are area specific (e.g. pockels).

Returns: a vector with all connections made, for storage and destructor call

Parameters

[in] _slot The slot that is connected to all ScopeValues in the ScannerVector

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 370 of file Framescan.cpp.

void scope::parameters::ScannerVectorFrameBiDi::ConnectRateUpdate ( signalchange_t::slot_type _slot )

overridevirtual

Connect a slot that is called if something in the ScannerVector changes that renders a recalculation of dependent rates (e.g.

framerate in parameters::Area) necessary

Parameters

[in] _slot The slot that is connected to certain ScopeValues in the ScannerVector

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 378 of file Framescan.cpp.

void scope::parameters::ScannerVectorFrameBiDi::ConnectMicronPerPixelUpdate ( signalchange_t::slot_type _slot )

overridevirtual

Connect a slot that is called if something in the ScannerVector changes that renders a recalculation of the micron per pixel (e.g.

through in parameters::Area::CalculateMicronPerPixel) necessary

Parameters

[in] _slot The slot that is connected to certain ScopeValues in the ScannerVector

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 385 of file Framescan.cpp.

void scope::parameters::ScannerVectorFrameBiDi::ConnectOnlineUpdate ( signalchange_t::slot_type _slot )

overridevirtual

Connect a slot that is called if something in the ScannerVector (which is displayed on the GUI) changes that makes an online update during scanning necessary.

Parameters

[in] _slot The slot that is connected to certain/all ScopeValues in the ScannerVector, mainly this would be ScopeControllerImpl::UpdateAreaParametersFromGui

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 392 of file Framescan.cpp.

uint32_t scope::parameters::ScannerVectorFrameBiDi::XTurnPixels ( ) const

inline

Returns: number of pixels per line spent for turning.

Definition at line 355 of file Framescan.h.

uint32_t scope::parameters::ScannerVectorFrameBiDi::XTotalPixels ( ) const

inlineoverridevirtual

Returns: total number of pixels per line (image pixels + turn pixels)

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 358 of file Framescan.h.

uint32_t scope::parameters::ScannerVectorFrameBiDi::YCutoffLines ( ) const

inline

Returns: number of additional cutoff lines at framestart

Definition at line 361 of file Framescan.h.

uint32_t scope::parameters::ScannerVectorFrameBiDi::YScanLines ( ) const

inline

Returns: number of lines during y scan ramp (image lines + cutoff lines)

Definition at line 364 of file Framescan.h.

uint32_t scope::parameters::ScannerVectorFrameBiDi::YRetraceLines ( ) const

inline

Returns: number of lines during retrace

Definition at line 367 of file Framescan.h.

uint32_t scope::parameters::ScannerVectorFrameBiDi::YTotalLines ( ) const

inlineoverridevirtual

Returns: total number of y pixels/lines (image lines + cutoff lines + retrace lines)

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 370 of file Framescan.h.

uint32_t scope::parameters::ScannerVectorFrameBiDi::TotalPixels ( ) const

inlineoverridevirtual

Returns: total number of pixels

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 374 of file Framescan.h.

uint32_t scope::parameters::ScannerVectorFrameBiDi::TotalPixelsOneFrame ( ) const

inlineoverridevirtual

Returns: total number of pixels for one image

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 377 of file Framescan.h.

void scope::parameters::ScannerVectorFrameBiDi::Load ( const wptree & pt )

overridevirtual

load parameters from a boost::property_tree

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 419 of file Framescan.cpp.

void scope::parameters::ScannerVectorFrameBiDi::Save ( wptree & pt ) const

overridevirtual

save parameters into a boost:property_tree

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 426 of file Framescan.cpp.

void scope::parameters::ScannerVectorFrameBiDi::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::ScannerVectorFrameBasic.

Definition at line 433 of file Framescan.cpp.

std::unique_ptr< ScannerVectorFrameBasic::Preset > scope::parameters::ScannerVectorFrameBiDi::MakePreset ( ) const

overridevirtual

Since preset loading is done in base class (here), we need to generate a derived preset, this can be done by calling this function and overriding it in derived classes.

(Be careful which classes Preset class is meant!)

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 441 of file Framescan.cpp.

void scope::parameters::ScannerVectorFrameBiDi::SaveToPreset	(	const std::wstring &	_name,
		const Daq &	_daq
	)

overridevirtual

Save parameters into a preset.

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 445 of file Framescan.cpp.

void scope::parameters::ScannerVectorFrameBiDi::LoadFromPreset	(	const std::wstring &	_name,
		Daq &	_daq
	)

overridevirtual

Load parameters from a preset.

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 463 of file Framescan.cpp.

Member Data Documentation

ScopeNumber<double> scope::parameters::ScannerVectorFrameBiDi::xturnfraction

fraction spent for turning the x galvo around

Definition at line 346 of file Framescan.h.

ScopeNumber<double> scope::parameters::ScannerVectorFrameBiDi::ycutoff

Cutoff fraction at beginning of frame, total lines per frame = yres * (1 + ycutoff + yretrace)

Definition at line 349 of file Framescan.h.

ScopeNumber<double> scope::parameters::ScannerVectorFrameBiDi::yretrace

Cutoff fraction for retrace at end of frame.

Definition at line 352 of file Framescan.h.

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

scope/parameters/Framescan.h
scope/parameters/Framescan.cpp

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation