LAL  7.1.7.1-2d066e5
High-Level Routines

Detailed Description

High-level routines for reading/writing HDF5 files.

These routines are high-level routines for accessing HDF files.

Routines to Write Vectors to HDF5 files

int XLALH5FileWriteCHARVector (LALH5File *file, const char *name, CHARVector *vector)
 Writes a vector to a LALH5File. More...
 
int XLALH5FileWriteINT2Vector (LALH5File *file, const char *name, INT2Vector *vector)
 Writes a vector to a LALH5File. More...
 
int XLALH5FileWriteINT4Vector (LALH5File *file, const char *name, INT4Vector *vector)
 Writes a vector to a LALH5File. More...
 
int XLALH5FileWriteINT8Vector (LALH5File *file, const char *name, INT8Vector *vector)
 Writes a vector to a LALH5File. More...
 
int XLALH5FileWriteUINT2Vector (LALH5File *file, const char *name, UINT2Vector *vector)
 Writes a vector to a LALH5File. More...
 
int XLALH5FileWriteUINT4Vector (LALH5File *file, const char *name, UINT4Vector *vector)
 Writes a vector to a LALH5File. More...
 
int XLALH5FileWriteUINT8Vector (LALH5File *file, const char *name, UINT8Vector *vector)
 Writes a vector to a LALH5File. More...
 
int XLALH5FileWriteREAL4Vector (LALH5File *file, const char *name, REAL4Vector *vector)
 Writes a vector to a LALH5File. More...
 
int XLALH5FileWriteREAL8Vector (LALH5File *file, const char *name, REAL8Vector *vector)
 Writes a vector to a LALH5File. More...
 
int XLALH5FileWriteCOMPLEX8Vector (LALH5File *file, const char *name, COMPLEX8Vector *vector)
 Writes a vector to a LALH5File. More...
 
int XLALH5FileWriteCOMPLEX16Vector (LALH5File *file, const char *name, COMPLEX16Vector *vector)
 Writes a vector to a LALH5File. More...
 
int XLALH5FileWriteStringVector (LALH5File *file, const char *name, LALStringVector *vector)
 Writes a vector to a LALH5File. More...
 

Routines to Write Arrays to HDF5 Files

int XLALH5FileWriteINT2Array (LALH5File *file, const char *name, INT2Array *array)
 Writes an array to a LALH5File. More...
 
int XLALH5FileWriteINT4Array (LALH5File *file, const char *name, INT4Array *array)
 Writes an array to a LALH5File. More...
 
int XLALH5FileWriteINT8Array (LALH5File *file, const char *name, INT8Array *array)
 Writes an array to a LALH5File. More...
 
int XLALH5FileWriteUINT2Array (LALH5File *file, const char *name, UINT2Array *array)
 Writes an array to a LALH5File. More...
 
int XLALH5FileWriteUINT4Array (LALH5File *file, const char *name, UINT4Array *array)
 Writes an array to a LALH5File. More...
 
int XLALH5FileWriteUINT8Array (LALH5File *file, const char *name, UINT8Array *array)
 Writes an array to a LALH5File. More...
 
int XLALH5FileWriteREAL4Array (LALH5File *file, const char *name, REAL4Array *array)
 Writes an array to a LALH5File. More...
 
int XLALH5FileWriteREAL8Array (LALH5File *file, const char *name, REAL8Array *array)
 Writes an array to a LALH5File. More...
 
int XLALH5FileWriteCOMPLEX8Array (LALH5File *file, const char *name, COMPLEX8Array *array)
 Writes an array to a LALH5File. More...
 
int XLALH5FileWriteCOMPLEX16Array (LALH5File *file, const char *name, COMPLEX16Array *array)
 Writes an array to a LALH5File. More...
 

Routines to Write Time Series to HDF5 Files

int XLALH5FileWriteINT2TimeSeries (LALH5File *file, const char *name, INT2TimeSeries *series)
 Writes a time series to a LALH5File. More...
 
int XLALH5FileWriteINT4TimeSeries (LALH5File *file, const char *name, INT4TimeSeries *series)
 Writes a time series to a LALH5File. More...
 
int XLALH5FileWriteINT8TimeSeries (LALH5File *file, const char *name, INT8TimeSeries *series)
 Writes a time series to a LALH5File. More...
 
int XLALH5FileWriteUINT2TimeSeries (LALH5File *file, const char *name, UINT2TimeSeries *series)
 Writes a time series to a LALH5File. More...
 
int XLALH5FileWriteUINT4TimeSeries (LALH5File *file, const char *name, UINT4TimeSeries *series)
 Writes a time series to a LALH5File. More...
 
int XLALH5FileWriteUINT8TimeSeries (LALH5File *file, const char *name, UINT8TimeSeries *series)
 Writes a time series to a LALH5File. More...
 
int XLALH5FileWriteREAL4TimeSeries (LALH5File *file, const char *name, REAL4TimeSeries *series)
 Writes a time series to a LALH5File. More...
 
int XLALH5FileWriteREAL8TimeSeries (LALH5File *file, const char *name, REAL8TimeSeries *series)
 Writes a time series to a LALH5File. More...
 
int XLALH5FileWriteCOMPLEX8TimeSeries (LALH5File *file, const char *name, COMPLEX8TimeSeries *series)
 Writes a time series to a LALH5File. More...
 
int XLALH5FileWriteCOMPLEX16TimeSeries (LALH5File *file, const char *name, COMPLEX16TimeSeries *series)
 Writes a time series to a LALH5File. More...
 

Routines to Write Frequency Series to HDF5 Files

int XLALH5FileWriteREAL4FrequencySeries (LALH5File *file, const char *name, REAL4FrequencySeries *series)
 Writes a frequency series to a LALH5File. More...
 
int XLALH5FileWriteREAL8FrequencySeries (LALH5File *file, const char *name, REAL8FrequencySeries *series)
 Writes a frequency series to a LALH5File. More...
 
int XLALH5FileWriteCOMPLEX8FrequencySeries (LALH5File *file, const char *name, COMPLEX8FrequencySeries *series)
 Writes a frequency series to a LALH5File. More...
 
int XLALH5FileWriteCOMPLEX16FrequencySeries (LALH5File *file, const char *name, COMPLEX16FrequencySeries *series)
 Writes a frequency series to a LALH5File. More...
 

Routines to Read Vectors from HDF5 Files

CHARVectorXLALH5FileReadCHARVector (LALH5File *file, const char *name)
 Reads a vector from a LALH5File. More...
 
INT2VectorXLALH5FileReadINT2Vector (LALH5File *file, const char *name)
 Reads a vector from a LALH5File. More...
 
INT4VectorXLALH5FileReadINT4Vector (LALH5File *file, const char *name)
 Reads a vector from a LALH5File. More...
 
INT8VectorXLALH5FileReadINT8Vector (LALH5File *file, const char *name)
 Reads a vector from a LALH5File. More...
 
UINT2VectorXLALH5FileReadUINT2Vector (LALH5File *file, const char *name)
 Reads a vector from a LALH5File. More...
 
UINT4VectorXLALH5FileReadUINT4Vector (LALH5File *file, const char *name)
 Reads a vector from a LALH5File. More...
 
UINT8VectorXLALH5FileReadUINT8Vector (LALH5File *file, const char *name)
 Reads a vector from a LALH5File. More...
 
REAL4VectorXLALH5FileReadREAL4Vector (LALH5File *file, const char *name)
 Reads a vector from a LALH5File. More...
 
REAL8VectorXLALH5FileReadREAL8Vector (LALH5File *file, const char *name)
 Reads a vector from a LALH5File. More...
 
COMPLEX8VectorXLALH5FileReadCOMPLEX8Vector (LALH5File *file, const char *name)
 Reads a vector from a LALH5File. More...
 
COMPLEX16VectorXLALH5FileReadCOMPLEX16Vector (LALH5File *file, const char *name)
 Reads a vector from a LALH5File. More...
 
LALStringVectorXLALH5FileReadStringVector (LALH5File *file, const char *name)
 Reads a vector from a LALH5File. More...
 

Routines to Read Arrays from HDF5 Files

INT2ArrayXLALH5FileReadINT2Array (LALH5File *file, const char *name)
 Reads an array from a LALH5File. More...
 
INT4ArrayXLALH5FileReadINT4Array (LALH5File *file, const char *name)
 Reads an array from a LALH5File. More...
 
INT8ArrayXLALH5FileReadINT8Array (LALH5File *file, const char *name)
 Reads an array from a LALH5File. More...
 
UINT2ArrayXLALH5FileReadUINT2Array (LALH5File *file, const char *name)
 Reads an array from a LALH5File. More...
 
UINT4ArrayXLALH5FileReadUINT4Array (LALH5File *file, const char *name)
 Reads an array from a LALH5File. More...
 
UINT8ArrayXLALH5FileReadUINT8Array (LALH5File *file, const char *name)
 Reads an array from a LALH5File. More...
 
REAL4ArrayXLALH5FileReadREAL4Array (LALH5File *file, const char *name)
 Reads an array from a LALH5File. More...
 
REAL8ArrayXLALH5FileReadREAL8Array (LALH5File *file, const char *name)
 Reads an array from a LALH5File. More...
 
COMPLEX8ArrayXLALH5FileReadCOMPLEX8Array (LALH5File *file, const char *name)
 Reads an array from a LALH5File. More...
 
COMPLEX16ArrayXLALH5FileReadCOMPLEX16Array (LALH5File *file, const char *name)
 Reads an array from a LALH5File. More...
 

Routines to Read Time Series from HDF5 Files

INT2TimeSeriesXLALH5FileReadINT2TimeSeries (LALH5File *file, const char *name)
 Reads a time series from a LALH5File. More...
 
INT4TimeSeriesXLALH5FileReadINT4TimeSeries (LALH5File *file, const char *name)
 Reads a time series from a LALH5File. More...
 
INT8TimeSeriesXLALH5FileReadINT8TimeSeries (LALH5File *file, const char *name)
 Reads a time series from a LALH5File. More...
 
UINT2TimeSeriesXLALH5FileReadUINT2TimeSeries (LALH5File *file, const char *name)
 Reads a time series from a LALH5File. More...
 
UINT4TimeSeriesXLALH5FileReadUINT4TimeSeries (LALH5File *file, const char *name)
 Reads a time series from a LALH5File. More...
 
UINT8TimeSeriesXLALH5FileReadUINT8TimeSeries (LALH5File *file, const char *name)
 Reads a time series from a LALH5File. More...
 
REAL4TimeSeriesXLALH5FileReadREAL4TimeSeries (LALH5File *file, const char *name)
 Reads a time series from a LALH5File. More...
 
REAL8TimeSeriesXLALH5FileReadREAL8TimeSeries (LALH5File *file, const char *name)
 Reads a time series from a LALH5File. More...
 
COMPLEX8TimeSeriesXLALH5FileReadCOMPLEX8TimeSeries (LALH5File *file, const char *name)
 Reads a time series from a LALH5File. More...
 
COMPLEX16TimeSeriesXLALH5FileReadCOMPLEX16TimeSeries (LALH5File *file, const char *name)
 Reads a time series from a LALH5File. More...
 

Routines to Read Frequency Series from HDF5 Files

REAL4FrequencySeriesXLALH5FileReadREAL4FrequencySeries (LALH5File *file, const char *name)
 Reads a frequency series from a LALH5File. More...
 
REAL8FrequencySeriesXLALH5FileReadREAL8FrequencySeries (LALH5File *file, const char *name)
 Reads a frequency series from a LALH5File. More...
 
COMPLEX8FrequencySeriesXLALH5FileReadCOMPLEX8FrequencySeries (LALH5File *file, const char *name)
 Reads a frequency series from a LALH5File. More...
 
COMPLEX16FrequencySeriesXLALH5FileReadCOMPLEX16FrequencySeries (LALH5File *file, const char *name)
 Reads a frequency series from a LALH5File. More...
 

Function Documentation

◆ XLALH5FileWriteCHARVector()

int XLALH5FileWriteCHARVector ( LALH5File file,
const char *  name,
CHARVector vector 
)

Writes a vector to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the vector vector.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
vectorPointer to a vector structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteINT2Vector()

int XLALH5FileWriteINT2Vector ( LALH5File file,
const char *  name,
INT2Vector vector 
)

Writes a vector to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the vector vector.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
vectorPointer to a vector structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteINT4Vector()

int XLALH5FileWriteINT4Vector ( LALH5File file,
const char *  name,
INT4Vector vector 
)

Writes a vector to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the vector vector.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
vectorPointer to a vector structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteINT8Vector()

int XLALH5FileWriteINT8Vector ( LALH5File file,
const char *  name,
INT8Vector vector 
)

Writes a vector to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the vector vector.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
vectorPointer to a vector structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteUINT2Vector()

int XLALH5FileWriteUINT2Vector ( LALH5File file,
const char *  name,
UINT2Vector vector 
)

Writes a vector to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the vector vector.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
vectorPointer to a vector structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteUINT4Vector()

int XLALH5FileWriteUINT4Vector ( LALH5File file,
const char *  name,
UINT4Vector vector 
)

Writes a vector to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the vector vector.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
vectorPointer to a vector structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteUINT8Vector()

int XLALH5FileWriteUINT8Vector ( LALH5File file,
const char *  name,
UINT8Vector vector 
)

Writes a vector to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the vector vector.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
vectorPointer to a vector structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteREAL4Vector()

int XLALH5FileWriteREAL4Vector ( LALH5File file,
const char *  name,
REAL4Vector vector 
)

Writes a vector to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the vector vector.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
vectorPointer to a vector structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteREAL8Vector()

int XLALH5FileWriteREAL8Vector ( LALH5File file,
const char *  name,
REAL8Vector vector 
)

Writes a vector to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the vector vector.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
vectorPointer to a vector structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteCOMPLEX8Vector()

int XLALH5FileWriteCOMPLEX8Vector ( LALH5File file,
const char *  name,
COMPLEX8Vector vector 
)

Writes a vector to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the vector vector.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
vectorPointer to a vector structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteCOMPLEX16Vector()

int XLALH5FileWriteCOMPLEX16Vector ( LALH5File file,
const char *  name,
COMPLEX16Vector vector 
)

Writes a vector to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the vector vector.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
vectorPointer to a vector structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteStringVector()

int XLALH5FileWriteStringVector ( LALH5File file,
const char *  name,
LALStringVector vector 
)

Writes a vector to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the vector vector.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
vectorPointer to a vector structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteINT2Array()

int XLALH5FileWriteINT2Array ( LALH5File file,
const char *  name,
INT2Array array 
)

Writes an array to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the array array.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
arrayPointer to an array structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteINT4Array()

int XLALH5FileWriteINT4Array ( LALH5File file,
const char *  name,
INT4Array array 
)

Writes an array to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the array array.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
arrayPointer to an array structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteINT8Array()

int XLALH5FileWriteINT8Array ( LALH5File file,
const char *  name,
INT8Array array 
)

Writes an array to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the array array.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
arrayPointer to an array structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteUINT2Array()

int XLALH5FileWriteUINT2Array ( LALH5File file,
const char *  name,
UINT2Array array 
)

Writes an array to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the array array.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
arrayPointer to an array structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteUINT4Array()

int XLALH5FileWriteUINT4Array ( LALH5File file,
const char *  name,
UINT4Array array 
)

Writes an array to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the array array.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
arrayPointer to an array structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteUINT8Array()

int XLALH5FileWriteUINT8Array ( LALH5File file,
const char *  name,
UINT8Array array 
)

Writes an array to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the array array.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
arrayPointer to an array structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteREAL4Array()

int XLALH5FileWriteREAL4Array ( LALH5File file,
const char *  name,
REAL4Array array 
)

Writes an array to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the array array.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
arrayPointer to an array structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteREAL8Array()

int XLALH5FileWriteREAL8Array ( LALH5File file,
const char *  name,
REAL8Array array 
)

Writes an array to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the array array.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
arrayPointer to an array structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteCOMPLEX8Array()

int XLALH5FileWriteCOMPLEX8Array ( LALH5File file,
const char *  name,
COMPLEX8Array array 
)

Writes an array to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the array array.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
arrayPointer to an array structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteCOMPLEX16Array()

int XLALH5FileWriteCOMPLEX16Array ( LALH5File file,
const char *  name,
COMPLEX16Array array 
)

Writes an array to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the array array.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
arrayPointer to an array structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteINT2TimeSeries()

int XLALH5FileWriteINT2TimeSeries ( LALH5File file,
const char *  name,
INT2TimeSeries series 
)

Writes a time series to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the time series series. Other metadata (name, epoch, deltaT, f0, and sampleUnits) are set as attributes.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
seriesPointer to time series structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteINT4TimeSeries()

int XLALH5FileWriteINT4TimeSeries ( LALH5File file,
const char *  name,
INT4TimeSeries series 
)

Writes a time series to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the time series series. Other metadata (name, epoch, deltaT, f0, and sampleUnits) are set as attributes.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
seriesPointer to time series structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteINT8TimeSeries()

int XLALH5FileWriteINT8TimeSeries ( LALH5File file,
const char *  name,
INT8TimeSeries series 
)

Writes a time series to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the time series series. Other metadata (name, epoch, deltaT, f0, and sampleUnits) are set as attributes.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
seriesPointer to time series structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteUINT2TimeSeries()

int XLALH5FileWriteUINT2TimeSeries ( LALH5File file,
const char *  name,
UINT2TimeSeries series 
)

Writes a time series to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the time series series. Other metadata (name, epoch, deltaT, f0, and sampleUnits) are set as attributes.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
seriesPointer to time series structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteUINT4TimeSeries()

int XLALH5FileWriteUINT4TimeSeries ( LALH5File file,
const char *  name,
UINT4TimeSeries series 
)

Writes a time series to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the time series series. Other metadata (name, epoch, deltaT, f0, and sampleUnits) are set as attributes.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
seriesPointer to time series structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteUINT8TimeSeries()

int XLALH5FileWriteUINT8TimeSeries ( LALH5File file,
const char *  name,
UINT8TimeSeries series 
)

Writes a time series to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the time series series. Other metadata (name, epoch, deltaT, f0, and sampleUnits) are set as attributes.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
seriesPointer to time series structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteREAL4TimeSeries()

int XLALH5FileWriteREAL4TimeSeries ( LALH5File file,
const char *  name,
REAL4TimeSeries series 
)

Writes a time series to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the time series series. Other metadata (name, epoch, deltaT, f0, and sampleUnits) are set as attributes.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
seriesPointer to time series structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteREAL8TimeSeries()

int XLALH5FileWriteREAL8TimeSeries ( LALH5File file,
const char *  name,
REAL8TimeSeries series 
)

Writes a time series to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the time series series. Other metadata (name, epoch, deltaT, f0, and sampleUnits) are set as attributes.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
seriesPointer to time series structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteCOMPLEX8TimeSeries()

int XLALH5FileWriteCOMPLEX8TimeSeries ( LALH5File file,
const char *  name,
COMPLEX8TimeSeries series 
)

Writes a time series to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the time series series. Other metadata (name, epoch, deltaT, f0, and sampleUnits) are set as attributes.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
seriesPointer to time series structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteCOMPLEX16TimeSeries()

int XLALH5FileWriteCOMPLEX16TimeSeries ( LALH5File file,
const char *  name,
COMPLEX16TimeSeries series 
)

Writes a time series to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the time series series. Other metadata (name, epoch, deltaT, f0, and sampleUnits) are set as attributes.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
seriesPointer to time series structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteREAL4FrequencySeries()

int XLALH5FileWriteREAL4FrequencySeries ( LALH5File file,
const char *  name,
REAL4FrequencySeries series 
)

Writes a frequency series to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the frequency series series. Other metadata (name, epoch, deltaF, f0, and sampleUnits) are set as attributes.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
seriesPointer to frequency series structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteREAL8FrequencySeries()

int XLALH5FileWriteREAL8FrequencySeries ( LALH5File file,
const char *  name,
REAL8FrequencySeries series 
)

Writes a frequency series to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the frequency series series. Other metadata (name, epoch, deltaF, f0, and sampleUnits) are set as attributes.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
seriesPointer to frequency series structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteCOMPLEX8FrequencySeries()

int XLALH5FileWriteCOMPLEX8FrequencySeries ( LALH5File file,
const char *  name,
COMPLEX8FrequencySeries series 
)

Writes a frequency series to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the frequency series series. Other metadata (name, epoch, deltaF, f0, and sampleUnits) are set as attributes.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
seriesPointer to frequency series structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileWriteCOMPLEX16FrequencySeries()

int XLALH5FileWriteCOMPLEX16FrequencySeries ( LALH5File file,
const char *  name,
COMPLEX16FrequencySeries series 
)

Writes a frequency series to a LALH5File.

Creates a new HDF5 dataset with name name within a HDF5 file associated with the LALH5File file structure and allocates a The data in the dataset is set to the data in the frequency series series. Other metadata (name, epoch, deltaF, f0, and sampleUnits) are set as attributes.

The LALH5File file passed to this routine must be a file opened for writing.

Parameters
filePointer to a LALH5File structure in which to create the dataset.
namePointer to a string with the name of the dataset to create.
seriesPointer to frequency series structure containing the data.
Return values
0Success.
-1Failure.

◆ XLALH5FileReadCHARVector()

CHARVector * XLALH5FileReadCHARVector ( LALH5File file,
const char *  name 
)

Reads a vector from a LALH5File.

Reads a vector of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to a vector containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadINT2Vector()

INT2Vector * XLALH5FileReadINT2Vector ( LALH5File file,
const char *  name 
)

Reads a vector from a LALH5File.

Reads a vector of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to a vector containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadINT4Vector()

INT4Vector * XLALH5FileReadINT4Vector ( LALH5File file,
const char *  name 
)

Reads a vector from a LALH5File.

Reads a vector of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to a vector containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadINT8Vector()

INT8Vector * XLALH5FileReadINT8Vector ( LALH5File file,
const char *  name 
)

Reads a vector from a LALH5File.

Reads a vector of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to a vector containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadUINT2Vector()

UINT2Vector * XLALH5FileReadUINT2Vector ( LALH5File file,
const char *  name 
)

Reads a vector from a LALH5File.

Reads a vector of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to a vector containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadUINT4Vector()

UINT4Vector * XLALH5FileReadUINT4Vector ( LALH5File file,
const char *  name 
)

Reads a vector from a LALH5File.

Reads a vector of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to a vector containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadUINT8Vector()

UINT8Vector * XLALH5FileReadUINT8Vector ( LALH5File file,
const char *  name 
)

Reads a vector from a LALH5File.

Reads a vector of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to a vector containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadREAL4Vector()

REAL4Vector * XLALH5FileReadREAL4Vector ( LALH5File file,
const char *  name 
)

Reads a vector from a LALH5File.

Reads a vector of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to a vector containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadREAL8Vector()

REAL8Vector * XLALH5FileReadREAL8Vector ( LALH5File file,
const char *  name 
)

Reads a vector from a LALH5File.

Reads a vector of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to a vector containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadCOMPLEX8Vector()

COMPLEX8Vector * XLALH5FileReadCOMPLEX8Vector ( LALH5File file,
const char *  name 
)

Reads a vector from a LALH5File.

Reads a vector of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to a vector containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadCOMPLEX16Vector()

COMPLEX16Vector * XLALH5FileReadCOMPLEX16Vector ( LALH5File file,
const char *  name 
)

Reads a vector from a LALH5File.

Reads a vector of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to a vector containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadStringVector()

LALStringVector * XLALH5FileReadStringVector ( LALH5File file,
const char *  name 
)

Reads a vector from a LALH5File.

Reads a vector of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to a vector containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadINT2Array()

INT2Array * XLALH5FileReadINT2Array ( LALH5File file,
const char *  name 
)

Reads an array from a LALH5File.

Reads an array of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to an array containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadINT4Array()

INT4Array * XLALH5FileReadINT4Array ( LALH5File file,
const char *  name 
)

Reads an array from a LALH5File.

Reads an array of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to an array containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadINT8Array()

INT8Array * XLALH5FileReadINT8Array ( LALH5File file,
const char *  name 
)

Reads an array from a LALH5File.

Reads an array of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to an array containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadUINT2Array()

UINT2Array * XLALH5FileReadUINT2Array ( LALH5File file,
const char *  name 
)

Reads an array from a LALH5File.

Reads an array of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to an array containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadUINT4Array()

UINT4Array * XLALH5FileReadUINT4Array ( LALH5File file,
const char *  name 
)

Reads an array from a LALH5File.

Reads an array of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to an array containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadUINT8Array()

UINT8Array * XLALH5FileReadUINT8Array ( LALH5File file,
const char *  name 
)

Reads an array from a LALH5File.

Reads an array of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to an array containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadREAL4Array()

REAL4Array * XLALH5FileReadREAL4Array ( LALH5File file,
const char *  name 
)

Reads an array from a LALH5File.

Reads an array of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to an array containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadREAL8Array()

REAL8Array * XLALH5FileReadREAL8Array ( LALH5File file,
const char *  name 
)

Reads an array from a LALH5File.

Reads an array of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to an array containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadCOMPLEX8Array()

COMPLEX8Array * XLALH5FileReadCOMPLEX8Array ( LALH5File file,
const char *  name 
)

Reads an array from a LALH5File.

Reads an array of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to an array containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadCOMPLEX16Array()

COMPLEX16Array * XLALH5FileReadCOMPLEX16Array ( LALH5File file,
const char *  name 
)

Reads an array from a LALH5File.

Reads an array of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to an array containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadINT2TimeSeries()

INT2TimeSeries * XLALH5FileReadINT2TimeSeries ( LALH5File file,
const char *  name 
)

Reads a time series from a LALH5File.

Reads a time series of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to a time series containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadINT4TimeSeries()

INT4TimeSeries * XLALH5FileReadINT4TimeSeries ( LALH5File file,
const char *  name 
)

Reads a time series from a LALH5File.

Reads a time series of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to a time series containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadINT8TimeSeries()

INT8TimeSeries * XLALH5FileReadINT8TimeSeries ( LALH5File file,
const char *  name 
)

Reads a time series from a LALH5File.

Reads a time series of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to a time series containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadUINT2TimeSeries()

UINT2TimeSeries * XLALH5FileReadUINT2TimeSeries ( LALH5File file,
const char *  name 
)

Reads a time series from a LALH5File.

Reads a time series of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to a time series containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadUINT4TimeSeries()

UINT4TimeSeries * XLALH5FileReadUINT4TimeSeries ( LALH5File file,
const char *  name 
)

Reads a time series from a LALH5File.

Reads a time series of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to a time series containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadUINT8TimeSeries()

UINT8TimeSeries * XLALH5FileReadUINT8TimeSeries ( LALH5File file,
const char *  name 
)

Reads a time series from a LALH5File.

Reads a time series of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to a time series containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadREAL4TimeSeries()

REAL4TimeSeries * XLALH5FileReadREAL4TimeSeries ( LALH5File file,
const char *  name 
)

Reads a time series from a LALH5File.

Reads a time series of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to a time series containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadREAL8TimeSeries()

REAL8TimeSeries * XLALH5FileReadREAL8TimeSeries ( LALH5File file,
const char *  name 
)

Reads a time series from a LALH5File.

Reads a time series of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to a time series containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadCOMPLEX8TimeSeries()

COMPLEX8TimeSeries * XLALH5FileReadCOMPLEX8TimeSeries ( LALH5File file,
const char *  name 
)

Reads a time series from a LALH5File.

Reads a time series of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to a time series containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadCOMPLEX16TimeSeries()

COMPLEX16TimeSeries * XLALH5FileReadCOMPLEX16TimeSeries ( LALH5File file,
const char *  name 
)

Reads a time series from a LALH5File.

Reads a time series of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to a time series containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadREAL4FrequencySeries()

REAL4FrequencySeries * XLALH5FileReadREAL4FrequencySeries ( LALH5File file,
const char *  name 
)

Reads a frequency series from a LALH5File.

Reads a frequency series of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to a frequency series containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadREAL8FrequencySeries()

REAL8FrequencySeries * XLALH5FileReadREAL8FrequencySeries ( LALH5File file,
const char *  name 
)

Reads a frequency series from a LALH5File.

Reads a frequency series of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to a frequency series containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadCOMPLEX8FrequencySeries()

COMPLEX8FrequencySeries * XLALH5FileReadCOMPLEX8FrequencySeries ( LALH5File file,
const char *  name 
)

Reads a frequency series from a LALH5File.

Reads a frequency series of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to a frequency series containing the data in the dataset.
Return values
NULLFailure.

◆ XLALH5FileReadCOMPLEX16FrequencySeries()

COMPLEX16FrequencySeries * XLALH5FileReadCOMPLEX16FrequencySeries ( LALH5File file,
const char *  name 
)

Reads a frequency series from a LALH5File.

Reads a frequency series of data from a dataset named name in an HDF5 file associated with the LALH5File file.

The LALH5File file passed to this routine must be a file opened for reading.

Parameters
filePointer to a LALH5File to be read.
namePointer to a string with the name of the dataset to read.
Returns
Pointer to a frequency series containing the data in the dataset.
Return values
NULLFailure.