XML API

EXPORTISMRMRD void deserialize (const char *xml, IsmrmrdHeader &h)

EXPORTISMRMRD void serialize (const IsmrmrdHeader &h, std::ostream &o)

EXPORTISMRMRD std::ostream & operator<< (std::ostream &os, const IsmrmrdHeader &)

EXPORTISMRMRD bool operator== (const IsmrmrdHeader &, const IsmrmrdHeader &)

EXPORTISMRMRD bool operator!= (const IsmrmrdHeader &lhs, const IsmrmrdHeader &rhs)

EXPORTISMRMRD bool operator== (const SubjectInformation &lhs, const SubjectInformation &rhs)

EXPORTISMRMRD bool operator!= (const SubjectInformation &lhs, const SubjectInformation &rhs)

EXPORTISMRMRD bool operator== (const StudyInformation &lhs, const StudyInformation &rhs)

EXPORTISMRMRD bool operator!= (const StudyInformation &lhs, const StudyInformation &rhs)

EXPORTISMRMRD bool operator== (const ReferencedImageSequence &lhs, const ReferencedImageSequence &rhs)

EXPORTISMRMRD bool operator!= (const ReferencedImageSequence &lhs, const ReferencedImageSequence &rhs)

EXPORTISMRMRD bool operator== (const MeasurementInformation &lhs, const MeasurementInformation &rhs)

EXPORTISMRMRD bool operator!= (const MeasurementInformation &lhs, const MeasurementInformation &rhs)

EXPORTISMRMRD bool operator== (const CoilLabel &lhs, const CoilLabel &rhs)

EXPORTISMRMRD bool operator!= (const CoilLabel &lhs, const CoilLabel &rhs)

EXPORTISMRMRD bool operator== (const AcquisitionSystemInformation &lhs, const AcquisitionSystemInformation &rhs)

EXPORTISMRMRD bool operator!= (const AcquisitionSystemInformation &lhs, const AcquisitionSystemInformation &rhs)

EXPORTISMRMRD bool operator== (const ExperimentalConditions &lhs, const ExperimentalConditions &rhs)

EXPORTISMRMRD bool operator!= (const ExperimentalConditions &lhs, const ExperimentalConditions &rhs)

EXPORTISMRMRD bool operator== (const MatrixSize &lhs, const MatrixSize &rhs)

EXPORTISMRMRD bool operator!= (const MatrixSize &lhs, const MatrixSize &rhs)

EXPORTISMRMRD bool operator== (const FieldOfView_mm &lhs, const FieldOfView_mm &rhs)

EXPORTISMRMRD bool operator!= (const FieldOfView_mm &lhs, const FieldOfView_mm &rhs)

EXPORTISMRMRD bool operator== (const EncodingSpace &lhs, const EncodingSpace &rhs)

EXPORTISMRMRD bool operator!= (const EncodingSpace &lhs, const EncodingSpace &rhs)

EXPORTISMRMRD bool operator== (const Limit &lhs, const Limit &rhs)

EXPORTISMRMRD bool operator!= (const Limit &lhs, const Limit &rhs)

EXPORTISMRMRD bool operator== (const EncodingLimits &lhs, const EncodingLimits &rhs)

EXPORTISMRMRD bool operator!= (const EncodingLimits &lhs, const EncodingLimits &rhs)

EXPORTISMRMRD bool operator== (const UserParameterLong &lhs, const UserParameterLong &rhs)

EXPORTISMRMRD bool operator!= (const UserParameterLong &lhs, const UserParameterLong &rhs)

EXPORTISMRMRD bool operator== (const UserParameterDouble &lhs, const UserParameterDouble &rhs)

EXPORTISMRMRD bool operator!= (const UserParameterDouble &lhs, const UserParameterDouble &rhs)

EXPORTISMRMRD bool operator== (const UserParameterString &lhs, const UserParameterString &rhs)

EXPORTISMRMRD bool operator!= (const UserParameterString &lhs, const UserParameterString &rhs)

EXPORTISMRMRD bool operator== (const UserParameters &lhs, const UserParameters &rhs)

EXPORTISMRMRD bool operator!= (const UserParameters &lhs, const UserParameters &rhs)

EXPORTISMRMRD bool operator== (const TrajectoryDescription &lhs, const TrajectoryDescription &rhs)

EXPORTISMRMRD bool operator!= (const TrajectoryDescription &lhs, const TrajectoryDescription &rhs)

EXPORTISMRMRD bool operator== (const AccelerationFactor &lhs, const AccelerationFactor &rhs)

EXPORTISMRMRD bool operator!= (const AccelerationFactor &lhs, const AccelerationFactor &rhs)

EXPORTISMRMRD bool operator== (const ParallelImaging &lhs, const ParallelImaging &rhs)

EXPORTISMRMRD bool operator!= (const ParallelImaging &lhs, const ParallelImaging &rhs)

EXPORTISMRMRD bool operator== (const Multiband &lhs, const Multiband &rhs)

EXPORTISMRMRD bool operator!= (const Multiband &lhs, const Multiband &rhs)

EXPORTISMRMRD bool operator== (const MultibandSpacing &lhs, const MultibandSpacing &rhs)

EXPORTISMRMRD bool operator!= (const MultibandSpacing &lhs, const MultibandSpacing &rhs)

EXPORTISMRMRD bool operator== (const Encoding &lhs, const Encoding &rhs)

EXPORTISMRMRD bool operator!= (const Encoding &lhs, const Encoding &rhs)

EXPORTISMRMRD bool operator== (const SequenceParameters &lhs, const SequenceParameters &rhs)

EXPORTISMRMRD bool operator!= (const SequenceParameters &lhs, const SequenceParameters &rhs)

EXPORTISMRMRD bool operator== (const WaveformInformation &lhs, const WaveformInformation &rhs)

EXPORTISMRMRD bool operator!= (const WaveformInformation &lhs, const WaveformInformation &rhs)

EXPORTISMRMRD bool operator== (const threeDimensionalFloat &lhs, const threeDimensionalFloat &rhs)

EXPORTISMRMRD bool operator!= (const threeDimensionalFloat &lhs, const threeDimensionalFloat &rhs)

EXPORTISMRMRD bool operator== (const MeasurementDependency &lhs, const MeasurementDependency &rhs)

EXPORTISMRMRD bool operator!= (const MeasurementDependency &lhs, const MeasurementDependency &rhs)

EXPORTISMRMRD bool operator== (const GradientDirection &lhs, const GradientDirection &rhs)

EXPORTISMRMRD bool operator!= (const GradientDirection &lhs, const GradientDirection &rhs)

EXPORTISMRMRD bool operator== (const Diffusion &lhs, const Diffusion &rhs)

EXPORTISMRMRD bool operator!= (const Diffusion &lhs, const Diffusion &rhs)

template<typename T> class Optional

Public Functions

inline Optional()

inline Optional(const T &v)

inline Optional &operator=(const Optional &o)

inline Optional &operator=(const T &v)

inline T *operator->()

inline T &operator*()

inline const T *operator->() const

inline const T &operator*() const

inline operator bool() const

inline bool is_present() const

inline bool has_value() const noexcept

inline T &value()

inline const T &value() const

inline T &get()

inline const T &get() const

inline bool operator==(const Optional<T> &other) const

inline bool operator==(const T &val) const

inline T &operator()()

inline void set(const T &v)

Protected Attributes

bool present_

T value_

struct threeDimensionalFloat

Public Members

float x

float y

float z

struct SubjectInformation

Public Members

Optional<std::string> patientName

Optional<float> patientWeight_kg

Optional<float> patientHeight_m

Optional<std::string> patientID

Optional<std::string> patientBirthdate

Optional<std::string> patientGender

struct StudyInformation

Public Members

Optional<std::string> studyDate

Optional<std::string> studyTime

Optional<std::string> studyID

Optional<ISMRMRD::int64_t> accessionNumber

Optional<std::string> referringPhysicianName

Optional<std::string> studyDescription

Optional<std::string> studyInstanceUID

Optional<std::string> bodyPartExamined

struct MeasurementDependency

Public Members

std::string dependencyType

std::string measurementID

struct ReferencedImageSequence

Public Members

std::string referencedSOPInstanceUID

struct MeasurementInformation

Public Members

Optional<std::string> measurementID

Optional<std::string> seriesDate

Optional<std::string> seriesTime

std::string patientPosition

Optional<threeDimensionalFloat> relativeTablePosition

Optional<ISMRMRD::int64_t> initialSeriesNumber

Optional<std::string> protocolName

Optional<std::string> sequenceName

Optional<std::string> seriesDescription

std::vector<MeasurementDependency> measurementDependency

Optional<std::string> seriesInstanceUIDRoot

Optional<std::string> frameOfReferenceUID

std::vector<ReferencedImageSequence> referencedImageSequence

struct CoilLabel

Public Members

ISMRMRD::uint16_t coilNumber

std::string coilName

struct AcquisitionSystemInformation

Public Members

Optional<std::string> systemVendor

Optional<std::string> systemModel

Optional<float> systemFieldStrength_T

Optional<float> relativeReceiverNoiseBandwidth

Optional<ISMRMRD::uint16_t> receiverChannels

std::vector<CoilLabel> coilLabel

Optional<std::string> institutionName

Optional<std::string> stationName

Optional<std::string> deviceID

Optional<std::string> deviceSerialNumber

struct ExperimentalConditions

Public Members

ISMRMRD::int64_t H1resonanceFrequency_Hz

struct MatrixSize

Public Functions

inline MatrixSize()

inline MatrixSize(ISMRMRD::uint16_t x, ISMRMRD::uint16_t y)

inline MatrixSize(ISMRMRD::uint16_t x, ISMRMRD::uint16_t y, ISMRMRD::uint16_t z)

Public Members

ISMRMRD::uint16_t x

ISMRMRD::uint16_t y

ISMRMRD::uint16_t z

struct FieldOfView_mm

Public Members

float x

float y

float z

struct EncodingSpace

Public Members

MatrixSize matrixSize

FieldOfView_mm fieldOfView_mm

struct Limit

Public Functions

inline Limit()

inline Limit(ISMRMRD::uint16_t minimum, ISMRMRD::uint16_t maximum, ISMRMRD::uint16_t center)

Public Members

ISMRMRD::uint16_t minimum

ISMRMRD::uint16_t maximum

ISMRMRD::uint16_t center

struct EncodingLimits

Public Members

Optional<Limit> kspace_encoding_step_0

Optional<Limit> kspace_encoding_step_1

Optional<Limit> kspace_encoding_step_2

Optional<Limit> average

Optional<Limit> slice

Optional<Limit> contrast

Optional<Limit> phase

Optional<Limit> repetition

Optional<Limit> set

Optional<Limit> segment

Optional<Limit> user[ISMRMRD_USER_INTS]

struct UserParameterLong

Public Members

std::string name

ISMRMRD::int64_t value

struct UserParameterDouble

Public Members

std::string name

double value

struct UserParameterString

Public Members

std::string name

std::string value

struct UserParameters

Public Members

std::vector<UserParameterLong> userParameterLong

std::vector<UserParameterDouble> userParameterDouble

std::vector<UserParameterString> userParameterString

std::vector<UserParameterString> userParameterBase64

struct TrajectoryDescription

Public Members

std::string identifier

std::vector<UserParameterLong> userParameterLong

std::vector<UserParameterDouble> userParameterDouble

std::vector<UserParameterString> userParameterString

Optional<std::string> comment

struct AccelerationFactor

Public Members

ISMRMRD::uint16_t kspace_encoding_step_1

ISMRMRD::uint16_t kspace_encoding_step_2

class TrajectoryType

Public Types

enum [anonymous]

Values:

enumerator CARTESIAN

enumerator EPI

enumerator RADIAL

enumerator GOLDENANGLE

enumerator SPIRAL

enumerator OTHER

Public Functions

inline TrajectoryType()

inline TrajectoryType(int value)

inline operator int() const

inline bool operator==(const TrajectoryType &rhs) const

Protected Attributes

int value_

class MultibandCalibrationType

Public Types

enum [anonymous]

Values:

enumerator SEPARABLE2D

enumerator FULL3D

enumerator OTHER

Public Functions

inline MultibandCalibrationType()

inline MultibandCalibrationType(int value)

inline operator int() const

inline bool operator==(const MultibandCalibrationType &rhs) const

Protected Attributes

int value_

struct MultibandSpacing

Public Members

std::vector<float> dZ

struct Multiband

Public Members

std::vector<MultibandSpacing> spacing

float deltaKz

ISMRMRD::uint32_t multiband_factor

MultibandCalibrationType calibration

ISMRMRD::uint64_t calibration_encoding

struct ParallelImaging

Public Members

AccelerationFactor accelerationFactor

Optional<std::string> calibrationMode

Optional<std::string> interleavingDimension

Optional<Multiband> multiband

struct Encoding

Public Members

EncodingSpace encodedSpace

EncodingSpace reconSpace

EncodingLimits encodingLimits

TrajectoryType trajectory

Optional<TrajectoryDescription> trajectoryDescription

Optional<ParallelImaging> parallelImaging

Optional<ISMRMRD::int64_t> echoTrainLength

struct GradientDirection

Public Members

float rl

float ap

float fh

class DiffusionDimension

Public Types

enum [anonymous]

Values:

enumerator AVERAGE

enumerator CONTRAST

enumerator PHASE

enumerator REPETITION

enumerator SET

enumerator SEGMENT

enumerator USER_0

enumerator USER_1

enumerator USER_2

enumerator USER_3

enumerator USER_4

enumerator USER_5

enumerator USER_6

enumerator USER_7

Public Functions

inline DiffusionDimension()

inline DiffusionDimension(int value)

inline operator int() const

inline bool operator==(const DiffusionDimension &rhs) const

Protected Attributes

int value_

struct Diffusion

Public Members

float bvalue

GradientDirection gradientDirection

struct SequenceParameters

Public Members

Optional<std::vector<float>> TR

Optional<std::vector<float>> TE

Optional<std::vector<float>> TI

Optional<std::vector<float>> flipAngle_deg

Optional<std::string> sequence_type

Optional<std::vector<float>> echo_spacing

Optional<DiffusionDimension> diffusionDimension

Optional<std::vector<Diffusion>> diffusion

Optional<std::string> diffusionScheme

class WaveformType

Public Types

enum [anonymous]

Values:

enumerator ECG

enumerator PULSE

enumerator RESPIRATORY

enumerator TRIGGER

enumerator GRADIENTWAVEFORM

enumerator OTHER

Public Functions

inline WaveformType()

inline WaveformType(int value)

inline operator int() const

inline bool operator==(const WaveformType &rhs) const

Protected Attributes

int value_

struct WaveformInformation

Public Members

std::string waveformName

WaveformType waveformType

Optional<UserParameters> userParameters

struct IsmrmrdHeader

Public Members

Optional<ISMRMRD::int64_t> version

Optional<SubjectInformation> subjectInformation

Optional<StudyInformation> studyInformation

Optional<MeasurementInformation> measurementInformation

Optional<AcquisitionSystemInformation> acquisitionSystemInformation

ExperimentalConditions experimentalConditions

std::vector<Encoding> encoding

Optional<SequenceParameters> sequenceParameters

Optional<UserParameters> userParameters

std::vector<WaveformInformation> waveformInformation