o iȈ@sUdZddlmZmZmZddlZddlZddlZddlm Z m Z m Z zddl Z Wn ey2YnwddlmZddlmZmZmZmZddlmZmZmZmZmZmZmZmZmZm Z m!Z!e rgddl"m#Z#e$e%Z&ee'd ge'e(BfZ)Gd d d ed d Z*Gdd d eZ+GdddeZ,e-e.e/ee/ee/ee/fZ0egdegdedddde1ddfdddde1ddfdddde1ddfdddde1ddfdddde1ddfgedddde1ddfdddde1ddfdddde1ddfdddde1ddfdddde1ddfgedddde1ddfdddde1ddfdddde1ddfdddde1dd fdddde1ddfgedddde1ddfdddde1ddfdddde1dd fdddde1ddfgedddd!e1dd"fdddd!e1dd"fdddde1ddfd#ddd!e1dd"fdddd!e1dd"fdddd!e1dd"fgedddd!e1dd"fdddd!e1dd"fd$ddd!e1dd"fdddd!e1dd"fdddd!e1dd"fge dddde1ddfdddde1ddfdddde1ddfdddde1dd fdddde1ddfgi Z2e3ee4e0fe5d%<e,e Z6e67gd&e,eZ8e89d'd(e,eZ:e:9d'd(e,eZ;e;9d)d*e,eZe>d0e.d-e,fd1d2Z?dS)4zPixel data encoding.)CallableIteratorIterableN)Anycast TYPE_CHECKING)config)Buffer RunnerBase CoderBase RunnerOptions) UIDJPEGBaseline8BitJPEGExtended12Bit JPEGLosslessJPEGLosslessSV1JPEGLSLosslessJPEGLSNearLosslessJPEG2000LosslessJPEG2000 RLELosslessJPEGLSTransferSyntaxesDataset EncodeRunnerc@s:eZdZUdZeed<eed<eeed<eeed<dS) EncodeOptionsz5Options accepted by EncodeRunner and encoding plugins byteorder jls_errorj2k_crj2k_psnrN) __name__ __module__ __qualname____doc__str__annotations__intlistfloatr)r)R/mnt/sdb/aimis/docanh/lib/python3.10/site-packages/pydicom/pixels/encoders/base.pyr)s  rF)totalc@seZdZdZdeddfddZdedBdefdd ZdedBdefd d Z dedBdefd d Z dedBdee BfddZ de eefddfddZd$ddZed%ddZdefddZd&ddZd&ddZd&d d!Zd&d"d#ZdS)'ra Class for managing the pixel data encoding process. .. versionadded:: 3.0 This class is not intended to be used directly. For encoding pixel data use the :class:`~pydicom.pixels.encoders.base.Encoder` instance corresponding to the transfer syntax of the pixel data. tsyntaxreturnNcCs&|||ddd|_d|_i|_dS)zCreate a new runner for encoding data as `tsyntax`. Parameters ---------- tsyntax : pydicom.uid.UID The transfer syntax UID corresponding to the pixel data to be encoded. < PixelData)transfer_syntax_uidr pixel_keyword)r0r1rN)_opts _undeletable _encoders)selfr,r)r)r*__init__Gs  zEncodeRunner.__init__indexc Csg}|jD]0\}}z ||||WSty7}zt|||d|WYd}~qd}~wwd|}td|)alReturn an encoded frame of pixel data as :class:`bytes`. Parameters ---------- index : int | None If `index` is ``None`` then the pixel data only contains one frame, otherwise `index` is the frame number to be encoded. Returns ------ bytes The encoded pixel data frame. : Nz zGUnable to encode as exceptions were raised by all available plugins: ) r4items get_frame ExceptionLOGGER exceptionappendjoin RuntimeError)r5r7failure_messagesnamefuncexcmessagesr)r)r*encodeZs   zEncodeRunner.encodecCs0|jr||S||}t|tst|S|S)aReturn a frame's worth of uncompressed pixel data as :class:`bytes`. Parameters ---------- index : int | None If the pixel data only has one from then use ``None``, otherwise `index` is the index of the frame to be returned. )is_array_get_frame_array_get_frame_buffer isinstancebytes)r5r7framer)r)r*r:vs  zEncodeRunner.get_framecCsttj|dur |j|n|j}|jdkrd}n/d|jkr#dkr(nnd}nd|jkr3dkr8nnd}nd|jkrCdkrGnnd}|jj|krX||jj|}|j t vrn|j d krn|j dkrn| dd d}tt|S) zBReturn a frame's worth of uncompressed pixel data from an ndarray.N @r)rnpndarraysrc bits_storeddtypeitemsizeastypekindtransfer_syntaxrsamples_per_pixelplanar_configuration transposerKtobytes)r5r7arrrZr)r)r*rHs      zEncodeRunner._get_frame_arraycCsdtt|jdd}|durdn||}tt|j|||}tt|jdd}t||}|jdkr@|dkr9|S|dd|Sd|jkrKdkrsnn&|d krS|St|d }|dd||ddd <|dd||ddd <|Sd|jkr~d krnnB|d kr|St|d }|dd||ddd <|dd||ddd <|d d||d dd <|d kr|d d||d dd <|S|dkr|St|d}|dd||ddd<|dd||ddd<|d d||d dd<|d d||d dd<|d d||d dd<|d kr|S|d d||d dd<|dkr$|S|dd||ddd<|S)zCReturn a frame's worth of uncompressed pixel data from buffer-like.rKunitNrpixelsrMrNrOrPrQrRrT)rr& frame_lengthrKrWlenrX bytearray)r5r7bytes_per_framestartrWexpected_lengthbytes_per_pixeloutr)r)r*rIsN        zEncodeRunner._get_frame_bufferencoderscCs ||_dS)zSet the encoders use for encoding compressed pixel data. Parameters ---------- encoders : dict[str, EncodeFunction] A dict of {name: encoder function}. N)r4)r5rpr)r)r* set_encoderss zEncodeRunner.set_encodersrWnp.ndarray | Dataset | BuffercCsddlm}t||r|||j|_d|_d St|ttBt Br*||_d|_d St|t j rZt j dkr7dnd}|jj }|dkrC|n|}|dkrR||jd}||_d |_d Std |jjd ) aSet the pixel data to be encoded. Parameters ---------- src : bytes | bytearray | memoryview | pydicom.dataset.Dataset | numpy.ndarray * If a buffer-like then the encoded pixel data * If a :class:`~pydicom.dataset.Dataset` then a dataset containing the pixel data and associated group ``0x0028`` elements. * If a :class:`numpy.ndarray` then an array containing the image data. rrrr littler.>=ArrayzD'src' must be bytes, numpy.ndarray or pydicom.dataset.Dataset, not ''N)pydicom.datasetrrJ_set_options_dsr/_src _src_typerKrj memoryviewrUrVsysrrYr[ newbyteorder TypeError __class__r )r5rWrsys_endiannessrr)r)r* set_sources*      zEncodeRunner.set_sourceBuffer | np.ndarraycCs|jS)zKReturn the buffer-like or :class:`numpy.ndarray` containing the pixel data.)rzr5r)r)r*rW&szEncodeRunner.srccCsfd|jjdg}|d|dd|jD|jr.|d|dd|jDd|S) z)Return nice string output for the runner.zEncodeRunner for 'rwOptionscSs g|] \}}d|d|qS) r8r)).0rBvaluer)r)r* /s z(EncodeRunner.__str__..EncoderscSsg|]}d|qS)rr)rrBr)r)r*r2s )r]rBr>extendoptionsr9r4r?)r5sr)r)r*__str__+s   zEncodeRunner.__str__cCs2||js |jr|n||dS)z4Validate the encoding options and source pixel data.N)_validate_options is_dataset is_buffer_validate_buffer_validate_array_validate_encoding_profilerr)r)r*validate6s    zEncodeRunner.validatec CsBttj|j}|j}|j}t|dvrtdt|d|j|j |j |j g}|ddkr3|ddn|}|ddvrA|ddn|}|t |krUtd t |d |t |tjt |tjg}t|sotd |d |jdk}||sd dg|}td |d|jd|d|jt|jdkrtd |d|jd||}} |rd|jd } d|jdd} n dd|jd} } || ks| | krtd| d| d|jd|jtkr|r|dd} || | ko| | | k} | r| std|jd| d| | d| | d dSdSdSdS)z4Check that the ndarray matches the supplied options.)rPrTrRzUnable to encode z D ndarraysrrNN)NrNz,Mismatch between the expected ndarray shape z and the actual shape zThe ndarray's dtype 'z=' is not supported, must be a signed or unsigned integer typeunsignedsignedzB' is not consistent with a (0028,0103) 'Pixel Representation' of 'z' (z integers)rMzB' is not consistent with a (0028,0100) 'Bits Allocated' value of 'rwrPzEThe ndarray contains values that are outside the allowable range of (, z,) for a (0028,0101) 'Bits Stored' value of 'rzThe supported range of pixel values when performing lossy JPEG-LS encoding of signed integers with a (0028,0103) 'Bits Stored' value of 'z' and a 'jls_error' of 'z' is ())rrUrVrWshaperYri ValueErrornumber_of_framesrowscolumnsr^tuple issubdtypeunsignedinteger signedintegeranypixel_representationrZmathceilbits_allocatedmaxminrXr]r get_option)r5rbrrYexpectedui is_signedramaxaminminimummaximumerrorwithinr)r)r*rAs           zEncodeRunner._validate_arraycCsB|jdd}||j}t|j}|krtd|d|ddS)z(Validate the supplied pixel data buffer.rKrczNThe length of the uncompressed pixel data doesn't match the expected length - z bytes actual vs. z expectedN)rhrrirWr)r5 length_bytesractualr)r)r*rs  zEncodeRunner._validate_buffercCs|jtvrdSt|j}|D]7\}}}}}z'|j|ksJ|j|ks$J|j|vs+J|j|vs2J|j|vs9JWdStyEYqwtd|jj d|jd|jd|jd|jd|jd ) apPerform UID specific validation of encoding parameters based on Part 5, Section 8 of the DICOM Standard. Encoding profiles should be: Tuple[str, int, Iterable[int], Iterable[int], Iterable[int]] as ( PhotometricInterpretation, SamplesPerPixel, PixelRepresentation, BitsAllocated, BitsStored ) NzNOne or more of the following values is not valid for pixel data encoded with 'z$': (0028,0002) Samples per Pixel: z+ (0028,0006) Photometric Interpretation: z (0028,0100) Bits Allocated: z (0028,0101) Bits Stored: z% (0028,0103) Pixel Representation: zC See Part 5, Section 8.2 of the DICOM Standard for more information) r]ENCODING_PROFILESphotometric_interpretationr^rrrXAssertionErrorrrB)r5profilepispppx_reprbits_abits_sr)r)r*rs:   z'EncodeRunner._validate_encoding_profile)rWrrr-N)r-rr-N)r r!r"r#r r6r&rKrFr:rHrjrIdictr$EncodeFunctionrqrpropertyrWrrrrrr)r)r)r*r=s  #K )  Z c seZdZdZdeddffdd Zdddd d d d edBd edede de f ddZ dddd d d edede de e f ddZ ZS)EncoderaFactory class for data encoders. Every available ``Encoder`` instance in *pydicom* corresponds directly to a single DICOM *Transfer Syntax UID*, and provides a mechanism for converting raw unencoded source data to meet the requirements of that transfer syntax using one or more :doc:`encoding plugins `. .. versionadded:: 2.2 uidr-Ncstj|dddS)zCreate a new data encoder. Parameters ---------- uid : pydicom.uid.UID The *Transfer Syntax UID* that the encoder supports. F)decoderN)superr6)r5rrr)r*r6szEncoder.__init__T)r7rencoding_pluginrWzbytes | np.ndarray | Datasetr7rrkwargscKs|dur |dkr tdt|j}|||jdi||tttdf| |t j r5t ||r;||jdkrH|durHtd||S)aReturn an encoded frame of the pixel data in `src` as :class:`bytes`. .. warning:: With the exception of *RLE Lossless*, this method requires the installation of additional packages to perform the actual pixel data encoding. See the :doc:`encoding documentation ` for more information. Parameters ---------- src : bytes, numpy.ndarray or pydicom.dataset.Dataset Single or multi-frame pixel data as one of the following: * :class:`~numpy.ndarray`: the uncompressed pixel data, should be :attr:`shaped` as: * (rows, columns) for single frame, single sample data. * (rows, columns, planes) for single frame, multi-sample data. * (frames, rows, columns) for multi-frame, single sample data. * (frames, rows, columns, planes) for multi-frame and multi-sample data. * :class:`~pydicom.dataset.Dataset`: the dataset containing the uncompressed *Pixel Data* to be encoded. * :class:`bytes`: the uncompressed little-endian ordered pixel data. `src` should use 1, 2, 4 or 8 bytes per pixel, whichever of these is sufficient for the (0028,0103) *Bits Stored* value. index : int, optional Required when `src` contains multiple frames, this is the index of the frame to be encoded. validate : bool, optional If ``True`` (default) then validate the supplied encoding options and pixel data prior to encoding, otherwise if ``False`` no validation will be performed. encoding_plugin : str, optional The name of the pixel data encoding plugin to use. If `encoding_plugin` is not specified then all available plugins will be tried (default). For information on the available plugins for each encoder see the :mod:`API documentation`. **kwargs The following keyword parameters are required when `src` is :class:`bytes` or :class:`~numpy.ndarray`: * ``'rows'``: :class:`int` - the number of rows of pixels in `src`, maximum 65535. * ``'columns'``: :class:`int` - the number of columns of pixels in `src`, maximum 65535. * ``'number_of_frames'``: :class:`int` - the number of frames in `src`. * ``'samples_per_pixel'``: :class:`int` - the number of samples per pixel in `src`, should be 1 or 3. * ``'bits_allocated'``: :class:`int` - the number of bits used to contain each pixel, should be a multiple of 8. * ``'bits_stored'``: :class:`int` - the number of bits actually used per pixel. For example, an ``ndarray`` `src` might have a :class:`~numpy.dtype` of ``'uint16'`` (range 0 to 65535) but only contain 12-bit pixel values (range 0 to 4095). * ``'pixel_representation'``: :class:`int` - the type of data being encoded, ``0`` for unsigned, ``1`` for 2's complement (signed) * ``'photometric_interpretation'``: :class:`str` - the intended color space of the *encoded* pixel data, such as ``'YBR_FULL'``. Optional keyword parameters for the encoding plugin may also be present. See the :doc:`encoding plugin options ` for more information. Returns ------- bytes The encoded pixel data. Nrz*'index' must be greater than or equal to 0rrNzMThe 'index' of the frame to be encoded is required for multi-frame pixel datar))rrr r set_optionsrqrrr$_validate_pluginsr debuggingr<debugrrrF)r5rWr7rrrrunnerr)r)r*rFs(T     zEncoder.encode)rrckst|j}|||jdi||tttdf||t j r*t ||r0| |jdkr=|dVdSt|jD]}||VqBdS)a"Yield encoded frames of the pixel data in `src` as :class:`bytes`. .. warning:: With the exception of *RLE Lossless*, this method requires the installation of additional packages to perform the actual pixel data encoding. See the :doc:`encoding documentation ` for more information. Parameters ---------- src : bytes, numpy.ndarray or pydicom.dataset.Dataset Single or multi-frame pixel data as one of the following: * :class:`~numpy.ndarray`: the uncompressed pixel data, should be :attr:`shaped` as: * (rows, columns) for single frame, single sample data. * (rows, columns, planes) for single frame, multi-sample data. * (frames, rows, columns) for multi-frame, single sample data. * (frames, rows, columns, planes) for multi-frame and multi-sample data. * :class:`~pydicom.dataset.Dataset`: the dataset containing the uncompressed *Pixel Data* to be encoded. * :class:`bytes`: the uncompressed little-endian ordered pixel data. `src` should use 1, 2, 4 or 8 bytes per pixel, whichever of these is sufficient for the (0028,0103) *Bits Stored* value. validate : bool, optional If ``True`` (default) then validate the supplied encoding options and pixel data prior to encoding, otherwise if ``False`` no validation will be performed. encoding_plugin : str, optional The name of the pixel data encoding plugin to use. If `encoding_plugin` is not specified then all available plugins will be tried (default). For information on the available plugins for each encoder see the :mod:`API documentation`. **kwargs The following keyword parameters are required when `src` is :class:`bytes` or :class:`~numpy.ndarray`: * ``'rows'``: :class:`int` - the number of rows of pixels in `src`, maximum 65535. * ``'columns'``: :class:`int` - the number of columns of pixels in `src`, maximum 65535. * ``'number_of_frames'``: :class:`int` - the number of frames in `src`. * ``'samples_per_pixel'``: :class:`int` - the number of samples per pixel in `src`, should be 1 or 3. * ``'bits_allocated'``: :class:`int` - the number of bits used to contain each pixel, should be a multiple of 8. * ``'bits_stored'``: :class:`int` - the number of bits actually used per pixel. For example, an ``ndarray`` `src` might have a :class:`~numpy.dtype` of ``'uint16'`` (range 0 to 65535) but only contain 12-bit pixel values (range 0 to 4095). * ``'pixel_representation'``: :class:`int` - the type of data being encoded, ``0`` for unsigned, ``1`` for 2's complement (signed) * ``'photometric_interpretation'``: :class:`str` - the intended color space of the encoded pixel data, such as ``'YBR_FULL'``. Optional keyword parameters for the encoding plugin may also be present. See the :doc:`encoding plugin options ` for more information. Yields ------ bytes An encoded frame of pixel data. rrNNr))rr rrrqrrr$rrrr<rrrrFrange)r5rWrrrrr7r)r)r* iter_encodeUs( O     zEncoder.iter_encode)r r!r"r#r r6r&boolr$rrKrFrr __classcell__r)r)rr*rs@  sr) MONOCHROME1rNrrMr MONOCHROME2rNrrr) YBR_FULL_422rTrrr)RGBrTrrr)r)rrNrrO r)rrNrrrrrN)rrN)rMrOrz PALETTE COLORrYBR_FULLrTrrPr )rMrOrQ('YBR_RCTYBR_ICTr))gdcm)zpydicom.pixels.encoders.gdcmencode_pixel_data) pylibjpegz!pydicom.pixels.encoders.pylibjpeg _encode_frame)pydicom)zpydicom.pixels.encoders.nativerpyjpegls)z pydicom.pixels.encoders.pyjpeglsrrrz2.2z3.0r-csdddddtD]\\}}|j}|j}|j}t|t|}fddt|D}d|jd |d g}| d | d || d | d d || d | dd ||_ q dS)z'Override the default Encoder docstring.z':ref:`pydicom `z+:ref:`pylibjpeg `z!:ref:`gdcm `z):ref:`pyjpegls `)rrrrcsg|]}|qSr)r)rplugin_doc_linksr)r*r=sz-_build_encoder_docstrings..zA *Pixel Data* encoder for *z* - ``z``rz.. versionadded:: zEncoding plugins: rzeSee the :class:`~pydicom.pixels.encoders.base.Encoder` reference for instance methods and attributes.rN) _PIXEL_DATA_ENCODERSvaluesr _availablekeys _unavailabler'sortedrBr>r?r#)enc versionaddedr available unavailablepluginsrr)rr*_build_encoder_docstrings.s,     rrcCs8t|}zt|dWStytd|jdw)aReturn the pixel data encoder corresponding to `uid`. .. versionadded:: 2.2 +--------------------------------------------------+----------------+ | Transfer Syntax | Version added | +-------------------------+------------------------+ + | Name | UID | | +=========================+========================+================+ | *JPEG-LS Lossless* | 1.2.840.10008.1.2.4.80 | 3.0 | +-------------------------+------------------------+----------------+ | *JPEG-LS Near Lossless* | 1.2.840.10008.1.2.4.81 | 3.0 | +-------------------------+------------------------+----------------+ | *JPEG 2000 Lossless* | 1.2.840.10008.1.2.4.90 | 3.0 | +-------------------------+------------------------+----------------+ | *JPEG 2000* | 1.2.840.10008.1.2.4.91 | 3.0 | +-------------------------+------------------------+----------------+ | *RLE Lossless* | 1.2.840.10008.1.2.5 | 2.2 | +-------------------------+------------------------+----------------+ rz2No pixel data encoders have been implemented for 'rw)r rKeyErrorNotImplementedErrorrB)rr)r)r* get_encoderOs  rr)@r#collections.abcrrrloggingrr}typingrrrnumpyrU ImportErrorrrpydicom.pixels.commonr r r r pydicom.uidr rrrrrrrrrrrxr getLoggerr r<rKrjrrrrrr$r& ProfileTyperrrr'r%RLELosslessEncoder add_pluginsJPEGLSLosslessEncoder add_pluginJPEGLSNearLosslessEncoderJPEG2000LosslessEncoderJPEG2000Encoderrrrr)r)r)r*s   4  tA