StackOfSpirals.h

Go to the documentation of this file.

// Copyright 2026 Julien Lamy, ICube, Université de Strasbourg-CNRS.
// Part of msl, distributed under the terms of the MIT license.
 
#ifndef _0cc05ba7_89a6_4523_b78c_63604892f081
#define _0cc05ba7_89a6_4523_b78c_63604892f081
 
#include "msl/iPATMask.h"
#include "msl/Sampling.h"
#include "msl/readouts/Spiral.h"
#include "msl/Vector.h"
 
namespace msl
{
namespace samplings
{

class StackOfSpirals:public Sampling
{
public:
    DECLARE_POINTERS(StackOfSpirals)
    
    StackOfSpirals();
    StackOfSpirals(StackOfSpirals const &) = default;
    StackOfSpirals(StackOfSpirals &&) = default;
    StackOfSpirals & operator=(StackOfSpirals const &) = default;
    StackOfSpirals & operator=(StackOfSpirals &&) = default;
    ~StackOfSpirals() override = default;
    
    double phase() const override;
    
    StackOfSpirals & setPhase(double phase) override;
    
    long contrast() const override;
    
    StackOfSpirals & setContrast(long contrast) override;
    
    long timeOffset() const override;
    
    StackOfSpirals & setTimeOffset(long timeOffset) override;
    
    GradientSpecs const & gradientSpecs() const override;
    
    StackOfSpirals & setGradientSpecs(GradientSpecs const & gradientSpecs) override;
    
    uint32_t interleaves() const;
    
    iPATMask const & mask() const;
    
    StackOfSpirals & setMask(iPATMask const & mask);
    
    iPATMask::Points enabledPoints() const;
    
    bool runFirstInterleaveOnly() const;
    
    StackOfSpirals & setRunFirstInterleaveOnly(bool runFirstInterleaveOnly);
    
    NLSStatus prepare(
        MrProt & protocol, SeqLim & limits, SeqExpo & exports) override;
    
    NLSStatus run(
        MrProt & protocol, SeqLim & limits, SeqExpo & exports) override;
    
    long startTime() const override;
    
    long endTime() const override;
    
    MrProtocolData::SeqExpoRFInfo rfInfo() const override;
    
    NLSStatus updateReadout(MrProt & protocol, SeqLim & limits, SeqExpo & exports) override;
    
    readouts::Spiral const & readout() const override;
 
private:
    readouts::Spiral _readout;
    bool _runFirstInterleaveOnly;
    iPATMask _mask;
    iPATMask::Points _enabledPoints;
};
 
}
}
 
#endif // _0cc05ba7_89a6_4523_b78c_63604892f081