DynExpInstr::LockinAmplifierDefs::LockinResultPolar Struct Reference

Type describing a recorded lock-in sample in polar coordinates. Must be trivially copyable. More...

#include <LockinAmplifier.h>

Public Types
using	DataType = double
	Data type used to store the sample.

Public Member Functions
constexpr	LockinResultPolar () noexcept=default
	Default-constructs a LockinResultPolar instance.
constexpr	LockinResultPolar (DataType R, DataType Theta) noexcept
	Constructs a LockinResultCartesian instance from the given coordinates.

Public Attributes
DataType	R {}
	Radial component of the signal in polar coordinates.
DataType	Theta {}
	Phase component of the signal in polar coordinates.

Detailed Description

Type describing a recorded lock-in sample in polar coordinates. Must be trivially copyable.

Definition at line 84 of file LockinAmplifier.h.

Member Typedef Documentation

DataType

using DynExpInstr::LockinAmplifierDefs::LockinResultPolar::DataType = double

Data type used to store the sample.

Definition at line 86 of file LockinAmplifier.h.

Constructor & Destructor Documentation

LockinResultPolar() [1/2]

constexpr DynExpInstr::LockinAmplifierDefs::LockinResultPolar::LockinResultPolar ( )

constexprdefaultnoexcept

Default-constructs a LockinResultPolar instance.

LockinResultPolar() [2/2]

constexpr DynExpInstr::LockinAmplifierDefs::LockinResultPolar::LockinResultPolar ( DataType  R, DataType  Theta  )

inlineconstexprnoexcept

Constructs a LockinResultCartesian instance from the given coordinates.

Parameters

R	Radial component of the signal in polar coordinates.
Theta	Phase component of the signal in polar coordinates.

Definition at line 98 of file LockinAmplifier.h.

Member Data Documentation

R

DataType DynExpInstr::LockinAmplifierDefs::LockinResultPolar::R {}

Radial component of the signal in polar coordinates.

Definition at line 100 of file LockinAmplifier.h.

Theta

DataType DynExpInstr::LockinAmplifierDefs::LockinResultPolar::Theta {}

Phase component of the signal in polar coordinates.

Definition at line 101 of file LockinAmplifier.h.

---

The documentation for this struct was generated from the following file:

• LockinAmplifier.h