o iI@sUdZddlmZmZddlmZddlmZddlm Z m Z m Z iZ e eeeeffed<eD]Zeeddd Zed d d eDd Zeefe e<q1d ededBfddZ  dFd ededededededdfddZde eeeeeeeffddfddZ dGded ededededdf ddZdede eeeeeeffddfd d!Zd e deeeeeeffd"d#Zd e defd$d%Zd e defd&d'Zd edefd(d)Z d e defd*d+Z!d e defd,d-Z"d e defd.d/Z#d e defd0d1Z$d e defd2d3Z%d4d5eDZ&e eefed6<dededBfd7d8Z'd edefd9d:Z(d;d e)DZ*dedefdd?Z,d e dedefd@dAZ-d e dedefdBdCZ.d e dedefdDdEZ/dS)Hz#Access dicom dictionary information)DicomDictionaryRepeatersDictionary) warn_and_log)private_dictionaries)TagBaseTagTagTypemasksx0cCsg|]}d|dkqS)F0r ).0crrF/mnt/sdb/aimis/docanh/lib/python3.10/site-packages/pydicom/datadict.py rtagreturnNcCs2tD]\}\}}||A|@dkr|SqdS)aReturn the repeaters tag mask for `tag`. Parameters ---------- tag : int The tag to check. Returns ------- str or None If the tag is in the repeaters dictionary then returns the corresponding masked tag, otherwise returns ``None``. rN)r items)rmask_xmask1mask2rrr mask_matchs r1VRkeyword descriptionVM is_retiredcCst||||||fidS)a#Update the DICOM dictionary with a new non-private entry. Parameters ---------- tag : int The tag number for the new dictionary entry. VR : str DICOM value representation. description : str The descriptive name used in printing the entry. Often the same as the keyword, but with spaces between words. VM : str, optional DICOM value multiplicity. If not specified, then ``'1'`` is used. is_retired : str, optional Usually leave as blank string (default). Set to ``'Retired'`` if is a retired data element. Raises ------ ValueError If the tag is a private tag. Notes ----- Does not permanently update the dictionary, but only during run-time. Will replace an existing entry if the tag already exists in the dictionary. See Also -------- pydicom.examples.add_dict_entry Example file which shows how to use this function add_dict_entries Update multiple values at once. Examples -------- >>> from pydicom import Dataset >>> add_dict_entry(0x10021001, "UL", "TestOne", "Test One") >>> add_dict_entry(0x10021002, "DS", "TestTwo", "Test Two", VM='3') >>> ds = Dataset() >>> ds.TestOne = 'test' >>> ds.TestTwo = ['1', '2', '3'] N)add_dict_entries)rrrrr r!rrradd_dict_entry-s5r#new_entries_dictcCs@tdd|Dr tdt|tdd|DdS)a?Update the DICOM dictionary with new non-private entries. Parameters ---------- new_entries_dict : dict :class:`dict` of form: ``{tag: (VR, VM, description, is_retired, keyword), ...}`` where parameters are as described in :func:`add_dict_entry`. Raises ------ ValueError If one of the entries is a private tag. See Also -------- add_dict_entry Add a single entry to the dictionary. Examples -------- >>> from pydicom import Dataset >>> new_dict_items = { ... 0x10021001: ('UL', '1', "Test One", '', 'TestOne'), ... 0x10021002: ('DS', '3', "Test Two", '', 'TestTwo'), ... } >>> add_dict_entries(new_dict_items) >>> ds = Dataset() >>> ds.TestOne = 'test' >>> ds.TestTwo = ['1', '2', '3'] cSg|]}t|jqSrr is_privaterrrrrrz$add_dict_entries..z^Private tags cannot be added using "add_dict_entries" - use "add_private_dict_entries" insteadcSsi|] \}}|d|qSr)rrvalrrr sz$add_dict_entries..N)any ValueErrorrupdate keyword_dictr)r$rrrr"es % r"private_creatorcCs|||df}t|||idS)a(Update the private DICOM dictionary with a new entry. Parameters ---------- private_creator : str The private creator for the new entry. tag : int The tag number for the new dictionary entry. Note that the 2 high bytes of the element part of the tag are ignored. VR : str DICOM value representation. description : str The descriptive name used in printing the entry. VM : str, optional DICOM value multiplicity. If not specified, then ``'1'`` is used. Raises ------ ValueError If the tag is a non-private tag. Notes ----- Behaves like :func:`add_dict_entry`, only for a private tag entry. See Also -------- add_private_dict_entries Add or update multiple entries at once. r N)add_private_dict_entries)r2rrrr new_dict_valrrradd_private_dict_entrys !r5cCsBtdd|Ds tddd|D}t|i|dS)aUpdate pydicom's private DICOM tag dictionary with new entries. Parameters ---------- private_creator: str The private creator for all entries in `new_entries_dict`. new_entries_dict : dict :class:`dict` of form ``{tag: (VR, VM, description, is_retired), ...}`` where parameters are as described in :func:`add_private_dict_entry`. Raises ------ ValueError If one of the entries is a non-private tag. See Also -------- add_private_dict_entry Function to add a single entry to the private tag dictionary. Examples -------- >>> new_dict_items = { ... 0x00410001: ('UL', '1', "Test One"), ... 0x00410002: ('DS', '3', "Test Two", '3'), ... } >>> add_private_dict_entries("ACME LTD 1.2", new_dict_items) >>> add_private_dict_entry("ACME LTD 1.3", 0x00410001, "US", "Test Three") cSr%rr&r(rrrrr)z,add_private_dict_entries..zfNon-private tags cannot be added using 'add_private_dict_entries()' - use 'add_dict_entries()' insteadcSs,i|]\}}|d?dd|d@d|qS)r 04Xxx02Xr)rrvaluerrrr-sz,add_private_dict_entries..N)allr/rr setdefaultr0)r2r$ new_entriesrrrr3s!r3cCsZt|ts t|}zt|WSty,|js$t|}|r$t|YStd|dw)a-Return an entry from the DICOM dictionary as a tuple. If the `tag` is not in the main DICOM dictionary, then the repeating group dictionary will also be checked. Parameters ---------- tag : int or str or Tuple[int, int] The tag for the element whose entry is to be retrieved, in any of the forms accepted by :func:`~pydicom.tag.Tag`. Only entries in the official DICOM dictionary will be checked, not entries in the private dictionary. Returns ------- tuple of str The (VR, VM, name, is_retired, keyword) from the DICOM dictionary. Raises ------ KeyError If the tag is not present in the DICOM data dictionary. See Also -------- get_private_entry Return an entry from the private dictionary. Tag  not found in DICOM dictionary) isinstancerrrKeyErrorr'rrrrrrr get_entrys !   rCcCsdt|dvS)a9Return ``True`` if the element corresponding to `tag` is retired. Only performs the lookup for official DICOM elements. Parameters ---------- tag : int or str or Tuple[int, int] The tag for the element whose retirement status is being checked, in any of the forms accepted by :func:`~pydicom.tag.Tag`. Returns ------- bool ``True`` if the element's retirement status is 'Retired', ``False`` otherwise. Raises ------ KeyError If the tag is not present in the DICOM data dictionary. retired)rClowerrrrrdictionary_is_retiredsrHcC t|dS)aReturn the VR of the element corresponding to `tag`. Only performs the lookup for official DICOM elements. Parameters ---------- tag : int or str or Tuple[int, int] The tag for the element whose value representation (VR) is being retrieved, in any of the forms accepted by :func:`~pydicom.tag.Tag`. Returns ------- str The VR of the corresponding element. Raises ------ KeyError If the tag is not present in the DICOM data dictionary. rrCrGrrr dictionary_VR0 rKcCs^zt|dWSty.|d?ddks$t|}|r$t|dYStdt|dw)z$Return the VR corresponding to `tag`rr r>r?)rrArrrrBrrr_dictionary_vr_fastHs rOcCrI)aReturn the VM of the element corresponding to `tag`. Only performs the lookup for official DICOM elements. Parameters ---------- tag : int or str or Tuple[int, int] The tag for the element whose value multiplicity (VM) is being retrieved, in any of the forms accepted by :func:`~pydicom.tag.Tag`. Returns ------- str The VM of the corresponding element. Raises ------ KeyError If the tag is not present in the DICOM data dictionary. rNrJrGrrr dictionary_VMVrLrPcCrI)aReturn the description of the element corresponding to `tag`. Only performs the lookup for official DICOM elements. Parameters ---------- tag : int or str or Tuple[int, int] The tag for the element whose description is being retrieved, in any of the forms accepted by :func:`~pydicom.tag.Tag`. Returns ------- str The description of the corresponding element. Raises ------ KeyError If the tag is not present in the DICOM data dictionary. rMrJrGrrrdictionary_descriptionnrLrQcCrI)aReturn the keyword of the element corresponding to `tag`. Only performs the lookup for official DICOM elements. Parameters ---------- tag : int or str or Tuple[int, int] The tag for the element whose keyword is being retrieved, in any of the forms accepted by :func:`~pydicom.tag.Tag`. Returns ------- str The keyword of the corresponding element. Raises ------ KeyError If the tag is not present in the DICOM data dictionary. r+rJrGrrrdictionary_keywordrLrRcCs$zt|tvWStyYdSw)aReturn ``True`` if `tag` is in the official DICOM data dictionary. Parameters ---------- tag : int or str or Tuple[int, int] The tag to check, in any of the forms accepted by :func:`~pydicom.tag.Tag`. Returns ------- bool ``True`` if the tag corresponds to an element present in the official DICOM data dictionary, ``False`` otherwise. F)rr ExceptionrGrrrdictionary_has_tags  rTcCs zt|WStyYdSw)aReturn the keyword of the element corresponding to `tag`. Parameters ---------- tag : int or str or Tuple[int, int] The tag for the element whose keyword is being retrieved, in any of the forms accepted by :func:`~pydicom.tag.Tag`. Returns ------- str If the element is in the DICOM data dictionary then returns the corresponding element's keyword, otherwise returns ``''``. For group length elements will always return ``'GroupLength'``. r )rRrArGrrrkeyword_for_tags   rUcCsi|]}t||qSr)rRr(rrrr-r)r-r1cCs t|S)aReturn the tag of the element corresponding to `keyword`. Only performs the lookup for official DICOM elements. Parameters ---------- keyword : str The keyword for the element whose tag is being retrieved. Returns ------- int or None If the element is in the DICOM data dictionary then returns the corresponding element's tag, otherwise returns ``None``. )r1getrrrrtag_for_keywords rXcCs t|tvS)a@Return ``True`` if `tag` is in the DICOM repeaters data dictionary. Parameters ---------- tag : int The tag to check. Returns ------- bool ``True`` if the tag is a non-private element tag present in the official DICOM repeaters data dictionary, ``False`` otherwise. )rrrGrrrrepeater_has_tags rYcCsg|]}|dqSr*r)rr,rrrrscCs|tvS)aOReturn ``True`` if `keyword` is in the DICOM repeaters data dictionary. Parameters ---------- keyword : str The keyword to check. Returns ------- bool ``True`` if the keyword corresponding to an element present in the official DICOM repeaters data dictionary, ``False`` otherwise. )REPEATER_KEYWORDSrWrrrrepeater_has_keywordsr[c st|ts t|}zt|Wn2ty$}z td|d|d}~wtyA}z|jd|d}t|t||d}~ww|jd}|j d}|||d|dd|dd d |ddg}fd d |D}|std |d|d|d}|S)aReturn an entry from the private dictionary corresponding to `tag`. Parameters ---------- tag : int or str or Tuple[int, int] The tag for the element whose entry is to be retrieved, in any of the forms accepted by :func:`~pydicom.tag.Tag`. Only entries in the private dictionary will be checked. private_creator : str The name of the private creator. Returns ------- tuple of str The (VR, VM, name, is_retired) from the private dictionary. Raises ------ KeyError If the tag or private creator is not present in the private dictionary. See Also -------- get_entry Return an entry from the DICOM data dictionary. zPrivate creator 'z' not in the private dictionaryNz 'z ' is not a valid private creatorr6r7rMxxxxcsg|]}|vr|qSrr)rk private_dictrrr?rz%get_private_entry..zTag 'z1' not in private dictionary for private creator ''r) r@rrrrA TypeErrorr2rgroupelem)rr2excmsg group_strelem_strkeys dict_entryrr_rget_private_entrysB       rkcCt||dS)aReturn the VR of the private element corresponding to `tag`. Parameters ---------- tag : int or str or Tuple[int, int] The tag for the element whose value representation (VR) is being retrieved, in any of the forms accepted by :func:`~pydicom.tag.Tag`. private_creator : str The name of the private creator. Returns ------- str The VR of the corresponding element. Raises ------ KeyError If the tag is not present in the private dictionary. rrkrr2rrrprivate_dictionary_VRJrocCrl)aReturn the VM of the private element corresponding to `tag`. Parameters ---------- tag : int or str or Tuple[int, int] The tag for the element whose value multiplicity (VM) is being retrieved, in any of the forms accepted by :func:`~pydicom.tag.Tag`. private_creator : str The name of the private creator. Returns ------- str The VM of the corresponding element. Raises ------ KeyError If the tag is not present in the private dictionary. rNrmrnrrrprivate_dictionary_VMbrprqcCrl)aDReturn the description of the private element corresponding to `tag`. Parameters ---------- tag : int or str or Tuple[int, int] The tag for the element whose description is being retrieved, in any of the forms accepted by :func:`~pydicom.tag.Tag`. private_creator : str The name of the private creator. Returns ------- str The description of the corresponding element. Raises ------ KeyError If the tag is not present in the private dictionary, or if the private creator is not valid. rMrmrnrrrprivate_dictionary_descriptionzsrr)rr )r)0__doc__pydicom._dicom_dictrr pydicom.miscrpydicom._private_dictr pydicom.tagrrrr dictstrtupleint__annotations__rreplacerjoinrrr#r"r5r3rCboolrHrKrOrPrQrRrTrUr1rXrYvaluesrZr[rkrorqrrrrrrs   8 3 % .-"C