This class describes methods to access and manipulate the header for a FITS HDU. This class does not include code specific to particular types of HDU.


The following tables list the members exposed by Header.

Public Constructors

  Name Description
Static Public method Header Overloaded. Initializes a new instance of the Header class.
Top

Public Properties

  Name Description
Public property Bitpix Set the BITPIX value for the header.
Public property DataSize Return the size of the data including any needed padding.
Public property FileOffset Get the offset of this header
Public property Naxes Set the value of the NAXIS keyword (The dimensionality of the data)
Public property NumberOfCards Find the number of cards in the header
Public property Rewriteable Can the header be rewritten without rewriting the entire file?
Public property Simple Set the SIMPLE keyword to the given value.
Public property Size Get the size of the header in bytes
Public property Xtension Set the XTENSION keyword to the given value. "IMAGE" and "BINTABLE" are supported.
Top

Public Methods

  Name Description
Public method AddCard Adds card to the end of the HeaderCard list
Public method AddComment Creates a new HeaderCard to accommodate comment, and adds the new card to the end of the HeaderCard list
Public method AddHistory Creates a new HeaderCard to accommodate history, and adds the new card to the end of the HeaderCard list
Public method AddLine Overloaded. Add a card image to the header.
Public method AddValue Overloaded. Creates a new HeaderCard to accommodate key, val, and comment, and adds the new card to the end of the HeaderCard list
Public method ContainsKey  
Public method DeleteKey Delete the card associated with the given key. Nothing occurs if the key is not found.
Public method DumpHeader Print the header to a given stream.
Public method Equals Determines whether the specified Object is equal to the current Object. (inherited from Object)
Public method FindCard Find the card associated with a given key. If found this sets the mark to the card, otherwise it unsets the mark.
Public method GetBooleanValue Overloaded. Get the boolean value associated with the given key.
Public method GetCard Get the n'th card image in the header
Public method GetCursor Get a cursor over the header cards
Public method GetDoubleValue Overloaded. Get the double value associated with the given key.
Public method GetEnumerator Gets cursor
Public method GetFloatValue Overloaded. Get the float value associated with the given key.
Public method GetHashCode Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table. (inherited from Object)
Public method GetIntValue Overloaded. Get the int value associated with the given key.
Public method GetLongValue Overloaded. Get the long value associated with the given key.
Public method GetStringValue Get the String value associated with the given key.
Public method GetType Gets the Type of the current instance. (inherited from Object)
Public method InsertCard Overloaded. Inserts card in front of posCard in the HeaderCard list. If posCard is null, card is added to the end of the list.
Public method InsertComment Overloaded. Creates a new HeaderCard to accommodate comment, and inserts the new HeaderCard in front of posCard in the HeaderCard list. If posCard is null, the new HeaderCard is added to the end of the list.
Public method InsertCommentStyle Add a line to the header using the COMMENT style, i.e., no '=' in column 9.
Public method InsertHistory Overloaded. Creates a new HeaderCard to accommodate comment, and inserts the new HeaderCard in front of posCard in the HeaderCard list. If posCard is null, the new HeaderCard is added to the end of the list.
Public method InsertValue Overloaded. Creates a new HeaderCard to accommodate key, val, and comment, and inserts the new HeaderCard in front of posCard in the HeaderCard list. If posCard is null, the new HeaderCard is added to the end of the list.
Public method MakeData Create the data element corresponding to the current header
Public method NextCard Get the next card in the Header using the current cursor
Public method Read Read a stream for header data.
Public method Static ReadHeader Create a header by reading the information from the input stream.
Public method RemoveCard Overloaded. Removes card from the HeaderCard list
Public method Rewrite Rewrite the header.
Public method SetNaxis Set the dimension for a given axis.
Public method ToString Returns a String that represents the current Object. (inherited from Object)
Public method UpdateLine Update a line in the header.
Public method UpdateLines Overwrite the lines in the header. Add the new PHDU header to the current one. If keywords appear twice, the new value and comment overwrite the current contents.
Public method Write Write the current header (including any needed padding) to the output stream.
Top

Protected Methods

  Name Description
Family method Finalize Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (inherited from Object)
Family method MemberwiseClone Creates a shallow copy of the current Object. (inherited from Object)
Top

Explicit Interface Implementations

  Name Description
Static Private method Header Overloaded. Initializes a new instance of the Header class.
Top

See Also

Syntax based on .NET Framework version 2.0.
Documentation version 1.0.0.0.