HR-e> ddlZddlZddlZddlZddlZddlZddlZddlmZddl m Z ddl m Z ddl mZmZmZmZddlmZddlmZmZmZmZmZd Zejed Zeeee d d Z!d Z"ej#Z#gdZ$GddZ%ej&j'(e%ej&j)(e%GddZ*GddZ+Gddej&j,Z-GddZ.Gdde.Z/Gdde.Z0dZ1dZ2d"d Z3d!Z4dS)#N) isiterable)AstropyUserWarning) parse_header)KEYWORD_LENGTH UNDEFINEDCard_pad)_File) decode_ascii encode_asciifileobj_closedfileobj_is_binary path_likei@ zA(?:(?PEND {77}) *)|(?PEND$|END {0,76}[^A-Z0-9_-]) zPEND )HeaderzHeader.commentszHeader.fromtextfilezHeader.totextfilez Header.setz Header.updateceZdZdZgdfdZdZdZdZdZdZ d Z d Z d Z d Z d ZdZdZedZedZedZejdZedGdZedHdZedZedZedZdHdZdIdZedJdZdKdZdZ dJd Z!d!Z"d"Z#edLd$Z$dLd%Z%dMd&Z&d'Z'd(Z(d)Z)d*Z*d+Z+dLd,Z,d-Z-dNd.Z. dOd/Z/d0Z0dPd1Z1dQd2Z2dKd3Z3dJd4Z4dPd5Z5dPd6Z6dRd7Z7d8Z8ed9Z9ed:Z:d;Z;d<ZZ>dTd?Z?d@Z@dAZAdBZBdCZCdDZDdEZEdPdFZFd#S)Ura FITS header class. This class exposes both a dict-like interface and a list-like interface to FITS headers. The header may be indexed by keyword and, like a dict, the associated value will be returned. When the header contains cards with duplicate keywords, only the value of the first card with the given keyword will be returned. It is also possible to use a 2-tuple as the index in the form (keyword, n)--this returns the n-th value with that keyword, in the case where there are duplicate keywords. For example:: >>> header['NAXIS'] 0 >>> header[('FOO', 1)] # Return the value of the second FOO keyword 'foo' The header may also be indexed by card number:: >>> header[0] # Return the value of the first card in the header 'T' Commentary keywords such as HISTORY and COMMENT are special cases: When indexing the Header object with either 'HISTORY' or 'COMMENT' a list of all the HISTORY/COMMENT values is returned:: >>> header['HISTORY'] This is the first history entry in this header. This is the second history entry in this header. ... See the Astropy documentation for more details on working with headers. Notes ----- Although FITS keywords must be exclusively upper case, retrieving an item in a `Header` object is case insensitive. Fc,|t|tr|r|}|j}n)t|t r|}|D]}||dd|_dS)a= Construct a `Header` from an iterable and/or text file. Parameters ---------- cards : list of `Card`, optional The cards to initialize the header with. Also allowed are other `Header` (or `dict`-like) objects. .. versionchanged:: 1.2 Allowed ``cards`` to be a `dict`-like object. copy : bool, optional If ``True`` copies the ``cards`` if they were another `Header` instance. Default is ``False``. .. versionadded:: 1.3 TendFN) clear isinstancercopycardsdictitemsappend _modified)selfrrcards 6lib/python3.11/site-packages/astropy/io/fits/header.py__init__zHeader.__init__`s* eV $ $ " % KEE t $ $ "KKMME ( (D KK$K ' ' ' 'c*t|jSN)len_cardsr s r"__len__zHeader.__len__s4;r$c#0K|jD] }|jV dSr&r(keywordr r!s r"__iter__zHeader.__iter__s2K  D,      r$c||jvs ||jvrdS ||n#ttf$rYdSwxYwdS)NTF)_keyword_indices _rvkc_indices _cardindexKeyError IndexErrorr r-s r" __contains__zHeader.__contains__sj d+ + +w$:L/L/L 4  OOG $ $ $ $*%   55 ts,AAct|tr*dj|DS|r4fd|DSt|t rS|}|tvr$|}t|St|tr |d}n|}j |}|j ||jkr|jS|j}|t"krdS|S)Nc6g|]}tj|Sr.0cs r" z&Header.__getitem__..s "J"J"JA49Q<<"J"J"Jr$cNg|]!}tjj|"Sr:)rr()r=idxr s r"r?z&Header.__getitem__..s*QQQ4;s+,,QQQr$r)rslice __class__r( _haswildcard_wildcardmatchstrstripupper_commentary_keywords_HeaderCommentaryCardstupler3field_specifier rawkeywordrawvaluevaluer)r keyr-r!rOs` r" __getitem__zHeader.__getitem__sU c5 ! ! 9>>"J"JS9I"J"J"JKK K   s # # 9>>QQQQ8K8KC8P8PQQQ S ! ! 9))++Cyy{{222iikk-dC888 c5 ! ! !fGGG{4??3//0   +4?0J0J=   I  4 r$c||||rdSt|trot|dkrt dt|dkr|dd}}|t }n(t|dkr|\}}|t }|d}nd}d}t|t jr|j|}n5t|tr |j| |}|t }|r"||_ |||_ |j r d|_ dSdS| |||fdS)NzA Header item may be set with either a scalar value, a 1-tuple containing a scalar value, or a 2-tuple containing a scalar value and comment string.rrT) _set_slicerrKr' ValueErrorrnumbersIntegralr(r3rOcommentr_update)r rPrOrYr!s r" __setitem__zHeader.__setitem__sk ??3t , ,  F eU # # 5zzA~~ D 5zzQ!&q4w=%EUq!&w=%E? GG c7+ , , 5;s#DD U # # 5;ts334D =E  0DJ"& ~ &!% & & LL#ug. / / / / /r$ct|ts||rt|trKt|t |}|jr|jdkrt|}n||}t|D]}||=dSt|tr_tj |}|j }||j vr|j }||vrtd|dt||D]}||=dS||}|j|}|j}|j|=tj |}|j |}|||s|j |=|j6|j |j}|||s |j |j=||dd|_dS)Nr Keyword ' ' not found.F) incrementT)rrBrDrangeindicesr'stepreversedrErFr normalize_keywordr1r2r4r3r(r-removerLrM_updateindicesr)r rPrarAr!r-s r" __delitem__zHeader.__delitem__s c5 ! !" T%6%6s%;%;" #u%% 3SYY!7!78801 &w//G--c22((  II F S ! ! (--C+G$///,'!!<3<<<=== --  II Fooc""{3, K (11'0s /%g.   +(9G NN3    8&t7 C5111r$c2|dddS)N Fsependcardpaddingtostringr)s r"__repr__zHeader.__repr__s}}ue}DDDr$c*|Sr&rnr)s r"__str__zHeader.__str__}}r$cBt|t|kS)zg Two Headers are equal only if they have the exact same string representation. rFr others r"__eq__z Header.__eq__ s 4yyCJJ&&r$c\|d}|||S)NF)rG)rextend)r rwtemps r"__add__zHeader.__add__'s,yyuy%% E r$c0|||Sr&)rzrvs r"__iadd__zHeader.__iadd__,s E r$c*|Sr&)r/r)s r"_ipython_key_completions_z Header._ipython_key_completions_0rsr$c t|S)z The underlying physical cards that make up this Header; it can be looked at, but it should not be modified directly. ) _CardAccessorr)s r"rz Header.cards3s T"""r$c t|S)aS View the comments associated with each keyword, if any. For example, to see the comment on the NAXIS keyword: >>> header.comments['NAXIS'] number of data axes Comments can also be updated through this interface: >>> header.comments['NAXIS'] = 'Number of data axes' )_HeaderCommentsr)s r"commentszHeader.comments;st$$$r$cptd|jD}|r d|jd<|jdS)z Whether or not the header has been modified; this is a property so that it can also check each card for modifications--cards may have been modified directly without the header containing it otherwise knowing. c3$K|] }|jV dSr&)rr<s r" z#Header._modified..Ss$>>QQ[>>>>>>r$Tr)anyr(__dict__)r modified_cardss r"rzHeader._modifiedLsE>>$+>>>>>  .*.DM+ &}[))r$c||jd<dS)Nrr)r vals r"rzHeader._modified[s%( k"""r$rTcg}t|t}t|tr6d}d}t d}|d}d}n d}d}t }d}d } g} | t|kr|r| tj z} n7 | || } n#t$rt|} YnwxYw|| | } | t|z} | r^| d d |kr| | | tj || |r | |krg} nLn4| |d |krg} n| g} | t|k| r:| tj || ||S) a Creates an HDU header from a byte string containing the entire header data. Parameters ---------- data : str or bytes String or bytes containing the entire header. In the case of bytes they will be decoded using latin-1 (only plain ASCII characters are allowed in FITS headers but latin-1 allows us to retain any invalid bytes that might appear in malformatted FITS files). sep : str, optional The string separating cards from each other, such as a newline. By default there is no card separator (as is the case in a raw FITS file). In general this is only used in cases where a header was printed as text (e.g. with newlines after each card) and you want to create a new `Header` from it by copy/pasting. Examples -------- >>> from astropy.io.fits import Header >>> hdr = Header({'SIMPLE': True}) >>> Header.fromstring(hdr.tostring()) == hdr True If you want to create a `Header` from printed text it's not necessary to have the exact binary structure as it would appear in a FITS file, with the full 80 byte card length. Rather, each "card" can end in a newline and does not have to be padded out to a full card length as long as it "looks like" a FITS header: >>> hdr = Header.fromstring("""\ ... SIMPLE = T / conforms to FITS standard ... BITPIX = 8 / array data type ... NAXIS = 0 / number of array dimensions ... EXTEND = T ... """, sep='\n') >>> hdr['SIMPLE'] True >>> hdr['BITPIX'] 8 >>> len(hdr) 4 Returns ------- `Header` A new `Header` instance. sCONTINUEsENDasciilatin1r$CONTINUEENDrTrN)setissubsetVALID_HEADER_CHARSrbytesEND_CARDencoder'r lengthindexrVr fromstringjoinsplitrstrip _fromcards) clsdatarkrrequire_full_cardlengthrrend_cardemptyrAimageend_idx next_images r"rzHeader.fromstring_s h#&c(("3"34F"G"G dE " "  #HCw//H**X&&CEE!HCHECIIoo& ( +("jjc22GG!(((!$iiGGG(c'k*JCHH$C Abqb>X--LL,,, T_UZZ->->??@@@& ))E*##C((+2244;;ELE7CIIoo<  = LLE):):;; < < <~~e$$$s-CC C Tcd}ttrEtj|rt dnt dd} t }fd}||||||d|rSS#|rwwxYw)a} Similar to :meth:`Header.fromstring`, but reads the header string from a given file-like object or filename. Parameters ---------- fileobj : str, file-like A filename or an open file-like object from which a FITS header is to be read. For open file handles the file pointer must be at the beginning of the header. sep : str, optional The string separating cards from each other, such as a newline. By default there is no card separator (as is the case in a raw FITS file). endcard : bool, optional If True (the default) the header must end with an END card in order to be considered valid. If an END card is not found an `OSError` is raised. padding : bool, optional If True (the default) the header will be required to be padded out to a multiple of 2880, the FITS header block size. Otherwise any padding, or lack thereof, is ignored. Returns ------- `Header` A new `Header` instance. Fr)encodingrbTc3HK |}|r|VndSr&)read)nbytesrfileobjs r" block_iterz#Header.fromfile..block_iter s:"<<//D"  r$r) rrospath expanduseropenr _from_blocksclose)rrrkrlrm close_file is_binaryrs ` r"fromfilezHeader.fromfilesB gy ) ) g((11G .w:::w--J )'22I     ##J 3QQRST   z   s 2B))CcP|}t|D]\}}|j|tj|j}|j|||j%|j|j |d|_ |SNF) enumerater(rr rdr-r1rLr2rMr)rrheaderrAr!r-s r"rzHeader._fromcardss"5)) B BIC M  & & &,T\::G  #G , 3 3C 8 8 8#/$T_5<> Iu   |E22 3 3 3  V        ,$U++) ,,WW[)) z#4fwWWWW 6V 6 6455 53>>*#>>>>>sAA!;C CCct|D]%}||zdkr|dr|}||dz||zdz }|rPt |d}tjd |tn#tjdtdt|d|ttz||ttzdz}d |fcSd |fS) z Utility method to search a header block for the END card and handle invalid END cards. This method can also returned a modified copy of the input header block in case an invalid end card needs to be sanitized. rinvalidubz]Unexpected bytes trailing END keyword: {}; these bytes will be replaced with spaces on write.zMissing padding to end of the FITS block after the END keyword; additional spaces will be appended to the file upon writing to pad out to z bytes.NTF) HEADER_END_REfinditerstartgrouprreprlstripwarningswarnformatr BLOCK_SIZEr rr')rrcard_lenmooffsettrailings r"rzHeader._find_end_cardksl ((//$ $ BxxzzH$))xx ""  !fx.?!.C!CDKKMM#H~~44T::HMGGMvhGWGW*MS?ISSS+ '6'N"8,,-FS]]24456 ;   e|r$cZg}|jD]P}t|}|r=||dtj|tjd}|=Q||}|r||t dzz }|r"|dtt|zz }|S)a Returns a string representation of the header. By default this uses no separator between cards, adds the END card, and pads the string with spaces to the next multiple of 2880 bytes. That is, it returns the header exactly as it would appear in a FITS file. Parameters ---------- sep : str, optional The character or string with which to separate cards. By default there is no separator, but one could use ``'\\n'``, for example, to separate each card with a new line endcard : bool, optional If True (default) adds the END card to the end of the header string padding : bool, optional If True (default) pads the string with spaces out to the next multiple of 2880 characters Returns ------- str A string representing a FITS header. Nr ) r(rFrr rrr _pad_lengthr')r rkrlrmlinesr!ss r"rozHeader.tostrings8K % %DD A % Q}}-...dkmm$ % HHUOO  # tE{{" "A  + {3q66*** *Ar$czt|}t|tst|d|} ||||}t |}|rVt ||zdkr@t dt ||z tzt| | | d| |r| dSdS#|r| wwxYw)a Writes the header to file or file-like object. By default this writes the header exactly as it would be written to a FITS file, with the END card included and padding to the next multiple of 2880 bytes. However, aspects of this may be controlled. Parameters ---------- fileobj : path-like or file-like, optional Either the pathname of a file, or an open file handle or file-like object. sep : str, optional The character or string with which to separate cards. By default there is no separator, but one could use ``'\\n'``, for example, to separate each card with a new line endcard : bool, optional If `True` (default) adds the END card to the end of the header string padding : bool, optional If `True` (default) pads the string with spaces out to the next multiple of 2880 characters overwrite : bool, optional If ``True``, overwrite the output file if it exists. Raises an ``OSError`` if ``False`` and the output file exists. Default is ``False``. ostream)mode overwriterjrz6Header size ({}) is not a multiple of block size ({}).rN) rrr rorr'rrrflushwriterr) r rrkrlrmrrrrs r"tofilez Header.tofiles8@$G,, '5)) JG)yIIIG ]]sGW]MMF +C 0 0  3v;;)::a??LSSF &77*Dj MMOOO MM&--00 1 1 1 MMOOO    z   s CD!!D:c4||d|dS)a  Read a header from a simple text file or file-like object. Equivalent to:: >>> Header.fromfile(fileobj, sep='\n', endcard=False, ... padding=False) See Also -------- fromfile riFrj)r)rrrls r" fromtextfilezHeader.fromtextfiles||Gw|NNNr$c:||d|d|dS)a Write the header as text to a file or a file-like object. Equivalent to:: >>> Header.tofile(fileobj, sep='\n', endcard=False, ... padding=False, overwrite=overwrite) See Also -------- tofile riF)rkrlrmrN)r)r rrlrs r" totextfilezHeader.totextfiles4 w      r$cg|_tjt|_tjt|_dS)z3 Remove all cards from the header. N)r( collections defaultdictlistr1r2r)s r"rz Header.clears7 + 7 = =(4T::r$cz|d|jD}|r||S)a Make a copy of the :class:`Header`. .. versionchanged:: 1.3 `copy.copy` and `copy.deepcopy` on a `Header` will call this method. Parameters ---------- strip : bool, optional If `True`, strip any headers that are specific to one of the standard HDU types, so that this header can be used in a different HDU. Returns ------- `Header` A new :class:`Header` instance. c3>K|]}tj|VdSr&r;)r=r!s r"rzHeader.copy..;s*EETYt__EEEEEEr$)rCr(rG)r rGtmps r"rz Header.copy's@(nnEEEEEEE   IIKKK r$c*|Sr&r;r)s r"__copy__zHeader.__copy__@yy{{r$c*|Sr&r;)r argskwargss r" __deepcopy__zHeader.__deepcopy__Crr$Nc|}t|ts|f}|D]}||f|z|S)au Similar to :meth:`dict.fromkeys`--creates a new `Header` from an iterable of keywords and an optional default value. This method is not likely to be particularly useful for creating real world FITS headers, but it is useful for testing. Parameters ---------- iterable Any iterable that returns strings representing FITS keywords. value : optional A default value to assign to each keyword; must be a valid type for FITS keywords. Returns ------- `Header` A new `Header` instance. )rrKr)riterablerOdrPs r"fromkeyszHeader.fromkeysFsW. CEE%'' HE % %C HHcVe^ $ $ $ $r$cF ||S#ttf$r|cYSwxYw)a~ Similar to :meth:`dict.get`--returns the value associated with keyword in the header, or a default value if the keyword is not found. Parameters ---------- key : str A keyword that may or may not be in the header. default : optional A default value to return if the keyword is not found in the header. Returns ------- value: str, number, complex, bool, or ``astropy.io.fits.card.Undefined`` The value associated with the given keyword, or the default value if the keyword is not in the header. r4r5r rPdefaults r"getz Header.getds:( 9 *%   NNN s    ct|tkrAtj|r"||jvrt|||}|j}n|}|tvre||vra| |j|}|||}||f||<||;|j | |}| |||ddSdS||| |||f||dS||f||<dS)a Set the value and/or comment and/or position of a specified keyword. If the keyword does not already exist in the header, a new keyword is created in the specified position, or appended to the end of the header if no position is specified. This method is similar to :meth:`Header.update` prior to Astropy v0.1. .. note:: It should be noted that ``header.set(keyword, value)`` and ``header.set(keyword, value, comment)`` are equivalent to ``header[keyword] = value`` and ``header[keyword] = (value, comment)`` respectively. New keywords can also be inserted relative to existing keywords using, for example:: >>> header.insert('NAXIS1', ('NAXIS', 2, 'Number of axes')) to insert before an existing keyword, or:: >>> header.insert('NAXIS', ('NAXIS1', 4096), after=True) to insert after an existing keyword. The only advantage of using :meth:`Header.set` is that it easily replaces the old usage of :meth:`Header.update` both conceptually and in terms of function signature. Parameters ---------- keyword : str A header keyword value : str, optional The value to set for the given keyword; if None the existing value is kept, but '' may be used to set a blank value comment : str, optional The comment to set for the given keyword; if None the existing comment is kept, but ``''`` may be used to set a blank comment before : str, int, optional Name of the keyword, or index of the `Card` before which this card should be located in the header. The argument ``before`` takes precedence over ``after`` if both specified. after : str, int, optional Name of the keyword, or index of the `Card` after which this card should be located in the header. NT)beforeafterreplacer r ) r'rr _keywd_FSC_REmatchr1r-rIrr(r3_relativeinsert) r r-rOrYr r new_card new_keywordr!s r"rz Header.set}s6z LLN * *"((11 +t444GUG44H"*KK!K 2 2 2{d7J7J-0}W "G,DM!U%6{4??7#;#;<$$T&t$TTTTT&7%6 5#4  '5'!:6QV W W W W W"G,DMMMr$c#bK|jD]$}|j|jtkrdn|jfV%dS)zLike :meth:`dict.items`.N)r(r-rOrr.s r"rz Header.itemssMK P PD, i(?(?TZO O O O O P Pr$c#0K|jD] }|jV dS)zv Like :meth:`dict.keys`--iterating directly over the `Header` instance has the same behavior. Nr,r.s r"keysz Header.keyss4 K  D,      r$c#TK|jD]}|jtkrdn|jVdS)zLike :meth:`dict.values`.N)r(rOrr.s r"valuesz Header.valuessFK B BD* 11$$tz A A A A B Br$c&t|dkrtdt|t|dkrd}n|d} ||}n3#ttf$rt|dkr |dcYSwxYw||=|S)z Works like :meth:`list.pop` if no arguments or an index argument are supplied; otherwise works like :meth:`dict.pop`. rSz-Header.pop expected at most 2 arguments, got rr)r' TypeErrorr4r5)r rrPrOs r"popz Header.pops t99q==WCPTIIWWXX X t99>>CCq'C IEE*%   4yyA~~Aw   I sA,B  B c t|\}}n#t$rtdwxYw||=||fS)z Similar to :meth:`dict.popitem`.zHeader is empty)rrrr4)r kvs r"popitemzHeader.popitems\ . %%DAqq . . .,-- - . G!t s $'AcP ||S#ttf$r|||<YnwxYw|S)z#Similar to :meth:`dict.setdefault`.rrs r" setdefaultzHeader.setdefaultsC 9 *%   DIII s  ##c|r |d}nd}fd}|nWt|tr!|jD]}|n!t |dr'|D]\}}|||nt |dr*|D]}||||nt|D]\}}t|tr|0t|tr:dt|cxkrdkr nnt|td ||r |dSdS) a Update the Header with new keyword values, updating the values of existing keywords and appending new keywords otherwise; similar to `dict.update`. `update` accepts either a dict-like object or an iterable. In the former case the keys must be header keywords and the values may be either scalar values or (value, comment) tuples. In the case of an iterable the items must be (keyword, value) tuples or (keyword, value, comment) tuples. Arbitrary arguments are also accepted, in which case the update() is called again with the kwargs dict as its only argument. That is, :: >>> header.update(NAXIS1=100, NAXIS2=100) is equivalent to:: header.update({'NAXIS1': 100, 'NAXIS2': 100}) .. warning:: As this method works similarly to `dict.update` it is very different from the ``Header.update()`` method in Astropy v0.1. Use of the old API was **deprecated** for a long time and is now removed. Most uses of the old API can be replaced as follows: * Replace :: header.update(keyword, value) with :: header[keyword] = value * Replace :: header.update(keyword, value, comment=comment) with :: header[keyword] = (value, comment) * Replace :: header.update(keyword, value, before=before_keyword) with :: header.insert(before_keyword, (keyword, value)) * Replace :: header.update(keyword, value, after=after_keyword) with :: header.insert(after_keyword, (keyword, value), after=True) See also :meth:`Header.set` which is a new method that provides an interface similar to the old ``Header.update()`` and may help make transition a little easier. rNct|tst||}n=dt|cxkrdkrnnt|f|z}nt d|z|dS)NrrSzHeader update value for key %r is invalid; the value must be either a scalar, a 1-tuple containing the scalar value, or a 2-tuple containing the value and a comment string.)rrKr r'rVrZ)rrr!r s r"update_from_dictz'Header.update..update_from_dictVsa'' AqzzSVVqqdQh( ADEE LL     r$rrrrzHeader update sequence item #{} is invalid; the item must either be a 2-tuple containing a keyword and value, or a 3-tuple containing a keyword, value, and comment string.)rrrrZhasattrrrrr rKr'rVrupdate) r rrrwr%r!rrrAs ` r"r'z Header.update sH  GEEE      =  v & &   # # T"""" # UG $ $   ' '1  A&&&& ' UF # # ZZ\\ . .  E!H---- .'u--   TdD)) LL&&&&e,,!c$ii2D2D2D2D12D2D2D2D2DLLt----$@AGs   KK       r$c"t|trt|}ngt|tr t|}nH|t}n7t|ts"t d||s |jrd}|r2|j|t|jdz }nt|jdz }|dkr/|j|jr|dz}|dkr|j|j|sQ|j tvrC|dkr=|j|j tvr$|dz}|dkr|j|j tv$|dz }|j ||| |tj|j }|j|||j%|j|j||s|s-|j tvr|j||rP|r<|tt|tjzd|_dS)a< Appends a new keyword+value card to the end of the Header, similar to `list.append`. By default if the last cards in the Header have commentary keywords, this will append the new keyword before the commentary (unless the new keyword is also commentary). Also differs from `list.append` in that it can be called with no arguments: In this case a blank card is appended to the end of the Header. In the case all the keyword arguments are ignored. Parameters ---------- card : str, tuple A keyword or a (keyword, value, [comment]) tuple representing a single header card; the comment is optional in which case a 2-tuple may be used useblanks : bool, optional If there are blank cards at the end of the Header, replace the first blank card so that the total number of cards in the Header does not increase. Otherwise preserve the number of blank cards. bottom : bool, optional If True, instead of appending after the last non-commentary card, append after the last non-blank card. end : bool, optional If True, ignore the useblanks and bottom options, and append at the very end of the Header. NzgThe value appended to a Header must be either a keyword or (keyword, value, [comment]) tuple; got: {!r}Trr)rrFr rKrVris_blankr(rr'r-rIinsertrfrdr1rLr2rMsort _countblanks _useblanksrr)r r! useblanksbottomrrAr-s r"rz Header.appendsD dC ::DD e $ $ ;DD \66DDD$'' ??Evd||   t} C  % K  t $ $ $dk""Q&CCdk""Q&C((t{3/8(q((t{3/8( dl2FFFQhh4;s#3#;?S#S#S1HCQhh4;s#3#;?S#S#S 1HC K  sD ) ) )    $ $ $(66 g&--c222   +  t / 6 6s ; ; ; ? 6dl.BBB%g.33555 ?T..00 ? CII$+ =>>>r$c @||} |r| t|r|jdj} nd} g} t | jD]\} } | j}|tvr|r|s||vr|rx| dkrF|rD|dkr| dks |dkr | dkr|d=|d| [| j | j f||<m||vr| j | j f||<| | | | |s|rP||vrL| j r| | ||D]}|| j krn| | | | | D]} | | |||dS)a Appends multiple keyword+value cards to the end of the header, similar to `list.extend`. Parameters ---------- cards : iterable An iterable of (keyword, value, [comment]) tuples; see `Header.append`. strip : bool, optional Remove any keywords that have meaning only to specific types of HDUs, so that only more general keywords are added from extension Header or Card list (default: `True`). unique : bool, optional If `True`, ensures that no duplicate keywords are appended; keywords already in this header are simply discarded. The exception is commentary keywords (COMMENT, HISTORY, etc.): they are only treated as duplicates if their values match. update : bool, optional If `True`, update the current header with the values and comments from duplicate keywords in the input header. This supersedes the ``unique`` argument. Commentary keywords are treated the same as if ``unique=True``. update_first : bool, optional If the first keyword in the header is 'SIMPLE', and the first keyword in the input header is 'XTENSION', the 'SIMPLE' keyword is replaced by the 'XTENSION' keyword. Likewise if the first keyword in the header is 'XTENSION' and the first keyword in the input header is 'SIMPLE', the 'XTENSION' keyword is replaced by the 'SIMPLE' keyword. This behavior is otherwise dumb as to whether or not the resulting header is a valid primary or extension header. This is mostly provided to support backwards compatibility with the old ``Header.fromTxtFile`` method, and only applies if ``update=True``. useblanks, bottom, end : bool, optional These arguments are passed to :meth:`Header.append` while appending new cards to the header. rNSIMPLEXTENSION)r.r/r) rCrGr'r(r-rrrIr*rOrYrr))r rrGuniquer' update_firstr.r/rr{first extend_cardsrAr!r-rOs r"rzz Header.extends'l~~e$$   JJLLL t99 KN*EEE  "4:..# .# .IClG222.&.W__.axxLx$x//EZ4G4G#z11ex6G6G $Q KK40000-1Z,FDMM D)-T\(BW $++D1111 ''---- .f .'T//}!$++D111 !%g22 DJ..!E/%++D111 ''----  K KD KK &cK J J J J K Kr$ctj|}||jvrtd|dt |j|S)a Returns the count of the given keyword in the header, similar to `list.count` if the Header object is treated as a list of keywords. Parameters ---------- keyword : str The keyword to count instances of in the header Keyword not found.)r rdr1r4r'r6s r"countz Header.countEsT(11 $/ / /L    $ $ $        ; OOCD NNdk9 : : :r$ctj|}||jvrB||j|d=|r(||jvr!||j|d=||jvdSdSdS|std|ddS)a Removes the first instance of the given keyword from the header similar to `list.remove` if the Header object is treated as a list of keywords. Parameters ---------- keyword : str The keyword of which to remove the first instance in the header. ignore_missing : bool, optional When True, ignores missing keywords. Otherwise, if the keyword is not present in the header a KeyError is raised. remove_all : bool, optional When True, all instances of keyword will be removed. Otherwise only the first instance of the given keyword is removed. rr]r^N)r rdr1r4)r r-ignore_missing remove_alls r"rez Header.removes&(11 d+ + +T*73A67 @!666T27;A>?!66666 @ @66 > >r$ctj|}tj|}|dkrtd|tvs |tvr"|tvr |tvstdn|s||vrtd|d||}|j|}||=||||j|jfdS)a Rename a card's keyword in the header. Parameters ---------- oldkeyword : str or int Old keyword or card index newkeyword : str New keyword force : bool, optional When `True`, if the new keyword already exists in the header, force the creation of a duplicate keyword. Otherwise a `ValueError` is raised. rzCan not rename to CONTINUEz=Regular and commentary keys can not be renamed to each other.zIntended keyword z already exists in header.N) r rdrVrIrr(r*rOrY)r oldkeyword newkeywordforceoldnewrAr!s r"rename_keywordzHeader.rename_keywords"$Z00$Z00 *  9:: : & & E*E*E///C;O4O4O S5P R3$;;PPPPQQ Qjjoo{3 I C#tz4<899999r$c8|d|||dS)a% Add a ``HISTORY`` card. Parameters ---------- value : str History text to be added. before : str or int, optional Same as in `Header.update` after : str or int, optional Same as in `Header.update` HISTORYrN_add_commentaryr rOr r s r" add_historyzHeader.add_history' YfEJJJJJr$c8|d|||dS)a Add a ``COMMENT`` card. Parameters ---------- value : str Text to be added. before : str or int, optional Same as in `Header.update` after : str or int, optional Same as in `Header.update` COMMENTrNrLrNs r" add_commentzHeader.add_comment/rPr$c8|d|||dS)a! Add a blank card. Parameters ---------- value : str, optional Text to be added. before : str or int, optional Same as in `Header.update` after : str or int, optional Same as in `Header.update` rTrNrLrNs r" add_blankzHeader.add_blank@s' RvUCCCCCr$c |dd}|dd}t|D],}|dt|dzzd-dD]>}t|D],}||t|dzzd-?dD]}||dd S) z Strip cards specific to a certain kind of header. Strip cards like ``SIMPLE``, ``BITPIX``, etc. so the rest of the header can be used to reconstruct another kind of header. NAXISrTFIELDSrT)rA) TFORMTSCALTZEROTNULLTTYPETUNITTDISPTDIMTHEAPTBCOL) r1r2BITPIXrWEXTENDPCOUNTGCOUNTGROUPSBSCALEBZEROrXN)r r`rerF)r naxistfieldsrAnames r"rGz Header.stripQs!$$((9a((<< E EC KK#cAg,,.tK D D D D  F FDW~~ F F D3sQw<</ EEEE F  3 3D KKTK 2 2 2 2 3 3r$c t|SzX Return the size (in bytes) of the data portion following the `Header`. _hdr_data_sizer)s r" data_sizezHeader.data_size d###r$c4|j}|t|zSzr Return the size (in bytes) of the data portion following the `Header` including padding. rqrr sizes r"data_size_paddedzHeader.data_size_padded ~k$''''r$c|\}}}|}|dr |dd}|tvrK||jvrB|j|d}|j|}||_|||_|jr d|_dSdS|tvr| ||}||jvr_| |t|dz d}|p|p| }t|D]} | |dz| | dS|D]} || d dS||dS) as The real update code. If keyword already exists, its value and/or comment will be updated. Otherwise a new card will be appended. This will not create a duplicate keyword except in the case of commentary cards. The only other way to force creation of a duplicate is to use the insert(), append(), or extend() methods. z HIERARCH NrTrr)rr<)r.)r/)rGrH startswithrIr1r(rOrYr_splitcommentaryrr'rcr*r) r r!r-rOrYrA existing_cardrisblankr>s r"rZzHeader._updates#'--//''))   k * * "abbkG . . .7d>S3S3S'03C K,M"'M "(/ %& &!% & & , , ,))'599E$///jjD A BjGG&:%:7;!%EEAKKa7{KDDDDEE00AKK$K////00 KK     r$ct|tr|}d}nt|tjrL|dkr|t |jz }|dks|t |jkrt d|St|tr|St|trct |dks;t|dtr t|dtjstd|\}}ntdtj |}|j |d}|rL|sJt |tksd|vrtd |d |j |d}|std |d  ||S#t $r$t d t |d |d wxYw)z@Returns an index into the ._cards list given a valid lookup key.rzHeader index out of range.rSrzSTuple indices must be 2-tuples consisting of a keyword string and an integer index.zAHeader indices must be either a string, a 2-tuple, or an integer.N.r8r9zThere are only rz cards in the header.)rrFrWrXr'r(r5rBrKrVr rdr1r rr4r2)r rPr-nras r"r3zHeader._cardindexs+ c3   GAA W- . . Qwws4;'''Qww#T[!1!111 !=>>>J U # # J U # # CA !#a&#..!#a&'*:;;!;JGQQS (11'++GT::  @7 @7||n,,w@'@@@AAA,00$?? >.get_insertion_idxsX<)9:: # C $4$444ool33"~qJr$rr)r3r-r'r(rIrcr}r*) r r!r r r rold_idx insertion_idxrArr>rs ` ` @r"rzHeader._relativeinsertsX > LL!L          oodl33G--//MDK 0 000WDK@P@PST@T5T5T!ma///F0"w-'?'?W  !! 7* * *T2247DGDDEEEEFE  A KKQ      r$c|t|jkrdS|rdnd}|j|jfD]D}|D]-}t |D]\}}||kr||xx|z cc<.EdS)z For all cards with index above idx, increment or decrement its index value in the keyword_indices dict. Nrr)r'r(r1r2rr)r rAr_ index_setsrajdx keyword_indexs r"rfzHeader._updateindicesAs T[!! ! ! F"*AA 0$2DE 2 2J%,,.. 2 2*3G*<*<22&C$++ 1 2 2 2 2r$ctdt|jD]}|j| js|dz cSdS)z;Returns the number of blank cards at the end of the Header.rr)r`r'r(r)r rAs r"r,zHeader._countblanksRsPC ,,--  C;t$- Qw qr$cZt|D]}|jdjr|d=dSdS)Nr)r`r(r))r r:_s r"r-zHeader._useblanksYsBu  A{2' HH   r$cft|to|dpd|vpd|vS)z?Return `True` if the input keyword contains a wildcard pattern....*?)rrFendswithr6s r"rDzHeader._haswildcard`s<'3''   U # # Gsg~ G r$c|dddd}|dddz}tj|tjjfdt |jDS) z Returns a list of indices of the cards matching the given wildcard pattern. * '*' matches 0 or more characters * '?' matches a single character * '...' matches 0 or more of any non-whitespace character rz.*rrrz\S*$c:g|]\}}|j|Sr:)r-)r=ir! match_patterns r"r?z)Header._wildcardmatch..rs.WWWga==;V;VWWWWr$)r recompileIrrr()r patternrs @r"rEzHeader._wildcardmatchfsz//#u--55c4@@//%0036 7BD117 WWWW4;!7!7WWWWr$ct|ts||rt|tr*t|t |}n||}t|tst|s"tj |t |}t||D] \}}|||< dSdS)zT Used to implement Header.__setitem__ and CardAccessor.__setitem__. TF) rrBrDr`rar'rErFr itertoolsrzip)r rPrOtargetrarArs r"rUzHeader._set_slicets c5 ! ! T%6%6s%;%; #u%% 3S[[!9!9:--c22%%% >Z->-> >!(G ==// " "S!s 4ur$c Ptjtz }t|}t ||krt||g}n]d}g}|t |krF|t|||||z||z }|t |kF|S)a* Given a commentary keyword and value, returns a list of the one or more cards needed to represent the full value. This is primarily used to create the multiple commentary cards needed to represent a long value that won't fit into a single commentary card. r)r rrrFr'r)r r-rOmaxlenvaluestrrrAs r"r}zHeader._splitcommentarys~-u:: x==F " "'5))*EECEH %% T'8C#,4F+GHHIIIv H %% r$cP|||||f||dS|||<dS)z Add a commentary card. If ``before`` and ``after`` are `None`, add to the last occurrence of cards of the same name (except blank card). If there is no card (or blank card), append at the end. Nr)r)r rPrOr r s r"rMzHeader._add_commentarysA  !2  #ufE J J J J JDIIIr$rT)rTTT)rTTTF)F)FFr&)NNNN)NTFF)TFFFTFF)NN)TF)rTNN)NNFT)G__name__ __module__ __qualname____doc__r#r*r/r7rQr[rgrprrrxr|r~rpropertyrrrsetter classmethodrrrrrrorrrrrrrrr rrrrrr r"r'rrzr:rr*rerIrOrSrUrGrqrxrZr3rrrfr,r-rDrErUr}rMr:r$r"rr7sz&&P e!!!!F      >(0(0(0T888tEEE''' ##X#%%X%  * *X *)))r%r%r%[r%hA A A [A F  [ C?C?[C?J..[.`****X4 4 4 4 l O O O[ O    ";;;2[:2T-T-T-T-lPPP BBB .p p p dWWWWx kKkKkKkKZ333(#P#P#P#PJ^^^^@>>>>8":":":":HKKKK"KKKK"DDDD"131313f$$X$ ((X('''R555n$9 9 9 9 v2222"   X X X(4      r$rc&eZdZdZddZdZdZdS)_DelayedHeaderz Descriptor used to create the Header object from the header string that was stored in HDU._header_str when parsing the file. Nc |jdS#t$rb|j't|j}d|_n%t dt |jd||jd<|cYSwxYw)N_header'z#' object has no attribute '_header')rr4 _header_strrrAttributeErrortyper)r objownerhdrs r"__get__z_DelayedHeader.__get__s < * *   *''88"&$OS *OOO'*CL #JJJ s A)A;:A;c||jd<dSNrr)r rrs r"__set__z_DelayedHeader.__set__s"% Yr$c|jd=dSrr)r rs r" __delete__z_DelayedHeader.__delete__s L # # #r$r&)rrrrrrrr:r$r"rrsP    &&&$$$$$r$rceZdZdZdZdZdS)_BasicHeaderCardsa& This class allows to access cards with the _BasicHeader.cards attribute. This is needed because during the HDU class detection, some HDUs uses the .cards interface. Cards cannot be modified here as the _BasicHeader object will be deleted once the HDU object is created. c||_dSr&)rr rs r"r#z_BasicHeaderCards.__init__s  r$c|jj|} |jj|S#t$r:|jj|}t j|}||jj|<|cYSwxYwr&)r_keysr(r4 _raw_cardsr rr rPcardstrr!s r"rQz_BasicHeaderCards.__getitem__syk$ ;%c* *   k,S1G?7++D&*DK s #KKK  s&AA*)A*N)rrrrr#rQr:r$r"rrs<     r$rcreZdZdZdZdZdZdZdZe dZ e dZ e d Z d S) _BasicHeaderaTThis class provides a fast header parsing, without all the additional features of the Header class. Here only standard keywords are parsed, no support for CONTINUE, HIERARCH, COMMENT, HISTORY, or rvkc. The raw card images are stored and parsed only if needed. The idea is that to create the HDU objects, only a small subset of standard cards is needed. Once a card is parsed, which is deferred to the Card class, the Card object is kept in a cache. This is useful because a small subset of cards is used a lot in the HDU creation process (NAXIS, XTENSION, ...). c||_t||_i|_t ||_d|_dSr)rrrrr(rrr)r rs r"r#z_BasicHeader.__init__sC%**,,''  't,, r$ct|tjr |j|} |j|jS#t $r5|j|}tj |x|j|<}|jcYSwxYwr&) rrWrXrr(rOr4rr rrs r"rQz_BasicHeader.__getitem__s c7+ , , "*S/C ;s#) )   oc*G&*og&>&> >DK t:     s;.Ms(>>Qa>>>>>>r$)rrr(r)s r"rpz_CardAccessor.__repr__Ls(yy>>$,*=>>>>>>r$c4t|jjSr&)r'rr(r)s r"r*z_CardAccessor.__len__Os4<&'''r$c4t|jjSr&)rrr(r)s r"r/z_CardAccessor.__iter__RsDL'(((r$ct|rt|trt|dkr|g}ndSt dt j||DS)NrFc3(K|] \}}||kVdSr&r:)r=abs r"rz'_CardAccessor.__eq__..^s*IIda16IIIIIIr$)rrrFr'allr zip_longestrvs r"rxz_CardAccessor.__eq__Usl%   Juc$:$: 4yyA~~uIIi&;D%&H&HIIIIIIr$c||k Sr&r:rvs r"__ne__z_CardAccessor.__ne__`sEM""r$ct|ts|j|r ||j|S|j|}|jj|Sr&)rrBrrDrCr3r()r itemrAs r"rQz_CardAccessor.__getitem__csi dE " " 6dl&?&?&E&E 6>>$,t"455 5l%%d++|"3''r$ct|ts|j|rt|tr*t |t |}n|j|}t|tst|s"tj |t |}t||D] \}}|||< dSdS)z Helper for implementing __setitem__ on _CardAccessor subclasses; slices should always be handled in this same way. TF) rrBrrDr`rar'rErFrrrr)r rrOrarArs r" _setslicez_CardAccessor._setslicejs dE " " dl&?&?&E&E $&& <c$ii!8!89,55d;;%%% >Z->-> >!(G ==//  SS 4ur$N) rrrrr#rpr*r/rxrrQrr:r$r"rr=s???((())) J J J###(((r$rc4eZdZdZdZdZfdZdZxZS)raa A class used internally by the Header class for the Header.comments attribute access. This object can be used to display all the keyword comments in the Header, or look up the comments on specific keywords. It allows all the same forms of keyword lookup as the Header class itself, but returns comments instead of values. c#:K|jjD] }|jV dSr&)rr(rYr.s r"r/z_HeaderComments.__iter__s5L'  D,      r$ct|jjD]$}tt |j%dfd|jjDS)z9Returns a simple list of all keywords and their comments.ric3\K|]&}d|j|jV'dS)z {:>{len}} {})r'N)rr-rY)r=r>keyword_lengths r"rz+_HeaderComments.__repr__..sP    " "19ai^ " L L      r$)rrr(maxr'r-r)r r!rs @r"rpz_HeaderComments.__repr__sz'L' D DD T\1B1BCCNNyy    \(      r$ct|}t|tr|S|jS)z Slices and filter strings return a new _HeaderComments containing the returned cards. Otherwise the comment of a single card is returned. )superrQrrrY)r rrCs r"rQz_HeaderComments.__getitem__s; ww""4(( dO , , K|r$c|j|||rdS|j|}|j|}||f|j|<dS)z Set/update the comment on specified card or cards. Slice/filter updates work similarly to how Header.__setitem__ works. N)rrUr3)r rrYrArOs r"r[z_HeaderComments.__setitem__s_ < " "4$ 7 7  Fl%%d++ S!"G, Sr$) rrrrr/rprQr[ __classcell__rCs@r"rr|so         - - - - - - -r$rcBeZdZdZd fd ZdZdZdZdZdZ xZ S) rJz This is used to return a list-like sequence over all the values in the header for a given commentary keyword, such as HISTORY. rTct|||_|j|j|_t |j|j|_dSr&) rr#_keywordrr:_countrBra_indices)r rr-rCs r"r#z_HeaderCommentaryCards.__init__s`     l((77 dk**224;?? r$c8tt|jSr&)r'r`rr)s r"r*z_HeaderCommentaryCards.__len__s5$-()))r$c#XKt|jD]}|j|j|fVdSr&)r`rrrrs r"r/z_HeaderCommentaryCards.__iter__sC$-( 5 5C, s34 4 4 4 4 5 5r$c@dd|DS)Nric34K|]}t|VdSr&ru)r=xs r"rz2_HeaderCommentaryCards.__repr__..s(..AQ......r$)rr)s r"rpz_HeaderCommentaryCards.__repr__s#yy........r$czt|trA||j|j}||j|_|St|tj st|jdtt|j|}|j|j|fS)Nz index must be an integer) rrBrCrrrarrrWrXrVrr`)r rArs r"rQz"_HeaderCommentaryCards.__getitem__s c5 ! ! Jt|T];;AT[11AJHC!122 J HHHII I5$-())#.|T]C011r$cd|j|||rdS||j|j|f<dS)z Set the value of a specified commentary card or cards. Slice/filter updates work similarly to how Header.__setitem__ works. N)rrUr)r rrOs r"r[z"_HeaderCommentaryCards.__setitem__s@ < " "4 5 5  F/4 dmT*+++r$r) rrrrr#r*r/rprQr[rrs@r"rJrJs @@@@@@***555/// 2 2 2 4 4 4 4 4 4 4r$rJc`tt|ttjzdz zzS)zg Determine the size of a FITS header block if a non-blank separator is used between cards. r)rr'r rrs r"rrs& SZ4;%>%BC DDr$c6t|tzz tzS)z?Bytes needed to pad the input stringlen to the next FITS block.)r) stringlens r"rrs )j0 1Z ??r$Tc|r|ddkrs|rA|ddkr(tjdtt tjdt|dd|rJt ||zdkr6t ||z tz}tdtd |dSdS) NrrTzhUnexpected extra padding at the end of the file. This padding may not be preserved when saving changes.zHeader block contains null bytes instead of spaces for padding, and is not FITS-compliant. Nulls may be replaced with spaces upon writing.rrzHeader size is not multiple of z: ) rGrrrrr r'rrV)r block_sizerr actual_lens r"rrs*jn,,  *j&&t,,22 MD"    **  M5#       tS ) ) )WS__z9a??__z1J> U:UUUUVVV WW??r$cDd}|dd}|dkrd}t|D] }||dt|dzzz}!|d}|dd}|dd}t||z||zzdz}|S)z@Calculate the data size (in bytes) following the given `Header`.rrWrrcrfrer)r r`rFabs)rrwrjrAbitpixgcountpcounts r"rprp s D JJw " "E qyy<< 9 9C&3sQw<rs3  $$$$$$777777 777777777777  LUVV SS%%d"3"34455 0vvvvvvvvr; ((000 ''///$$$$$$$$88N N N N N ;?*N N N b<<<<<<<<~1-1-1-1-1-m1-1-1-h.4.4.4.4.4].4.4.4bEEE@@@ WWWW>     r$