/**
@file brukerimage.cpp
*/
+
#include "brukerimage.h"
/**
-* This method takes care of the initialization of the main parameters usually needed to deal with an MRI experiment
+ * @brief This method takes care of the initialization of the main parameters usually needed to deal with an MRI experiment
* @fn bool BrukerImage::Init(BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco, int TheValue)
* @param TheOrigAcqp
* @param TheOrigReco
}
/**
-* @fn bool BrukerImage::setAbsoluteTimePosition (BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco, int TheValue )
+ * @fn bool BrukerImage::setAbsoluteTimePosition (BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco, int TheValue )
* @brief AbsoluteTimePosition is an integer number giving the time of the begining of the acquisition of the dataset
* @param TheOrigAcqp
* @param TheOrigReco
return true;
}
-
/**
* @brief RelativeTimePosition is the estimated time position of the time the k-space center was acquired
* This notion is very relative when dealing with long experiments and a line or object averaging (NA or NAE <> 1)
* @brief RelativeTimePosition is the estimated instant when the k-space center of each image was acquired
This notion is very relative when dealing with long experiments and a line or object averaging (NA or NAE <> 1)
-* @fn bool BrukerImage::setRelativeTimePosition (BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco, int TheValue )
+ * @fn bool BrukerImage::setRelativeTimePosition (BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco, int TheValue )
* @param TheOrigAcqp
* @param TheOrigReco
* @param TheValue
return true;
}
-
/**
* @brief FOVpixels is a 1x2 integer vector. it's one of the view value we need to pick in the reco headermap
- * @fn bool BrukerImage::setFOVpixels(BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco, int TheValue)
+ * @fn bool BrukerImage::setFOVpixels(BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco, int TheValue)
* @param TheOrigAcqp
* @param TheOrigReco
* @param TheValue
return FOVpixels;
}
-
/**
* @brief FOVcm is also picked in reco headermap
* @fn bool BrukerImage::setFOVcm(BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco, int TheValue)
}
/**
-* @brief picks the echo time of the image number TheValue
+ * @brief picks the echo time of the image number TheValue
* @fn bool BrukerImage::setTE( BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco,int TheValue)
* @param TheOrigAcqp
* @param TheOrigReco
return TE;
}
-
/**
- * @brief picks the repetition time of the image number TheValue
+ * @brief picks the repetition time of the image number TheValue
* @fn bool BrukerImage::setTR( BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco,int TheValue)
* @param TheOrigAcqp
* @param TheOrigReco
}
/**
-* @brief picks the invertion time of the image number TheValue
+ * @brief picks the invertion time of the image number TheValue
* @fn bool BrukerImage::setTI( BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco,int TheValue)
* @param TheOrigAcqp
* @param TheOrigReco
}
/**
-* @brief picks the flip angle of the image number TheValue
+ * @brief picks the flip angle of the image number TheValue
* @fn bool BrukerImage::setFlipAngle( BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco,int TheValue)
* @param TheOrigAcqp
* @param TheOrigReco
return LoopStamp;
}
-
/**
* @brief NA number of accumulation is useful to track image quality
* @fn bool BrukerImage::setNA(BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco, int TheValue)
}
/**
-@brief NAE number of object exterior accumulation is useful to track image quality and rather used than NA to average movement artefacts
+ * @brief NAE number of object exterior accumulation is useful to track image quality and rather used than NA to average movement artefacts
* @fn bool BrukerImage::setNAE(BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco, int TheValue)
* @param TheOrigAcqp
* @param TheOrigReco
}
/**
- @brief NAE number of object exterior accumulation is useful to track image quality and rather used than NA to average movement artefacts
+ * @brief NAE number of object exterior accumulation is useful to track image quality and rather used than NA to average movement artefacts
* @fn int BrukerImage::getNAE() const
* @return NAE
*/
}
/**
-@brief DS (dummy scan) is useful to establish a dynamic equilibrium or to know if one was used
+ * @brief DS (dummy scan) is useful to establish a dynamic equilibrium or to know if one was used
* @fn bool BrukerImage::setDS(BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco, int TheValue)
* @param TheOrigAcqp
* @param TheOrigReco
}
/**
-@brief Phase factor is the number of kspace line acquired in a single shot
+ * @brief Phase factor is the number of kspace line acquired in a single shot
* @fn bool BrukerImage::setACQ_phase_factor(BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco, int TheValue)
* @param TheOrigAcqp
* @param TheOrigReco
}
/**
- @brief Phase factor is the number of kspace line acquired in a single shot
- @fn int BrukerImage::getACQ_phase_factor() const
- @return
-*/
+ * @brief Phase factor is the number of kspace line acquired in a single shot
+ * @fn int BrukerImage::getACQ_phase_factor() const
+ * @return
+ */
int BrukerImage::getACQ_phase_factor() const
{
return ACQ_phase_factor;
/**
-@brief The number of repetition NR is used to repeat a full objects acquisition NR times with a given delay
-* This method returns at which repetition belongs the image TheValue
+ * @brief The number of repetition NR is used to repeat a full objects acquisition NR times with a given delay
+ * This method returns at which repetition belongs the image TheValue
* @fn bool BrukerImage::NR(BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco, int TheValue)
* @param TheOrigAcqp
* @param TheOrigReco
}
/**
- @brief The number of repetition NR is used to repeat a full objects acquisition NR times with a given delay
+ * @brief The number of repetition NR is used to repeat a full objects acquisition NR times with a given delay
* This method returns at which repetition belongs the image TheValue
- @fn int BrukerImage::getNR() const
- @return NR
+ * @fn int BrukerImage::getNR() const
+ * @return NR
*/
int BrukerImage::getNR() const
{
return NR;
}
-
-
/**
-@brief RotationMatrixRPS2XYZ is a 3x3 rotation matrix giving the orientation of the TheValue image
+ * @brief RotationMatrixRPS2XYZ is a 3x3 rotation matrix giving the orientation of the TheValue image
* @fn bool BrukerImage::setRotationMatrixRPS2XYZ(BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco, int TheValue)
* @param TheOrigAcqp
* @param TheOrigReco
return RotationMatrixRPS2XYZ;
}
-
-
/**
-@brief TranslationVectorRPS2XYZ is a 1x3 vector of the TheValue image position to the magnet center (in mm)
+ * @brief TranslationVectorRPS2XYZ is a 1x3 vector of the TheValue image position to the magnet center (in mm)
* @fn bool BrukerImage::setTranslationVectorRPS2XYZ(BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco, int TheValue)
* @param TheOrigAcqp
* @param TheOrigReco
}
/**
-@brief WordType returns the type of data to read int32_t, int16_t, uint8_t or float32_t
+ * @brief WordType returns the type of data to read int32_t, int16_t, uint8_t or float32_t
* @fn bool BrukerImage::setWordType(BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco, int TheValue)
* @param TheOrigAcqp
* @param TheOrigReco
}
/**
-@brief ImageType returns the type of image : values real for amplitude, real imaginary or phase images and complex for complex images
+ * @brief ImageType returns the type of image : values real for amplitude, real imaginary or phase images and complex for complex images
* @fn bool BrukerImage::setImageType(BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco, int TheValue)
* @param TheOrigAcqp
* @param TheOrigReco
return ((std::string)"real");
}
-
/**
-@brief DataEndianness gives information on how to swap or no the binary data to read
+ * @brief DataEndianness gives information on how to swap or no the binary data to read
* @fn bool BrukerImage::setDataEndianness(BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco, int TheValue)
* @param TheOrigAcqp
* @param TheOrigReco
return true;
}
- /**
- @brief DataEndianness gives information on how to swap or no the binary data to read
- @fn std::string BrukerImage::getDataEndianness() const
- @return DataEndianness
- */
+/**
+ * @brief DataEndianness gives information on how to swap or no the binary data to read
+ * @fn std::string BrukerImage::getDataEndianness() const
+ * @return DataEndianness
+ */
const std::string &BrukerImage::getDataEndianness() const
{
return DataEndianness;
}
/**
-@brief Information on the image size in byte, useful for offsets calculation
+ * @brief Information on the image size in byte, useful for offsets calculation
* @fn bool BrukerImage::setImageByteSize(BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco, int TheValue)
* @param TheOrigAcqp
* @param TheOrigReco
return true;
}
- /**
- @brief Information on the image size in byte, useful for offsets calculation
- @fn size_t BrukerImage::getImageByteSize() const
- @return ImageByteSize
- */
+/**
+ * @brief Information on the image size in byte, useful for offsets calculation
+ * @fn size_t BrukerImage::getImageByteSize() const
+ * @return ImageByteSize
+ */
size_t BrukerImage::getImageByteSize() const
{
return ImageByteSize;
}
-
/**
- @brief BeginingOfImageInBytes is the offset of the image number TheValue to the begining of 2dseq file
- @fn size_t BrukerImage::getBeginingOfImageInBytes() const
- @return BeginingOfImageInBytes
-*/
-
-
+ * @brief BeginingOfImageInBytes is the offset of the image number TheValue to the begining of 2dseq file
+ * @fn size_t BrukerImage::getBeginingOfImageInBytes() const
+ * @return BeginingOfImageInBytes
+ */
size_t BrukerImage::getBeginingOfImageInBytes() const
{
return BeginingOfImageInBytes;
}
-
/**
-@brief BeginingOfImageInBytes is the offset of the image number TheValue to the begining of 2dseq file
+ * @brief BeginingOfImageInBytes is the offset of the image number TheValue to the begining of 2dseq file
* @fn bool BrukerImage::setBeginingOfImageInBytes(BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco, int TheValue)
* @param TheOrigAcqp
* @param TheOrigReco
bool BrukerImage::setBeginingOfImageInBytes (BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco, int TheValue)
{
BeginingOfImageInBytes = TheValue*getImageByteSize();
-
- return true;
+ return true;
}
git://git.creatis.insa-lyon.fr / creaBruker.git / commitdiff