C++ API

bool operator==(const EncodingCounters &ec1, const EncodingCounters &ec2)

template<typename T> EXPORTISMRMRD ISMRMRD_DataTypes get_data_type ()

class FlagBit

Public Functions

inline FlagBit(unsigned short b)

inline bool isSet(const uint64_t &m) const

Public Members

uint64_t bitmask_

class AcquisitionHeader : public ISMRMRD::ISMRMRD_AcquisitionHeader

Public Functions

AcquisitionHeader()

bool operator==(const AcquisitionHeader &acq) const

bool isFlagSet(const ISMRMRD_AcquisitionFlags val) const

void setFlag(const ISMRMRD_AcquisitionFlags val)

void clearFlag(const ISMRMRD_AcquisitionFlags val)

void clearAllFlags()

bool isChannelActive(uint16_t channel_id) const

void setChannelActive(uint16_t channel_id)

void setChannelNotActive(uint16_t channel_id)

void setAllChannelsNotActive()

class Acquisition

Public Functions

Acquisition()

Acquisition(uint16_t num_samples, uint16_t active_channels = 1, uint16_t trajectory_dimensions = 0)

Acquisition(const Acquisition &other)

Acquisition &operator=(const Acquisition &other)

~Acquisition()

uint16_t version() const

uint64_t flags() const

uint32_t &measurement_uid()

uint32_t &scan_counter()

uint32_t &acquisition_time_stamp()

uint32_t (&physiology_time_stamp())[ISMRMRD_PHYS_STAMPS]

const uint16_t &number_of_samples()

uint16_t &available_channels()

const uint16_t &active_channels()

const uint64_t (&channel_mask())[ISMRMRD_CHANNEL_MASKS]

uint16_t &discard_pre()

uint16_t &discard_post()

uint16_t &center_sample()

uint16_t &encoding_space_ref()

const uint16_t &trajectory_dimensions()

float &sample_time_us()

float (&position())[3]

float (&read_dir())[3]

float (&phase_dir())[3]

float (&slice_dir())[3]

float (&patient_table_position())[3]

ISMRMRD_EncodingCounters &idx()

int32_t (&user_int())[ISMRMRD_USER_INTS]

float (&user_float())[ISMRMRD_USER_FLOATS]

uint32_t measurement_uid() const

uint32_t scan_counter() const

uint32_t acquisition_time_stamp() const

const uint32_t (&physiology_time_stamp() const)[ISMRMRD_PHYS_STAMPS]

uint16_t number_of_samples() const

uint16_t available_channels() const

uint16_t active_channels() const

const uint64_t (&channel_mask() const)[ISMRMRD_CHANNEL_MASKS]

uint16_t discard_pre() const

uint16_t discard_post() const

uint16_t center_sample() const

uint16_t encoding_space_ref() const

uint16_t trajectory_dimensions() const

float sample_time_us() const

const float (&position() const)[3]

const float (&read_dir() const)[3]

const float (&phase_dir() const)[3]

const float (&slice_dir() const)[3]

const float (&patient_table_position() const)[3]

const ISMRMRD_EncodingCounters &idx() const

const int32_t (&user_int() const)[ISMRMRD_USER_INTS]

const float (&user_float() const)[ISMRMRD_USER_FLOATS]

void resize(uint16_t num_samples, uint16_t active_channels = 1, uint16_t trajectory_dimensions = 0)

size_t getNumberOfDataElements() const

size_t getNumberOfTrajElements() const

size_t getDataSize() const

size_t getTrajSize() const

const AcquisitionHeader &getHead() const

void setHead(const AcquisitionHeader &other)

const complex_float_t *getDataPtr() const

complex_float_t *getDataPtr()

complex_float_t &data(uint16_t sample, uint16_t channel)

void setData(complex_float_t *data)

complex_float_t *data_begin()

const complex_float_t *data_begin() const

complex_float_t *data_end()

const complex_float_t *data_end() const

const float *getTrajPtr() const

float *getTrajPtr()

float &traj(uint16_t dimension, uint16_t sample)

void setTraj(float *traj)

float *traj_begin()

const float *traj_begin() const

float *traj_end()

const float *traj_end() const

bool isFlagSet(const uint64_t val) const

void setFlag(const uint64_t val)

void clearFlag(const uint64_t val)

void clearAllFlags()

inline bool isFlagSet(const FlagBit &val) const

inline void setFlag(const FlagBit &val)

inline void clearFlag(const FlagBit &val)

bool isChannelActive(uint16_t channel_id) const

void setChannelActive(uint16_t channel_id)

void setChannelNotActive(uint16_t channel_id)

void setAllChannelsNotActive()

Protected Attributes

ISMRMRD_Acquisition acq

Friends

friend class Dataset

class ImageHeader : public ISMRMRD::ISMRMRD_ImageHeader

Public Functions

ImageHeader()

bool isFlagSet(const uint64_t val) const

void setFlag(const uint64_t val)

void clearFlag(const uint64_t val)

void clearAllFlags()

template<typename T> class Image

Public Functions

Image(uint16_t matrix_size_x = 0, uint16_t matrix_size_y = 1, uint16_t matrix_size_z = 1, uint16_t channels = 1)

Image(const Image &other)

Image &operator=(const Image &other)

~Image()

void resize(uint16_t matrix_size_x, uint16_t matrix_size_y, uint16_t matrix_size_z, uint16_t channels)

uint16_t getMatrixSizeX() const

void setMatrixSizeX(uint16_t matrix_size_x)

uint16_t getMatrixSizeY() const

void setMatrixSizeY(uint16_t matrix_size_y)

uint16_t getMatrixSizeZ() const

void setMatrixSizeZ(uint16_t matrix_size_z)

uint16_t getNumberOfChannels() const

void setNumberOfChannels(uint16_t channels)

void setFieldOfView(float fov_x, float fov_y, float fov_z)

float getFieldOfViewX() const

void setFieldOfViewX(float f)

float getFieldOfViewY() const

void setFieldOfViewY(float f)

float getFieldOfViewZ() const

void setFieldOfViewZ(float f)

void setPosition(float x, float y, float z)

float getPositionX() const

void setPositionX(float x)

float getPositionY() const

void setPositionY(float y)

float getPositionZ() const

void setPositionZ(float z)

void setReadDirection(float x, float y, float z)

float getReadDirectionX() const

void setReadDirectionX(float x)

float getReadDirectionY() const

void setReadDirectionY(float y)

float getReadDirectionZ() const

void setReadDirectionZ(float z)

void setPhaseDirection(float x, float y, float z)

float getPhaseDirectionX() const

void setPhaseDirectionX(float x)

float getPhaseDirectionY() const

void setPhaseDirectionY(float y)

float getPhaseDirectionZ() const

void setPhaseDirectionZ(float z)

void setSliceDirection(float x, float y, float z)

float getSliceDirectionX() const

void setSliceDirectionX(float x)

float getSliceDirectionY() const

void setSliceDirectionY(float y)

float getSliceDirectionZ() const

void setSliceDirectionZ(float z)

void setPatientTablePosition(float x, float y, float z)

float getPatientTablePositionX() const

void setPatientTablePositionX(float x)

float getPatientTablePositionY() const

void setPatientTablePositionY(float y)

float getPatientTablePositionZ() const

void setPatientTablePositionZ(float z)

uint16_t getVersion() const

ISMRMRD_DataTypes getDataType() const

uint32_t getMeasurementUid() const

void setMeasurementUid(uint32_t measurement_uid)

uint16_t getAverage() const

void setAverage(uint16_t average)

uint16_t getSlice() const

void setSlice(uint16_t slice)

uint16_t getContrast() const

void setContrast(uint16_t contrast)

uint16_t getPhase() const

void setPhase(uint16_t phase)

uint16_t getRepetition() const

void setRepetition(uint16_t repetition)

uint16_t getSet() const

void setSet(uint16_t set)

uint32_t getAcquisitionTimeStamp() const

void setAcquisitionTimeStamp(uint32_t acquisition_time_stamp)

uint32_t getPhysiologyTimeStamp(unsigned int stamp_id) const

void setPhysiologyTimeStamp(unsigned int stamp_id, uint32_t value)

uint16_t getImageType() const

void setImageType(uint16_t image_type)

uint16_t getImageIndex() const

void setImageIndex(uint16_t image_index)

uint16_t getImageSeriesIndex() const

void setImageSeriesIndex(uint16_t image_series_index)

float getUserFloat(unsigned int index) const

void setUserFloat(unsigned int index, float value)

int32_t getUserInt(unsigned int index) const

void setUserInt(unsigned int index, int32_t value)

uint64_t getFlags() const

void setFlags(const uint64_t flags)

bool isFlagSet(const uint64_t val) const

void setFlag(const uint64_t val)

void clearFlag(const uint64_t val)

void clearAllFlags()

ImageHeader &getHead()

const ImageHeader &getHead() const

void setHead(const ImageHeader &head)

void getAttributeString(std::string &attr) const

const char *getAttributeString() const

void setAttributeString(const std::string &attr)

void setAttributeString(const char *attr)

size_t getAttributeStringLength() const

T *getDataPtr()

const T *getDataPtr() const

size_t getNumberOfDataElements() const

size_t getDataSize() const

T *begin()

T *end()

T &operator()(uint16_t x, uint16_t y = 0, uint16_t z = 0, uint16_t channel = 0)

Protected Attributes

ISMRMRD_Image im

Friends

friend class Dataset

template<typename T> class NDArray

Public Functions

NDArray()

NDArray(const std::vector<size_t> dimvec)

NDArray(const NDArray<T> &other)

~NDArray()

NDArray<T> &operator=(const NDArray<T> &other)

uint16_t getVersion() const

ISMRMRD_DataTypes getDataType() const

uint16_t getNDim() const

const size_t (&getDims())[ISMRMRD_NDARRAY_MAXDIM]

size_t getDataSize() const

void resize(const std::vector<size_t> dimvec)

size_t getNumberOfElements() const

T *getDataPtr()

const T *getDataPtr() const

T *begin()

T *end()

T &operator()(uint16_t x, uint16_t y = 0, uint16_t z = 0, uint16_t w = 0, uint16_t n = 0, uint16_t m = 0, uint16_t l = 0)

Protected Attributes

ISMRMRD_NDArray arr

Friends

friend class Dataset

Read the Docs v: latest

Versions: latest; stable

Downloads

On Read the Docs: Project Home; Builds