Functions
def	length (self)

def	iter (self)

def	next (self)

def	to_string (self)

def	contains (self, name)

def	getitem (self, name)

def	setitem (self, name, value)

def	delitem (self, name)

def	items (self)

Function Documentation

◆ contains()

def astshim.fitsChanContinued.contains	(	self,
		name
	)

Returns True if either the supplied name is present in the FitsChan
or the supplied integer is acceptable to the FitsChan.

Definition at line 126 of file fitsChanContinued.py.

 def contains(self, name):
     """Returns True if either the supplied name is present in the FitsChan
     or the supplied integer is acceptable to the FitsChan.
     """
     if isinstance(name, int):
         # index will be zero-based
         if name >= 0 and name < self.nCard:
             return True
     elif isinstance(name, str):
         currentCard = self.getCard()
         try:
             self.clearCard()
             result = self.findFits(name, False)
         finally:
             self.setCard(currentCard)
         if result.found:
             return True
 
     return False
 
 
 FitsChan.__contains__ = contains
 
 

◆ delitem()

def astshim.fitsChanContinued.delitem	(	self,
		name
	)

Delete an item from the FitsChan either by index (0-based) or by name.

Parameters
----------
name : `str` or `int`
    If the name is an integer index the card at that position will be
    removed.  The index is zero-based.  A negative index counts from the
    end of the FitsChan.
    If the name is a string all cards matching that name will be removed.

Raises
------
IndexError
    Raised if the supplied index is out of range.
KeyError
    Raised if the supplied name is not found in the FitsChan.

Definition at line 317 of file fitsChanContinued.py.

 def delitem(self, name):
     """Delete an item from the FitsChan either by index (0-based) or by name.
 
     Parameters
     ----------
     name : `str` or `int`
         If the name is an integer index the card at that position will be
         removed.  The index is zero-based.  A negative index counts from the
         end of the FitsChan.
         If the name is a string all cards matching that name will be removed.
 
     Raises
     ------
     IndexError
         Raised if the supplied index is out of range.
     KeyError
         Raised if the supplied name is not found in the FitsChan.
     """
     if isinstance(name, int):
         # Correct to 1-based
         newpos = _calc_card_pos(self, name)
         if newpos <= 0 or newpos > self.nCard:
             # AST will ignore this but we raise if the index is out of range
             raise IndexError(f"No FITS card at index {name}")
         self.setCard(newpos)
         self.delFits()
         return
 
     if not isinstance(name, str):
         raise KeyError(f"Supplied key, '{name}' of unsupported type")
 
     self.clearCard()
     # Delete any cards with matching keyword
     deleted = False
     while True:
         found = self.findFits(name, False)
         if not found.found:
             break
         self.delFits()
         deleted = True
 
     if not deleted:
         raise KeyError(f"No FITS card named {name}")
 
 
 FitsChan.__delitem__ = delitem
 
 

◆ getitem()

def astshim.fitsChanContinued.getitem	(	self,
		name
	)

Return a value associated with the supplied name.

Parameters
----------
name : `str` or `int`
    If the FitsChan is being accessed by integer index the returned value
    will be the corresponding 80-character card.  Index values are 0-based.
    A negative index counts from the end of the FitsChan.
    If the FitsChan is being accessed by string the returned value will
    be the scalar value associated with the first card that matches the
    supplied name.

Returns
-------
value : `str`, `int`, `float`, `bool`, or `None`
    The complete 80-character header card if an integer index is supplied,
    else the first matching value of the named header.

Raises
------
IndexError
    Raised if an integer index is provided and the index is out of range.
KeyError
    Raised if a string is provided and that string is not present in
    the FitsChan. Also raised if the supplied name is neither an integer
    not a string.
RuntimeError
    Raised if there is some problem accessing the value in the FitsChan.

Definition at line 150 of file fitsChanContinued.py.

 def getitem(self, name):
     """Return a value associated with the supplied name.
 
     Parameters
     ----------
     name : `str` or `int`
         If the FitsChan is being accessed by integer index the returned value
         will be the corresponding 80-character card.  Index values are 0-based.
         A negative index counts from the end of the FitsChan.
         If the FitsChan is being accessed by string the returned value will
         be the scalar value associated with the first card that matches the
         supplied name.
 
     Returns
     -------
     value : `str`, `int`, `float`, `bool`, or `None`
         The complete 80-character header card if an integer index is supplied,
         else the first matching value of the named header.
 
     Raises
     ------
     IndexError
         Raised if an integer index is provided and the index is out of range.
     KeyError
         Raised if a string is provided and that string is not present in
         the FitsChan. Also raised if the supplied name is neither an integer
         not a string.
     RuntimeError
         Raised if there is some problem accessing the value in the FitsChan.
     """
 
     # Save current card position
     currentCard = self.getCard()
 
     if isinstance(name, int):
         # Calculate position in FitsChan (0-based to 1-based)
         newpos = _calc_card_pos(self, name)
         self.setCard(newpos)
         try:
             result = self.findFits("%f", False)
         finally:
             self.setCard(currentCard)
         if not result.found:
             raise IndexError(f"No FITS card at index {name}")
         return result.value
 
     elif isinstance(name, str):
 
         try:
             # Rewind FitsChan so we search all cards
             self.clearCard()
 
             # We are only interested in the first matching card
             result = self.findFits(name, False)
             if not result.found:
                 raise KeyError(f"{name}'")
 
             this_name, value = _get_current_card_value(self)
             if this_name != name:
                 raise RuntimeError(f"Internal inconsistency in get: {this_name} != {name}")
 
         finally:
             # Reinstate the original card position
             self.setCard(currentCard)
 
         return value
 
     raise KeyError(f"Supplied key, '{name}' of unsupported type")
 
 
 FitsChan.__getitem__ = getitem
 
 

◆ items()

def astshim.fitsChanContinued.items ( self )

Iterate over each card, returning the keyword and value in a tuple.

Returns
-------
key : `str`
    The key associated with the card.  Can be an empty string for some
    comment styles.  The same key name can be returned multiple times
    and be associated with different values.
value : `str`, `int`, `bool`, `float`
    The value.

Notes
-----
The position of the iterator is internal to the FitsChan.  Do not
change the card position when iterating.

Definition at line 365 of file fitsChanContinued.py.

 def items(self):
     """Iterate over each card, returning the keyword and value in a tuple.
 
     Returns
     -------
     key : `str`
         The key associated with the card.  Can be an empty string for some
         comment styles.  The same key name can be returned multiple times
         and be associated with different values.
     value : `str`, `int`, `bool`, `float`
         The value.
 
     Notes
     -----
     The position of the iterator is internal to the FitsChan.  Do not
     change the card position when iterating.
     """
     self.clearCard()
     nCards = self.nCard
     thisCard = self.getCard()
 
     while thisCard <= nCards:
         name, value = _get_current_card_value(self)
         yield name, value
         self.setCard(thisCard + 1)
         thisCard = self.getCard()
 
 
 FitsChan.items = items

◆ iter()

def astshim.fitsChanContinued.iter ( self )

The FitsChan is its own iterator, incrementing the card position on
each call.

The position of the iterator is handled internally in the FitsChan and
is moved to the start of the FitsChan by this call.
Whilst iterating do not change the internal card position.

The iterator will return 80-character header cards.

Definition at line 87 of file fitsChanContinued.py.

 def iter(self):
     """The FitsChan is its own iterator, incrementing the card position on
     each call.
 
     The position of the iterator is handled internally in the FitsChan and
     is moved to the start of the FitsChan by this call.
     Whilst iterating do not change the internal card position.
 
     The iterator will return 80-character header cards.
     """
     self.clearCard()
     return self
 
 
 FitsChan.__iter__ = iter
 
 

◆ length()

def astshim.fitsChanContinued.length ( self )

Definition at line 80 of file fitsChanContinued.py.

 def length(self):
     return self.nCard
 
 FitsChan.__len__ = length

◆ next()

def astshim.fitsChanContinued.next ( self )

Return each 80-character header card until we run out of cards.

Definition at line 104 of file fitsChanContinued.py.

 def next(self):
     """Return each 80-character header card until we run out of cards.
     """
     card = self.findFits("%f", True)
     if not card.found:
         raise StopIteration
     return card.value
 
 
 FitsChan.__next__ = next
 
 

◆ setitem()

def astshim.fitsChanContinued.setitem	(	self,
		name,
		value
	)

Set a new value.

Parameters
----------
name : `str` or `int`
    If the name is an integer index this corresponds to a position within
    the FitsChan.  Index values are 0-based. A negative index counts
    from the end of the FitsChan.  If the index matches the number of
    cards (e.g. the return value of `len()`) the new value will be
    appended to the end of the FitsChan.
    If the name is an empty string or `None`, the value will be inserted
    at the current card position as a comment card.
    If the name is a string corresponding to a header card that is already
    present in the FitsChan, the new value will overwrite the existing
    value leaving the header name and any comment unchanged.
    Any other cards matching that name later in the header will
    be removed.  If there is no header with that name, a new card will
    be inserted at the end of the FitsChan.
value : `str`, `int`, `float`, `bool`, `None`
    The new value to be inserted.  If an integer index is given it must be
    a complete FITS header card.  The string will be padded to 80
    characters.

Raises
------
IndexError
    Raised if the supplied integer index is out of range.
KeyError
    Raised if the supplied name is neither a string or an integer.
TypeError
    Raised if an integer index is given but the supplied value is not
    a string.

Definition at line 223 of file fitsChanContinued.py.

 def setitem(self, name, value):
     """Set a new value.
 
     Parameters
     ----------
     name : `str` or `int`
         If the name is an integer index this corresponds to a position within
         the FitsChan.  Index values are 0-based. A negative index counts
         from the end of the FitsChan.  If the index matches the number of
         cards (e.g. the return value of `len()`) the new value will be
         appended to the end of the FitsChan.
         If the name is an empty string or `None`, the value will be inserted
         at the current card position as a comment card.
         If the name is a string corresponding to a header card that is already
         present in the FitsChan, the new value will overwrite the existing
         value leaving the header name and any comment unchanged.
         Any other cards matching that name later in the header will
         be removed.  If there is no header with that name, a new card will
         be inserted at the end of the FitsChan.
     value : `str`, `int`, `float`, `bool`, `None`
         The new value to be inserted.  If an integer index is given it must be
         a complete FITS header card.  The string will be padded to 80
         characters.
 
     Raises
     ------
     IndexError
         Raised if the supplied integer index is out of range.
     KeyError
         Raised if the supplied name is neither a string or an integer.
     TypeError
         Raised if an integer index is given but the supplied value is not
         a string.
     """
 
     if isinstance(name, int):
         # Calculate position in FitsChan (0-based to 1-based)
         newpos = _calc_card_pos(self, name)
         self.setCard(newpos)
 
         if not value:
             value = " "
 
         # Overwrite the entire value
         self.putFits(value, True)
         return
 
     # A blank name results in a comment card being inserted at the
     # current position
     if not name:
         self.setFitsCM(value, False)
         return
 
     if not isinstance(name, str):
         raise KeyError(f"Supplied key, '{name}' of unsupported type")
 
     # Get current card position and rewind
     currentCard = self.getCard()
     try:
         self.clearCard()
 
         # Look for a card with the specified name
         # We do not care about the result, if nothing is found we will be at the
         # end of the header
         self.findFits(name, False)
 
         # pyast seems to want to delete items if the value is None but
         # astropy and PropertyList think the key should be undefined.
         if value is None:
             self.setFitsU(name, overwrite=True)
         elif isinstance(value, int):
             self.setFitsI(name, value, overwrite=True)
         elif isinstance(value, float):
             self.setFitsF(name, value, overwrite=True)
         elif isinstance(value, bool):
             self.setFitsL(name, value, overwrite=True)
         else:
             # Force to string
             self.setFitsS(name, str(value), overwrite=True)
 
         # Delete any later cards with matching keyword
         while True:
             found = self.findFits(name, False)
             if not found.found:
                 break
             self.delFits()
     finally:
         # Try to reinstate the current card
         self.setCard(currentCard)
 
 
 FitsChan.__setitem__ = setitem
 
 

◆ to_string()

def astshim.fitsChanContinued.to_string ( self )

A FitsChan string representation is a FITS header with newlines
after each 80-character header card.

Definition at line 116 of file fitsChanContinued.py.

 def to_string(self):
     """A FitsChan string representation is a FITS header with newlines
     after each 80-character header card.
     """
     return "\n".join(c for c in self)
 
 
 FitsChan.__str__ = to_string
 
 

Functions