scope::parameters::Stack Class Reference

#include <Runstates.h>

Inherits scope::parameters::Base.

Public Member Functions
virtual double	Range (const uint32_t &_area)
virtual double	Increment (const uint32_t &_area)
virtual double	Lambda (const uint32_t &_area)
void	Load (const wptree &pt) override
void	Save (wptree &pt) const override
void	SetReadOnlyWhileScanning (const RunState &_runstate) override

Public Attributes
std::array< PlaneProperties, SCOPE_NAREAS >	startat
std::array< PlaneProperties, SCOPE_NAREAS >	stopat
ScopeNumber< double >	spacing
std::vector< std::array< PlaneProperties, SCOPE_NAREAS > >	planes___
ScopeValue< ZDevice >	zdevicetype
ScopeNumber< double >	overalltime

Protected Member Functions
virtual void	UpdatePlanes ()
virtual void	ResetPlanes ()

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

Detailed Description

Parameters for stack acquisition.

Definition at line 20 of file Runstates.h.

Member Function Documentation

double scope::parameters::Stack::Range ( const uint32_t &  _area )

virtual

total span of z stack

Definition at line 73 of file Runstates.cpp.

double scope::parameters::Stack::Increment ( const uint32_t &  _area )

virtual

distance between planes

Definition at line 77 of file Runstates.cpp.

double scope::parameters::Stack::Lambda ( const uint32_t &  _area )

virtual

space constant for exponential pockels interpolation

Definition at line 81 of file Runstates.cpp.

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

overridevirtual

load parameters from a boost::property_tree

Reimplemented from scope::parameters::Base.

Definition at line 89 of file Runstates.cpp.

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

overridevirtual

save parameters into a boost:property_tree

Reimplemented from scope::parameters::Base.

Definition at line 103 of file Runstates.cpp.

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

Definition at line 117 of file Runstates.cpp.

void scope::parameters::Stack::UpdatePlanes ( )

protectedvirtual

Updates planes with positions and pockels adjustment etc.

Definition at line 28 of file Runstates.cpp.

void scope::parameters::Stack::ResetPlanes ( )

protectedvirtual

Resets start/stop and all planes.

Called when changing zdevicetype.

Definition at line 61 of file Runstates.cpp.

Member Data Documentation

std::array<PlaneProperties, SCOPE_NAREAS> scope::parameters::Stack::startat

Start plane, measured with the zdevicetype.

Definition at line 26 of file Runstates.h.

std::array<PlaneProperties, SCOPE_NAREAS> scope::parameters::Stack::stopat

Stop plane, measured with the zdevicetype.

Definition at line 29 of file Runstates.h.

ScopeNumber<double> scope::parameters::Stack::spacing

Spacing between planes in microns.

Definition at line 32 of file Runstates.h.

std::vector<std::array<PlaneProperties, SCOPE_NAREAS> > scope::parameters::Stack::planes___

Vector with properties for every plane.

Definition at line 35 of file Runstates.h.

ScopeValue<ZDevice> scope::parameters::Stack::zdevicetype

type of z device to use

Definition at line 38 of file Runstates.h.

ScopeNumber<double> scope::parameters::Stack::overalltime

time in seconds for all timeseries

Definition at line 41 of file Runstates.h.

---

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

• scope/parameters/Runstates.h
• scope/parameters/Runstates.cpp