#include <fitsio.h>

Collaboration diagram for FITSfile:

Data Fields
int	filehandle
	handle returned by the file open function More...

int	driver
	defines which set of I/O drivers should be used More...

int	open_count
	number of opened 'fitsfiles' using this structure More...

char *	filename
	file name More...

int	validcode
	magic value used to verify that structure is valid More...

int	only_one
	flag meaning only copy the specified extension More...

LONGLONG	filesize
	current size of the physical disk file in bytes More...

LONGLONG	logfilesize
	logical size of file, including unflushed buffers More...

int	lasthdu
	is this the last HDU in the file? 0 = no, else yes More...

LONGLONG	bytepos
	current logical I/O pointer position in file More...

LONGLONG	io_pos
	current I/O pointer position in the physical file More...

int	curbuf
	number of I/O buffer currently in use More...

int	curhdu
	current HDU number; 0 = primary array More...

int	hdutype
	0 = primary array, 1 = ASCII table, 2 = binary table More...

int	writemode
	0 = readonly, 1 = readwrite More...

int	maxhdu
	highest numbered HDU known to exist in the file More...

int	MAXHDU
	dynamically allocated dimension of headstart array More...

LONGLONG *	headstart
	byte offset in file to start of each HDU More...

LONGLONG	headend
	byte offest in file to end of the current HDU header More...

LONGLONG	ENDpos
	byte offest to where the END keyword was last written More...

LONGLONG	nextkey
	byte offset in file to beginning of next keyword More...

LONGLONG	datastart
	byte offset in file to start of the current data unit More...

int	imgdim
	dimension of image; cached for fast access More...

LONGLONG	imgnaxis [99]
	length of each axis; cached for fast access More...

int	tfield
	number of fields in the table (primary array has 2) More...

int	startcol
	used by ffgcnn to record starting column number More...

LONGLONG	origrows
	original number of rows (value of NAXIS2 keyword) More...

LONGLONG	numrows
	number of rows in the table (dynamically updated) More...

LONGLONG	rowlength
	length of a table row or image size (bytes) More...

tcolumn *	tableptr
	pointer to the table structure More...

LONGLONG	heapstart

LONGLONG	heapsize

int	request_compress_type
	requested image compression algorithm More...

long	request_tilesize [MAX_COMPRESS_DIM]
	requested tiling size More...

float	request_quantize_level
	requested quantize level More...

int	request_quantize_method
	requested quantizing method More...

int	request_dither_seed
	starting offset into the array of random dithering More...

int	request_lossy_int_compress
	lossy compress integer image as if float image? More...

int	request_huge_hdu
	use '1Q' rather then '1P' variable length arrays More...

float	request_hcomp_scale
	requested HCOMPRESS scale factor More...

int	request_hcomp_smooth
	requested HCOMPRESS smooth parameter More...

int	compress_type
	type of compression algorithm More...

long	tilesize [MAX_COMPRESS_DIM]
	size of compression tiles More...

float	quantize_level
	floating point quantization level More...

int	quantize_method
	floating point pixel quantization algorithm More...

int	dither_seed
	starting offset into the array of random dithering More...

int	compressimg
	1 if HDU contains a compressed image, else 0 More...

char	zcmptype [12]
	compression type string More...

int	zbitpix
	FITS data type of image (BITPIX) More...

int	zndim
	dimension of image More...

long	znaxis [MAX_COMPRESS_DIM]
	length of each axis More...

long	maxtilelen
	max number of pixels in each image tile More...

long	maxelem
	maximum byte length of tile compressed arrays More...

int	cn_compressed
	column number for COMPRESSED_DATA column More...

int	cn_uncompressed
	column number for UNCOMPRESSED_DATA column More...

int	cn_gzip_data
	column number for GZIP2 lossless compressed data More...

int	cn_zscale
	column number for ZSCALE column More...

int	cn_zzero
	column number for ZZERO column More...

int	cn_zblank
	column number for the ZBLANK column More...

double	zscale
	scaling value, if same for all tiles More...

double	zzero
	zero pt, if same for all tiles More...

double	cn_bscale
	value of the BSCALE keyword in header More...

double	cn_bzero
	value of the BZERO keyword (may be reset) More...

double	cn_actual_bzero
	actual value of the BZERO keyword More...

int	zblank
	value for null pixels, if not a column More...

int	rice_blocksize
	first compression parameter: Rice pixels/block More...

int	rice_bytepix
	2nd compression parameter: Rice bytes/pixel More...

float	hcomp_scale
	1st hcompress compression parameter More...

int	hcomp_smooth
	2nd hcompress compression parameter More...

int *	tilerow
	row number of the array of uncompressed tiledata More...

long *	tiledatasize
	length of the array of tile data in bytes More...

int *	tiletype
	datatype of the array of tile (TINT, TSHORT, etc) More...

void **	tiledata
	array of uncompressed tile of data, for row *tilerow More...

void **	tilenullarray
	array of optional array of null value flags More...

int *	tileanynull
	anynulls in the array of tile? More...

char *	iobuffer
	pointer to FITS file I/O buffers More...

long	bufrecnum [NIOBUF]
	file record number of each of the buffers More...

int	dirty [NIOBUF]
	has the corresponding buffer been modified? More...

int	ageindex [NIOBUF]
	relative age of each buffer More...

Detailed Description

structure used to store basic FITS file information

Field Documentation

FITSfile::ageindex

relative age of each buffer

FITSfile::bufrecnum

file record number of each of the buffers

FITSfile::bytepos

current logical I/O pointer position in file

FITSfile::cn_actual_bzero

actual value of the BZERO keyword

FITSfile::cn_bscale

value of the BSCALE keyword in header

FITSfile::cn_bzero

value of the BZERO keyword (may be reset)

FITSfile::cn_compressed

column number for COMPRESSED_DATA column

FITSfile::cn_gzip_data

column number for GZIP2 lossless compressed data

FITSfile::cn_uncompressed

column number for UNCOMPRESSED_DATA column

FITSfile::cn_zblank

column number for the ZBLANK column

FITSfile::cn_zscale

column number for ZSCALE column

FITSfile::cn_zzero

column number for ZZERO column

FITSfile::compress_type

type of compression algorithm

FITSfile::compressimg

1 if HDU contains a compressed image, else 0

FITSfile::curbuf

number of I/O buffer currently in use

FITSfile::curhdu

current HDU number; 0 = primary array

FITSfile::datastart

byte offset in file to start of the current data unit

FITSfile::dirty

has the corresponding buffer been modified?

FITSfile::dither_seed

starting offset into the array of random dithering

FITSfile::driver

defines which set of I/O drivers should be used

FITSfile::ENDpos

byte offest to where the END keyword was last written

FITSfile::filehandle

handle returned by the file open function

FITSfile::filename

file name

FITSfile::filesize

current size of the physical disk file in bytes

FITSfile::hcomp_scale

1st hcompress compression parameter

FITSfile::hcomp_smooth

2nd hcompress compression parameter

FITSfile::hdutype

0 = primary array, 1 = ASCII table, 2 = binary table

FITSfile::headend

byte offest in file to end of the current HDU header

FITSfile::headstart

byte offset in file to start of each HDU

LONGLONG FITSfile::heapsize

LONGLONG FITSfile::heapstart

FITSfile::imgdim

dimension of image; cached for fast access

FITSfile::imgnaxis[99]

length of each axis; cached for fast access

FITSfile::io_pos

current I/O pointer position in the physical file

FITSfile::iobuffer

pointer to FITS file I/O buffers

FITSfile::lasthdu

is this the last HDU in the file? 0 = no, else yes

FITSfile::logfilesize

logical size of file, including unflushed buffers

FITSfile::maxelem

maximum byte length of tile compressed arrays

FITSfile::maxhdu

highest numbered HDU known to exist in the file

FITSfile::MAXHDU

dynamically allocated dimension of headstart array

FITSfile::maxtilelen

max number of pixels in each image tile

FITSfile::nextkey

byte offset in file to beginning of next keyword

FITSfile::numrows

number of rows in the table (dynamically updated)

FITSfile::only_one

flag meaning only copy the specified extension

FITSfile::open_count

number of opened 'fitsfiles' using this structure

FITSfile::origrows

original number of rows (value of NAXIS2 keyword)

FITSfile::quantize_level

floating point quantization level

FITSfile::quantize_method

floating point pixel quantization algorithm

FITSfile::request_compress_type

requested image compression algorithm

FITSfile::request_dither_seed

starting offset into the array of random dithering

FITSfile::request_hcomp_scale

requested HCOMPRESS scale factor

FITSfile::request_hcomp_smooth

requested HCOMPRESS smooth parameter

FITSfile::request_huge_hdu

use '1Q' rather then '1P' variable length arrays

FITSfile::request_lossy_int_compress

lossy compress integer image as if float image?

FITSfile::request_quantize_level

requested quantize level

FITSfile::request_quantize_method

requested quantizing method

FITSfile::request_tilesize

requested tiling size

FITSfile::rice_blocksize

first compression parameter: Rice pixels/block

FITSfile::rice_bytepix

2nd compression parameter: Rice bytes/pixel

FITSfile::rowlength

length of a table row or image size (bytes)

FITSfile::startcol

used by ffgcnn to record starting column number

FITSfile::tableptr

pointer to the table structure

FITSfile::tfield

number of fields in the table (primary array has 2)

FITSfile::tileanynull

anynulls in the array of tile?

FITSfile::tiledata

array of uncompressed tile of data, for row *tilerow

FITSfile::tiledatasize

length of the array of tile data in bytes

FITSfile::tilenullarray

array of optional array of null value flags

FITSfile::tilerow

row number of the array of uncompressed tiledata

FITSfile::tilesize

size of compression tiles

FITSfile::tiletype

datatype of the array of tile (TINT, TSHORT, etc)

FITSfile::validcode

magic value used to verify that structure is valid

FITSfile::writemode

0 = readonly, 1 = readwrite

FITSfile::zbitpix

FITS data type of image (BITPIX)

FITSfile::zblank

value for null pixels, if not a column

FITSfile::zcmptype

compression type string

FITSfile::znaxis

length of each axis

FITSfile::zndim

dimension of image

FITSfile::zscale

scaling value, if same for all tiles

FITSfile::zzero

zero pt, if same for all tiles

The documentation for this struct was generated from the following files:

Data Fields

Detailed Description

Field Documentation