#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	XCutoffPixels () const

uint32_t	XScanPixels () const

uint32_t	XRetracePixels () 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 ScannerVectorFrameSaw &_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 >	xcutoff

ScopeNumber< double >	ycutoff

ScopeNumber< double >	xretrace

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 ScannerVectorFrameSaw.

Definition at line 210 of file Framescan.h.

Member Function Documentation

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

inlinestatic

Create function for factory.

Definition at line 239 of file Framescan.h.

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

inlinestatic

Create copy function for factory.

Definition at line 242 of file Framescan.h.

std::vector< boost::signals2::connection > scope::parameters::ScannerVectorFrameSaw::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 239 of file Framescan.cpp.

void scope::parameters::ScannerVectorFrameSaw::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 248 of file Framescan.cpp.

void scope::parameters::ScannerVectorFrameSaw::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 256 of file Framescan.cpp.

void scope::parameters::ScannerVectorFrameSaw::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 264 of file Framescan.cpp.

uint32_t scope::parameters::ScannerVectorFrameSaw::XCutoffPixels ( ) const

inline

Returns: number of additional cutoff pixels at linestart

Definition at line 265 of file Framescan.h.

uint32_t scope::parameters::ScannerVectorFrameSaw::XScanPixels ( ) const

inline

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

Definition at line 268 of file Framescan.h.

uint32_t scope::parameters::ScannerVectorFrameSaw::XRetracePixels ( ) const

inline

Returns: number of pixels during retrace

Definition at line 271 of file Framescan.h.

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

inlineoverridevirtual

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

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 274 of file Framescan.h.

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

inline

Returns: number of additional cutoff lines at framestart

Definition at line 277 of file Framescan.h.

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

inline

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

Definition at line 280 of file Framescan.h.

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

inline

Returns: number of lines during retrace

Definition at line 283 of file Framescan.h.

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

inlineoverridevirtual

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

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 286 of file Framescan.h.

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

inlineoverridevirtual

Returns: total number of pixels (final image + cutoff portions + retrace portions)

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 289 of file Framescan.h.

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

inlineoverridevirtual

Returns: total number of pixels for one image

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 292 of file Framescan.h.

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

overridevirtual

load parameters from a boost::property_tree

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 295 of file Framescan.cpp.

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

overridevirtual

save parameters into a boost:property_tree

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 303 of file Framescan.cpp.

void scope::parameters::ScannerVectorFrameSaw::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 311 of file Framescan.cpp.

std::unique_ptr< ScannerVectorFrameBasic::Preset > scope::parameters::ScannerVectorFrameSaw::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 321 of file Framescan.cpp.

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

overridevirtual

Save parameters into a preset.

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 325 of file Framescan.cpp.

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

overridevirtual

Load parameters from a preset.

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 344 of file Framescan.cpp.

Member Data Documentation

ScopeNumber<double> scope::parameters::ScannerVectorFrameSaw::xcutoff

Cutoff fraction at beginning of line, total pixels per line = xres * (1 + xcutoff + xretrace)

Definition at line 253 of file Framescan.h.

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

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

Definition at line 256 of file Framescan.h.

ScopeNumber<double> scope::parameters::ScannerVectorFrameSaw::xretrace

Cutoff fraction for retrace at end of line.

Definition at line 259 of file Framescan.h.

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

Cutoff fraction for retrace at end of frame.

Definition at line 262 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