SAOTk Reference Manual
Table of Contents

SAOTk Frame FITS Commands

commands

  • get fits count
  • get fits header
  • get fits file name
  • get fits file names
  • get fits full file name
  • get fits full file names
  • get fits object name
  • load fits alloc
  • load fits channel
  • load fits mmap
  • load fits shared
  • load array alloc
  • load array channel
  • load array mmap
  • load array shared
  • load fits mosaic alloc
  • load fits mosaic channel
  • load fits mosaic mmap
  • load fits mosaic shared
  • load fits mosaic ext alloc
  • load fits mosaic ext channel
  • load fits mosaic ext mmap
  • load fits mosaic ext shared
  • get fits count

    Return the number of FITS files currently loaded
    Syntax:  get fits count
    Example: get fits count

    get fits header

    Return the header of the specified FITS file loaded. The first FITS file loaded is number 1.
    Syntax:  get fits header number integer
    Example: get fits header number 2

    get fits file name

    Return the file name of the specified loaded FITS file.
    Syntax:  get fits file number integer # return file name of FITS file numer
                  get fits file canvas coordinate system coordinate # return file name based on the specified coordinate.
    Example: get fits file name 2
             get fits file canvas 10 10

    get fits file names

    Return the file names of all loaded FITS files
    Syntax:  get fits file names
    Example: get fits file names

    get fits full file name

    Return the full file name of the specified loaded FITS file.
    Syntax:  get fits full file number integer # return full file name of FITS file numer
                  get fits full file canvas coordinate system coordinate # return full file name based on the specified coordinate.
    Example: get fits full file name 2
             get fits full file canvas 10 10

    get fits full file names

    Return the full file names of all loaded FITS files
    Syntax:  get fits full file names
    Example: get fits full file names

    get fits object name

    Return the FITS keyword OBJECT value for specified FITS file loaded.
    Syntax:  get fits object name canvas coordinate system coordinate
    Example: get fits object name canvas 100 200

    load fits alloc

    Load a FITS file from file or stdin and use allocated memory
    Syntax:  load fits alloc string
    Example: load fits alloc foo.fits

    load fits channel

    Load a FITS file from a TCL channel and use allocated memory. The first argument is the channel name and the second argument is the optional extension/binning parameters.
    Syntax:  load fits channel string
                   load fits channel string string
    Example: load fits channel file2

    load fits mmap

    Load a FITS file from file and use mmap memory. This is the default method.
    Syntax:  load fits string
                   load fits mmap string
    Example: load fits mmap foo.fits

    load fits shared

    Use shared memory segment which contains a vaild FITS file. The first argment is the shared memory id, the second is the size of the segment, and the optional third parameter is the optional extension/binning parameters.
    Syntax:  load fits shared integer integer
                  load fits shared integer integer string
    Example: load fits shared 15 4096 [bin=x,y]

    load array alloc

    Load a raw data array file from file or stdin and use allocated memory
    Syntax:  load array alloc string
    Example: load fits alloc foo.arr[xdim=512,ydim=512,bitpix=16]

    load array channel

    Load a fits file from a TCL channel and use allocated memory. The first argument is the channel name and the second argument is the array parameters
    Syntax:  load array channel string
                  load array channel string string
    Example: load array channel file2 [xdim=512,ydim=512,bitpix=16]

    load array mmap

    Load a fits file from file and use mmap memory.
    Syntax:  load array string
                   load array mmap string
    Example: load array mmap foo.arr[xdim=512,ydim=512,bitpix=16]

    load array shared

    Use shared memory segment which contains a raw data array file. The first argment is the shared memory id, the second is the size of the segment, and the optional third parameter is the optional extension/binning parameters.
    Syntax:  load array shared integer integer
                  load array shared integer integer string
    Example: load array shared 15 4096 [xdim=512,ydim=512,bitpix=16]

    load fits mosaic alloc

    Load a FITS mosic file from file or stdin and use allocated memory
    Syntax:  load fits mosic alloc string
    Example: load fits mosaic alloc foo.fits

    load fits mosaic channel

    Load a FITS mosaic file from a TCL channel and use allocated memory. The first argument is the channel name and the second argument is the optional file name.
    Syntax:  load fits mosaic channel string
                   load fits mosaic channel string string
    Example: load fits mosaic channel file2

    load fits mosaic mmap

    Load a FITS mosaic file from file and use mmap memory. This is the default method.
    Syntax:  load fits mosaic string
                   load fits mosaic mmap string
    Example: load fits mosaic mmap foo.fits

    load fits mosaic shared

    Use shared memory segment which contains a vaild FITS mosaic file. The first argment is the shared memory id, the second is the size of the segment, and the optional third parameter is the optional file name.
    Syntax:  load fits mosaic shared integer integer
                  load fits mosaic shared integer integer string
    Example: load fits mosaic shared 15 4096

    load fits mosaic ext alloc

    Load a FITS mosic file segment from file or stdin and use allocated memory
    Syntax:  load fits mosic ext alloc string
    Example: load fits mosaic ext alloc foo.fits

    load fits mosaic ext channel

    Load a FITS mosaic file segment from a TCL channel and use allocated memory. The first argument is the channel name and the second argument is the optional file name.
    Syntax:  load fits mosaic ext channel string
                   load fits mosaic ext channel string string
    Example: load fits mosaic ext channel file2

    load fits mosaic ext mmap

    Load a FITS mosaic file segment from file and use mmap memory. This is the default method.
    Syntax:  load fits ext mosaic string
                   load fits ext mosaic mmap string
    Example: load fits mosaic ext mmap foo.fits

    load fits mosaic ext shared

    Use shared memory segment which contains a vaild FITS mosaic file segment . The first argment is the shared memory id, the second is the size of the segment, and the optional third parameter is the optional file name.
    Syntax:  load fits mosaic ext shared integer integer
                  load fits mosaic ext shared integer integer string
    Example: load fits mosaic ext shared 15 4096