M3.h File Reference

The C/C++ API for the serial M3 commands. More...

#include <stdint.h>
#include <M3_error.h>
#include "M3_internal.h"
#include <M3_format.h>

Go to the source code of this file.

Data Structures

struct  M3_PointingEl
 Pointing element. More...
struct  M3_MapEl
 Map element. More...
struct  M3_FilterEl
 Filter element. More...
struct  M3_Interval
 Time sample interval. More...
struct  M3_CoordEl
 Coordinate element. More...
struct  M3_BinEl
 Mulitpole bin element. More...
struct  M3_BPSel
 Binned power spectrum element. More...
struct  M3_SparsePixelMatrixEl
 Sparse pixel-pixel matrix element. More...
struct  M3_SparsePixelMatrixColumn
 Sparse pixel-pixel matrix column designator. More...
struct  M3_SparsePixelMatrixData
 Sparse pixel-pixel matrix structure. More...

Defines

#define M3_NUM_FILTER_TYPE   4
#define M3_W_FILTER_TYPE   0
#define M3_E_FILTER_TYPE   1
#define M3_S_FILTER_TYPE   2
#define M3_B_FILTER_TYPE   3
#define M3_DEFAULT_PIXEL_TYPE   0
#define M3_CMB_I_PIXEL_TYPE   1

Functions

void M3_RunConfigStruct_Read (M3_RunConfigStruct **runConfig, char *runConfigFileName, int runType)
 Reads a run configuration XML file.
void M3_RunConfigStruct_Write (M3_RunConfigStruct *runConfig, char *runConfigFileName)
 Writes an XML run configuration file.
void M3_RunConfigStruct_Destroy (M3_RunConfigStruct *runConfig)
 Destroys the memory associated with a run configuration.
void M3_RunConfigStruct_Duplicate (M3_RunConfigStruct *inRunConfig, M3_RunConfigStruct **outRunConfig)
 Duplicates a run configuration data structure.
int M3_RunConfigStruct_GetDataSetRoot (M3_RunConfigStruct *runConfig, M3_DataSetLL **dataSetRoot)
 Gives the first data set listed in the run configuration.
int M3_RunConfigStruct_GetPixelClassRoot (M3_RunConfigStruct *runConfig, M3_PixelClassLL **pixelClassRoot)
 Gives the first pixel class listed in the run configuration.
int M3_RunConfigStruct_GetPowerSpectrum (M3_RunConfigStruct *runConfig, M3_PowerSpectrumStruct **powerSpectrum)
 Gives the power spectrum structure associated with the run configuration.
int M3_RunConfigStruct_GetSparseMatrixName (M3_RunConfigStruct *runConfig, char *name, long maxStringLength)
 Gives the name of the sparse matrix file.
int M3_RunConfigStruct_GetSparseMatrixNumNZ (M3_RunConfigStruct *runConfig, M3_SparsePixelMatrixData *sparsePixelMatrixData)
 Fills in an M3_SparsePixelMatrixData structure with the number of non-zero elements.
int M3_RunConfigStruct_GetSparseMatrix (M3_RunConfigStruct *runConfig, M3_SparsePixelMatrixData *sparsePixelMatrixData)
 Fills in an M3_SparsePixelMatrixData structure with sparse matrix data.
int M3_RunConfigStruct_GetDenseMatrixName (M3_RunConfigStruct *runConfig, char *name, long maxStringLength)
 Gives the name of the dense pixel matrix file.
int M3_DataSetLL_GetNextNodeInList (M3_DataSetLL **dataSetNode)
 Advances to the next node in the data set linked list.
void M3_DataSetLL_GetName (M3_DataSetLL *dataSetNode, char *name, long maxStringLength)
 Gives the name associated with the data set.
int M3_DataSetLL_GetCoveredIntervalRoot (M3_DataSetLL *dataSetNode, M3_IntervalLL **intervalRoot)
 Gives the first covered interval listed in the data set.
void M3_DataSetLL_GetNumNZ (M3_DataSetLL *dataSetNode, int32_t *numNZ)
 Gives the number of non-zero elements per row of the pointing matrix.
int M3_DataSetLL_GetPointingClassRoot (M3_DataSetLL *dataSetNode, M3_PointingClassLL **pointingClassRoot)
 Gives the first pointing class listed in the data set.
void M3_DataSetLL_GetTOD (M3_DataSetLL *dataSetNode, M3_Interval readInterval, double *tod)
 Gives the time ordered data.
void M3_DataSetLL_GetPointing (M3_DataSetLL *dataSetNode, M3_Interval readInterval, M3_PointingEl *pointing)
 Gives the pointing matrix.
void M3_DataSetLL_GetEuler (M3_DataSetLL *dataSetNode, M3_Interval readInterval, double *eulerAngles)
 Gives the first inverse time-time noise correlation object listed in the dataset.
int M3_DataSetLL_GetNoiseFile (M3_DataSetLL *dataSetNode, M3_Interval stationaryInterval, M3_FileLL **noiseFile)
 Gives the inverse time-time noise correlation object listed in the dataset that is associated with a specified stationary interval.


Detailed Description

The C/C++ API for the serial M3 commands.

This header defines all of the functions and data structures that make up the interface to the serial functionality of M3.

Definition in file M3.h.


Generated on Mon Nov 24 10:05:12 2008 for M3 by  doxygen 1.5.3-20071008