From: jean-pierre roux Date: Tue, 12 Jan 2010 15:34:00 +0000 (+0000) Subject: indent X-Git-Tag: CREATOOLS.2-0-3~26 X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?p=creaBruker.git;a=commitdiff_plain;h=ce65a86c9c44ed14ee9c8207fafa7d1958253589 indent --- diff --git a/lib/src1/brukerimage.cpp b/lib/src1/brukerimage.cpp index 7957475..cd1789a 100644 --- a/lib/src1/brukerimage.cpp +++ b/lib/src1/brukerimage.cpp @@ -12,10 +12,11 @@ /** @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 @@ -78,7 +79,7 @@ int BrukerImage::getAbsoluteTimePosition() const } /** -* @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 @@ -91,7 +92,6 @@ bool BrukerImage::setAbsoluteTimePosition (BrukerDataSet &TheOrigAcqp, BrukerDat 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) @@ -107,7 +107,7 @@ double BrukerImage::getRelativeTimePosition() const * @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 @@ -120,10 +120,9 @@ bool BrukerImage::setRelativeTimePosition (BrukerDataSet &TheOrigAcqp, BrukerDat 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 @@ -145,7 +144,6 @@ const std::vector &BrukerImage::getFOVpixels() const return FOVpixels; } - /** * @brief FOVcm is also picked in reco headermap * @fn bool BrukerImage::setFOVcm(BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco, int TheValue) @@ -195,7 +193,7 @@ double BrukerImage::getSliceThickness() const } /** -* @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 @@ -218,9 +216,8 @@ double BrukerImage::getTE() const 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 @@ -244,7 +241,7 @@ double BrukerImage::getTR() const } /** -* @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 @@ -268,7 +265,7 @@ double BrukerImage::getTI() const } /** -* @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 @@ -319,7 +316,6 @@ const std::vector &BrukerImage::getLoopStamp() const return LoopStamp; } - /** * @brief NA number of accumulation is useful to track image quality * @fn bool BrukerImage::setNA(BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco, int TheValue) @@ -346,7 +342,7 @@ int BrukerImage::getNA() const } /** -@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 @@ -360,7 +356,7 @@ bool BrukerImage::setNAE(BrukerDataSet &TheOrigAcqp, BrukerDataSet &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 */ @@ -371,7 +367,7 @@ int BrukerImage::getNAE() const } /** -@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 @@ -396,7 +392,7 @@ int BrukerImage::getDS() const } /** -@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 @@ -410,10 +406,10 @@ bool BrukerImage::setACQ_phase_factor(BrukerDataSet &TheOrigAcqp, BrukerDataSet } /** - @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; @@ -421,8 +417,8 @@ int BrukerImage::getACQ_phase_factor() const /** -@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 @@ -436,20 +432,18 @@ bool BrukerImage::setNR(BrukerDataSet &TheOrigAcqp, BrukerDataSet &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 @@ -472,10 +466,8 @@ const std::vector > &BrukerImage::getRotationMatrixRPS2XYZ() 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 @@ -502,7 +494,7 @@ const std::vector &BrukerImage::getTranslationVectorRPS2XYZ() const } /** -@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 @@ -530,7 +522,7 @@ std::string BrukerImage::getWordType() const } /** -@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 @@ -554,9 +546,8 @@ std::string BrukerImage::getImageType() const 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 @@ -569,18 +560,18 @@ bool BrukerImage::setDataEndianness(BrukerDataSet &TheOrigAcqp, BrukerDataSet &T 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 @@ -603,32 +594,28 @@ bool BrukerImage::setImageByteSize(BrukerDataSet &TheOrigAcqp, BrukerDataSet &Th 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 @@ -638,6 +625,5 @@ size_t BrukerImage::getBeginingOfImageInBytes() const bool BrukerImage::setBeginingOfImageInBytes (BrukerDataSet &TheOrigAcqp, BrukerDataSet &TheOrigReco, int TheValue) { BeginingOfImageInBytes = TheValue*getImageByteSize(); - - return true; + return true; }