# doc-cache created by Octave 11.1.0
# name: cache
# type: cell
# rows: 3
# columns: 5
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 8
fitsdisp


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 923
 -- INFO = fitsdisp(FILENAME)
 -- INFO = fitsdisp(FILENAME, PROPERTYNAME, PROPERTYVALUE)
     Display metadata about fits format file

     Inputs
     ......

     FILENAME - filename to open.

     PROPERTYNAME, PROPERTYVALUE - property name/value pairs

     Known property names are:
     'Index'
          Value is a scalar or vector of hdu numbers to display
     'Mode'
          display mode of 'standard' (default), 'min' or 'full'

     'standard' display mode shows the standard keywords for the
     selected HDUs.
     'min' display mode shows only the type and size of the selected
     HDUs.
     'full' display shows all keywords for the selected HDU.

     Outputs
     .......

     INFO - the metadata of the file.  If no output variable is
     provided, it displays to the screen.

     Examples
     ........

          filename = file_in_loadpath("demos/tst0012.fits");

          fitsdisp(filename);


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 39
Display metadata about fits format file



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 8
fitsinfo


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 379
 -- INFO = fitsinfo(FILENAME)
     Read information about fits format file

     Inputs
     ......

     FILENAME - filename to open.

     Outputs
     .......

     INFO - a struct containing the structure and information about the
     fits file.

     Examples
     ........

          filename = file_in_loadpath("demos/tst0012.fits");

          info = fitsinfo(filename);


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 39
Read information about fits format file



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 8
fitsread


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 1818
 -- DATA = fitsread(FILENAME)
 -- DATA = fitsread(FILENAME, 'raw')
 -- DATA = fitsread(FILENAME, EXTNAME)
 -- DATA = fitsread(FILENAME, EXTNAME, INDEX)
 -- DATA = fitsread(FILENAME, ____, PROPERTYNAME, PROPERTYVALUE)
     Read the primary data, or specified extension data.  It scales the
     data and applied Nan to any undefined values.

     Inputs
     ......

     FILENAME - filename to open.

     EXTTYPE - can be 'primary', 'asciitable', 'binarytable', 'image',
     'unknown'.

     INDEX - can be used to specify which table when more than one of a
     given type exists.

     'raw'- If the 'raw' keyword is used, the raw data from the file
     will be used without replacing undefined values with Nan

     Known property names are:
     Info
          input info from fitsinfo call.
     PixelRegion
          pixel region to extract data for in an image.  It expects a
          cell array of same size as the number of axis in the image.
          Each cell should be in vector format of: start, [start stop]
          or [start, increment, stop].
     TableColumns
          A list of columns to extract from a ascii or binary table.
     TableRows
          A list of rows to extract from an ascii or binary table.

     Outputs
     .......

     DATA - The read data from the table or image.

     Examples
     ........

          filename = file_in_loadpath("demos/tst0012.fits");

          # read the primary image data
          imagedata = fitsread(filename);

          # read the 1st non primary image
          imagedata = fitsread(filename, "image");

          # read the first binary table, selected columns
          tbldata = fitsread(filename, "binarytable", "TableColumns", [1 2 11]);

          # read the first ascii table
          atbldata = fitsread(filename, "asciitable");


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 51
Read the primary data, or specified extension data.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 9
fitswrite


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 887
 -- fitswrite(DATA, FILENAME)
 -- fitswrite(DATA, FILENAME, PROPERTYNAME, PROPERTYVALUE)
     Write image data DATA to FITS file FILENAME.  If the fie already
     exists, overwrite it.

     Inputs
     ......

     DATA - imagedata to write to a file.

     FILENAME - filename to write to.

     PROPERTYNAME, PROPERTYVALUE - property name/value pairs

     Additional properties can be set as PROPERTYNAME, PROPERTYVALUE
     pairs.  Known property names are:
     WriteMode
          Set mode for writing to image as 'overwrite' (default) or
          'append' to append images.
     Compression
          Set compression type to use for image as 'none' (default),
          'gzip', 'rice', 'hcompress' or 'plio'.

     Outputs
     .......

     None

     Examples
     ........

          filename = tempname();
          X =  double([1:3;4:6]);
          fitswrite(X, filename);


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 44
Write image data DATA to FITS file FILENAME.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 11
import_fits


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 120
 -- import_fits
     Import the fits functions into a fits.xxxxx variable, to emulate
     importing the fits namespace.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Import the fits functions into a fits.xxxxx variable, to emulate
importing th...





