o iEc@sdZddlmZmZddlmZddlmZmZm Z ddl m Z ddl m Z ddlmZerJddlmZdd lmZdd lmZmZdd lmZmZeeBeBZGd d d ZeGdddeeZ GdddZ!Gddde ddZ"dS)z'Common objects for pixel data handling.)Enumunique) import_module) TYPE_CHECKINGAny TypedDict) warn_and_log)as_pixel_options)UID)Callable)Dataset) DecodeOptionsDecodeFunction) EncodeOptionsEncodeFunctionc@seZdZdZdededdfddZded eeefddfd d Z d e eeeeeffddfd dZ e deedffddZ e defddZe defddZe defddZe de efddZdeddfddZe defddZ d$dedeed feed!fBfd"d#ZdS)% CoderBasez#Base class for Decoder and Encoder.uiddecoderreturnNcCs||_i|_i|_||_dS)a Create a new data decoder or encoder. Parameters ---------- uid : pydicom.uid.UID The supported *Transfer Syntax UID*. decoder : bool ``True`` for a decoder subclass, ``False`` for an encoder subclass. N)_uid _available _unavailable_decoder)selfrrrK/mnt/sdb/aimis/docanh/lib/python3.10/site-packages/pydicom/pixels/common.py__init__s  zCoderBase.__init__label import_pathcCs||jvs ||jvrtdt|jd|dt|d}||jr0t||d|j|<dS|j r7|j }n|j }|j|vrLtd|d|jj d||j|j|<dS)aAdd a plugin to the class instance. .. warning:: This method is not thread-safe. The requirements for encoding plugins are available :doc:`here`, while the requirements for decoding plugins are available :doc:`here `. Only encoding plugins should be added to :class:`~pydicom.pixels.encoders.base.Encoder` class instances and only decoding plugins should be added to :class:`~pydicom.pixels.decoders.base.Decoder` class instances. Parameters ---------- label : str The label to use for the plugin, should be unique. import_path : Tuple[str, str] The module import path and the function's name (e.g. ``('pydicom.pixels.encoders.pylibjpeg', 'encode_pixel_data')`` or ``('pydicom.pixels.decoders.pylibjpeg', 'decode_pixel_data')``). Raises ------ ModuleNotFoundError If the module import path is incorrect or unavailable. AttributeError If the plugin's required functions and attributes aren't found in the module. 'z' already has a plugin named 'rzThe 'z' plugin doesn't support 'N) rr ValueErrortype__name__r is_availabler getattrrDECODER_DEPENDENCIESENCODER_DEPENDENCIESname)rrrmoduledepsrrr add_plugin,s"   zCoderBase.add_pluginpluginscCs|D] \}}|||qdS)a?Add multiple plugins to the class instance. .. warning:: This method is not thread-safe. The requirements for encoding plugins are available :doc:`here`, while the requirements for decoding plugins are available :doc:`here `. Only encoding plugins should be added to :class:`~pydicom.pixels.encoders.base.Encoder` class instances and only decoding plugins should be added to :class:`~pydicom.pixels.decoders.base.Decoder` class instances. Parameters ---------- plugins : list[tuple[str, tuple[str, str]]] A list of [label, import path] for the plugins, where: * `label` is the label to use for the plugin, which should be unique. * `import path` is the module import path and the function's name (e.g. ``('pydicom.pixels.encoders.pylibjpeg', 'encode_pixel_data')`` or ``('pydicom.pixels.decoders.pylibjpeg', 'decode_pixel_data')``). N)r+)rr,rrrrr add_pluginsfs zCoderBase.add_plugins.cCstt|jS)z,Return a tuple containing available plugins.)tuplesortedrkeysrrrravailable_pluginsszCoderBase.available_pluginscCs|jr |jjs dSt|jS)zyReturn ``True`` if plugins are available that can be used to encode or decode data, ``False`` otherwise. T)rr is_encapsulatedboolrr1rrrr$s zCoderBase.is_availablecCs|jjS)zlReturn ``True`` if the decoder is for an encapsulated transfer syntax, ``False`` otherwise. )r r3r1rrrr3zCoderBase.is_encapsulatedcCs|j S)zfReturn ``True`` if the decoder is for an native transfer syntax, ``False`` otherwise. )r3r1rrr is_nativer5zCoderBase.is_nativec Csg}|jD]8\}}|s||dqt|dkr3||dd|ddd|dq||d|dq|S) z:Return nice strings for plugins with missing dependencies.z& - plugin indicating it is unavailabler - requires , N and r)ritemsappendlenjoin)rsrr*rrrmissing_dependenciess .zCoderBase.missing_dependenciescCs<||jvr |j|=dS||jvr|j|=dStd|d)zRemove a plugin. .. warning:: This method is not thread-safe. Parameters ---------- label : str The label of the plugin to remove. zUnable to remove 'z', no such plugin'N)rrr!)rrrrr remove_plugins   zCoderBase.remove_plugincC|jS)zLReturn the corresponding *Transfer Syntax UID* as :class:`~pydicom.uid.UID`.)rr1rrrr z CoderBase.UIDpluginrrcCsV|jr |jjs iS|r}||jvr||j|iS|j|d}r[|d}t|dkr:d|ddd|d}|jrLt d|jj d|d |t d |jj d |d |d |d |jj t |j d}|jry|dd|j7}t||jr|jSddd|jD}|jrt d|jj d|t d |jj d|)aReturn available plugins. Parameters ---------- plugin : str, optional If not used (default) then return all available plugins, otherwise only return the plugin with a matching name (if it's available). Returns ------- dict[str, DecodeFunction] | dict[str, EncodeFunction] A dict of available {plugin name: decode/encode function} that can be used to decode/encode the corresponding pixel data. Nrr r8r9r:zUnable to decompress 'zD' pixel data because the specified plugin is missing dependencies: r7z)Unable to compress the pixel data using 'z9' because the specified plugin is missing dependencies: zNo plugin named 'z' has been added to 'rz, available plugins are:  cSsg|]}d|qS) r).0r?rrr sz/CoderBase._validate_plugins..z;' pixel data because all plugins are missing dependencies: z0' because all plugins are missing dependencies: )rr r3r2rrgetr=r> RuntimeErrorr(keywordr"r#r!copyr@)rrEr*missingmsgrrr_validate_pluginssZ        zCoderBase._validate_plugins)rD)r# __module__ __qualname____doc__r r4rstrr.r+listr-propertyr2r$r3r6r@rAdictrPrrrrrs0&: rc@sReZdZdZdZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZdZdefddZdS)PhotometricInterpretationz3Values for (0028,0004) *Photometric Interpretation* MONOCHROME1 MONOCHROME2 PALETTE COLORRGBYBR_FULL YBR_FULL_422YBR_ICTYBR_RCTHSVARGBCMYKYBR_PARTIAL_422YBR_PARTIAL_420rcCs t|SN)rT__str__r1rrrrg!s z!PhotometricInterpretation.__str__N)r#rQrRrSrYrZ PALETTE_COLORr\r]r^r_r`rarbrcrdrerTrgrrrrrX s rXc@seZdZdZdeddfddZedefddZedefd d Z edefd d Z d e ddfddZ ede eeeefe eefBdBfddZdBde deeBfddZdCd e dedefddZedefddZedefddZedefddZedefdd Zedefd!d"ZedDd$d%Zede fd&d'Zede fd(d)Zedefd*d+Zedefd,d-Zedefd.d/Z edefd0d1Z!d e d2eddfd3d4Z"dEd6d7Z#dFd:d;Z$edefdd?Z&dGd@dAZ'dS)H RunnerBasezABase class for the pixel data decoding/encoding process managers.tsyntaxrNcCs"i|_|d|d|_d|_dS)zCreate a new runner for encoding/decoding data. Parameters ---------- tsyntax : pydicom.uid.UID The transfer syntax UID corresponding to the pixel data to be decoded. transfer_syntax_uid)rk UNDEFINEDN)_opts set_option _undeletable _src_type)rrjrrrr(s  zRunnerBase.__init__cC"|jdd}dur |Std)z>Return the expected number of bits allocated used by the data.bits_allocatedNz*No value for 'bits_allocated' has been setrmrJAttributeErrorrvaluerrrrr:zRunnerBase.bits_allocatedcCrq)z;Return the expected number of bits stored used by the data. bits_storedNz'No value for 'bits_stored' has been setrsrurrrrxBrwzRunnerBase.bits_storedcCrq)z2Return the expected number of columns in the data.columnsNz#No value for 'columns' has been setrsrurrrryJrwzRunnerBase.columnsr(cCs,||jvr td|d|j|ddS)z%Delete option `name` from the runner.z Deleting 'z' is not allowedN)ror!rmpop)rr(rrr del_optionRs zRunnerBase.del_optioncCs|jddS)aRReturn the extended offsets table and lengths Returns ------- tuple[list[int], list[int]] | tuple[bytes, bytes] | None Returns the extended offsets and lengths as either lists of int or their equivalent encoded values, or ``None`` if no extended offsets have been set. extended_offsetsNrmrJr1rrrr|Ys zRunnerBase.extended_offsetsbytesunitcCs|j|j|j}|dkr|S|jdkr0|jjr#|d|ddk}n|d}|r/t|}n||jd9}|jt j krG|jjsG|dd}|S)aReturn the expected length (in number of bytes or pixels) of each frame of pixel data. Parameters ---------- unit : str, optional If ``"bytes"`` then returns the expected length of the pixel data in whole bytes and NOT including an odd length trailing NULL padding byte. If ``"pixels"`` then returns the expected length of the pixel data in terms of the total number of pixels (default ``"bytes"``). Returns ------- int | float The expected length of a single frame of pixel data in either whole bytes or pixels, excluding the NULL trailing padding byte for odd length data. For "pixels", an integer will always be returned. For "bytes", a float will be returned for images with BitsAllocated of 1 whose frames do not consist of a whole number of bytes. pixelsr r) rowsrysamples_per_pixelrrtransfer_syntaxr3 is_integerintphotometric_interpretationrXr^)rrlengthrrr frame_lengthhs    zRunnerBase.frame_lengthdefaultcCs|j||S)z&Return the value of the option `name`.r})rr(rrrr get_optionszRunnerBase.get_optioncC |jdkS)zFReturn ``True`` if the pixel data source is an :class:`~numpy.ndarray`Arrayrpr1rrris_array zRunnerBase.is_arraycCr)z4Return ``True`` if the pixel data source is BinaryIOBinaryIOrr1rrr is_binaryrzRunnerBase.is_binarycCr)z9Return ``True`` if the pixel data source is a buffer-likeBufferrr1rrr is_bufferrzRunnerBase.is_buffercCr)zOReturn ``True`` if the pixel data source is a :class:`~pydicom.dataset.Dataset`r rr1rrr is_datasetrzRunnerBase.is_datasetcCrq)z1Return the expected number of frames in the data.number_of_framesNz,No value for 'number_of_frames' has been setrsrurrrrrwzRunnerBase.number_of_framesDecodeOptions | EncodeOptionscCrB)z0Return a reference to the runner's options dict.rmr1rrroptionsrCzRunnerBase.optionscCrq)z;Return the expected photometric interpretation of the data.rNz6No value for 'photometric_interpretation' has been setrsrurrrrrwz%RunnerBase.photometric_interpretationcCrq)zReturn the expected pixel keyword of the data. Returns ------- str One of ``"PixelData"``, ``"FloatPixelData"``, ``"DoubleFloatPixelData"`` pixel_keywordNz)No value for 'pixel_keyword' has been setrsrurrrrs zRunnerBase.pixel_keywordcCrq)z5Return the expected pixel representation of the data.pixel_representationNz0No value for 'pixel_representation' has been setrsrurrrrrwzRunnerBase.pixel_representationcCs.|jdd}dur |S|jjrdStd)z5Return the expected planar configuration of the data.planar_configurationNrz0No value for 'planar_configuration' has been set)rmrJr is_compressedrtrurrrrs zRunnerBase.planar_configurationcCrq)z/Return the expected number of rows in the data.rNz No value for 'rows' has been setrsrurrrrrwzRunnerBase.rowscCrq)zReturn the expected transfer syntax corresponding to the data.rkrr1rrrr0rzRunnerBase.transfer_syntaxcCstt|jd)z5Validate the runner options and source data (if any).z$.validate() has not been implemented)NotImplementedErrorr"r#r1rrrvalidate5szRunnerBase.validatecCsd}|jddurt|dd|jkrdkr(nn |jdkr1|jdr1td|jd d |jvrd|jd durEt|d d|jkrV|jkrVdksdntd |jd|jd|jddurst|dd|jkr~dksntd|jd|jddur|jdkrtd|jd|jddurt|dzt |j Wnt y|j dkrtd|j dYnwd}|j|vrtd|jd|jdkr|jd durt|d!|j d"vrtd#|j d$|jd%durt|d&d|j krdks%ntd'|j d|jd(dur5t|d)|jd*vrDtd+|jd,|jd-kri|jd.durZt|d/|jd"vrktd0|jd$dSdS)1z?Validate the supplied options to ensure they meet requirements.zMissing required element: (0028rrNz,0100) 'Bits Allocated'r @rz)A (0028,0100) 'Bits Allocated' value of 'zF' is invalid, it must be 1 or a multiple of 8 and in the range (1, 64)Floatrxz,0101) 'Bits Stored'z&A (0028,0101) 'Bits Stored' value of 'zm' is invalid, it must be in the range (1, 64) and no greater than the (0028,0100) 'Bits Allocated' value of 'rryz,0011) 'Columns'riz"A (0028,0011) 'Columns' value of 'z0' is invalid, it must be in the range (1, 65535)rz+A (0028,0008) 'Number of Frames' value of 'z3' is invalid, it must be greater than or equal to 1rz#,0004) 'Photometric Interpretation'r[z8Unknown (0028,0004) 'Photometric Interpretation' value ') PixelDataFloatPixelDataDoubleFloatPixelDatazUnknown 'pixel_keyword' value 'rrz,0103) 'Pixel Representation')rr z/A (0028,0103) 'Pixel Representation' value of 'z' is invalid, it must be 0 or 1rz ,0010) 'Rows'zA (0028,0010) 'Rows' value of 'rz,0002) 'Samples per Pixel')r rz,A (0028,0002) 'Samples per Pixel' value of 'z' is invalid, it must be 1 or 3rrz,0006) 'Planar Configuration'z/A (0028,0006) 'Planar Configuration' value of ')rmrJrtrrr!rrxryrrXrrrrrr)rprefixkwrrr_validate_options;s  $             zRunnerBase._validate_options)r~rf)rr)rrrN)rr rN)rN)(r#rQrRrSr rrVrrrrxryrTr{r.rUr~r|floatrrrr4rrrrrrrrrrrrrnrrrrrrrrrri%s^" 5       ric@seZdZUdZeed<eed<eed<eed<eed<eed<eed<eed <eed <eed <eed <ee e fee ee efBed <dS) RunnerOptionszOptions accepted by RunnerBaserrrxryrrrrrrrkrr|N) r#rQrRrSr__annotations__rTr r.r~rUrrrrrs (rF)totalN)#rSenumrr importlibrtypingrrr pydicom.miscrpydicom.pixels.utilsr pydicom.uidr collections.abcr pydicom.datasetr pydicom.pixels.decoders.baser rpydicom.pixels.encoders.baserrr~ bytearray memoryviewrrrTrXrirrrrrs*       xy