XMM-Newton Science Analysis System

ssclib (ssclib-4.36.1) [xmmsas_20230412_1735-21.0.0]

ssclib

Abstract:

Library of Fortran 90 (and Perl) utilities needed for SAS task development.

Description
- Introduction
- Angle conventions
- Dependency relations:
- Module index
General-purpose array-processing utilities
- aryStatInfoFlagT structure definition
- aryStatInfo???T structure definition
- AryEdgesInfoT structure definition
- Integer (index) $\to$ scalar integers
- Array or vector $\to$ scalar integers
- Array or vector $\to$ scalar reals
- Array or vector $\to$ array or vector
- Array or vector $\to$ other
Subroutine shortcuts for manipulating information used for setting the CAL state
- Extract information about the instrument, exposure start time and spacecraft and instrument attitude from a dataset header.
- Spacecraft $\to$ instrument attitude
- Instrument $\to$ spacecraft attitude
Routines to calculate source confusion
A module which contains various mathematical and physical constants
- Constants
- Unit conversion routines
- Black Body routines
  - Per unit frequency
  - Per unit wavelength
Routines for performing coordinate transforms
- getPsfImagePixelCorners
- raDecToInst
- instToRaDec
- raDecToPixels
- pixelsToRaDec
- raDecToTan
- tanToRaDec
- polarsToRaDec
- instToTan
- tanToInst
- instToRaw
- rawToInst (rawToDet)
- getThetaPhiMaps
- skyToCartesian
- cartesianToSky
- telCoordToDetXY
- detXYToTelCoord
- detXY unit definition
- angleBetweenCelCoords
An additional layer over the DAL which implements some short cuts
- splitSetTabName
- readArrayData
- addOrOpenColumn
- readColDataToFixed
- readColDataToPtr
- minNonNullValue
- maxNonNullValue
- getDataType
- getTypeName
- getAttributeTypeName
Poissonian statistics and source detectability in this regime
- Integrated $\chi ^2$ probability
- Poisson probability
- Integrated Poisson probability
- Source detection limits
  - Single-band detection
  - Parallel detection over bands (with no assumptions made about source spectrum)
- Integrated Gaussian probability
- `Degrees of freedom' for a sum of likelihoods
DSS utilities
- Routines which involve the whole DSS
  - hasDss
  - dumpDss
- Routines which return information about DSS components
- Routines which return information about the filters in a specific component
- Routines which act on DSS RangeT scalars
- Routines which act on DSS RangeT vectors
- Routines which deal with DSS GTI filters
- Routines which deal with DSS bitmask filters
  - getBitMasksFromFilter
  - allBitsEquiv
Subroutines for dumping test output to file or STDOUT
- String content
- Dumping images to FITS array
Routines which deal with the geometry of ellipses
- `Rotated' and `phase' formats
- Is a given point inside a given ellipse?
- Generating a set of points along an ellipse locus
- EllipseT structure definition
A module containing routines to give supplementary information about EPIC
A module containing routines to perform calculations relating to exposure issues
Some utilities and definitions for applications which make use of the FFTW library
A module containing some useful type definitions
Routines for constructing histograms
Routines to manipulate data of type IntervalT (see caltypes)
- intervalsAreWellFormed
- isWithinInterval
- andIntervals
- orIntervals
Least-squares fitting routines
- stdDev
- fitLine
- fitPolynomial
- solveLinearTriDiag
- solveLinearEquations
- invertPosDefMatrix
Miscellaneous mathematical utilities
Function minimization routines
Helper subroutines for handling ODF (OAL)
- printODFProposal
List Parsing
A tool to regrid data from one 2D pixel grid to another
Contains an analytic approximation to the off-axis PSF, and routines to sample it.
Routines to return random numbers in various distributions
Array Reallocation
Utilities to rebin 1D or 2D data between parallel pixel grids
Utilities to regrid 1D or 2D data between parallel pixel grids
- Calculates OldPixelCorners via an Affine transform
- Regrids in the Cartesian coordinates
Short cuts to saving (or overwriting) output images
- saveDetImage(): Save DETX/DETY images
  - Examples
- getDetImageEdgesInfo(): Get a default frame information for a DET image
Quick Sorting
A routine which returns circles or ellipses to mark source locations
1D and 2D cubic-spline routines
Miscellaneous utilities
- Find a Free I/O Unit
- stripStr()
- splitStr()
Some functions for testing/debugging
- isNearlyEqual(): Comparing numbers with a given precision
  - Examples
Routines to perform hyperbolic distortion of values in the interval [0:1]
Utilities to assist in the reading and manipulation of WCS keywords
Utilities to assist development in Perl
General coordinates class in Perl
Celestial coordinates utilities in Perl
References
Index

XMM-Newton SOC -- 2023-04-16