23 std::stringstream CSVData;
25 CSVData << std::setprecision(6);
28 CSVData <<
"RFFreqSpan = " <<
RFFreqSpan <<
" Hz\n";
30 CSVData <<
"RFDwellTime = " <<
RFDwellTime <<
" s\n";
32 CSVData <<
"RFModulation = ";
38 default: CSVData <<
"\n";
46 CSVData <<
"IsRFOffResonance = " << (IsRFOffResonance ?
"yes" :
"no") <<
"\n";
60 CSVData <<
"SweepSeries = ";
66 default: CSVData <<
"\n";
74 CSVData <<
"AuxAnalogOutValue = " << AuxAnalogOutValue <<
"\n";
79 auto LockinData = DynExp::dynamic_InstrumentData_cast<DynExpInstr::LockinAmplifier>(
GetSignalDetector()->GetInstrumentData());
81 auto Sensitivity = LockinData->GetSensitivity();
82 auto TimeConstant = LockinData->GetTimeConstant();
83 unsigned int FilterOrder = LockinData->GetFilterOrder();
85 CSVData <<
"LockinSensitivity = " << Sensitivity <<
" " << LockinInstr.GetSensitivityUnitString() <<
"\n";
86 CSVData <<
"LockinTimeConstant = " << TimeConstant <<
" s\n";
87 CSVData <<
"LockinFilterOrder = " << FilterOrder <<
"\n";
90 CSVData <<
"HEADER_END\n";
153 : QModuleBase(OwnerThreadID, std::move(Params)),
154 StateMachine(InitializingState, ReadyState,
155 MeasurementSeriesStepState, MeasurementSeriesInitState,
156 ODMRTraceInitState, ODMRTraceWaitState, ODMRTraceFinishState,
157 SensitivityInitState, SensitivityWaitState, SensitivityFinishState)
163 auto CurrentState = StateMachine.GetCurrentState()->GetState();
167 return std::chrono::milliseconds(30);
169 return std::chrono::milliseconds(2);
180 auto LockinData = DynExp::dynamic_InstrumentData_cast<DynExpInstr::LockinAmplifier>(
ModuleData->GetSignalDetector()->GetInstrumentData());
182 ModuleData->AcquisitionTime = LockinData->GetAcquisitionTime();
209 std::unique_ptr<DynExp::QModuleWidget> ODMR::MakeUIWidget()
211 auto Widget = std::make_unique<ODMRWidget>(*
this);
261 void ODMR::UpdateUIChild(
const ModuleBase::ModuleDataGetterType& ModuleDataGetter)
263 auto Widget = GetWidget<ODMRWidget>();
268 auto ModuleData = DynExp::dynamic_ModuleData_cast<ODMR>(ModuleDataGetter());
284 SensitivityPlot =
ModuleData->SensitivityPlot;
285 ModuleData->SensitivityPlot.HasChanged =
false;
291 Widget->UpdateODMRPlot(ODMRPlot);
295 Widget->UpdateSensitivityPlot(SensitivityPlot);
308 if (
ModuleData->SweepSeriesAdvanceLastValue && SweepIndex == 1)
309 SweepIndex =
ModuleData->GetSweepNumberSteps() - 1;
310 else if (
ModuleData->SweepSeriesAdvanceLastValue && SweepIndex > 1)
354 std::this_thread::sleep_for(std::chrono::milliseconds(200));
368 void ODMR::ConnectChartWidgets(QLineSeries* ODMRLineSeries)
379 auto ModuleParams = DynExp::dynamic_Params_cast<ODMR>(Instance->
ParamsGetter());
396 if (ModuleParams->AuxAnalogOut.ContainsID())
498 ModuleData->SaveDataPath = Path.toStdString();
522 ModuleData->SensitivityOncePerSweep = Checked;
528 ModuleData->SensitivityOffResonanceEnabled = Checked;
534 ModuleData->SensitivityResonanceFreq = Value * 1e6;
540 ModuleData->SensitivityOffResonanceFreq = Value * 1e6;
546 ModuleData->SensitivityResonanceSpan = Value * 1e6;
564 ModuleData->SensitivityAnalysisEnabled = Checked;
621 ModuleData->SweepSeriesAdvanceLastValue = Checked;
673 ModuleData->ODMRPlot.SelectedPoint = State ? Point : QPointF();
704 auto LockinAmplifier =
ModuleData->GetLockinAmplifier();
707 LockinAmplifier->SetEnable(
true);
761 auto LockinAmplifier =
ModuleData->GetLockinAmplifier();
763 LockinAmplifier->SetSamplingRate(
ModuleData->ODMRSamplingRate);
780 std::vector<std::tuple<double, double, double>> SaveSamples;
782 bool PerformSensitivityMeasurement =
false;
783 double RFStartFreq{};
786 bool IsBasicSampleTimeUsed{};
787 double SamplingRate{ .0 };
796 std::vector<double> FitXData;
797 std::vector<double> FitYData;
798 std::string Filename;
799 std::string ValueUnitStr;
800 std::stringstream CSVData;
805 if (!
ModuleData->GetSignalDetector()->CanRead())
813 SensitivityResonanceFreq =
ModuleData->SensitivityResonanceFreq;
814 SensitivityResonanceSpan =
ModuleData->SensitivityResonanceSpan;
816 auto SignalDetectorData = DynExp::dynamic_InstrumentData_cast<DynExpInstr::DataStreamInstrument>(
ModuleData->GetSignalDetector()->GetInstrumentData());
817 SignalDetectorData->GetSampleStream()->SeekBeg(std::ios_base::in);
818 ODMRSamples = SignalDetectorData->GetSampleStream()->ReadBasicSamples(SignalDetectorData->GetSampleStream()->GetStreamSizeRead());
820 IsBasicSampleTimeUsed = SignalDetectorData->GetSampleStream()->IsBasicSampleTimeUsed();
823 SamplingRate =
ModuleData->GetAnalogIn()->GetNumericSampleStreamParams().SamplingRate;
825 if (SamplingRate == .0)
831 for (
size_t i = 0; i < ODMRSamples.size(); ++i)
833 const auto& Sample = ODMRSamples[i];
835 auto Frequency = RFStartFreq + (IsBasicSampleTimeUsed ? Sample.Time : (
static_cast<double>(i) / SamplingRate)) / RFDwellTime * RFFreqSpacing;
836 ODMRDataPoints.push_back({ Frequency / 1e9, Sample.Value });
837 ODMRDataPointsMinValues = { std::min(ODMRDataPointsMinValues.x(), Frequency / 1e9), std::min(ODMRDataPointsMinValues.y(), Sample.Value) };
838 ODMRDataPointsMaxValues = { std::max(ODMRDataPointsMaxValues.x(), Frequency / 1e9), std::max(ODMRDataPointsMaxValues.y(), Sample.Value) };
840 SaveSamples.emplace_back(std::make_tuple(Frequency, Sample.Time, Sample.Value));
842 if (PerformSensitivityMeasurement &&
843 Frequency >= SensitivityResonanceFreq - SensitivityResonanceSpan / 2 &&
844 Frequency <= SensitivityResonanceFreq + SensitivityResonanceSpan / 2)
846 FitXData.push_back(Frequency - SensitivityResonanceFreq);
847 FitYData.push_back(Sample.Value);
851 if (PerformSensitivityMeasurement)
853 double c0{0}, c1{0}, cov00{0}, cov01{0}, cov11{0}, chisq{0};
854 gsl_fit_linear(FitXData.data(), 1, FitYData.data(), 1, FitXData.size(), &c0, &c1, &cov00, &cov01, &cov11, &chisq);
855 ODMRFitParams = { c0, c1 };
857 for (
const auto& f : FitXData)
858 ODMRFitPoints.push_back({ (f + SensitivityResonanceFreq) / 1e9, c0 + c1 * f });
864 ModuleData->ODMRPlot.DataPoints = std::move(ODMRDataPoints);
865 ModuleData->ODMRPlot.DataPointsMinValues = ODMRDataPointsMinValues;
866 ModuleData->ODMRPlot.DataPointsMaxValues = ODMRDataPointsMaxValues;
867 ModuleData->ODMRPlot.FitParams = ODMRFitParams;
868 ModuleData->ODMRPlot.FitPoints = ODMRFitPoints;
872 ValueUnitStr =
ModuleData->GetSignalDetector()->GetValueUnitStr();
880 CSVData <<
"f(Hz);t(s);Value(" << ValueUnitStr <<
")\n";
881 for (
const auto& Sample : SaveSamples)
882 CSVData << std::get<0>(Sample) <<
";" << std::get<1>(Sample) <<
";" << std::get<2>(Sample) <<
"\n";
908 auto LockinAmplifier =
ModuleData->GetLockinAmplifier();
909 LockinAmplifier->SetStreamSize(
ModuleData->SensitivityDuration *
ModuleData->SensitivitySamplingRate);
910 LockinAmplifier->SetSamplingRate(
ModuleData->SensitivitySamplingRate);
926 std::vector<std::tuple<double, double>> SaveSamples;
929 bool SensitivityOffResonanceEnabled =
false;
930 bool SensitivityAnalysisEnabled =
false;
934 std::vector<std::complex<double>> SensitivityASD;
938 std::string Filename;
939 std::string FilenamePrefix;
940 std::string ValueUnitStr;
941 std::stringstream CSVData;
946 if (!
ModuleData->GetSignalDetector()->CanRead())
949 MeasurementMode =
ModuleData->MeasurementMode;
951 SensitivityOffResonanceEnabled =
ModuleData->SensitivityOffResonanceEnabled;
952 SensitivityAnalysisEnabled =
ModuleData->SensitivityAnalysisEnabled;
953 ODMRFitParams =
ModuleData->ODMRPlot.FitParams;
954 GyromagneticRatio =
ModuleData->GyromagneticRatio;
956 auto SignalDetectorData = DynExp::dynamic_InstrumentData_cast<DynExpInstr::DataStreamInstrument>(
ModuleData->GetSignalDetector()->GetInstrumentData());
957 SignalDetectorData->GetSampleStream()->SeekBeg(std::ios_base::in);
958 SensitivitySamples = SignalDetectorData->GetSampleStream()->ReadBasicSamples(SignalDetectorData->GetSampleStream()->GetStreamSizeRead());
961 for (
const auto& Sample : SensitivitySamples)
963 SaveSamples.emplace_back(std::make_tuple(Sample.Time, Sample.Value));
966 SensitivityASD.emplace_back(Sample.Value / std::get<1>(ODMRFitParams) / GyromagneticRatio, 0);
971 const auto Length =
static_cast<double>(SensitivityASD.size());
973 SensitivityASD =
Util::FFT(SensitivityASD);
974 std::transform(SensitivityASD.cbegin(), SensitivityASD.cend(), SensitivityASD.begin(), [Length](
auto x) { return std::abs(x / Length); });
977 SensitivityASD.erase(SensitivityASD.cbegin() + SensitivityASD.size() / 2 + 1, SensitivityASD.cend());
978 std::transform(SensitivityASD.cbegin() + 1, SensitivityASD.cend(), SensitivityASD.begin() + 1, [Length](
auto x) { return 2.0 * x; });
981 double TimeSamplingRate = 1 / (std::abs(SensitivitySamples.back().Time - SensitivitySamples.front().Time) / (SensitivitySamples.size() - 1));
982 std::vector<double> Frequencies(Length / 2 + 1, 0);
983 std::iota(Frequencies.begin(), Frequencies.end(), 0);
984 std::transform(Frequencies.cbegin(), Frequencies.cend(), Frequencies.begin(), [TimeSamplingRate, Length](
auto x) { return TimeSamplingRate * x / Length; });
986 double FrequencySamplingRate = std::abs(Frequencies.back() - Frequencies.front()) / (Frequencies.size() - 1);
987 std::transform(SensitivityASD.cbegin(), SensitivityASD.cend(), SensitivityASD.begin(), [FrequencySamplingRate](
auto x) { return x / std::sqrt(FrequencySamplingRate); });
989 if (SensitivityASD.size() == Frequencies.size())
990 for (
size_t i = 1; i < SensitivityASD.size(); ++i)
992 SensitivityDataPoints.push_back({ Frequencies[i], SensitivityASD[i].real() });
993 SensitivityDataPointsMinValues = { std::min(SensitivityDataPointsMinValues.x(), SensitivityDataPoints.back().x()),
994 std::min(SensitivityDataPointsMinValues.y(), SensitivityDataPoints.back().y()) };
995 SensitivityDataPointsMaxValues = { std::max(SensitivityDataPointsMaxValues.x(), SensitivityDataPoints.back().x()),
996 std::max(SensitivityDataPointsMaxValues.y(), SensitivityDataPoints.back().y()) };
1005 ModuleData->SensitivityPlot.DataPoints = std::move(SensitivityDataPoints);
1006 ModuleData->SensitivityPlot.DataPointsMinValues = SensitivityDataPointsMinValues;
1007 ModuleData->SensitivityPlot.DataPointsMaxValues = SensitivityDataPointsMaxValues;
1008 ModuleData->SensitivityPlot.HasChanged =
true;
1010 FilenamePrefix =
"Sensitivity";
1013 FilenamePrefix =
"OffResSensitivity";
1016 ValueUnitStr =
ModuleData->GetSignalDetector()->GetValueUnitStr();
1024 CSVData <<
"t(s);Value(" << ValueUnitStr <<
")\n";
1025 CSVData << std::setprecision(12);
1026 for (
const auto& Sample : SaveSamples)
1027 CSVData << std::get<0>(Sample) <<
";" << std::get<1>(Sample) <<
"\n";
1032 if (SensitivityOffResonanceEnabled)
Implementation of a module to perform optically detected magnetic resonance (ODMR) measurements.
Meta instrument for a single analog input port based on the data stream and generic input port meta i...
std::vector< BasicSample > BasicSampleListType
Type of a list containing data stream samples of type BasicSample.
@ Arbitrary
Arbitrary units (a.u.)
Meta instrument for a lock-in amplifier based on the data stream meta instrument.
bool SweepSeriesAdvanceLastValue
DynExpInstr::DataStreamInstrumentData::ValueType AuxAnalogOutMinValue
double SensitivityResonanceFreq
std::stringstream AssembleCSVHeader(double RFPower, double RFModulationDepth, double AuxAnalogOutValue, bool IsRFOffResonance)
bool TestFeature(const std::array< FeatureType, N > &Flags) const
DynExpInstr::DataStreamInstrumentData::UnitType AuxAnalogOutValueUnit
SweepSeriesType SweepSeries
double SensitivitySamplingRate
unsigned long long CurrentSweepIndex
SensitivityPlotType SensitivityPlot
DynExpInstr::FunctionGeneratorDefs::FunctionDescType RFGeneratorMaxFuncDesc
double SensitivityResonanceSpan
Util::FeatureTester< FeatureType > Features
double SensitivityOffResonanceFreq
unsigned long long GetSweepNumberSteps() const noexcept
bool SensitivityOncePerSweep
auto & GetSignalDetector() noexcept
bool SensitivityAnalysisEnabled
unsigned int CurrentSaveIndex
MeasurementModeType MeasurementMode
auto & GetRFGenerator() noexcept
DynExpInstr::FunctionGeneratorDefs::FunctionDescType RFGeneratorDefaultFuncDesc
RFModulationType RFModulation
double SensitivityDuration
DynExpInstr::FunctionGeneratorDefs::FunctionDescType RFGeneratorMinFuncDesc
bool SensitivityOffResonanceEnabled
DynExpInstr::DataStreamInstrumentData::ValueType AuxAnalogOutMaxValue
void ResetImpl(dispatch_tag< QModuleDataBase >) override final
size_t NumFailedUpdateAttempts
void InitRFGenerator(double Frequency, bool EnableRF, Util::SynchronizedPointer< ModuleDataType > &ModuleData) const
void OnSweepSeriesStopChanged(DynExp::ModuleInstance *Instance, double Value) const
void OnRFModDepthChanged(DynExp::ModuleInstance *Instance, double Value) const
void ConnectChartWidgets(QLineSeries *ODMRLineSeries)
Util::StateMachine< StateMachineStateType > StateMachine
void WaitUntilReadyAndTrigger(Util::SynchronizedPointer< ModuleDataType > &ModuleData) const
void OnStopClicked(DynExp::ModuleInstance *Instance, bool) const
void OnRFAutoEnableClicked(DynExp::ModuleInstance *Instance, int Checked) const
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 OnRFOnClicked(DynExp::ModuleInstance *Instance, bool) const
double NextAuxAnalogOutValue
void OnRFModPulseClicked(DynExp::ModuleInstance *Instance, bool Checked) const
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
void OnRecordSensitivityClicked(DynExp::ModuleInstance *Instance, int Checked) const
void OnSensitivityOffResonanceFreqChanged(DynExp::ModuleInstance *Instance, double Value) const
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
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
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
void OnStartSensitivityClicked(DynExp::ModuleInstance *Instance, bool) const
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 OnRecordSensitivityOncePerSweepClicked(DynExp::ModuleInstance *Instance, int Checked) const
void OnSweepSeriesStartChanged(DynExp::ModuleInstance *Instance, double Value) const
const Util::StateMachineContext< StateMachineStateType > SensitivityOffResonanceContext
void OnRFCenterFreqChanged(DynExp::ModuleInstance *Instance, double Value) const
void OnSensitivityDurationChanged(DynExp::ModuleInstance *Instance, double Value) const
const std::unique_ptr< ModuleDataType > ModuleData
Module data belonging to this ModuleBase instance.
Refer to ParamsBase::dispatch_tag.
Defines data for a thread belonging to a ModuleBase instance. Refer to RunnableInstance.
const ModuleBase::ModuleDataGetterType ModuleDataGetter
Getter for module's data. Refer to ModuleBase::ModuleDataGetterType.
Refer to ParamsBase::dispatch_tag.
QModuleWidget * Widget
User interface widget belonging to the module.
void Connect(SenderType *Sender, SignalType Signal, ReceiverType *Receiver, EventType Event)
Uses Qt's connect mechanism to connect a QObject's signal to a DynExp module's event....
const Object::ParamsGetterType ParamsGetter
Invoke to obtain the parameters (derived from ParamsBase) of Owner.
void UnlockObject(LinkedObjectWrapperContainer< ObjectT > &ObjectWrapperContainer)
Unlocks an Object instance stored in the LinkedObjectWrapperContainer ObjectWrapperContainer....
void LockObject(const ParamsBase::Param< ObjectLink< ObjectT >> &LinkParam, LinkedObjectWrapperContainer< ObjectT > &ObjectWrapperContainer, std::chrono::milliseconds Timeout=ObjectLinkBase::LockObjectTimeoutDefault)
Locks an Object instance referenced by a parameter LinkParam of type ParamsBase::Param< ObjectLink< O...
const auto & GetOwner() const noexcept
Returns Owner.
Data to operate on is invalid for a specific purpose. This indicates a corrupted data structure or fu...
Pointer to lock a class derived from ISynchronizedPointerLockable for synchronizing between threads....
Thrown when an operation timed out before it could be completed, especially used for locking shared d...
@ Rise
Trigger on rising edge.
@ ExternSingle
Run once after an external trigger signal has been detected.
QList< QPointF > DataPoints
QPointF DataPointsMaxValues
std::tuple< double, double > FitParams
QPointF DataPointsMaxValues
QPointF DataPointsMinValues
QPointF DataPointsMinValues
QList< QPointF > DataPoints
QList< QPointF > FitPoints
void WaitForInstruments(InstrTs &... Instruments)
Blocks until every instrument passed to the function as a reference parameter has arrived at a synchr...
std::unique_ptr< ParamsBase > ParamsBasePtrType
Alias for a pointer to the parameter system base class ParamsBase.
DynExpErrorCodes
DynExp's error codes
std::string ToStr(const T &Value, int Precision=-1)
Converts a (numeric) value of type T to a std::string using operator<< of std::stringstream.
bool SaveToFile(const QString &Filename, std::string_view Text)
Saves a std::string_view to a file (using QFile). Creates a new file or truncates an existing file's ...
std::vector< std::complex< double > > FFT(const std::vector< std::complex< double >> &Data, bool InverseTransform)
Computes the Fast Fourier Transform (FFT) a vector of complex values.
auto RemoveExtFromPath(std::string Path)
Removes the filename's extension from a path.
Accumulates include statements to provide a precompiled header.
@ Sine
Sinusoidally modulate the affected quantity.
@ Pulse
Pulse (binary) modulation switching the affected quantity between two values.
@ Frequency
Modulation affecting the waveform's frequency.
@ Frequency
Sweep the waveform's frequency.