Program: gdcm
Module: $RCSfile: gdcmDicomDir.h,v $
Language: C++
- Date: $Date: 2007/08/22 16:14:03 $
- Version: $Revision: 1.81 $
+ Date: $Date: 2007/09/17 12:16:02 $
+ Version: $Revision: 1.82 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
void SetDirectoryName(std::string const &dirName)
{ ParseDir = true; if (Filename != dirName)
Filename = dirName, IsDocumentModified = true;}
- /// Accessor to \ref Filename
+ /// Accessor to Filename
virtual void SetFileName(std::string const &fileName)
{ ParseDir = false; if (Filename != fileName)
Filename = fileName, IsDocumentModified = true;}
Program: gdcm
Module: $RCSfile: gdcmDictEntry.h,v $
Language: C++
- Date: $Date: 2007/08/22 16:14:04 $
- Version: $Revision: 1.46 $
+ Date: $Date: 2007/09/17 12:16:02 $
+ Version: $Revision: 1.47 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
~DictEntry();
private:
- /// Dicom \ref TagKey. Contains Dicom Group number and Dicom Element number
+ /// Dicom TagKey. Contains Dicom Group number and Dicom Element number
TagKey Tag;
/// \brief Value Representation i.e. some clue about the nature
/// of the data represented e.g.
- /// - "FD" short for "Floating Point Double"(see \ref VR)
+ /// - "FD" short for "Floating Point Double"(see VR)
/// - "PN" short for "Person Name"
VRKey VR;
Program: gdcm
Module: $RCSfile: gdcmDocEntry.h,v $
Language: C++
- Date: $Date: 2007/08/29 15:30:49 $
- Version: $Revision: 1.70 $
+ Date: $Date: 2007/09/17 12:16:02 $
+ Version: $Revision: 1.71 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
/// \brief Value Representation (to avoid accessing Dicom Dict every time!)
VRKey VR; // JPRx
- /// \brief Dicom \ref TagKey. Contains Dicom Group number and Dicom Element number
+ /// \brief Dicom TagKey. Contains Dicom Group number and Dicom Element number
/// (to avoid accessing Dicom Dict every time !) // JPRx
TagKey Key; // JPRx
private:
Program: gdcm
Module: $RCSfile: gdcmDocEntrySet.cxx,v $
Language: C++
- Date: $Date: 2007/07/27 21:21:48 $
- Version: $Revision: 1.75 $
+ Date: $Date: 2007/09/17 12:16:02 $
+ Version: $Revision: 1.76 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
}
/**
- * \brief Same as \ref Document::GetDocEntry except it returns a result
+ * \brief Same as DocEntrySet::GetDocEntry except it returns a result
* only when the corresponding entry is of type DataEntry.
* @param group Group number of the searched Dicom Element
* @param elem Element number of the searched Dicom Element
}
/**
- * \brief Same as \ref Document::GetDocEntry except it returns a result
+ * \brief Same as DocEntrySet::GetDocEntry except it returns a result
* only when the corresponding entry is of type SeqEntry.
* @param group Group number of the searched Dicom Element
* @param elem Element number of the searched Dicom Element
Program: gdcm
Module: $RCSfile: gdcmDocEntrySet.h,v $
Language: C++
- Date: $Date: 2007/08/29 15:30:49 $
- Version: $Revision: 1.72 $
+ Date: $Date: 2007/09/17 12:16:02 $
+ Version: $Revision: 1.73 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
//-----------------------------------------------------------------------------
/**
* \brief
- * \ref DocEntrySet is an abstract base class for \ref ElementSet, \ref SQItem
+ * DocEntrySet is an abstract base class for ElementSet, SQItem
* which are both containers for DocEntries.
- * - \ref ElementSet is based on the STL map<> container
- * (see \ref ElementSet::TagHT)
- * - \ref SQItem is based on an STL list container (see \ref ListDocEntry).
+ * - ElementSet is based on the STL map<> container
+ * (see ElementSet::TagHT)
+ * - SQItem is based on an STL list container (see ListDocEntry).
*
* Since the syntax for adding a new element to a map<> or a list<>
- * differ, \ref DocEntrySet is designed as an adapter to unify the
- * interfaces of \ref DocEntrySet and \ref ElementSet.
+ * differ, DocEntrySet is designed as an adapter to unify the
+ * interfaces of DocEntrySet and ElementSet.
*
* As an illustration of this design, please refer to the implementation
- * of \ref AddEntry (or any pure virtual method) in both derived classes.
+ * of AddEntry (or any pure virtual method) in both derived classes.
* This adapter unification of interfaces enables the parsing of a
* DICOM header containing (optionaly heavily nested) sequences to be
- * written recursively [see \ref Document::ParseDES
- * which calls \ref Document::ParseSQ, which in turn calls
- * \ref Document::ParseDES ].
+ * written recursively [see Document::ParseDES
+ * which calls Document::ParseSQ, which in turn calls
+ * Document::ParseDES ].
*
* \note Developpers should strongly resist to the temptation of adding
* members to this class since this class is designed as an adapter
Program: gdcm
Module: $RCSfile: gdcmDocument.cxx,v $
Language: C++
- Date: $Date: 2007/08/29 15:30:49 $
- Version: $Revision: 1.368 $
+ Date: $Date: 2007/09/17 12:16:02 $
+ Version: $Revision: 1.369 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
/**
* \brief This default constructor neither loads nor parses the file.
- * You should then invoke \ref Document::Load.
+ * You should then invoke Document::Load.
*
*/
Document::Document()
//
// -----------------File I/O ---------------
/**
- * \brief Tries to open the file \ref Document::Filename and
+ * \brief Tries to open the file Document::Filename and
* checks the preamble when existing,
* or if the file starts with an ACR-NEMA look-like element.
* @return The FILE pointer on success, 0 on failure.
//}
/**
- * \brief Compares two documents, according to \ref DicomDir rules
+ * \brief Compares two documents, according to DicomDir rules
* \warning Does NOT work with ACR-NEMA files
* \todo Find a trick to solve the pb (use RET fields ?)
* @param document to compare with current one
Program: gdcm
Module: $RCSfile: gdcmDocument.h,v $
Language: C++
- Date: $Date: 2007/08/22 16:14:04 $
- Version: $Revision: 1.146 $
+ Date: $Date: 2007/09/17 12:16:02 $
+ Version: $Revision: 1.147 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
std::string GetTransferSyntaxName();
// Swap code
- /// 'Swap code' accessor (see \ref SwapCode )
+ /// 'Swap code' accessor (see SwapCode )
int GetSwapCode() { return SwapCode; }
// File I/O
- /// Accessor to \ref Filename
+ /// Accessor to Filename
const std::string &GetFileName() const { return Filename; }
- /// Accessor to \ref Filename
+ /// Accessor to Filename
virtual void SetFileName(std::string const &fileName)
{ if (Filename != fileName)
Filename = fileName, IsDocumentModified = true; }
Program: gdcm
Module: $RCSfile: gdcmElementSet.h,v $
Language: C++
- Date: $Date: 2007/08/29 15:30:49 $
- Version: $Revision: 1.58 $
+ Date: $Date: 2007/09/17 12:16:02 $
+ Version: $Revision: 1.59 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
//-----------------------------------------------------------------------------
/**
* \brief
- * \ref ElementSet is based on the STL map<> container
- * (see \ref ElementSet::TagHT), as opposed to \ref SQItem
- * which is based on an STL list container (see \ref ListDocEntry).
+ * ElementSet is based on the STL map<> container
+ * (see ElementSet::TagHT), as opposed to SQItem
+ * which is based on an STL list container (see ListDocEntry).
* It contains the 'zero-level- DocEntry (out of any Dicom Sequence)
*/
class GDCM_EXPORT ElementSet : public DocEntrySet
Program: gdcm
Module: $RCSfile: gdcmFile.cxx,v $
Language: C++
- Date: $Date: 2007/08/27 16:14:47 $
- Version: $Revision: 1.336 $
+ Date: $Date: 2007/09/17 12:16:02 $
+ Version: $Revision: 1.337 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
// Private
/**
* \brief Parse pixel data from disk of [multi-]fragment RLE encoding.
- * Compute the RLE extra information and store it in \ref RLEInfo
+ * Compute the RLE extra information and store it in RLEInfo
* for later pixel retrieval usage.
*/
void File::ComputeRLEInfo()
/**
* \brief Parse pixel data from disk of [multi-]fragment Jpeg encoding.
* Compute the jpeg extra information (fragment[s] offset[s] and
- * length) and store it[them] in \ref JPEGInfo for later pixel
+ * length) and store it[them] in JPEGInfo for later pixel
* retrieval usage.
*/
void File::ComputeJPEGFragmentInfo()
}
/**
- * \brief Assuming the internal file pointer \ref Document::Fp
+ * \brief Assuming the internal file pointer Document::Fp
* is placed at the beginning of a tag, check whether this
* tag is (TestGroup, TestElem).
- * \warning On success the internal file pointer \ref Document::Fp
+ * \warning On success the internal file pointer Document::Fp
* is modified to point after the tag.
* On failure (i.e. when the tag wasn't the expected tag
* (TestGroup, TestElem) the internal file pointer
- * \ref Document::Fp is restored to its original position.
+ * Document::Fp is restored to its original position.
* @param testGroup The expected group of the tag.
* @param testElem The expected Element of the tag.
* @return True on success, false otherwise.
}
/**
- * \brief Assuming the internal file pointer \ref Document::Fp
+ * \brief Assuming the internal file pointer Document::Fp
* is placed at the beginning of a tag (TestGroup, TestElement),
* read the length associated to the Tag.
- * \warning On success the internal file pointer \ref Document::Fp
+ * \warning On success the internal file pointer Document::Fp
* is modified to point after the tag and its length.
* On failure (i.e. when the tag wasn't the expected tag
* (TestGroup, TestElement) the internal file pointer
- * \ref Document::Fp is restored to its original position.
+ * Document::Fp is restored to its original position.
* @param testGroup The expected Group of the tag.
* @param testElem The expected Element of the tag.
* @return On success returns the length associated to the tag. On failure
Program: gdcm
Module: $RCSfile: gdcmFile.h,v $
Language: C++
- Date: $Date: 2007/08/22 16:14:04 $
- Version: $Revision: 1.133 $
+ Date: $Date: 2007/09/17 12:16:02 $
+ Version: $Revision: 1.134 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
int GetNumberOfScalarComponents();
int GetNumberOfScalarComponentsRaw();
- /// Accessor to \ref File::GrPixel
+ /// Accessor to File::GrPixel
uint16_t GetGrPixel() { return GrPixel; }
- /// Accessor to \ref File::NumPixel
+ /// Accessor to File::NumPixel
uint16_t GetNumPixel() { return NumPixel; }
size_t GetPixelOffset();
Module: $RCSfile: gdcmFileHelper.cxx,v $
Language: C++
- Date: $Date: 2007/09/14 12:57:02 $
- Version: $Revision: 1.128 $
+ Date: $Date: 2007/09/17 12:16:02 $
+ Version: $Revision: 1.129 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
}
/**
- * \brief Access to the underlying \ref PixelReadConverter RGBA LUT
+ * \brief Access to the underlying PixelReadConverter RGBA LUT
*/
uint8_t* FileHelper::GetLutRGBA()
{
}
/**
- * \brief Access to the underlying \ref PixelReadConverter RGBA LUT Item Number
+ * \brief Access to the underlying PixelReadConverter RGBA LUT Item Number
*/
int FileHelper::GetLutItemNumber()
{
}
/**
- * \brief Access to the underlying \ref PixelReadConverter RGBA LUT Item Size
+ * \brief Access to the underlying PixelReadConverter RGBA LUT Item Size
*/
int FileHelper::GetLutItemSize()
{
break;
case JPEG2000:
- /// \TODO Maybe we should consider doing the compression here !
+ /// \todo Maybe we should consider doing the compression here !
// PixelWriteConverter->SetCompressJPEG2000UserData(inData, expectedSize, FileInternal);
SetWriteFileTypeToJPEG2000();
--> 'Referenced SOP Instance UID' (0x0008, 0x1155)
whose value is the original 'SOP Class UID'
-3) TODO : find a trick to allow user to pass to the writter the list of the Dicom images
+3) TO DO : find a trick to allow user to pass to the writter the list of the Dicom images
or the Series, (or the Study ?) he used to created his image
(MIP, MPR, cartography image, ...)
These info should be stored (?)
Program: gdcm
Module: $RCSfile: gdcmFileHelper.h,v $
Language: C++
- Date: $Date: 2007/09/04 13:14:33 $
- Version: $Revision: 1.54 $
+ Date: $Date: 2007/09/17 12:16:01 $
+ Version: $Revision: 1.55 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
void Print(std::ostream &os = std::cout, std::string const &indent = "");
- /// Accessor to \ref File
+ /// Accessor to File
File *GetFile() { return FileInternal; }
/// \brief Tells gdcm wether we want to keep ACR-NEMA-like overlays or not.
Program: gdcm
Module: $RCSfile: gdcmJPEGFragment.h,v $
Language: C++
- Date: $Date: 2007/08/22 16:14:04 $
- Version: $Revision: 1.22 $
+ Date: $Date: 2007/09/17 12:16:01 $
+ Version: $Revision: 1.23 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
*
* Each instance of this class (they can be as many instances for
* a given Document as they are JPEG fragments and they are
- * collected in a \ref JPEGFragmentsInfo )
+ * collected in a JPEGFragmentsInfo )
*/
class GDCM_EXPORT JPEGFragment : public Base
{
Program: gdcm
Module: $RCSfile: gdcmJPEGFragmentsInfo.h,v $
Language: C++
- Date: $Date: 2007/08/22 16:14:04 $
- Version: $Revision: 1.23 $
+ Date: $Date: 2007/09/17 12:16:01 $
+ Version: $Revision: 1.24 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
{
/**
* \brief Utility class for gathering the informations of the collection
- * of JPEG fragment[s] (see \ref JPEGFragment) when handling
+ * of JPEG fragment[s] (see JPEGFragment) when handling
* "Encapsulated JPEG Compressed Images".
* The informations on each frame are obtained during the pixel parsing
- * of a gdcm::File (refer to \ref File::ComputeJPEGFragmentInfo() ).
+ * of a gdcm::File (refer to File::ComputeJPEGFragmentInfo() ).
* They shall be used when (if necessary) decoding the fragments.
*
- * This class is simply a stl list<> of \ref JPEGFragment.
+ * This class is simply a stl list<> of JPEGFragment.
*/
class GDCM_EXPORT JPEGFragmentsInfo
{
Program: gdcm
Module: $RCSfile: gdcmRLEFrame.h,v $
Language: C++
- Date: $Date: 2007/08/22 16:14:04 $
- Version: $Revision: 1.22 $
+ Date: $Date: 2007/09/17 12:16:01 $
+ Version: $Revision: 1.23 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
*
* Each instance of this class (they can be as many instances for
* a given Document as they are frames and they are collected in
- * a \ref RLEFramesInfo ) describes :
+ * a RLEFramesInfo ) describes :
* - the total number of segments (up to 15),
* - the offsets of each segment of the frame,
* - the (corresponding) lengths of each segment of the frame.
Program: gdcm
Module: $RCSfile: gdcmRLEFramesInfo.h,v $
Language: C++
- Date: $Date: 2007/08/22 16:14:04 $
- Version: $Revision: 1.24 $
+ Date: $Date: 2007/09/17 12:16:01 $
+ Version: $Revision: 1.25 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
{
/**
* \brief Utility class for gathering the informations of the collection
- * of RLE frame[s] (see \ref RLEFrame) when handling
+ * of RLE frame[s] (see RLEFrame) when handling
* "Encapsulated RLE Compressed Images" (see PS 3.5-2003 annex G).
* Note: a classical image can be considered as the degenerated case
* of a multiframe image. In this case the collection is limited
* to a single individual frame.
* The informations on each frame are obtained during the pixel parsing
* of a gdcm::File (refer to
- * \ref File::ComputeRLEInfo() ).
+ * File::ComputeRLEInfo() ).
* They shall be used when (if necessary) decoding the frames.
*
- * This class is simply a stl list<> of \ref RLEFrame.
+ * This class is simply a stl list<> of RLEFrame.
*/
class GDCM_EXPORT RLEFramesInfo
{
Program: gdcm
Module: $RCSfile: gdcmSQItem.h,v $
Language: C++
- Date: $Date: 2007/08/29 15:30:50 $
- Version: $Revision: 1.55 $
+ Date: $Date: 2007/09/17 12:16:01 $
+ Version: $Revision: 1.56 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
/// \brief Sets the ordinal position of a given SQItem
void SetSQItemNumber(int itemNumber) { SQItemNumber = itemNumber; }
- /// \brief Accessor on \ref SQDepthLevel.
+ /// \brief Accessor on SQDepthLevel.
int GetDepthLevel() { return SQDepthLevel; }
- /// \brief Accessor on \ref SQDepthLevel.
+ /// \brief Accessor on SQDepthLevel.
void SetDepthLevel(int depth) { SQDepthLevel = depth; }
virtual void Copy(DocEntrySet *set);
ListDocEntry::iterator ItDocEntries;
private:
- /// \brief Sequences can be nested. This \ref SQDepthLevel represents
+ /// \brief Sequences can be nested. This SQDepthLevel represents
/// the level of the nesting of instances of this class.
- /// \ref SQDepthLevel and its \ref SeqEntry::SQDepthLevel
+ /// SQDepthLevel and its SeqEntry::SQDepthLevel
/// counterpart are only defined on printing purposes
- /// (see \ref Print).
+ /// (see Print).
int SQDepthLevel;
/// \brief SQ Item ordinal number
Program: gdcm
Module: $RCSfile: gdcmSeqEntry.h,v $
Language: C++
- Date: $Date: 2007/08/29 15:30:50 $
- Version: $Revision: 1.46 $
+ Date: $Date: 2007/09/17 12:16:01 $
+ Version: $Revision: 1.47 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
/// sequence terminator item
DocEntry *SeqTerm;
- /// \brief Defines the depth level of this \ref SeqEntry inside
- /// the (optionaly) nested sequences. \ref SQDepthLevel
- /// and its \ref SQItem::SQDepthLevel counterpart
- /// are only defined on printing purposes (see \ref Print).
+ /// \brief Defines the depth level of this SeqEntry inside
+ /// the (optionaly) nested sequences. SQDepthLevel
+ /// and its SQItem::SQDepthLevel counterpart
+ /// are only defined on printing purposes (see Print).
int SQDepthLevel;
};
} // end namespace gdcm
Program: gdcm
Module: $RCSfile: gdcmVR.cxx,v $
Language: C++
- Date: $Date: 2007/09/15 11:13:37 $
- Version: $Revision: 1.59 $
+ Date: $Date: 2007/09/17 12:16:01 $
+ Version: $Revision: 1.60 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
/**
* \brief Simple predicate that checks whether the given argument
- * corresponds to the Value Representation of a \ref DataEntry .
+ * corresponds to the Value Representation of a DataEntry .
* @param tested value representation to check for.
*/
bool VR::IsVROfBinaryRepresentable(VRKey const &tested)
Program: gdcm
Module: $RCSfile: gdcmVR.h,v $
Language: C++
- Date: $Date: 2007/08/22 16:14:05 $
- Version: $Revision: 1.33 $
+ Date: $Date: 2007/09/17 12:16:01 $
+ Version: $Revision: 1.34 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
bool IsVROfStringRepresentable(VRKey const &tested);
/// \brief Simple predicate that checks whether the given argument
- /// corresponds to the Value Representation of a \ref SeqEntry
+ /// corresponds to the Value Representation of a SeqEntry
bool IsVROfSequence(VRKey const &tested) { return tested == "SQ"; }
// Remove inline optimization for VS6
projects / gdcm.git / commitdiff