1 /*=========================================================================
4 Module: $RCSfile: gdcmDataEntry.cxx,v $
6 Date: $Date: 2006/07/04 09:36:18 $
7 Version: $Revision: 1.40 $
9 Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
10 l'Image). All rights reserved. See Doc/License.txt or
11 http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
13 This software is distributed WITHOUT ANY WARRANTY; without even
14 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 PURPOSE. See the above copyright notices for more information.
17 =========================================================================*/
19 #include "gdcmDataEntry.h"
22 #include "gdcmGlobal.h"
24 #include "gdcmDebug.h"
28 #if defined(__BORLANDC__)
29 #include <mem.h> // for memcpy
30 #include <stdlib.h> // for atof
31 #include <ctype.h> // for isdigit
36 //-----------------------------------------------------------------------------
37 #define MAX_SIZE_PRINT_ELEMENT_VALUE 0x7fffffff
38 uint32_t DataEntry::MaxSizePrintEntry = MAX_SIZE_PRINT_ELEMENT_VALUE;
40 //-----------------------------------------------------------------------------
41 // Constructor / Destructor
43 * \brief Constructor for a given DataEntry
44 * @param group group number of the Data Entry to be created
45 * @param elem element number of the Data Entry to be created
46 * @param vr Value Representation of the Data Entry to be created
48 DataEntry::DataEntry(uint16_t group,uint16_t elem,
50 : DocEntry(group,elem,vr)
60 * \brief Constructor for a given DocEntry
61 * @param e Pointer to existing Doc entry
63 DataEntry::DataEntry(DocEntry *e)
64 //: DocEntry(e->GetDictEntry())
65 : DocEntry(e->GetGroup(),e->GetElement(), e->GetVR() )
75 * \brief Canonical destructor.
77 DataEntry::~DataEntry ()
82 //-----------------------------------------------------------------------------
85 //-----------------------------------------------------------------------------
88 * \brief Sets the value (non string) of the current DataEntry
92 void DataEntry::SetBinArea( uint8_t *area, bool self )
102 * \brief Inserts the value (non string) into the current DataEntry
104 * @param length length
106 void DataEntry::CopyBinArea( uint8_t *area, uint32_t length )
110 uint32_t lgh = length + length%2;
113 if( area && length > 0 )
116 memcpy(BinArea,area,length);
120 State = STATE_LOADED;
125 * \brief Inserts the elementary (non string) value into the current DataEntry
126 * @param id index of the elementary value to be set
127 * @param val value, passed as a double
129 void DataEntry::SetValue(const uint32_t &id, const double &val)
133 State = STATE_LOADED;
135 if( id > GetValueCount() )
137 gdcmErrorMacro("Index (" << id << ")is greater than the data size");
141 const VRKey &vr = GetVR();
142 if( vr == "US" || vr == "SS" )
144 uint16_t *data = (uint16_t *)BinArea;
145 data[id] = (uint16_t)val;
147 else if( vr == "UL" || vr == "SL" )
149 uint32_t *data = (uint32_t *)BinArea;
150 data[id] = (uint32_t)val;
152 else if( vr == "FL" )
154 float *data = (float *)BinArea;
155 data[id] = (float)val;
157 else if( vr == "FD" )
159 double *data = (double *)BinArea;
160 data[id] = (double)val;
162 else if( Global::GetVR()->IsVROfStringRepresentable(vr) )
164 gdcmErrorMacro("SetValue on String representable not implemented yet");
168 BinArea[id] = (uint8_t)val;
172 * \brief returns, as a double (?!?) one of the values
173 * (when entry is multivaluated), identified by its index.
174 * Returns 0.0 if index is wrong
177 double DataEntry::GetValue(const uint32_t &id) const
181 if (GetLength() != 0) // avoid stupid messages
182 /// \todo warn the user there was a problem !
183 gdcmErrorMacro("BinArea not set " << std::hex
184 << GetGroup() << " " << GetElement()
185 << " Can't get the value");
189 uint32_t count = GetValueCount();
192 gdcmErrorMacro("Index (" << id << ") is greater than the data size");
196 /// \todo FIX the API : user *knows* that entry contains a US
197 /// and he receives a double ?!?
199 const VRKey &vr = GetVR();
200 /// \todo FIX the API : user *knows* that entry contains a US,
201 /// the method is supposed to return a double
202 /// but sends a US ?!?
203 if( vr == "US" || vr == "SS" )
204 return ((uint16_t *)BinArea)[id];
205 else if( vr == "UL" || vr == "SL" )
206 return ((uint32_t *)BinArea)[id];
207 else if( vr == "FL" )
208 return ((float *)BinArea)[id];
209 else if( vr == "FD" )
210 return ((double *)BinArea)[id];
211 else if( Global::GetVR()->IsVROfStringRepresentable(vr) )
213 // this is for VR = "DS", ...
216 // Don't use std::string to accelerate processing
218 char *tmp = new char[GetLength()+1];
219 memcpy(tmp,BinArea,GetLength());
230 for(uint32_t i=0;i<GetLength();i++)
260 * \brief Checks if the multiplicity of the value follows Dictionary VM
262 bool DataEntry::IsValueCountValid() /*const*/
265 const std::string &strVM = GetVM();
266 uint32_t vc = GetValueCount();
267 bool valid = vc == 0;
271 // FIXME : what shall we do with VM = "2-n", "3-n", etc
275 // make sure there is at least one ??? FIXME
280 std::istringstream os;
284 // vm respects the one from the dict
285 // vm is 0 (we need to check if this element is allowed to be empty) FIXME
289 // Entries whose type is 1 are mandatory, with a mandatory value.
290 // Entries whose type is 1c are mandatory-inside-a-Sequence,
291 // with a mandatory value.
292 // Entries whose type is 2 are mandatory, with an optional value.
293 // Entries whose type is 2c are mandatory-inside-a-Sequence,
294 // with an optional value.
295 // Entries whose type is 3 are optional.
297 // case vc == 0 is only applicable for 'type 2' entries.
298 // Problem : entry type may depend on the modality and/or the Sequence
299 // it's embedded in !
300 // (Get the information in the 'Conformance Statements' ...)
307 * \brief returns the number of elementary values
309 uint32_t DataEntry::GetValueCount( ) const
311 const VRKey &vr = GetVR();
312 if( vr == "US" || vr == "SS" )
313 return GetLength()/sizeof(uint16_t);
314 else if( vr == "UL" || vr == "SL" )
315 return GetLength()/sizeof(uint32_t);
316 else if( vr == "FL" || vr == "OF" )
317 return GetLength()/4 ; // FL has a *4* length! sizeof(float);
318 else if( vr == "FD" )
319 return GetLength()/8; // FD has a *8* length! sizeof(double);
320 else if( Global::GetVR()->IsVROfStringRepresentable(vr) )
322 // Some element in DICOM are allowed to be empty
325 // Don't use std::string to accelerate processing
327 for(uint32_t i=0;i<GetLength();i++)
329 if( BinArea[i] == '\\')
338 * \brief Gets a std::vector <double> holding the value(s) of a DS DataEntry
339 * @param valueVector std::vector double of value(s)
340 * \return false if VR not "DS" or DataEntry empty
342 bool DataEntry::GetDSValue(std::vector <double> &valueVector)
344 /// \todo rewrite the whole method, in order *not to use* std::string !
345 std::vector<std::string> tokens;
347 if (GetVR() != "DS") // never trust a user !
350 Util::Tokenize ( GetString().c_str(), tokens, "\\" );
352 int nbValues= tokens.size();
356 for (int loop=0; loop<nbValues; loop++)
357 valueVector.push_back(atof(tokens[loop].c_str()));
363 * \brief Sets the 'value' of a DataEntry, passed as a std::string
364 * @param value string representation of the value to be set
366 void DataEntry::SetString(std::string const &value)
369 const VRKey &vr = GetVR();
370 if ( vr == "US" || vr == "SS" )
372 std::vector<std::string> tokens;
373 Util::Tokenize (value, tokens, "\\");
374 SetLength(tokens.size()*sizeof(uint16_t));
377 uint16_t *data = (uint16_t *)BinArea;
378 for (unsigned int i=0; i<tokens.size();i++)
379 data[i] = atoi(tokens[i].c_str());
382 else if ( vr == "UL" || vr == "SL" )
384 std::vector<std::string> tokens;
385 Util::Tokenize (value, tokens, "\\");
386 SetLength(tokens.size()*sizeof(uint32_t));
389 uint32_t *data = (uint32_t *)BinArea;
390 for (unsigned int i=0; i<tokens.size();i++)
391 data[i] = atoi(tokens[i].c_str());
394 else if ( vr == "FL" )
396 std::vector<std::string> tokens;
397 Util::Tokenize (value, tokens, "\\");
398 SetLength(tokens.size()*sizeof(float));
401 float *data = (float *)BinArea;
402 for (unsigned int i=0; i<tokens.size();i++)
403 data[i] = (float)atof(tokens[i].c_str());
406 else if ( vr == "FD" )
408 std::vector<std::string> tokens;
409 Util::Tokenize (value, tokens, "\\");
410 SetLength(tokens.size()*sizeof(double));
413 double *data = (double *)BinArea;
414 for (unsigned int i=0; i<tokens.size();i++)
415 data[i] = atof(tokens[i].c_str());
420 size_t l = value.size();
423 memcpy(BinArea, value.c_str(), l);
424 if (l%2) // padded with blank except for UI
430 State = STATE_LOADED;
433 * \brief returns as a string (when possible) the value of the DataEntry
435 std::string const &DataEntry::GetString() const
437 static std::ostringstream s;
438 const VRKey &vr = GetVR();
444 // When short integer(s) are stored, convert the following (n * 2) characters
445 // as a displayable string, the values being separated by a back-slash
448 uint16_t *data=(uint16_t *)BinArea;
449 for (unsigned int i=0; i < GetValueCount(); i++)
457 else if (vr == "SS" )
459 int16_t *data=(int16_t *)BinArea;
460 for (unsigned int i=0; i < GetValueCount(); i++)
467 } // See above comment on multiple short integers (mutatis mutandis).
468 else if( vr == "UL" )
470 uint32_t *data=(uint32_t *)BinArea;
471 for (unsigned int i=0; i < GetValueCount(); i++)
479 else if( vr == "SL" )
481 int32_t *data=(int32_t *)BinArea;
482 for (unsigned int i=0; i < GetValueCount(); i++)
489 } else if( vr == "FL" )
491 float *data=(float *)BinArea;
492 for (unsigned int i=0; i < GetValueCount(); i++)
500 else if( vr == "FD" )
502 double *data=(double *)BinArea;
503 for (unsigned int i=0; i < GetValueCount(); i++)
513 StrArea.append((const char *)BinArea,GetLength());
514 // to avoid gdcm to propagate oddities in lengthes
516 StrArea.append(" ",1); }
522 * \brief Copies all the attributes from an other DocEntry
523 * @param doc entry to copy from
524 * @remarks The content BinArea is copied too
526 void DataEntry::Copy(DocEntry *doc)
530 DataEntry *entry = dynamic_cast<DataEntry *>(doc);
533 State = entry->State;
535 CopyBinArea(entry->BinArea,entry->GetLength());
540 * \brief Writes the 'value' area of a DataEntry
541 * @param fp already open ofstream pointer
542 * @param filetype type of the file (ACR, ImplicitVR, ExplicitVR, ...)
544 void DataEntry::WriteContent(std::ofstream *fp, FileType filetype)
546 DocEntry::WriteContent(fp, filetype);
548 if ( GetGroup() == 0xfffe )
550 return; //delimitors have NO value
553 // --> We only deal with Little Endian writting.
554 // --> forget Big Endian Transfer Syntax writting!
555 // Next DICOM version will give it up ...
557 // WARNING - For Implicit VR private element,
558 // we have *no choice* but considering them as
559 // something like 'OB' values.
560 // we rewrite them as we found them on disc.
561 // Some trouble will occur if element was
562 // *actually* OW, if image was produced
563 // on Big endian based processor, read and writen
564 // on Little endian based processor
565 // and, later on, somebody needs
566 // this 'OW' Implicit VR private element (?!?)
567 // (Same stuff, mutatis mutandis, for Little/Big)
569 // 8/16 bits Pixels problem should be solved automatiquely,
570 // since we ensure the VR (OB vs OW) is conform to Pixel size.
572 uint8_t *data = BinArea; //safe notation
573 size_t l = GetLength();
574 // gdcmDebugMacro("in DataEntry::WriteContent " << GetKey() << " AtomicLength: "
575 // << Global::GetVR()->GetAtomicElementLength(this->GetVR() ) // << " BinArea in :" << &BinArea
577 if (BinArea) // the binArea was *actually* loaded
579 #if defined(GDCM_WORDS_BIGENDIAN) || defined(GDCM_FORCE_BIGENDIAN_EMULATION)
580 unsigned short vrLgth =
581 Global::GetVR()->GetAtomicElementLength(this->GetVR());
587 binary_write (*fp, data, l );
592 uint16_t *data16 = (uint16_t *)data;
593 for(i=0;i<l/vrLgth;i++)
594 binary_write( *fp, data16[i]);
599 uint32_t *data32 = (uint32_t *)data;
600 for(i=0;i<l/vrLgth;i++)
601 binary_write( *fp, data32[i]);
606 double *data64 = (double *)data;
607 for(i=0;i<l/vrLgth;i++)
608 binary_write( *fp, data64[i]);
613 binary_write (*fp, data, l );
614 #endif //GDCM_WORDS_BIGENDIAN
619 // nothing was loaded, but we need to skip space on disc
622 // --> WARNING : nothing is written;
623 // --> the initial data (on the the source image) is lost
624 // --> user is *not* informed !
625 gdcmDebugMacro ("Nothing was loaded, but we need to skip space on disc. "
626 << "Length =" << l << " for " << GetKey() );
627 fp->seekp(l, std::ios::cur); // At Write time, for unloaded elems
630 // to avoid gdcm to propagate oddities
631 // (length was already modified)
633 fp->seekp(1, std::ios::cur); // At Write time, for non even length elems
637 * \brief Compute the full length of the elementary DataEntry (not only value
638 * length) depending on the VR.
640 uint32_t DataEntry::ComputeFullLength()
642 return GetFullLength();
645 //-----------------------------------------------------------------------------
647 /// \brief Creates a DataEntry owned BinArea (remove previous one if any)
648 void DataEntry::NewBinArea( )
651 if( GetLength() > 0 )
652 BinArea = new uint8_t[GetLength()];
655 /// \brief Removes the BinArea, if owned by the DataEntry
656 void DataEntry::DeleteBinArea(void)
658 if (BinArea && SelfArea)
665 //-----------------------------------------------------------------------------
668 //-----------------------------------------------------------------------------
671 * \brief Prints a DataEntry (Dicom entry)
672 * @param os ostream we want to print in
673 * @param indent Indentation string to be prepended during printing
675 void DataEntry::Print(std::ostream &os, std::string const & )
680 uint16_t g = GetGroup();
681 if (g == 0xfffe) // delimiters have NO value
683 return; // just to avoid identing all the remaining code
686 std::ostringstream s;
692 const VRKey &vr = GetVR();
694 if( vr == "US" || vr == "SS" || vr == "UL" || vr == "SL"
695 || vr == "FL" || vr == "FD")
696 s << " [" << GetString() << "]";
699 if(Global::GetVR()->IsVROfStringRepresentable(vr))
701 // replace non printable characters by '.'
702 std::string cleanString = Util::CreateCleanString(v);
703 if ( cleanString.length() <= GetMaxSizePrintEntry()
706 // FIXME : when IsNotLoaded(), you create a Clean String ?!?
707 // FIXME : PrintLevel<2 *does* print the values
708 // (3 is only for extra offsets printing)
709 // What do you wanted to do ? JPR
711 s << " [" << cleanString << "]";
715 s << " [gdcm::too long for print (" << cleanString.length() << ") ]";
720 // A lot of Private elements (with no VR) contain actually
721 // only printable characters;
722 // Let's deal with them as is they were VR std::string representable
724 if ( Util::IsCleanArea( GetBinArea(), GetLength() ) )
726 // FIXME : since the 'Area' *is* clean, just use
727 // a 'CreateString' method, to save CPU time.
728 std::string cleanString =
729 Util::CreateCleanString( BinArea,GetLength() );
730 s << " [" << cleanString << "]";
734 s << " [" << GDCM_BINLOADED << ";"
735 << "length = " << GetLength() << "]";
743 s << " [" << GDCM_NOTLOADED << "]";
744 else if( IsUnfound() )
745 s << " [" << GDCM_UNFOUND << "]";
746 else if( IsUnread() )
747 s << " [" << GDCM_UNREAD << "]";
748 else if ( GetLength() == 0 )
753 s << " (" << GDCM_PIXELDATA << ")";
755 // Display the UID value (instead of displaying only the rough code)
756 // First 'clean' trailing character (space or zero)
759 const uint16_t &gr = GetGroup();
760 const uint16_t &elt = GetElement();
761 TS *ts = Global::GetTS();
765 // Any more to be displayed ?
766 if ( elt == 0x0010 || elt == 0x0002 )
768 if ( v.length() != 0 ) // for brain damaged headers
770 if ( ! isdigit((unsigned char)v[v.length()-1]) )
772 v.erase(v.length()-1, 1);
775 s << " ==>\t[" << ts->GetValue(v) << "]";
778 else if (gr == 0x0008)
780 if ( elt == 0x0016 || elt == 0x1150 )
782 if ( v.length() != 0 ) // for brain damaged headers
784 if ( ! isdigit((unsigned char)v[v.length()-1]) )
786 v.erase(v.length()-1, 1);
789 s << " ==>\t[" << ts->GetValue(v) << "]";
792 else if (gr == 0x0004)
794 if ( elt == 0x1510 || elt == 0x1512 )
796 if ( v.length() != 0 ) // for brain damaged headers
798 if ( ! isdigit((unsigned char)v[v.length()-1]) )
800 v.erase(v.length()-1, 1);
803 s << " ==>\t[" << ts->GetValue(v) << "]";
811 //-----------------------------------------------------------------------------
812 } // end namespace gdcm