Class RFits::IO::Proxy
In: lib/rfits/ext/rfitsio.c
Parent: Object

A namespace encapsulating a subset of CFITSIO‘s routines.

Methods

fits_close_file   fits_copy_cell2image   fits_copy_col   fits_copy_file   fits_copy_hdu   fits_copy_header   fits_copy_image2cell   fits_create_file   fits_create_hdu   fits_create_img   fits_create_tbl   fits_delete_col   fits_delete_file   fits_delete_hdu   fits_delete_key   fits_delete_rowlist   fits_delete_rowrange   fits_delete_rows   fits_file_mode   fits_file_name   fits_get_col_display_width   fits_get_colname   fits_get_colnum   fits_get_coltype   fits_get_compression_type   fits_get_eqcoltype   fits_get_hcomp_scale   fits_get_hcomp_smooth   fits_get_hdrspace   fits_get_hdu_num   fits_get_hdu_type   fits_get_img_dim   fits_get_img_equivtype   fits_get_img_param   fits_get_img_size   fits_get_img_type   fits_get_keytype   fits_get_noise_bits   fits_get_num_cols   fits_get_num_hdus   fits_get_num_rows   fits_get_tile_dim   fits_hdr2str   fits_img_compress   fits_img_decompress   fits_insert_atbl   fits_insert_btbl   fits_insert_cols   fits_insert_img   fits_insert_rows   fits_is_compressed_image   fits_modify_vector_len   fits_movabs_hdu   fits_open_file   fits_read_col   fits_read_img   fits_read_key   fits_read_keyn   fits_read_keyword   fits_read_pix   fits_read_subset   fits_read_tdim   fits_resize_img   fits_set_compression_type   fits_set_hcomp_scale   fits_set_hcomp_smooth   fits_set_noise_bits   fits_set_tile_dim   fits_update_key   fits_update_key_null   fits_url_type   fits_write_colnull   fits_write_comment   fits_write_grphdr   fits_write_history   fits_write_img   fits_write_null_img   fits_write_pixnull   fits_write_subset   fits_write_tdim  

Constants

READONLY = INT2NUM(READONLY)
READWRITE = INT2NUM(READWRITE)
IMAGE_HDU = INT2NUM(IMAGE_HDU)
ASCII_TBL = INT2NUM(ASCII_TBL)
BINARY_TBL = INT2NUM(BINARY_TBL)
ANY_HDU = INT2NUM(ANY_HDU)
BYTE_IMG = INT2NUM(BYTE_IMG)
SHORT_IMG = INT2NUM(SHORT_IMG)
LONG_IMG = INT2NUM(LONG_IMG)
LONGLONG_IMG = INT2NUM(LONGLONG_IMG)
FLOAT_IMG = INT2NUM(FLOAT_IMG)
DOUBLE_IMG = INT2NUM(DOUBLE_IMG)
SBYTE_IMG = INT2NUM(SBYTE_IMG)
USHORT_IMG = INT2NUM(USHORT_IMG)
ULONG_IMG = INT2NUM(ULONG_IMG)
TSTRING = INT2NUM(TSTRING)
TBIT = INT2NUM(TBIT)
TLOGICAL = INT2NUM(TLOGICAL)
TBYTE = INT2NUM(TBYTE)
TSBYTE = INT2NUM(TSBYTE)
TSHORT = INT2NUM(TSHORT)
TUSHORT = INT2NUM(TUSHORT)
TINT = INT2NUM(TINT)
TUINT = INT2NUM(TUINT)
TLONG = INT2NUM(TLONG)
TLONGLONG = INT2NUM(TLONGLONG)
TULONG = INT2NUM(TULONG)
TFLOAT = INT2NUM(TFLOAT)
TDOUBLE = INT2NUM(TDOUBLE)
TCOMPLEX = INT2NUM(TCOMPLEX)
TDBLCOMPLEX = INT2NUM(TDBLCOMPLEX)
RICE_1 = INT2NUM(RICE_1)
GZIP_1 = INT2NUM(GZIP_1)
PLIO_1 = INT2NUM(PLIO_1)
HCOMPRESS_1 = INT2NUM(HCOMPRESS_1)
CASESEN = INT2NUM(CASESEN)
CASEINSEN = INT2NUM(CASEINSEN)

Public Class methods

Close a previously opened FITS file.

Copy an n-dimensional image in a particular row and column of a binary table (in a vector column) to a primary array or image extension.

Copy a column from one HDU to another (or to the same HDU).

Copy all or part of the HDUs in the FITS file associated with in and append them to the end of the FITS file associated with out.

Copy the current HDU from the FITS file associated with in and append it to the end of the FITS file associated with out.

Copy the header (and not the data) from the CHDU associated with in to the CHDU associated with out.

Copy an n-dimensional image in a particular row and column of a binary table (in a vector column) from a primary array or image extension.

Create and open a new empty output FITS file.

Create (append) a new empty HDU at the end of the FITS file.

Create a new primary array or IMAGE extension at the end of the file.

Create a new ASCII or bintable table extension.

Delete column in an ASCII or binary table.

Close a previously opened FITS file and delete it.

Delete the CHDU in the FITS file.

Delete a keyword record with the specifically named keyword.

Delete rows in an ASCII or binary table using a row list.

Delete rows in an ASCII or binary table using a range list.

Delete rows in an ASCII or binary table.

Return the IO mode of the opened FITS file.

Return the name of the opened FITS file.

Return the display width of a column.

Get the table column name and number of the column whose name matches an input template name.

Get the table column number of the column whose name matches an input template name.

Return the data type, vector repeat value, and the width in bytes of a column in an ASCII or binary table.

Get the compression type of the IMAGE.

Return the equivalent data type, vector repeat value, and the width in bytes of a column in an ASCII or binary table.

Get the compression scale factor for the IMAGE.

Get the compression smoothing for the IMAGE.

Return the number of existing keywords (not counting the END keyword) and the amount of space currently available for more keywords.

Return the number of the current HDU (CHDU) in the FITS file (where the primary array = 1).

Return the type of the current HDU in the FITS file.

Get the number of dimensions of the image.

Get the equivalent data type (bitpix) of the image.

Get the number of dimension, image type (bitpix), and the dimensions of the image.

Get the size of each dimension of the image.

Get the data type (bitpix) of the image.

Determine the data type of a keyword value string.

Get the compression noise bits for the IMAGE.

Get the number of columns in the current FITS table.

Return the total number of HDUs in the FITS file.

Get the number of rows in the current FITS table.

Get the compression tile dimensions for the IMAGE.

Concatenate the header keywords in the CHDU into a single long string of characters.

Compress an IMAGE.

Decompress an IMAGE.

Insert a new ASCII table extension immediately following the CHDU.

Insert a new binary table extension immediately following the CHDU.

Insert column(s) in an ASCII or binary table.

Insert a new primary array or IMAGE extension with a specified data type and size at the CHDU.

Insert blank rows in an ASCII or binary table.

Determine whether the CHDU is compressed.

Modify the vector length of a binary table column (e.g., change a column from TFORMn = ‘1E’ to ‘20E’).

Move to a specified absolute HDU number (starting with 1 for the primary array) in the FITS file.

Open an existing data file.

Read an array of values from the FITS file (doing data type conversion if necessary).

Read elements from the FITS data array.

Return the specified keyword

Return the nth header record in the CHU.

Return the keyword value as a character string (a literal copy of what is in the value field) regardless of the intrinsic data type of the keyword.

Read pixels from the FITS data array.

Read an arbitrary data subsection from the data array.

Return the number of and size of the dimensions of a table column in a binary table.

Modify the size, dimensions, and/or data type of the current primary array or image extension.

Set the compression type of the IMAGE.

Set the compression scale factor for the IMAGE.

Set the compression smoothing for the IMAGE.

Set the compression noise bits for the IMAGE.

Set the compression tile dimensions for the IMAGE.

Update or append a string keyword to the CHU.

Update or append a null keyword to the CHU.

Return the file type (e.g. ‘file://’, ‘ftp://’) of the opened FITS file.

Writes the array of values to the FITS file (doing data type conversion if necessary).

Write (append) a COMMENT keyword to the CHU.

Write the required extension header keywords into the CHU.

Write (append) a HISTORY keyword to the CHU.

Write elements into the FITS data array.

Set FITS data array elements equal to the appropriate null pixel value.

Write pixels into the FITS data array.

Write a rectangular subimage (or the whole image) to the FITS data array.

Write a TDIMn keyword whose value has the form ’(l,m,n…)’ where l, m, n… are the dimensions of a multidimension array column in a binary table.

[Validate]