next up previous contents Back To Software Index
Next: FITS ASCII and Up: FITS Primary Array Previous: Write Image Data

Read Image Data Routines

1
Get elements from the data array. The `datatype' parameter specifies the datatype of the parameters pointed to by the `nulval' and `array' pointers; it can have one of the following symbolic constant values: TBYTE, TSHORT, TUSHORT, TINT, TLONG, TULONG, TFLOAT, TDOUBLE. Undefined array elements will be returned with a value = *nullval, (note that this parameter gives the address of the null value, not the null value itself) unless nulval = 0 or *nulval = 0, in which case no checks for undefined pixels will be performed.

  int fits_read_img / ffgpv
      (fitsfile *fptr, int  datatype, long firstelem, long nelements,
       DTYPE *nulval, > DTYPE *array, int *anynul, int *status)

2
Get elements from the data array. Undefined array elements will be returned with a value = nullval, unless nullval = 0 in which case no checks for undefined pixels will be performed.

  int fits_read_img_[byt, sht, usht, lng, ulng, int, flt, dbl] /
      ffgpv[b,i,ui,j,uj,k,e,d]
      (fitsfile *fptr, long group, long firstelem, long nelements,
       DTYPE nulval, > DTYPE *array, int *anynul, int *status)

3
Get elements and nullflags from data array. Any undefined array elements will have the corresponding nularray element set equal to 1, else 0.

  int  fits_read_imgnull_[byt, sht, usht, lng, ulng, int, flt, dbl] /
       ffgpf[b,i,ui,j,uj,k,e,d]
       (fitsfile *fptr, long group, long firstelem, long nelements,
       > DTYPE *array, char *nularray, int *anynul, int *status)

4
Get values from group parameters. This routine only applies to the `Random Grouped' FITS format which has been used for applications in radio interferometry, but is offically deprecated for future use.

  int  fits_read_grppar_[byt, sht, usht, lng, ulng, int, flt, dbl] /
       ffggp[b,i,ui,j,uj,k,e,d]
       (fitsfile *fptr, long group, long firstelem, long nelements,
       > DTYPE *array, int *status)

5
Get 2-D image from the data array. Undefined pixels in the array will be set equal to the value of 'nulval', unless nulval=0 in which case no testing for undefined pixels will be performed.

  int  fits_read_2d_[byt, sht, usht, lng, ulng, int, flt, dbl] /
       ffg2d[b,i,ui,j,uj,k,e,d]
       (fitsfile *fptr, long group, DTYPE nulval, long dim1, long naxis1,
       long naxis2, > DTYPE *array, int *anynul, int *status)

6
Get 3-D cube from the data array. Undefined pixels in the array will be set equal to the value of 'nulval', unless nulval=0 in which case no testing for undefined pixels will be performed.

  int  fits_read_3d_[byt, sht, usht, lng, ulng, int, flt, dbl] /
       ffg3d[b,i,ui,j,uj,k,e,d]
       (fitsfile *fptr, long group, DTYPE nulval, long dim1,
       long dim2, long naxis1, long naxis2, long naxis3,
       > DTYPE *array, int *anynul, int *status)

7
Get an arbitrary data subsection from the data array. Undefined pixels in the array will be set equal to the value of 'nulval', unless nullval=0 in which case no testing for undefined pixels will be performed.

  int  fits_read_subset_[byt, sht, usht, lng, ulng, int, flt, dbl] /
       ffgsv[b,i,ui,j,uj,k,e,d]
       (fitsfile *fptr, int group, int naxis, long *naxes,
       long *fpixels, long *lpixels, long *inc, DTYPE nulval,
       > DTYPE *array, int *anynul, int *status)

8
Get an arbitrary data subsection from the data array. Any Undefined pixels in the array will have the corresponding 'nularray' element set equal to TRUE.

  int  fits_read_subsetnull_[byt, sht, usht, lng, ulng, int, flt, dbl] /
       ffgsf[b,i,ui,j,uj,k,e,d]
       (fitsfile *fptr, int group, int naxis, long *naxes,
       long *fpixels, long *lpixels, long *inc, > DTYPE *array,
       char *nularray, int *anynul, int *status)



next up previous contents Back To Software Index
Next: FITS ASCII and Up: FITS Primary Array Previous: Write Image Data