CartesianReadout.h

Go to the documentation of this file.

// Copyright 2025 Julien Lamy, ICube, Université de Strasbourg-CNRS.
// Part of msl, distributed under the terms of the MIT license.
 
#ifndef _5ab5cca8_2d48_40c2_89b5_30f7c75ca92d
#define _5ab5cca8_2d48_40c2_89b5_30f7c75ca92d
 
#include <MrMeasSrv/SeqIF/libRT/sREADOUT.h>
 
#include <msl/KSpace.h>
#include <msl/GradientPulse.h>
#include <msl/NCOPair.h>
#include <msl/RealTimeEvents.h>
#include <msl/Vector.h>
 
namespace msl
{
 
class CartesianReadout: public RealTimeEvents
{
public:
    CartesianReadout();
    virtual ~CartesianReadout() override = default;
    CartesianReadout(CartesianReadout const &) = default;
    CartesianReadout(CartesianReadout &&) = default;
    CartesianReadout & operator=(CartesianReadout const &) = default;
    CartesianReadout & operator=(CartesianReadout &&) = default;
    
    double phase() const;
    
    CartesianReadout & setPhase(double phase);
    
    msl::Vector2l index() const;
    
    CartesianReadout & setIndex(msl::Vector2l const & index);
    
    double adcStartPosition() const;
    
    CartesianReadout & setADCStartPosition(double k);
    
    CartesianReadout & setADCStartPosition(double x, msl::KSpace const & kspace);
    
    double adcEndPosition() const;
    
    CartesianReadout & setADCEndPosition(double k);
    
    CartesianReadout & setADCEndPosition(double x, msl::KSpace const & kspace);
    
    CartesianReadout & setADCPosition(double kStart, double kEnd);
    
    CartesianReadout & setADCPosition(
        double xStart, double xEnd, msl::KSpace const & kSpace);
    
    long contrast() const;
    
    CartesianReadout & setContrast(long contrast);
    
    long timeOffset() const;
    
    CartesianReadout & setTimeOffset(long timeOffset);
    
    bool reverted() const;
    
    CartesianReadout & setReverted(bool reverted);
    
    long echoTime() const;
    
    msl::Vector3d startPosition() const;
    
    msl::Vector3d endPosition() const;
    
    NLSStatus prepare(
        MrProt & protocol, SeqLim & limits, SeqExpo & exports) override;
    NLSStatus run(
        MrProt & protocol, SeqLim & limits, SeqExpo & exports) override;
    
    MrProtocolData::SeqExpoRFInfo rfInfo() const override;
    
    long startTime() const override;
    long endTime() const override;
    
    msl::GradientPulse const & gradient() const;
    
    long adcStartTime() const;
    
    long adcEndTime() const;
    
    msl::Vector3d areaBeforeADC() const;
    
    msl::Vector3d areaBeforeEcho() const;
    
    msl::Vector3d areaAfterEcho() const;
    
    msl::Vector3d areaAfterADC() const;
    
    sREADOUT const & adc() const;
    
    sREADOUT & adc();
 
private:
    double _phase;
    msl::Vector2l _index;
    double _adcStartPosition, _adcEndPosition;
    long _contrast;
    long _timeOffset;
    bool _reverted;
    
    long _echoTime;
    
    msl::GradientPulse _gradient;
    sREADOUT _adc;
    msl::NCOPair _nco;
};
 
}
 
#endif // _5ab5cca8_2d48_40c2_89b5_30f7c75ca92d