Cards¶
Card
¶
-
class
astropy.io.fits.
Card
(keyword=None, value=None, comment=None, **kwargs)[source] [edit on github]¶ Bases:
astropy.io.fits.verify._Verify
-
ascardimage
(*args, **kwargs)[source] [edit on github]¶ Deprecated since version 0.1: The ascardimage function is deprecated and may be removed in a future version. Use the
image
attribute instead.
-
cardimage
¶ Deprecated since version 0.1: The cardimage function is deprecated and may be removed in a future version. Use the
image
attribute instead.
-
comment
¶ Get the comment attribute from the card image if not already set.
-
classmethod
fromstring
(image)[source] [edit on github]¶ Construct a
Card
object from a (raw) string. It will pad the string if it is not the length of a card image (80 columns). If the card image is longer than 80 columns, assume it containsCONTINUE
card(s).
-
image
¶ The card “image”, that is, the 80 byte character string that represents this card in an actual FITS header.
-
is_blank
¶ True
if the card is completely blank–that is, it has no keyword, value, or comment. It appears in the header as 80 spaces.Returns
False
otherwise.
-
key
¶ Deprecated since version 0.1: The key function is deprecated and may be removed in a future version. Use the
keyword
attribute instead.
-
keyword
¶ Returns the keyword name parsed from the card image.
-
length
= 80¶ The length of a Card image; should always be 80 for valid FITS files.
-
classmethod
normalize_keyword
(keyword)[source] [edit on github]¶ classmethod
to convert a keyword value that may contain a field-specifier to uppercase. The effect is to raise the key to uppercase and leave the field specifier in its original case.Parameters: key : or str
A keyword value or a
keyword.field-specifier
value
-
rawkeyword
¶ On record-valued keyword cards this is the name of the standard <= 8 character FITS keyword that this RVKC is stored in. Otherwise it is the card’s normal keyword.
-
rawvalue
¶ On record-valued keyword cards this is the raw string value in the
<field-specifier>: <value>
format stored in the card in order to represent a RVKC. Otherwise it is the card’s normal value.
-
run_option
(option=u'warn', err_text=u'', fix_text=u'Fixed.', fix=None, fixable=True) [edit on github]¶ Execute the verification with selected option.
-
value
¶ The value associated with the keyword stored in this card.
-
verify
(option=u'warn') [edit on github]¶ Verify all values in the instance.
Parameters: option : str
Output verification option. Must be one of
"fix"
,"silentfix"
,"ignore"
,"warn"
, or"exception"
. May also be any combination of"fix"
or"silentfix"
with"+ignore"
,+warn
, or+exception" (e.g. ``"fix+warn"
). See Verification options for more info.
-
Deprecated Interfaces¶
The following classes and functions are deprecated as of the PyFITS 3.1 header refactoring, though they are currently still available for backwards-compatibility.
-
class
astropy.io.fits.
CardList
(cards=[], keylist=None)[source] [edit on github]¶ Bases:
list
Deprecated since version 0.1:
CardList
used to provide the list-like functionality for manipulating a header as a list of cards. This functionality is now subsumed into theHeader
class itself, so it is no longer necessary to create or useCardList
s.Construct the
CardList
object from a list ofCard
objects.CardList
is now merely a thin wrapper aroundHeader
to provide backwards compatibility for the old API. This should not be used for any new code.Parameters: cards
A list of
Card
objects.-
append
(*args, **kwargs)[source] [edit on github]¶ Deprecated since version 0.1: The append function is deprecated and may be removed in a future version. Use
Header.append()
instead.Append a
Card
to theCardList
.Parameters: card :
Card
objectThe
Card
to be appended.useblanks : bool, optional
Use any extra blank cards?
If
useblanks
isTrue
, and if there are blank cards directly beforeEND
, it will use this space first, instead of appending after these blank cards, so the total space will not increase. Whenuseblanks
isFalse
, the card will be appended at the end, even if there are blank cards in front ofEND
.bottom : bool, optional
-
copy
(*args, **kwargs)[source] [edit on github]¶ Deprecated since version 0.1: The copy function is deprecated and may be removed in a future version. Use
Header.copy()
instead.Make a (deep)copy of the
CardList
.
-
count
(*args, **kwargs)[source] [edit on github]¶ Deprecated since version 0.1: The count function is deprecated and may be removed in a future version. Use
Header.count()
instead.
-
count_blanks
(*args, **kwargs)[source] [edit on github]¶ Deprecated since version 0.1: The count_blanks function is deprecated and may be removed in a future version.
Returns how many blank cards are directly before the
END
card.
-
extend
(*args, **kwargs)[source] [edit on github]¶ Deprecated since version 0.1: The extend function is deprecated and may be removed in a future version. Use
Header.extend()
instead.
-
filter_list
(*args, **kwargs)[source] [edit on github]¶ Deprecated since version 0.1: The filter_list function is deprecated and may be removed in a future version. Use
header[<wildcard_pattern>]
instead.Construct a
CardList
that contains references to all of the cards in thisCardList
that match the input key value including any special filter keys (*
,?
, and...
).Parameters: key : str
key value to filter the list with
Returns: cardlist
A
CardList
object containing references to all the requested cards.
-
index
(*args, **kwargs)[source] [edit on github]¶ Deprecated since version 0.1: The index function is deprecated and may be removed in a future version. Use
Header.index()
instead.
-
index_of
(*args, **kwargs)[source] [edit on github]¶ Deprecated since version 0.1: The index_of function is deprecated and may be removed in a future version. Use
Header.index()
instead.Get the index of a keyword in the
CardList
.Parameters: key : str or int
The keyword name (a string) or the index (an integer).
backward : bool, optional
When
True
, search the index from theEND
, i.e., backward.Returns: index : int
The index of the
Card
with the given keyword.
-
insert
(*args, **kwargs)[source] [edit on github]¶ Deprecated since version 0.1: The insert function is deprecated and may be removed in a future version. Use
Header.insert()
instead.Insert a
Card
to theCardList
.Parameters: pos : int
The position (index, keyword name will not be allowed) to insert. The new card will be inserted before it.
card :
Card
objectThe card to be inserted.
useblanks : bool, optional
-
keys
(*args, **kwargs)[source] [edit on github]¶ Deprecated since version 0.1: The keys function is deprecated and may be removed in a future version. Use
Header.keys()
instead.Return a list of all keywords from the
CardList
.
-
pop
(*args, **kwargs)[source] [edit on github]¶ Deprecated since version 0.1: The pop function is deprecated and may be removed in a future version. Use
Header.pop()
instead.
-
remove
(*args, **kwargs)[source] [edit on github]¶ Deprecated since version 0.1: The remove function is deprecated and may be removed in a future version. Use
Header.remove()
instead.
-
values
(*args, **kwargs)[source] [edit on github]¶ Deprecated since version 0.1: The values function is deprecated and may be removed in a future version. Use
Header.values()
instead.Return a list of the values of all cards in the
CardList
.For
RecordValuedKeywordCard
objects, the value returned is the floating point value, exclusive of thefield_specifier
.
-
-
astropy.io.fits.
create_card
(*args, **kwargs)[source] [edit on github]¶ Deprecated since version 0.1: The create_card function is deprecated and may be removed in a future version. Use
Card.__init__
instead.
-
astropy.io.fits.
create_card_from_string
(*args, **kwargs)[source] [edit on github]¶ Deprecated since version 0.1: The create_card_from_string function is deprecated and may be removed in a future version. Use
Card.fromstring()
instead.Construct a
Card
object from a (raw) string. It will pad the string if it is not the length of a card image (80 columns). If the card image is longer than 80 columns, assume it containsCONTINUE
card(s).
-
astropy.io.fits.
upper_key
(*args, **kwargs)[source] [edit on github]¶ Deprecated since version 0.1: The upper_key function is deprecated and may be removed in a future version. Use
Card.normalize_keyword()
instead.classmethod
to convert a keyword value that may contain a field-specifier to uppercase. The effect is to raise the key to uppercase and leave the field specifier in its original case.Parameters: key : or str
A keyword value or a
keyword.field-specifier
value