heasp

•  MergeARFRMF.c
  

  Contains routine to multiply an ARF and an RMF.
  • long MergeARFRMF(struct ARF *arf, struct RMF *rmf)

    Multiplies the ARF and RMF structures and returns the result in the RMF structure. If there is a mismatch between energy bins returns the first inconsistent bin number.

•  RMF.c
  

  Contains RMF manipulation routines.
  • void RMFCompressLine(float *Vector, long VectorLength, float Threshold, long CurrentGroup, long CurrentElement, long *GroupStart, long *GroupSize, long *GroupFirstElement, long *NumberGroups, float *MatrixElements, long *NumberElements)

    Compress the vector representation of the response for a single energy and add into the RMF.

  • void RMFExpandLine(long *GroupStart, long *GroupSize, long *GroupFirstElement, long NumberGroups, long FirstGroup, float *MatrixElements, long VectorLength, float *Vector)

    Extract from the RMF the vector representation of the response for a single energy.

  • float ReturnRMFElement(struct RMF *rmf, long channel, long energybin)

    Return the RMF element for the input channel and energy bin.

  • float ReturnRMFchanElement(struct RMFchan *rmfchan, long channel, long energybin)

    Return the RMF element for the input channel and energy bin when the RMF is stored in the transposed RMFchan structure.

•  ReadARF.c
  

  Contains routine to read an ARF.
  • int ReadARF(fitsfile *fptr, long ARFnumber, struct ARF *arf)

    Read an ARF from the SPECRESP extension in the opened FITS file. If there are multiple SPECRESP extensions will read the ARFnumber one.

•  ReadPHA.c
  

  Contains routine to read a PHA file.
  • int ReturnPHAtype(fitsfile *fptr, long PHAnumber)

    Return either 1 or 2 depending on whether the PHAnumber'th SPECTRUM extension is a type 1 or 2 PHA type.

  • long ReturnNumberofSpectra(fitsfile *fptr, long PHAnumber)

    Return the number of spectra in the PHAnumber'th SPECTRUM extension in the opened file.

  • int ReadPHAtypeI(fitsfile *fptr, long PHAnumber, struct PHA *pha)

    Read the PHAnumber'th SPECTRUM extension into the PHA structure. Assumes the file is opened but not necessarily positioned at the correct extension.

  • int ReadPHAtypeII(fitsfile *fptr, long PHAnumber, long NumberSpectra, long *SpectrumNumber, struct PHA **pha)

    Read the PHAnumber'th SPECTRUM extension. Reads the spectra specified by the SpectrumNumber array into an array of PHA structures.

•  ReadRMF.c
  

  Contains routines to read the RMF file.
  • int ReadRMFMatrix(fitsfile *fptr, long RMFnumber, struct RMF *rmf)

    Read the RMFnumber'th MATRIX (or SPECRESP MATRIX) extension into a RMF structure.

  • int ReadRMFEbounds(fitsfile *fptr, long EBDnumber, struct RMF *rmf)

    Read the EBDnumber'th EBOUNDS extension into a RMF structure.

•  ReturnChannel.c
  

  Routine to return a channel given an RMF and an input energy.
  • void ReturnChannel(struct RMF *rmf, float energy, int NumberPhoton, long *channel)

    Return NumberPhoton channel numbers from the input energy by drawing randum numbers from a distribution derived from the RMF.

•  SPio.c
  

  Internal I/O routines mainly to provide transparent handling of keywords which may be columns in type II PHA files.
  • int SP_read_key(fitsfile *fptr, int datatype, char *keyword_name, void *keyword_value, void *keyword_default)

    Read keyword_name of type datatype into keyword_value.

  • int SPII_read_key(fitsfile *fptr, int datatype, char *keyword_name, long ispec, void *keyword_value, void *keyword_default)

    Read keyword_name or type datatype into keyword_value from a type II file. Looks first for a keyword of the requested name then if ispec > 0 for an entry in a column.

  • int SP_read_col(fitsfile *fptr, int datatype, char *column_name, long number_values, void *column_values)

    Read column_name of type datatype into column_values.

  • int SPII_read_col(fitsfile *fptr, int datatype, char *column_name, long ispec, long number_values, void *column_values)

    Read column_name of type datatype into column_values. Will read either from a keyword, a column, or a vector element of a column as appropriate.

  • int SP_write_key(fitsfile *fptr, int datatype, char *keyword_name, void *keyword_value, char *comment)

    Write keyword_value to keyword_name.

  • int SPII_write_key(fitsfile *fptr, int tfields, char *ttype[], int datatype, char *keyword_name, void *keyword_value, char *comment)

    Write keyword_value to keyword_name unless it is a column.

  • int SP_need_col(void *array, long array_size, int datatype)

    Returns true if not all elements of array are the same value.

  • int SPII_set_table_str(char *column_name, char **column_values, long number_values, int *tfields, char *ttype[], char *tform[], char *tunit[])

    Check whether the array of strings in column_values are all the same. If not set the table parameters and increment the tfield counter.

  • int SP_write_col(fitsfile *fptr, int datatype, char *column_name, int *colnum, long nrows, void *column_values)

    Writes column_values to column_name unless all the values are the same in which case write to a keyword. If a column is written the colnum is incremented.

  • int SPII_write_col(fitsfile *fptr, int tfields, char *ttype[], int datatype, char *column_name, int rownum, long vector_length, void *column_values)

    Write column_values as a vector element in column_name.

•  SPutils.c
  

  Internal utility routines for the heasp library.
  • int SPReadBinningFile(char *filename, struct BinFactors *binning)

    Read an ascii file of binning factors into the BinFactors structure.

  • int SPSetGroupArray(int inputSize, struct BinFactors *binning, int *grouping)

    Sets up a grouping array using the information in the BinFactors structure. Assumes that the grouping array has been allocated enough memory, that the binning ranges are contiguous, the start channel of a range is the channel after the end channel of the previous range, and that the first channel is 1.

  • int SPBinArray(int inputSize, float *input, int *grouping, int mode, float *output)

    Bin the input array up using the grouping data to create the output array. Mode takes four values : 1 means sum bins, 2 take the mean, 3 return the value of the first channel in the bin, and 4 return the value of the last channel in the bin.

•  TransposeRMF.c
  

  Routine to transpose the RMF matrix.
  • void TransposeRMF(struct RMF *rmf, struct RMFchan *rmfchan)

    Transpose the matrix in the RMF structure and output in the RMFchan structure.

•  WriteARF.c
  

  Routine to write an ARF.
  • int WriteARF(fitsfile *fptr, struct ARF *arf)

    Write the ARF structure to the output FITS file. Assumes the file is open and creates a new SPECRESP extension.

•  WritePHA.c
  

  Routines to write the PHA file.
  • int WritePHAtypeI(fitsfile *fptr, struct PHA *pha)

    Write the PHA structure to the output FITS file. Assumes the file is open and creates a new SPECTRUM extension.

  • int WritePHAtypeII(fitsfile *fptr, long NumberSpectra, struct PHA **pha)

    Write the array of PHA structures to the output FITS file. Assumes the file is open and creates a new type II SPECTRUM extension.

•  WriteRMF.c
  

  Routines to write the RMF file.
  • int WriteRMFMatrix(fitsfile *fptr, struct RMF *rmf)

    Write the MATRIX extension to the output FITS file. Assumes the file is open and creates a new extension.

  • int WriteRMFEbounds(fitsfile *fptr, struct RMF *rmf)

    Write the EBOUNDS extension to the output FITS file. Assumes the file is open and creates a new extension.