#include <FITSInOut.hpp>
|
| static void | read (const SimulationItem *item, string filename, Array &data, int &nx, int &ny, int &nz) |
| |
| static void | write (const SimulationItem *item, string description, string filename, const Array &data, string dataUnits, int nx, int ny, double incx, double incy, double xc, double yc, string xyUnits, const Array &z=Array(), string zUnits=string(), const ObserverInfo *obsInfo=nullptr) |
| |
|
| static void | read (string filepath, Array &data, int &nx, int &ny, int &nz) |
| |
| static void | readColumn (string filepath, Array &data, int n) |
| |
| static void | write (string filepath, const Array &data, string dataUnits, int nx, int ny, double incx, double incy, double xc, double yc, string xyUnits, const Array &z, string zUnits, const ObserverInfo *obsInfo) |
| |
The FITSInOut class offers static functions to read/write a 2D or 3D data stream from/to a standard FITS file, with support for a basic set of metadata in the header.
◆ read() [1/2]
| static void FITSInOut::read |
( |
const SimulationItem * |
item, |
|
|
string |
filename, |
|
|
Array & |
data, |
|
|
int & |
nx, |
|
|
int & |
ny, |
|
|
int & |
nz |
|
) |
| |
|
static |
This function reads data from a FITS file in the context of the simulation item hierarchy specified through the first argument. This allows the function to issue log messages and to determine a full path from the input filename specified as the second argument, relative to the simulation's input path. The input filename should include the filename extension. The remaining arguments of this function are the same as those described for the basic read() function in this class.
◆ read() [2/2]
| static void FITSInOut::read |
( |
string |
filepath, |
|
|
Array & |
data, |
|
|
int & |
nx, |
|
|
int & |
ny, |
|
|
int & |
nz |
|
) |
| |
|
staticprivate |
This function reads a data frame or cube from a FITS file containing one or more data planes (i.e. a 2D or 3D data array). The first argument specifies a relative or absolute file path; a file with that name should exist. By default, the function uses the first nonempty data unit in the file; usually this is the primary data unit. To specify another data unit, add the extension name (EXTNAME) between square brackets after the file name. For example:
SomePath/myFile.fits[SED]
The subsequent function arguments serve to store data read from the file: data receives the actual values in the data cube; nx and ny receive the number of values in each direction, nz specifies the number of planes (which is equal to 1 for 2D data). The values in the data array are ordered such that the index along the x-axis varies most rapidly, the index along the y-axis varies less rapidly, and the index along the z-axis (if present) varies least rapidly.
◆ readColumn()
| static void FITSInOut::readColumn |
( |
string |
filepath, |
|
|
Array & |
data, |
|
|
int |
n |
|
) |
| |
|
staticprivate |
This function reads a single table column from a FITS file containing a two-dimensional table. The first argument specifies a relative or absolute file path; a file with that name should exist. By default, the function uses the first column of the first table in the file. To specify another table, add the extension name (EXTNAME) of the data unit containing the table between square brackets after the file name. To specify another column in the table, add the column name as follows:
SomePath/myFile.fits[AXES][col time]
The data argument serves to store the column data read from the file, and n specifies the number of values (i.e. rows) to be read.
◆ write() [1/2]
| static void FITSInOut::write |
( |
const SimulationItem * |
item, |
|
|
string |
description, |
|
|
string |
filename, |
|
|
const Array & |
data, |
|
|
string |
dataUnits, |
|
|
int |
nx, |
|
|
int |
ny, |
|
|
double |
incx, |
|
|
double |
incy, |
|
|
double |
xc, |
|
|
double |
yc, |
|
|
string |
xyUnits, |
|
|
const Array & |
z = Array(), |
|
|
string |
zUnits = string(), |
|
|
const ObserverInfo * |
obsInfo = nullptr |
|
) |
| |
|
static |
This function writes a 2D data frame or a 3D data cube to a FITS file in the context of the simulation item hierarchy specified through the first argument. This allows the function to issue log messages using the human-readable description of the data given as the second argument, to skip writing in non-root processes of a multi-process similation, and to determine a full path from the output filename specified as the third argument, relative to the simulation's output path. The output filename should not include the filename extension nor the simulation prefix. The remaining arguments of this function are the same as those described for the basic write() function in this class. Note that the arguments describing the z-axis and observer info may be omitted when writing a 2D data frame.
◆ write() [2/2]
| static void FITSInOut::write |
( |
string |
filepath, |
|
|
const Array & |
data, |
|
|
string |
dataUnits, |
|
|
int |
nx, |
|
|
int |
ny, |
|
|
double |
incx, |
|
|
double |
incy, |
|
|
double |
xc, |
|
|
double |
yc, |
|
|
string |
xyUnits, |
|
|
const Array & |
z, |
|
|
string |
zUnits, |
|
|
const ObserverInfo * |
obsInfo |
|
) |
| |
|
staticprivate |
This function writes a 2D data frame or a 3D data cube to the primary data unit of a FITS file. The x and y axes are assumed to discretize spatial extent on a regular, linear grid. The optional z axis often represents spectral extent and may be discretized on an arbitary grid. If it is present (i.e. for a 3D data cube), the function also writes the z-axis grid points to the FITS file as a binary table extension, so that the file is self-contained.
The first argument specifies a relative or absolute file path; if a file with that name already exists, it is overwritten. The subsequent arguments specify the contents of the file. data contains the actual values in the frame or data cube; the values in this array must be ordered such that the index along the x-axis varies most rapidly, the index along the y-axis varies less rapidly, and the index along the z-axis (if present) varies least rapidly. dataUnits describes the units of the data values; nx and ny specify the number of values in each spatial direction, incx and incy specify the increment between subsequent grid points in each spatial direction, xc and yc specify the center of the frame(s), and xyUnits describes the units of the xy-grid increments. z contains the z-axis grid points (often wavelengths), and zUnits describes the units of these grid points. Finally, obsInfo is a pointer to an optional data structure holding observer information (or the null pointer).
The documentation for this class was generated from the following file:
