lsst.astshim g50ff169b8f+417d68efa6
Loading...
Searching...
No Matches
Functions | Variables
astshim.fitsChanContinued Namespace Reference

Functions

 _calc_card_pos (self, index)
 
 _get_current_card_value (self)
 
 length (self)
 
 iter (self)
 
 next (self)
 
 to_string (self)
 
 contains (self, name)
 
 getitem (self, name)
 
 setitem (self, name, value)
 
 delitem (self, name)
 
 items (self)
 

Variables

 items
 
 getFitsF
 
 getFitsS
 
 getFitsCF
 

Function Documentation

◆ _calc_card_pos()

astshim.fitsChanContinued._calc_card_pos ( self,
index )
protected
Convert a python index into a FitsChan position.

Parameters
----------
self : `FitsChan`
    The FitsChan to index.
index : `int`
    0-based index into header. If negative, counts from end.

Raises
------
IndexError
    Raised if the index exceeds the size of the FitsChan. If the index
    equals the size of the FitsChan (noting that in 0-based indexing the
    final card is one less than the size) then this refers to the end of
    the header.

Definition at line 6 of file fitsChanContinued.py.

◆ _get_current_card_value()

astshim.fitsChanContinued._get_current_card_value ( self)
protected
Retrieve the value of the current card along with the keyword name.

Returns
-------
name : `str`
    The name of the current card.
value : `object`
    The value in the correct Python type.

Definition at line 36 of file fitsChanContinued.py.

◆ contains()

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 127 of file fitsChanContinued.py.

◆ delitem()

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 318 of file fitsChanContinued.py.

◆ getitem()

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 151 of file fitsChanContinued.py.

◆ items()

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 366 of file fitsChanContinued.py.

◆ iter()

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 88 of file fitsChanContinued.py.

◆ length()

astshim.fitsChanContinued.length ( self)

Definition at line 81 of file fitsChanContinued.py.

◆ next()

astshim.fitsChanContinued.next ( self)
Return each 80-character header card until we run out of cards.

Definition at line 105 of file fitsChanContinued.py.

◆ setitem()

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 224 of file fitsChanContinued.py.

◆ to_string()

astshim.fitsChanContinued.to_string ( self)
A FitsChan string representation is a FITS header with newlines
after each 80-character header card.

Definition at line 117 of file fitsChanContinued.py.

Variable Documentation

◆ getFitsCF

astshim.fitsChanContinued.getFitsCF

Definition at line 50 of file fitsChanContinued.py.

◆ getFitsF

astshim.fitsChanContinued.getFitsF

Definition at line 48 of file fitsChanContinued.py.

◆ getFitsS

astshim.fitsChanContinued.getFitsS

Definition at line 49 of file fitsChanContinued.py.

◆ items

astshim.fitsChanContinued.items

Definition at line 394 of file fitsChanContinued.py.