StackOfStars.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 _b32783a9_89e5_4cf9_8562_045921f4107c
#define _b32783a9_89e5_4cf9_8562_045921f4107c
 
#include "msl/iPATMask.h"
#include "msl/Sampling.h"
#include "msl/helpers.h"
#include "msl/readouts/Linear.h"
 
namespace msl
{
namespace samplings
{

class StackOfStars: public Sampling
{
public:
    enum Mode
    {
        Regular,
        GoldenAngle
    };
    
    DECLARE_POINTERS(StackOfStars)
    
    StackOfStars();
    StackOfStars(StackOfStars const &) = default;
    StackOfStars(StackOfStars &&) = default;
    StackOfStars & operator=(StackOfStars const &) = default;
    StackOfStars & operator=(StackOfStars &&) = default;
    ~StackOfStars() override = default;
    
    Mode const & mode() const;
    
    StackOfStars & setMode(Mode mode);
    
    // NOTE: 0 undefined or 1 not tiny
    unsigned int const & tinyGoldenAngle() const;
    
    StackOfStars & setTinyGoldenAngle(unsigned int tiny);
    
    double phase() const override;
    
    StackOfStars & setPhase(double phase) override;
    
    long contrast() const override;
    
    StackOfStars & setContrast(long contrast) override;
    
    long timeOffset() const override;
    
    StackOfStars & setTimeOffset(long timeOffset) override;
    
    GradientSpecs const & gradientSpecs() const override;
    
    StackOfStars & setGradientSpecs(GradientSpecs const & gradientSpecs) override;
    
    uint16_t spokes() const;
    
    StackOfStars & setSpokes(uint16_t spokes);
    
    double relativeStart() const;
    
    StackOfStars & setRelativeStart(double relativeStart);
    
    iPATMask const & mask() const;
    
    StackOfStars & setMask(iPATMask const & mask);
    
    iPATMask::Points enabledPoints() const;
    
    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::Linear const & readout() const override;
    
private:
    Mode _mode;
    unsigned int _tinyGoldenAngle;
    
    // No need to precompute the trajectories, store one and update it each time
    // std::vector<readouts::Linear> _readouts;
    readouts::Linear _readout;
    
    uint16_t _spokes;
    double _relativeStart;
    
    iPATMask _mask;
    iPATMask::Points _enabledPoints;
};
 
}
}
 
#endif // _b32783a9_89e5_4cf9_8562_045921f4107c