o i@shUdZddlZddlmZddlmZmZddlZddlm Z m Z m Z ddl m Z mZmZddlmZmZmZddlmZdd lmZd Zhd Zd hZd d d dddd ddd ZdedefddZdddddedededdd d! Zd"d#eDZ d$d#eDZ!d%ed&ed'e"e#e"e"fBde#e$effd(d)Z%d%ed&ede#e$effd*d+Z&d%ed&ede#e$effd,d-Z'd%ed&ede#e$effd.d/Z(d%ed&ede#e$effd0d1Z)d%ed&ed2e"de#e$effd3d4Z*d%ed&ede#e$effd5d6Z+d%ed&ede#e$effd7d8Z,d%ed&ede#e$effd9d:Z-d&ee.Bddfd;d<Z/d=d=d>d>d?d?d>d?d@Z0d%ed&edAe1dBe1de#e$eff dCdDZ2idEe+dFe)dGe+dHdIdJdKe+dLdMdJdNdOdJdPdQdJdRe+dSe'dTe'dUdVdJdWdXdJdYdZdJd[d\dJd]d^dJd_d`dJe-e'dadJdbdJe'dcdJdddJe+dedJdfdJe)dgdJdh Z3 dd%ed&edie1djeeege#e$effdBddf dkdlZ4eGdmdndneeZ5he5j6e5j7e5j8e5j9e5j:e5j;e5j<e5j=e5j>e5j?e5j@e5jAe5jBe5jCe5jDe5jEe5jFe5jGe5jHe5jIe5jJe5jKe5jLe5jMe5jNe5jOe5jPe5jQe5jRe5jSe5jTe5jUe5jVe5jWZXe5jYe5jZe5j[e5j\hZ]e5j6e5j7e5j9e5j:e5j;e5jhZae5j8e5j?e5jJe5jLe5jNe5jRe5jUe5jWhZbe5jKhZce^e_BZde5jAe5jMe5jVe5jYe5j[e5j\he`BZee5jAe5jPe5jVhe`Be]BZfe5j6e5j7e5j8e5j9e5j:e5j;e5je5j=e5j?e5j@e5jAe5jHe5jIe5jJe5jLe5jMe5jOe5jQe5jRe5jUhZgeXegZhe`e5j\hBe5jShZiGdodpdpZjGdqdHdHejejkZ:GdrdLdLejejZ ^r@i(i) AECSDSISLOLTSHSTUIregexreturnc Cs$d|d|d|d|d|d S)zvCompose a regex that allows ranges of the given regex, as defined for VRs DA, DT and TM in PS 3.4, C.2.2.2.5. ^z$|^\-z ?$|^z\- ?$|^z\-z ?$)r!r$r$F/mnt/sdb/aimis/docanh/lib/python3.10/site-packages/pydicom/valuerep.py _range_regex/s$r&z^[\x20-\x7e]*$z^\d\d\d[DWMY]$z ^[A-Z0-9 _]*$z0^ *[+\-]?(\d+|\d+\.\d*|\.\d+)([eE][+\-]?\d+)? *$z^ *[+\-]?\d+ *$z#\d{4}(0[1-9]|1[0-2])([0-2]\d|3[01])zs\d{4}((0[1-9]|1[0-2])(([0-2]\d|3[01])(([01]\d|2[0-3])([0-5]\d((60|[0-5]\d)(\.\d{1,6} ?)?)?)?)?)?)?([+-][01]\d\d\d)?z6([01]\d|2[0-3])([0-5]\d((60|[0-5]\d)(\.\d{1,6} ?)?)?)?z%^(0|[1-9][0-9]*)(\.(0|[1-9][0-9]*))*$z)^[A-Za-z_\d:/?#\[\]@!$&'()*+,;=%\-.~]* *$) rASrrrDADTTMr URcCsi|] \}}|t|qSr$)recompile.0vrr!r$r$r% Gsr1cCs i|] \}}|t|qSr$)r,r-encoder.r$r$r%r1Hs r0valuetypescCs2|durt||sddt|jd|dfSdS)ayChecks for valid types for a given VR. Parameters ---------- vr : str The value representation to validate against. value : Any The value to validate. types: Type or Tuple[Type] The type or tuple of types supported for the given VR. Returns ------- A tuple of a boolean validation result and the error message. NFzA value of type 'z&' cannot be assigned to a tag with VR .T) isinstancetype__name__)r0r3r4r$r$r% validate_typeKsr;cCsDt|d}|dkr t|}||kr dd|d|d|dfSdS)aValidate the value length for a given VR. Parameters ---------- vr : str The value representation to validate against. value : Any The value to validate. Returns ------- A tuple of a boolean validation result and the error message. rFzThe value length (z ) exceeds the maximum length of z allowed for VR r5r6) MAX_VALUE_LENgetlen)r0r3 max_length value_lengthr$r$r%validate_vr_lengthes rAcC*t||ttf\}}|s||fSt||S)a3Validate the correct type and the value length for a given VR. Parameters ---------- vr : str The value representation to validate against. value : Any The value to validate. Returns ------- A tuple of a boolean validation result and the error message. )r;strbytesrAr0r3validmsgr$r$r%validate_type_and_length~s rHcCs^|r-t|trt|}d}nt|}d}t||r"|r-|d|kr-dd|d|dfSdS) aMValidate the value for a given VR for allowed characters using a regular expression. Parameters ---------- vr : str The value representation to validate against. value : Any The value to validate. Returns ------- A tuple of a boolean validation result and the error message.  rFzInvalid value for VR z: r5r6)r8rCSTR_VR_REGEXESBYTE_VR_REGEXESr,match)r0r3r!newliner$r$r%validate_regexs rOcCrB)ayValidate that the value is of type :class:`str` or :class:`bytes` and that the value matches the VR-specific regular expression. Parameters ---------- vr : str The value representation to validate against. value : Any The value to validate. Returns ------- A tuple of a boolean validation result and the error message. )r;rCrDrOrEr$r$r%validate_type_and_regexs rPdate_time_typecCs|r t||r dSt||S)aChecks for valid values for date/time related VRs. Parameters ---------- vr : str The value representation to validate against. value : Any The value to validate. date_time_type: type The specific type supported for the given VR (additional to str/bytes). Returns ------- A tuple of a boolean validation result and the error message. r6)r8rP)r0r3rQr$r$r%validate_date_times rRcCsft||ttf\}}|s||fSt||\}}t||\}}d||g}|r-|d7}|o0||fS)aValidate the value for a given VR for maximum length, for the correct value type, and for allowed characters using a regular expression. Parameters ---------- vr : str The value representation to validate against. value : Any The value to validate. Returns ------- A tuple of a boolean validation result and the error message.  z~ Please see for allowed values for each VR.)r;rCrDrArOjoinstrip)r0r3rFrG is_valid_lenmsg1 is_valid_exprmsg2r$r$r%"validate_length_and_type_and_regexs rZcCs$t|dkrddt|dfSdS)aValidate the PN component value for the maximum length. Parameters ---------- vr : str Ignored. value : str The value to validate. Returns ------- A tuple of a boolean validation result and the error message. rFzThe PN component length (z+) exceeds the maximum allowed length of 64.r6)r>r0r3r$r$r%validate_pn_component_lengths r\cCs|rt|tr dSt||ttf\}}|s||fSt|tr$|d}n|d}t|dkr9ddt|dfS|D]}td|\}}|sLd|fSq;dS) aCValidate the value for VR PN for the maximum number of components and for the maximum length of each component. Parameters ---------- vr : str Ignored. value : str The value to validate. Returns ------- A tuple of a boolean validation result and the error message. r6==Fz$The number of PN components length (z*) exceeds the maximum allowed number of 3.PN)r8 PersonNamer;rCrDsplitr>r\)r0r3rFrG componentscompr$r$r% validate_pn s$     recCstd|tjjtdS)a$Validate the value of a single component of VR PN for maximum length. Parameters ---------- value : str or bytes The component value to validate. Raises ------ ValueError If the validation fails and the validation mode is set to `RAISE`. r`N)validate_valuersettingswriting_validation_moder\)r3r$r$r%validate_pn_component2s ri)USSSULSLUVSVFLFD min_value max_valuecCst||ttf\}}|s||fSt|tr-||ks||kr+dd|d|d|dfSd St|t|rGddt|d|dt|dfSd S) aValidate the value for a numerical VR for type and allowed range. Parameters ---------- vr : str The value representation to validate against. value : Any The value to validate. min_value : int The minimum allowed value. max_value : int The maximum allowed value. Returns ------- A tuple of a boolean validation result and the error message. Fz)Invalid value: a value for a tag with VR z must be between z and r5zInvalid value length z%: the value length for a tag with VR z must be a multiple of r6)r;intrDr8r> VALUE_LENGTH)r0r3rurvrFrGr$r$r%validate_numberKs,   ryrr'rr(cCt||tjSN)rRdatetimedater[r$r$r%tr~rr)cCst||tjSr{)rRr|r[r$r$r%r~vrrtcCt||ttfSr{r;floatrwr[r$r$r%r~wrscCrr{rr[r$r$r%r~xrrrrOBcCrr{r;rD bytearrayr[r$r$r%r~|rODcCrr{rr[r$r$r%r~}rOFcCrr{rr[r$r$r%r~~rOLcCrr{rr[r$r$r%r~rOWcCrr{rr[r$r$r%r~rOVcCrr{rr[r$r$r%r~rcCt||ddS)Niryr[r$r$r%r~rcCr)Niirr[r$r$r%r~rcCr)Nllrr[r$r$r%r~scCrzr{)rRr|timer[r$r$r%r~rcCr)Nrlrr[r$r$r%r~rcCr)Nrirr[r$r$r%r~rcCr)Nrlrr[r$r$r%r~r) r`rrprnrrrr*r rormr+rqvalidation_mode validatorcCsh|tjkrdS|dur.|pt|}|dur0|||\}}|s2|tjkr(t|t|dSdSdSdS)aaValidate the given value against the DICOM standard. Parameters ---------- vr : str The VR of the tag the value is added to. value : Any The value to be validated. validation_mode : int Defines if values are validated and how validation errors are handled. validator : Callable or None Function that does the actual validation. If not given, the validator is taken from the VR-specific validator table instead. Raises ------ ValueError If the validation fails and the validation mode is set to `RAISE`. N)rIGNORE VALIDATORSr=RAISE ValueErrorr)r0r3rris_validrGr$r$r%rfs   rfc@seZdZdZdZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZ dZ!d Z"d!Z#d"Z$d#Z%d$Z&d%Z'd&Z(d'Z)d(e*fd)d*Z+d+S),VRz.DICOM Data Element's Value Representation (VR)rr'ATrr(rr)rtrsrrrrrrrrrr`rrpSQrnrrrr*UCr roUNr+rmUTrqzUS or SS or OWzUS or SSzUS or OWzOB or OWr"cCs t|Sr{)rC__str__selfr$r$r%r z VR.__str__N),r: __module__ __qualname____doc__rr'rrr(rr)rtrsrrrrrrrrrr`rrprrnrrrr*rr rorr+rmrrqUS_SS_OWUS_SSUS_OWOB_OWrCrr$r$r$r%rsRrcseZdZUdZeed<deeeffddZdeeefddfdd Z d e de ed fffd d Z deffdd Z defddZZS) _DateTimeBasez1Base class for DT, DA and TM element sub-classes.original_stringr"cCs |jSr{)__dict__copyrr$r$r% __getstate__arz_DateTimeBase.__getstate__stateNcCs|j|dSr{)rupdate)rrr$r$r% __setstate__dz_DateTimeBase.__setstate__protocol.cs(tttdft|}||fS)N.)r tupler super __reduce_ex__r)rr reduce_ex __class__r$r%rgsz_DateTimeBase.__reduce_ex__cst|dr|jStSNr)hasattrrrrrrr$r%rns  z_DateTimeBase.__str__cCs d|dS)N"r$rr$r$r%__repr__ts z_DateTimeBase.__repr__)r:rrrrC__annotations__dictr rrrwrrrr __classcell__r$r$rr%r[s rc sPeZdZdZdeddedededffdd Zdededdfd d ZZ S) r(zStore value for an element with VR **DA** as :class:`datetime.date`. Note that the :class:`datetime.date` base class is immutable. clsargskwargsr"c sV|r|ddur dS|d}t|tru|dkrdSt|dkrBt|dd}t|dd}t|dd}t||||St|dkru|ddkru|d dkrut|dd}t|d d }t|dd}t||||St|tjrt||j |j |j Sztj|g|Ri|WSt y}z t d |d |d}~ww) a#Create an instance of DA object. Raise an exception if the string cannot be parsed or the argument is otherwise incompatible. The arguments (``*args`` and ``**kwargs``) are either the ones inherited from :class:`datetime.date`, or the first argument is a string conformant to the DA definition in the DICOM Standard, Part 5, :dcm:`Table 6.2-1`, or it is a :class:`datetime.date` object, or an object of type :class:`~pydicom.valuerep.DA`. rNr7rlrkrr5Unable to convert 'z' to 'DA' object)r8rCrUr>rwr__new__r|r}yearmonthday Exceptionr)rrrvalrrrexcrr$r%r~s0   $ z DA.__new__NcOsl|d}t|tr||_dSt|trt|dr|j|_dSt|tjr4|j|jd|j d|_dSdS)z"Create a new **DA** element value.rr02N) r8rCrr(rr|r}rrrrrrrr$r$r%__init__s     z DA.__init__) r:rrrr9r rrrrr$r$rr%r(xs-c sreZdZdZedZedede j fddZ de dde d e dedffd d Zde d e dd fd dZZS)r)zStore value for an element with VR **DT** as :class:`datetime.datetime`. Note that the :class:`datetime.datetime` base class is immutable. z&((\d{4,14})(\.(\d{1,6}))?)([+-]\d{4})?r3r"cCs\t|ddd}t|dd}||d}|ddkr!| n|}tjtj|d|dS) aReturn the UTC Offset suffix as a :class:`datetime.timezone`. Parameters ---------- value : str The value of the UTC offset suffix, such as ``'-1000'`` or ``'+0245'``. Returns ------- datetime.timezone r_<rr-)seconds)name)rwr|timezone timedelta)r3hourminuteoffsetr$r$r% _utc_offsets  zDT._utc_offsetrrrc s(|r|ddur dS|d}t|tr|dkrdS|j|}|r)t|dkr1td|d|d}t|ddt|d krEd nt|dd t|d krTd nt|d d f}t|d krednt|d d t|d krtdnt|d d t|dkrdnt|d ddd}t|dkr|drt|d d d|d<|d}|r| |nd|d<|ddkrt dd|d<t j|g|Ri|St|tjrt j|g|dd |j|jRSzt j|g|Ri|WSty}z td|d|d}~ww)a+Create an instance of DT object. Raise an exception if the string cannot be parsed or the argument is otherwise incompatible. The arguments (``*args`` and ``**kwargs``) are either the ones inherited from :class:`datetime.datetime`, or the first argument is a string conformant to the DT definition in the DICOM Standard, Part 5, :dcm:`Table 6.2-1`, or it is a :class:`datetime.datetime` object, or an object of type :class:`~pydicom.valuerep.DT`. rNr7(Unable to convert non-conformant value 'z' to 'DT' objectrjrkrrrlrr)rrsecond microsecond0rrtzinforrz]'datetime.datetime' doesn't allow a value of '60' for the seconds component, changing to '59';r)r8rCrU _regex_dtrMr>rgrouprwrstripljustrrrrr| timetuplerrr)rrrrrMdt_matchtz_matchrrr$r%rs^        z DT.__new__NcOs$|d}t|tr||_dSt|trt|dr|j|_dSt|tjr|jd|jd|jd|j d|j d|j d|_|j dkrP|jd|j d7_|j dur|j |}|dur|jdd |jd }|dkrqd nd }t|}|j||d d|d d7_dSdSdSdS) z"Create a new **DT** element value.rr04rr506Nr+r)r8rCrr)rr|rrrrrrrr utcoffsetdaysrabs)rrrrr offset_minsignr$r$r%rs8         z DT.__init__)r:rrrr,r-r staticmethodrCr|rrr9r rrrrr$r$rr%r)s Dc s^eZdZdZedZdeddedede dffdd Z dededd ffd d Z Z S) r*zStore value for an element with VR **TM** as :class:`datetime.time`. Note that the :class:`datetime.time` base class is immutable. zd(?P^([01][0-9]|2[0-3]))((?P([0-5][0-9]))((?P([0-5][0-9]|60))(\.(?P([0-9]{1,6})?))?)?)?$rrrr"c sd|r|ddur dS|d}t|trz|dkrdS|j|}|s+td|dt|d}|ddur;dnt|d}|ddurKdnt|d}|d kr\td d }d}|d rpt|d  d d}t |||||St|t jrt ||j|j|j|jSzt j |g|Ri|WSty} z td|d| d} ~ ww)a1Create an instance of TM object from a string. Raise an exception if the string cannot be parsed or the argument is otherwise incompatible. The arguments (``*args`` and ``**kwargs``) are either the ones inherited from :class:`datetime.time`, or the first argument is a string conformant to the TM definition in the DICOM Standard, Part 5, :dcm:`Table 6.2-1`, or it is a :class:`datetime.time` object, or an object of type :class:`~pydicom.valuerep.TM`. rNr7rz' to 'TM' objecthmsrzY'datetime.time' doesn't allow a value of '60' for the seconds component, changing to '59'rmsrrr)r8rCrU_RE_TIMErMrrwrrrrrrr|rrrrrr) rrrrrMrrrrrrr$r%rAsB        z TM.__new__Ncst|d}t|tr||_dSt|tr#t|dr#|j|_dSt|tjrK|j d|j d|j d|_|j dkrM|jd|j d7_dSdSdS)Nrrrr5r) rrr8rCrr*rr|rrrrrrrr$r%rys      z TM.__init__) r:rrrr,r-rr9r rrrrr$r$rr%r*4s"8r*rcCstd|dS)aSCheck whether this string is a valid decimal string. Valid decimal strings must be 16 characters or fewer, and contain only characters from a limited set. Parameters ---------- s: str String to test. Returns ------- bool True if the string is a valid decimal string. Otherwise False. rr)rZrr$r$r% is_valid_dssrrcCst|ttBs tdt|std|dt|}t|dkr#|Stt ttBt |}|dkr4dnd}|dkp?|d |k}|r`d |}|d |d }t|dkr^|d |dd }|S|d krod |t t |}nd |}|d |dS)aTruncate a float's representation to give a valid Decimal String (DS). DICOM's decimal string (DS) representation is limited to strings with 16 characters and a limited set of characters. This function represents a float that satisfies these constraints while retaining as much precision as possible. Some floats are represented using scientific notation to make more efficient use of the limited number of characters. Note that this will incur a loss of precision if the number cannot be represented with 16 characters. Furthermore, non-finite floats (infs and nans) cannot be represented as decimal strings and will cause an error to be raised. Parameters ---------- val: float | Decimal The floating point value whose representation is required. Returns ------- str String representation of the float satisfying the constraints of the decimal string representation. Raises ------ ValueError If val does not represent a finite value z.'val' must be of type float or decimal.Decimalz?Cannot encode non-finite floats as DICOM decimal strings. Got ''rgrrrrr5eg?f) r8rr TypeErrorrrrCr>rr rrwr)rvalstrlogval sign_charsuse_scientificremaining_chars trunc_strr$r$r%format_number_as_dss,    rc seZdZUdZeed<  ddedddeBeBe Be BdededBdd f fd d Z  ddeeBe Be BdededBddfd d Z de de ffdd Zdeffdd Zde de fddZdefddZdeffdd ZZS)DSfloataStore value for an element with VR **DS** as :class:`float`. If constructed from an empty string, return the empty string, not an instance of this class. Parameters ---------- val: str | int | float | Decimal Value to store as a DS. auto_format: bool If True, automatically format the string representation of this number to ensure it satisfies the constraints in the DICOM standard. Note that this will lead to loss of precision for some numbers. auto_formatFNrrrr"zstr | DSfloat | Nonecs4|dur|St|tr|dkr|St||SNr7r8rCrUrrrrrrrr$r%rs zDSfloat.__new__cCs|durtjj}|t|d}d}t|tr||_nt|tt Br0|j r*d}d}|r0|j|_||_ |j rP|sPt|drKt |jsJt t |j|_nt ||_|tjkrr|j sttt|dkrdtdt t|svtd|ddSdSdS) zaStore the original string if one given, for exact write-out of same value later. NrFTraAValues for elements with a VR of 'DS' must be <= 16 characters long, but the float provided requires > 16 characters to be accurately represented. Use a smaller string, set 'config.settings.reading_validation_mode' to 'WARN' to override the length check, or explicitly construct a DS object with 'auto_format' set to TrueValue "+" is not valid for elements with a VR of DS)rrgreading_validation_moderr8rCrUrr DSdecimalrrrrrr> OverflowErrorr)rrrr has_attribute pre_checkedr$r$r%r sB           zDSfloat.__init__otherc"t|tr t||kSt|Sz.Override to allow string equality comparisons.r8rCr__eq__rrrr$r%rB   zDSfloat.__eq__c tSr{r__hash__rrr$r%rIrzDSfloat.__hash__cC ||k Sr{r$rr$r$r%__ne__LrzDSfloat.__ne__cCs&t|dr |js |jSt|ddSNrrrJ)rrrreprrr$r$r%rOszDSfloat.__str__cs*t|dr d|jdSdtdSNrr)rrrrrrr$r%rVs zDSfloat.__repr__FNr:rrrboolrr9rCrwrrrrr rrrrrrr$r$rr%rs@  8rc seZdZUdZeed<  ddedddeBeBe Be BdededBdd f fd d Z  ddeeBe Be BdededBddfd d Z de de ffdd Zdeffdd Zde de fddZdeffdd ZdefddZZS)raStore value for an element with VR **DS** as :class:`decimal.Decimal`. Parameters ---------- val: str | int | float | Decimal Value to store as a DS. auto_format: bool If True, automatically format the string representation of this number to ensure it satisfies the constraints in the DICOM standard. Note that this will lead to loss of precision for some numbers. Notes ----- If constructed from an empty string, returns the empty string, not an instance of this class. rFNrrrr"zstr | DSdecimal | NonecsL|dur|St|tr|dkr|St|trtjstdt||S)aCreate an instance of DS object, or return a blank string if one is passed in, e.g. from a type 2 DICOM blank value. Parameters ---------- val : str or numeric A string or a number type which can be converted to a decimal. Nr7z'DS' cannot be instantiated with a float value unless 'config.allow_DS_float' is set to True. You should convert the value to a string with the desired number of digits, or use 'Decimal.quantize()' and pass a 'Decimal' instance.) r8rCrUrrallow_DS_floatrrrr rr$r%rrszDSdecimal.__new__cCs"|durtjj}|d}t|tr||_nt|ttBr.|j r%d}d}t |dr.|j|_||_ |j rN|sNt |drIt |jsHt t |j|_nt ||_|tjkrtt|ddkrod}|tjkrit|t|dSt t|dsd|d }|tjkrt|t|dSdSdS) zStore the original string if one given, for exact write-out of same value later. E.g. if set ``'1.23e2'``, :class:`~decimal.Decimal` would write ``'123'``, but :class:`DS` will use the original. NFTrrra?Values for elements with a VR of 'DS' values must be <= 16 characters long. Use a smaller string, set 'config.settings.reading_validation_mode' to 'WARN' to override the length check, use 'Decimal.quantize()' and initialize with a 'Decimal' instance, or explicitly construct a DS instance with 'auto_format' set to Truer r )rrgrr8rCrUrrrrrrrrrr>r rrrr)rrrrrrGr$r$r%rsF              zDSdecimal.__init__rcrrrrrr$r%rrzDSdecimal.__eq__crr{rrrr$r%rrzDSdecimal.__hash__cCrr{r$rr$r$r%rrzDSdecimal.__ne__cs,t|d}|rt|jdkr|jStS)Nrr)rr>rrr)rhas_strrr$r%rs  zDSdecimal.__str__cCs$t|dr d|jdSd|dSr!)rrrr$r$r%rs  zDSdecimal.__repr__r"r#r$r$rr%r]s@ ! =rDSclassFrcCs`|dur|S|durtjj}t|tr!|dkr|Std||tjr*t|||St |||S)aFactory function for creating DS class instances. Checks for blank string; if so, returns that, else calls :class:`DSfloat` or :class:`DSdecimal` to create the class instance. This avoids overriding ``DSfloat.__new__()`` (which carries a time penalty for large arrays of DS). Similarly the string clean and check can be avoided and :class:`DSfloat` called directly if a string has already been processed. Nr7r) rrgrr8rCrUrfuse_DS_decimalrr)rrrr$r$r%rs     c speZdZdZ d deddeeBeBdedBdeeBffdd Z d deeBeBdedBddfd d Z Z S) ISfloata`Store value for an element with VR **IS** as :class:`float`. Stores original integer string for exact rewriting of the string originally read or stored. Note: By the DICOM standard, IS can only be an :class:`int`, however, it is not uncommon to see float IS values. This class is used if the config settings allow non-strict reading. Generally, use :class:`~pydicom.valuerep.IS` to create IS values, this is returned instead if the value cannot be represented as an :class:`int`. See :class:`~pydicom.valuerep.IS` for details of the parameters and return values. Nrrrr"cs(t|tr |dkr dSt||Sr r )rrrrr$r%r szISfloat.__new__cCs~t|tr ||_nt|ttBrt|dr|j|_|r;d|d}|tjkr.t |dS|tj kr=|d7}t |dSdS)Nrr z+" is not valid for elements with a VR of ISz8 Set reading_validation_mode to WARN or IGNORE to bypass) r8rCrUrrr)rrWARNrrr)rrrrGr$r$r%r*s      zISfloat.__init__r{) r:rrrr9rCrrrwrrrr$r$rr%r)s(   r)c seZdZdZ ddedddeBeBeBeBdedBddffdd Z ddeeBeBeBdedBddfd d Z d e de ffd d Z deffdd Z d e de fddZdefddZdeffdd ZZS)rzStore value for an element with VR **IS** as :class:`int`. Stores original integer string for exact rewriting of the string originally read or stored. Nrrrr"zstr | IS | ISfloat | Nonecs|dur|S|durtjj}t|tr!|dkr|Std||z t||}Wnt y<t|t |}Ynwt|t t BtBrQ|t |krQt ||}d|kr[dksen|tj kretd|S)z%Create instance if new integer stringNr7rrlzElements with a VR of IS must have a value between -2**31 and (2**31 - 1). Set 'config.settings.reading_validation_mode' to 'WARN' to override the value check)rrgrr8rCrUrfrrrrrr)rr)rrrnewvalrr$r%rBs(      z IS.__new__cCs@t|tr ||_dSt|trt|dr|j|_dSdSdSr)r8rCrUrrr)rrrr$r$r%rjs  z IS.__init__rcrrrrrr$r%rsrz IS.__eq__crr{rrrr$r%rzrz IS.__hash__cCrr{r$rr$r$r%r}rz IS.__ne__cCs t|dr|jSt|ddSr)rrr rr$r$r%rs z IS.__str__csdtdS)Nr)rrrrr$r%rsz IS.__repr__r{)r:rrrr9rCrwrrrrr rrrrrrr$r$rr%r;s2 )   encodings.cCs$|durdSt|tr|fSt|S)z+Checks the encoding to ensure proper formatN)r8rCrr,r$r$r%_verify_encodingss  r.rccsPddlmfdd|D}t|r$|ds$|t|r$|drt|S)a?Return a list of decoded person name components. Parameters ---------- components : list of bytes The list of the up to three encoded person name components encodings : list of str The Python encodings uses to decode `components`. Returns ------- text type The unicode string representing the person name. If the decoding of some component parts is not possible using the given encodings, they are decoded with the first encoding using replacement characters for bytes that cannot be decoded. r) decode_bytescsg|]}|tqSr$) PN_DELIMSr/cr/r,r$r% sz&_decode_personname..rJ)pydicom.charsetr/r>popr)rcr,compsr$r3r%_decode_personnames r8cszddlmg}|D]}fdd|dD}d|}||q t|r8|ds8|t|r8|dr,d|S) aOEncode a list of text string person name components. Parameters ---------- components : list of str The list of the up to three unicode person name components encodings : list of str The Python encodings uses to encode `components`. Returns ------- byte string The byte string that can be written as a PN DICOM tag value. If the encoding of some component parts is not possible using the given encodings, they are encoded with the first encoding using replacement bytes for characters that cannot be encoded. r) encode_stringcsg|]}|qSr$r$)r/rr9r,r$r%r4sz&_encode_personname..r#^rJr])r5r9rbrTappendr>r6)rcr, encoded_compsrdgroups encoded_compr$r:r%_encode_personnames    r@c$seZdZdZdeddedededffdd Z   ddd d d ee dBd e dBd e dBddf ddZ de e e ffddZedee dffddZde de fddZede fddZede fddZede fddZede fddZede fd d!Zede fd"d#Zede fd$d%Zede fd&d'Zd(edefd)d*Zd(edefd+d,Zde fd-d.Zdee fd/d0Zde fd1d2Z d3ede!fd4d5Z"de fd6d7Z#de fd8d9Z$ded ee dBddfd:d;Z%ded ee dBde fdd?Z'd@e de fdAdBZ(de!fdCdDZ)e* dedEee e BdFee e BdGee e Bd e+e dBde f dHdIZ,e- J J J J J J J J J J J J J J J dfdKe e BdLe e BdMe e BdNe e BdOe e BdPe e BdQe e BdRe e BdSe e BdTe e BdUe e BdVe e BdWe e BdXe e BdYe e Bd e+e dBddf"dZd[Z.e- J J J J J J dgd\e e Bd]e e Bd^e e Bd_e e Bd`e e Bdae e Bd e+e dBddfdbdcZ/Z0S)hraz:Representation of the value for an element with VR **PN**.rrrr"cs$t|r |ddur dSt|S)Nr)r>rr)rrrrr$r%rs zPersonName.__new__Nrzbytes | str | PersonNamer,rrcCs|d|_||durtjj}||_t|tr)|j}|j|_t t | d|_n@t|t r;||_t d||d|_n.tt ||_t d|rG|n||| d}t|rd|dsd|t|rd|drXt ||_t||_dS)aCreate a new ``PersonName``. Parameters ---------- val: str, bytes, PersonName The value to use for the **PN** element. encodings: list of str, optional A list of the encodings used for the value. original_string: bytes, optional When creating a ``PersonName`` using a decoded string, this is the original encoded value. Notes ----- A :class:`PersonName` may also be constructed by specifying individual components using the :meth:`from_named_components` and :meth:`from_named_components_veterinary` class methods. Nr^r`rJ) _componentsrrgrrr8rar,rrrCrbrDrfr r>r6r.)rrr,rrrcr$r$r%rs0      zPersonName.__init__csgd}fdd|DS)zCreates a dictionary of person name group and component names. Used exclusively for `formatted` for backwards compatibility. ) family_name given_name middle_name name_prefix name_suffix ideographicphoneticcsi|] }|t|dqS)r7)getattrr1rr$r%r1*sz+PersonName._create_dict..r$)rpartsr$rr% _create_dicts zPersonName._create_dict.cCs4|jdur|jd}|jptg}t|||_|jS)a-Returns up to three decoded person name components as a :class:`tuple` of :class:`str`. Returns ------- Tuple[str, ...] The (alphabetic, ideographic, phonetic) components of the decoded person name. Any of the components may be absent. Nr])rArrbr,default_encodingr8)rr>r,r$r$r%rc,s   zPersonName.componentsicCs,z |jdd|WStyYdSw)z"Return the `i`th part of the name.rr#r7)rcrb IndexError)rrMr$r$r% _name_part>s  zPersonName._name_partcC |dS)zvReturn the first (family name) group of the alphabetic person name representation as a unicode string rrOrr$r$r%rBE zPersonName.family_namecCrP)zvReturn the second (given name) group of the alphabetic person name representation as a unicode string rrQrr$r$r%rCLrRzPersonName.given_namecCrP)zvReturn the third (middle name) group of the alphabetic person name representation as a unicode string rjrQrr$r$r%rDSrRzPersonName.middle_namecCrP)zwReturn the fourth (name prefix) group of the alphabetic person name representation as a unicode string r_rQrr$r$r%rEZrRzPersonName.name_prefixcCrP)zvReturn the fifth (name suffix) group of the alphabetic person name representation as a unicode string rkrQrr$r$r%rFarRzPersonName.name_suffixcC"z|jdWStyYdSw)zXReturn the first (alphabetic) person name component as a unicode string rr7rcrNrr$r$r% alphabetich   zPersonName.alphabeticcCrS)zZReturn the second (ideographic) person name component as a unicode string rr7rTrr$r$r%rGrrVzPersonName.ideographiccCrS)zVReturn the third (phonetic) person name component as a unicode string rjr7rTrr$r$r%rH|rVzPersonName.phoneticrcCs t||kS)z3Return ``True`` if `other` equals the current name.)rCrr$r$r%r zPersonName.__eq__cCr)z:Return ``True`` if `other` doesn't equal the current name.r$rr$r$r%r zPersonName.__ne__cCd|jS)z+Return a string representation of the name.r^)rTrcrrr$r$r%rzPersonName.__str__ccs|EdHdS)zIterate through the name.Nrrr$r$r%__iter__szPersonName.__iter__cCs t|S)z%Return the length of the person name.)r>rrr$r$r%__len__rWzPersonName.__len__xcCs ||vS)z&Return ``True`` if `x` is in the name.r[)rr^r$r$r% __contains__rWzPersonName.__contains__cCrY)z$Return a representation of the name.r^)rTrcrrr$r$r%rrZzPersonName.__repr__cCs t|jS)zReturn a hash of the name.)hashrcrr$r$r%rrXzPersonName.__hash__cCsZ|dus ||jkr |St|}|jdur't|j|jptg|_td|j|jt|j|S)a"Return the patient name decoded by the given `encodings`. Parameters ---------- encodings : list of str, optional The list of encodings used for decoding the byte string. If not given, the initial encodings set in the object are used. Returns ------- valuerep.PersonName A person name object that will return the decoded string with the given encodings on demand. If the encodings are not given, the current object is returned. Nr`) r,r.rr@rcrLrfrrarr,r$r$r%decodes  zPersonName.decodecCs\t|p|j}||jkr|jdurt|jttt|S|jdur+t|j|p(tg|_|jS)azReturn the patient name decoded by the given `encodings`. Parameters ---------- encodings : list of str, optional The list of encodings used for encoding the unicode string. If not given, the initial encodings set in the object are used. Returns ------- bytes The person name encoded with the given encodings as a byte string. If no encoding is given, the original byte string is returned, if available, otherwise each group of the patient name is encoded with the first matching of the given encodings. N) r.r,r@rcr r rCrrLrar$r$r%r2s  zPersonName.encodecCs|jd|jS)z#Return the name as "Family, Given".z, )rBrCrr$r$r%family_comma_givenszPersonName.family_comma_given format_strcCs ||S)z?Return the name as a :class:`str` formatted using `format_str`.)rK)rrdr$r$r% formattedrWzPersonName.formattedcCs6|jst|jot|jdkpt|jdSt|jS)z)Return ``True`` if the name is not empty.rr)rr$rcr>rr$r$r%__bool__s   zPersonName.__bool__alphabetic_groupideographic_groupphonetic_groupcsddlmmdtdtffdd dtdtffdd d d }gd d ttBdtffd d dtttBdtffdd }||||||g}||}||}|S)aCreates a byte string for a person name from lists of parts. Each of the three component groups (alphabetic, ideographic, phonetic) are supplied as a list of components. Parameters ---------- alphabetic_group: Sequence[str | bytes] List of components for the alphabetic group. ideographic_group: Sequence[str | bytes] List of components for the ideographic group. phonetic_group: Sequence[str | bytes] List of components for the phonetic group. encodings: list[str] | None A list of encodings used for the other input parameters. Returns ------- bytes: Bytes string representation of the person name. Raises ------ ValueError: If any of the input strings contain disallowed characters: '\' (single backslash), '^', '='. r)r9r/rr"cs|ptgSr{)rLrr:r$r%encrz0PersonName._encode_component_groups..enccs|ptgtSr{)rLsetrr3r$r%decsz0PersonName._encode_component_groups..decr#r^)\r^r#rcsJt|tr |}|}n|}|}D]}||vr"td|dq|S)NzStrings may not contain the z character)r8rDr)rval_encval_decr2)rldisallowed_charsrjr$r%standardize_encoding's  zAPersonName._encode_component_groups..standardize_encodingrccs&fdd|D}|}|S)Ncsg|]}|qSr$r$r1)rqr$r%r4;szUPersonName._encode_component_groups..make_component_group..)rTr)rcencoded_componentsjoined_components)encoded_component_seprqr$r%make_component_group:s  zAPersonName._encode_component_groups..make_component_group)r5r9r/rCrDr rTr)rgrhrir,encoded_group_seprucomponent_groups joined_groupsr$)rlr/rprjr9rtr,rqr%_encode_component_groupss"   z#PersonName._encode_component_groupsr7rBrCrDrErFfamily_name_ideographicgiven_name_ideographicmiddle_name_ideographicname_prefix_ideographicname_suffix_ideographicfamily_name_phoneticgiven_name_phoneticmiddle_name_phoneticname_prefix_phoneticname_suffix_phoneticcCsF|||||g}|||| | g}| | | ||g}|||||}|||dS)u Construct a PersonName from explicit named components. The DICOM standard describes human names using five components: family name, given name, middle name, name prefix, and name suffix. Any component may be an empty string (the default) if not used. A component may contain multiple space-separated words if there are, for example, multiple given names, middle names, or titles. Additionally, each component may be represented in ideographic or phonetic form in addition to (or instead of) alphabetic form. For more information see the following parts of the DICOM standard: - :dcm:`Value Representations ` - :dcm:`PN Examples ` - :dcm:`PN Precise semantics ` Example ------- A case with multiple given names and suffixes (DICOM standard, part 5, sect 6.2.1.1): >>> pn = PersonName.from_named_components( family_name='Adams', given_name='John Robert Quincy', name_prefix='Rev.', name_suffix='B.A. M.Div.' ) A Korean case with phonetic and ideographic representations (PS3.5-2008 section I.2 p. 108): >>> pn = PersonName.from_named_components( family_name='Hong', given_name='Gildong', family_name_ideographic='洪', given_name_ideographic='吉洞', family_name_phonetic='홍', given_name_phonetic='길동', encodings=[default_encoding, 'euc_kr'] ) Parameters ---------- family_name: str | bytes Family name in alphabetic form. given_name: str | bytes Given name in alphabetic form. middle_name: str | bytes Middle name in alphabetic form. name_prefix: str | bytes Name prefix in alphabetic form, e.g. 'Mrs.', 'Dr.', 'Sr.', 'Rev.'. name_suffix: str | bytes Name prefix in alphabetic form, e.g. 'M.D.', 'B.A., M.Div.', 'Chief Executive Officer'. family_name_ideographic: str | bytes Family name in ideographic form. given_name_ideographic: str | bytes Given name in ideographic form. middle_name_ideographic: str | bytes Middle name in ideographic form. name_prefix_ideographic: str | bytes Name prefix in ideographic form. name_suffix_ideographic: str | bytes Name suffix in ideographic form. family_name_phonetic: str | bytes Family name in phonetic form. given_name_phonetic: str | bytes Given name in phonetic form. middle_name_phonetic: str | bytes Middle name in phonetic form. name_prefix_phonetic: str | bytes Name prefix in phonetic form. name_suffix_phonetic: str | bytes Name suffix in phonetic form. encodings: list[str] | None A list of encodings used for the other input parameters. Returns ------- PersonName: PersonName constructed from the supplied components. Notes ----- Strings may not contain the following characters: '^', '=', or the backslash character. r-ry)rrBrCrDrErFrzr{r|r}r~rrrrrr,rgrhri encoded_valuer$r$r%from_named_componentsHs2l   z PersonName.from_named_componentsresponsible_party_name patient_name"responsible_party_name_ideographicpatient_name_ideographicresponsible_party_name_phoneticpatient_name_phoneticc Cs4||g}||g} ||g} ||| | |} || |dS)a Construct a PersonName from explicit named components following the veterinary usage convention. The DICOM standard describes names for veterinary use with two components: responsible party family name OR responsible party organization name, and patient name. Any component may be an empty string (the default) if not used. A component may contain multiple space-separated words if necessary. Additionally, each component may be represented in ideographic or phonetic form in addition to (or instead of) alphabetic form. For more information see the following parts of the DICOM standard: - :dcm:`Value Representations ` - :dcm:`PN Examples ` - :dcm:`PN Precise semantics ` Example ------- A horse whose responsible organization is named "ABC Farms", and whose name is "Running On Water" >>> pn = PersonName.from_named_components_veterinary( responsible_party_name='ABC Farms', patient_name='Running on Water' ) Parameters ---------- responsible_party_name: str | bytes Name of the responsible party in alphabetic form. This may be either the family name of the responsible party, or the name of the responsible organization. patient_name: str | bytes Patient name in alphabetic form. responsible_party_name_ideographic: str | bytes Name of the responsible party in ideographic form. patient_name_ideographic: str | bytes Patient name in ideographic form. responsible_party_name_phonetic: str | bytes Name of the responsible party in phonetic form. patient_name_phonetic: str | bytes Patient name in phonetic form. encodings: list[str] | None A list of encodings used for the other input parameters Returns ------- PersonName: PersonName constructed from the supplied components Notes ----- Strings may not contain the following characters: '^', '=', or the backslash character. r-r) rrrrrrrr,rgrhrirr$r$r% from_named_components_veterinarysE z+PersonName.from_named_components_veterinary)NNNr{)r7r7r7r7r7r7r7r7r7r7r7r7r7r7r7N)r7r7r7r7r7r7N)1r:rrrr9r rrr rCrDrwrrrKpropertyrrcrOrBrCrDrErFrUrGrHrrrr r\r]r$r_rrrbr2rcrerfrlistry classmethodrrrr$r$rr%ras*   <   !       O         rar{r")zrr|decimalrenumrrr,mathrrrtypingrr r collections.abcr r r pydicomr pydicom.miscrrLTEXT_VR_DELIMSr0r<rCr& VR_REGEXESitemsrKrLr9rr$r;rArHrOrPrRrZr\rerDrirxrwryrrfrrr'rrr(rr)rtrsrrrrrrrrrr`rrprrnrrrr*rr rorr+rmrrq STANDARD_VRrrrr AMBIGUOUS_VRDEFAULT_CHARSET_VRCUSTOMIZABLE_CHARSET_VRBYTES_VRFLOAT_VRINT_VRLIST_VRSTR_VRALLOW_BACKSLASH LONG_VALUE_VREXPLICIT_VR_LENGTH_16EXPLICIT_VR_LENGTH_32BUFFERABLE_VRSrr}rrrrrrrr(r'r)r.r8r@rar$r$r$r%s0       "%  %     ' (1      !"%  $ >~SOt   +*P