13 #include "../../MetaInstruments/FunctionGenerator.h"
14 #include "../../MetaInstruments/LockinAmplifier.h"
15 #include "../../MetaInstruments/AnalogIn.h"
16 #include "../../MetaInstruments/AnalogOut.h"
17 #include "../../MetaInstruments/DigitalOut.h"
130 "SignalDetector",
"Signal detector",
"Detector to record the ODMR signal (might be a lock-in amplifier or any DAQ device)",
DynExpUI::Icons::Instrument };
132 "TriggerOut",
"Trigger output (DO)",
"Trigger output to synchronize an RF frequency sweep and the data acquisition",
DynExpUI::Icons::Instrument };
134 "AuxAnalogOut",
"Auxiliary analog output (AO)",
"Auxiliary output to perform ODMR parameter sweeps with",
DynExpUI::Icons::Instrument,
true };
160 constexpr
static auto Name() noexcept {
return "ODMR"; }
161 constexpr
static auto Category() noexcept {
return "Experiments"; }
175 void ResetImpl(dispatch_tag<QModuleBase>)
override final;
177 std::unique_ptr<DynExp::QModuleWidget>
MakeUIWidget() override final;
Defines DynExp's core module as an interface between the UI and DynExp objects.
UnitType
Units which can be used for data stream instruments.
double ValueType
Data type to represent hardware limits on the sample values to write to the hardware adapter assigned...
virtual ~ODMRConfigurator()=default
ODMRConfigurator()=default
virtual DynExp::ParamsBasePtrType MakeParams(DynExp::ItemIDType ID, const DynExp::DynExpCore &Core) const override final
Override to make derived classes call DynExp::MakeParams with the correct configurator type derived f...
bool SweepSeriesAdvanceLastValue
DynExpInstr::DataStreamInstrumentData::ValueType AuxAnalogOutMinValue
double SensitivityResonanceFreq
bool TestFeature(FeatureType Flag)
std::stringstream AssembleCSVHeader(double RFPower, double RFModulationDepth, double AuxAnalogOutValue, bool IsRFOffResonance)
bool TestFeature(const std::array< FeatureType, N > &Flags) const
double GetRFStopFreq() const noexcept
DynExpInstr::DataStreamInstrumentData::UnitType AuxAnalogOutValueUnit
SweepSeriesType SweepSeries
double SensitivitySamplingRate
DynExp::LinkedObjectWrapperContainer< DynExpInstr::DigitalOut > TriggerOut
unsigned long long CurrentSweepIndex
SensitivityPlotType SensitivityPlot
DynExpInstr::FunctionGeneratorDefs::FunctionDescType RFGeneratorMaxFuncDesc
double SensitivityResonanceSpan
Util::FeatureTester< FeatureType > Features
double SensitivityOffResonanceFreq
unsigned long long GetSweepNumberSteps() const noexcept
void SetFeature(FeatureType Flag)
auto GetLockinAmplifier()
virtual void ResetImpl(dispatch_tag< ODMRData >)
unsigned long long GetNumSamples() const noexcept
bool SensitivityOncePerSweep
auto & GetSignalDetector() noexcept
bool SensitivityAnalysisEnabled
DynExp::LinkedObjectWrapperContainer< DynExpInstr::DataStreamInstrument > SignalDetector
DynExp::LinkedObjectWrapperContainer< DynExpInstr::FunctionGenerator > RFGenerator
unsigned int CurrentSaveIndex
double GetRFStartFreq() const noexcept
MeasurementModeType MeasurementMode
auto & GetTrigger() noexcept
DynExp::LinkedObjectWrapperContainer< DynExpInstr::AnalogOut > AuxAnalogOut
auto & GetRFGenerator() noexcept
DynExpInstr::FunctionGeneratorDefs::FunctionDescType RFGeneratorDefaultFuncDesc
RFModulationType RFModulation
double SensitivityDuration
DynExpInstr::FunctionGeneratorDefs::FunctionDescType RFGeneratorMinFuncDesc
virtual ~ODMRData()=default
bool SensitivityOffResonanceEnabled
auto & GetAuxAnalogOut() noexcept
DynExpInstr::DataStreamInstrumentData::ValueType AuxAnalogOutMaxValue
void ResetImpl(dispatch_tag< QModuleDataBase >) override final
virtual const char * GetParamClassTag() const noexcept override
This function is intended to be overridden once in each derived class returning the name of the respe...
Param< DynExp::ObjectLink< DynExpInstr::FunctionGenerator > > RFGenerator
Param< DynExp::ObjectLink< DynExpInstr::DataStreamInstrument > > SignalDetector
virtual ~ODMRParams()=default
ODMRParams(DynExp::ItemIDType ID, const DynExp::DynExpCore &Core)
Param< DynExp::ObjectLink< DynExpInstr::AnalogOut > > AuxAnalogOut
void ConfigureParamsImpl(dispatch_tag< QModuleParamsBase >) override final
Param< DynExp::ObjectLink< DynExpInstr::DigitalOut > > TriggerOut
std::unique_ptr< DynExp::QModuleWidget > MakeUIWidget() override final
Used by InitUI() as a factory function for the module's user interface widget. Create the widget here...
size_t NumFailedUpdateAttempts
static constexpr auto MeasurementSeriesInitState
void InitRFGenerator(double Frequency, bool EnableRF, Util::SynchronizedPointer< ModuleDataType > &ModuleData) const
virtual std::string GetCategory() const override
Returns the category of this Object type.
constexpr static auto Name() noexcept
void OnSweepSeriesStopChanged(DynExp::ModuleInstance *Instance, double Value) const
void OnRFModDepthChanged(DynExp::ModuleInstance *Instance, double Value) const
void ConnectChartWidgets(QLineSeries *ODMRLineSeries)
static constexpr auto SensitivityWaitState
static constexpr auto ODMRTraceFinishState
void UpdateUIChild(const ModuleBase::ModuleDataGetterType &ModuleDataGetter) override final
void OnExit(DynExp::ModuleInstance *Instance) const override final
This event is triggered right before the module thread terminates (not due to an exception,...
Util::StateMachine< StateMachineStateType > StateMachine
Util::DynExpErrorCodes::DynExpErrorCodes ModuleMainLoop(DynExp::ModuleInstance &Instance) override final
Module main loop. The function is executed periodically by the module thread. Also refer to GetMainLo...
void WaitUntilReadyAndTrigger(Util::SynchronizedPointer< ModuleDataType > &ModuleData) const
static constexpr auto ODMRTraceWaitState
StateType MeasurementSeriesInitFunc(DynExp::ModuleInstance &Instance)
void OnStopClicked(DynExp::ModuleInstance *Instance, bool) const
void OnRFAutoEnableClicked(DynExp::ModuleInstance *Instance, int Checked) const
StateType ODMRTraceWaitFunc(DynExp::ModuleInstance &Instance)
void OnRFModNoneClicked(DynExp::ModuleInstance *Instance, bool Checked) const
void OnRFFreqSpanChanged(DynExp::ModuleInstance *Instance, double Value) const
void OnGyromagneticRatioChanged(DynExp::ModuleInstance *Instance, double Value) const
std::chrono::milliseconds GetMainLoopDelay() const override final
Specifies in which time intervals the module's event queue runs to handle pending events.
void OnRecordSensitivityOffResonanceClicked(DynExp::ModuleInstance *Instance, int Checked) const
bool IsReadyState() const noexcept
void OnODMRSamplingRateChanged(DynExp::ModuleInstance *Instance, double Value) const
void OnEnableSweepSeriesClicked(DynExp::ModuleInstance *Instance, int Checked) const
void ResetImpl(dispatch_tag< QModuleBase >) override final
void OnRFOnClicked(DynExp::ModuleInstance *Instance, bool) const
double NextAuxAnalogOutValue
void OnRFModPulseClicked(DynExp::ModuleInstance *Instance, bool Checked) const
static constexpr auto SensitivityFinishState
StateType ReadyStateFunc(DynExp::ModuleInstance &Instance)
ODMR(const std::thread::id OwnerThreadID, DynExp::ParamsBasePtrType &&Params)
void OnSavePathChanged(DynExp::ModuleInstance *Instance, QString Path) const
void OnSweepSeriesStepChanged(DynExp::ModuleInstance *Instance, double Value) const
void OnSensitivityResonanceSpanChanged(DynExp::ModuleInstance *Instance, double Value) const
StateType SensitivityWaitFunc(DynExp::ModuleInstance &Instance)
void OnRecordSensitivityClicked(DynExp::ModuleInstance *Instance, int Checked) const
void OnSensitivityOffResonanceFreqChanged(DynExp::ModuleInstance *Instance, double Value) const
StateType SensitivityFinishFunc(DynExp::ModuleInstance &Instance)
static constexpr auto SensitivityInitState
StateType ODMRTraceInitFunc(DynExp::ModuleInstance &Instance)
StateType InitializingStateFunc(DynExp::ModuleInstance &Instance)
double NextRFModulationDepth
void OnSweepSeriesRetraceClicked(DynExp::ModuleInstance *Instance, int Checked) const
void SetAuxAnalogOutValue(Util::SynchronizedPointer< ModuleDataType > &ModuleData) const
void OnSaveIndexChanged(DynExp::ModuleInstance *Instance, int Index) const
void OnODMRChartHovered(DynExp::ModuleInstance *Instance, QPointF Point, bool State) const
StateType SensitivityInitFunc(DynExp::ModuleInstance &Instance)
StateType MeasurementSeriesStepFunc(DynExp::ModuleInstance &Instance)
void OnODMRChartClicked(DynExp::ModuleInstance *Instance, QPointF Point) const
void OnRFFreqSpacingChanged(DynExp::ModuleInstance *Instance, double Value) const
void OnRFModFreqChanged(DynExp::ModuleInstance *Instance, double Value) const
void OnAutosaveClicked(DynExp::ModuleInstance *Instance, int Checked) const
void OnRFDwellTimeChanged(DynExp::ModuleInstance *Instance, double Value) const
static constexpr auto InitializingState
void OnStartClicked(DynExp::ModuleInstance *Instance, bool) const
void InitSweepValues(Util::SynchronizedPointer< ModuleDataType > &ModuleData)
void OnSensitivitySamplingRateChanged(DynExp::ModuleInstance *Instance, double Value) const
void OnSensitivityResonanceFreqChanged(DynExp::ModuleInstance *Instance, double Value) const
void OnRFModSineClicked(DynExp::ModuleInstance *Instance, bool Checked) const
void OnSweepSeriesAdvanceLastValueClicked(DynExp::ModuleInstance *Instance, int Checked) const
static constexpr auto ODMRTraceInitState
void OnStartSensitivityClicked(DynExp::ModuleInstance *Instance, bool) const
static constexpr auto ReadyState
virtual std::string GetName() const override
Returns the name of this Object type.
static constexpr auto MeasurementSeriesStepState
constexpr static auto Category() noexcept
void OnRFOffClicked(DynExp::ModuleInstance *Instance, bool) const
void OnSweepSeriesParamChanged(DynExp::ModuleInstance *Instance, int Index) const
void OnEnableSensitivityAnalysisClicked(DynExp::ModuleInstance *Instance, bool Checked) const
void OnRFPowerChanged(DynExp::ModuleInstance *Instance, double Value) const
void OnInit(DynExp::ModuleInstance *Instance) const override final
This event is triggered right before the module thread starts. Override it to lock instruments this m...
void OnRecordSensitivityOncePerSweepClicked(DynExp::ModuleInstance *Instance, int Checked) const
void OnSweepSeriesStartChanged(DynExp::ModuleInstance *Instance, double Value) const
StateType ODMRTraceFinishFunc(DynExp::ModuleInstance &Instance)
const Util::StateMachineContext< StateMachineStateType > SensitivityOffResonanceContext
bool TreatModuleExceptionsAsWarnings() const override final
Determines whether this module should be terminated if an exception leaves the module's main loop or ...
void OnRFCenterFreqChanged(DynExp::ModuleInstance *Instance, double Value) const
void OnSensitivityDurationChanged(DynExp::ModuleInstance *Instance, double Value) const
DynExp's core class acts as the interface between the user interface and DynExp's internal data like ...
Base class for modules. Modules implement programs on their own (e.g. measurement protocols or server...
Util::CallableMemberWrapper< ModuleBase, ModuleDataTypeSyncPtrType(ModuleBase::*)(const std::chrono::milliseconds)> ModuleDataGetterType
Invoking an instance of this alias is supposed to call ModuleBase::GetModuleData() of the instance th...
const std::unique_ptr< ModuleDataType > ModuleData
Module data belonging to this ModuleBase instance.
ModuleBase(const std::thread::id OwnerThreadID, ParamsBasePtrType &&Params)
Constructs a ModuleBase instance.
Configurator class for ModuleBase.
Data structure to contain data which is synchronized in between different threads....
Refer to ParamsBase::dispatch_tag.
Defines data for a thread belonging to a ModuleBase instance. Refer to RunnableInstance.
Parameter class for ModuleBase.
const std::thread::id OwnerThreadID
Thread id of the thread which has constructed (and owns) this Object instance.
const ParamsBasePtrType Params
Pointer to the parameter class instance belonging to this Object instance.
const ItemIDType ID
ID of the Object this parameter class instance belongs to.
const auto & GetCore() const noexcept
Returns a reference to DynExp's core.
const DynExpCore & Core
Reference to DynExp's core.
Tag for function dispatching mechanism within this class used when derived classes are not intended t...
Base class for modules with a Qt-based user interface. Derive from this class to implement modules wi...
Configurator class for QModuleBase.
Data class for QModuleBase.
Parameter class for QModuleBase.
QModuleParamsBase(ItemIDType ID, const DynExpCore &Core)
Constructs the parameters for a QModuleBase instance.
void Set(EnumType Flag)
Sets a flag.
bool Test(const std::array< EnumType, N > &Flags) const
Tests whether all of the flags passed as an array are set.
State machine context as used by class StateMachine. A state machine context holds a map with keys an...
State machine state as used by class StateMachine. A state mainly wraps a state function of the membe...
This class models a state machine. It keeps track of the current state and allows to invoke its assoc...
Pointer to lock a class derived from ISynchronizedPointerLockable for synchronizing between threads....
constexpr auto Instrument
std::unique_ptr< ParamsBase > ParamsBasePtrType
Alias for a pointer to the parameter system base class ParamsBase.
size_t ItemIDType
ID type of objects/items managed by DynExp.
DynExpErrorCodes
DynExp's error codes
Accumulates include statements to provide a precompiled header.
Type describing a generic periodic function.