GradientPulse.h

Go to the documentation of this file.

// Copyright 2025-2026 Julien Lamy, ICube, Université de Strasbourg-CNRS.
// Part of msl, distributed under the terms of the MIT license.
 
#ifndef _a2706a74_88a7_497b_91e7_d5df6c57161f
#define _a2706a74_88a7_497b_91e7_d5df6c57161f
 
#include <array>
#include <vector>
#include <MrMeasSrv/SeqIF/libRT/sGRAD_PULSE.h>
#include "Vector.h"
 
namespace msl
{

class GradientPulse
{
public:
    enum class Kind { Trapezoidal, Arbitrary };
    
    GradientPulse();
    
    GradientPulse(Vector3d const & amplitude, long rampDuration, long plateauDuration);
    
    GradientPulse(std::vector<Vector3d> const & amplitude);
    
    GradientPulse(GradientPulse const &) = default;
    GradientPulse(GradientPulse &&) = default;
    GradientPulse & operator=(GradientPulse const &) = default;
    GradientPulse & operator=(GradientPulse &&) = default;
    ~GradientPulse() = default;
    
    GradientPulse & update(GradientPulse const & pulse);
    
    Vector3d amplitude() const;
    
    long rampDuration() const;
    
    long plateauDuration() const;
    
    long duration() const;
    
    Vector3d area() const;
    
    Vector3d area(double begin, double end) const;
    
    Vector3d areaFrom(double begin) const;
     
    Vector3d areaTo(double end) const;
    
    Vector3d rampArea() const;
    
    Vector3d plateauArea() const;
    
    long startTime() const;
    
    GradientPulse & setStartTime(long startTime);
    
    long plateauTime() const;
    
    GradientPulse & setPlateauTime(long plateauTime);
    
    long endTime() const;
    
    GradientPulse & setEndTime(long endTime);
    
    IGRAD_PULSE_BASE * operator[](std::size_t i) const;
    
    Kind const & kind() const;
    
    NLSStatus run();
private:
    Kind _kind;
    
    std::array<sGRAD_PULSE_TRAP, 3> _trapezoidalGradients;
    
    std::array<sGRAD_PULSE_ARB, 3> _arbitraryGradients;
    
    void _checkKind(Kind const & kind) const;
};
 
}
 
#endif // _a2706a74_88a7_497b_91e7_d5df6c57161f