FrChan.h File Reference

#include "ldastoolsal/ldas_types.h"
#include "framecpp/FrAdcData.hh"
#include "framecpp/FrProcData.hh"
#include "framecppc/FrameC.h"
#include "framecppc/Stream.h"
#include "framecppc/FrVect.h"

Include dependency graph for FrChan.h:

Typedefs
typedef const char *	fr_chan_comment_t
typedef FR_ADC_DATA_CHANNEL_GROUP_TYPE	fr_chan_channel_group_t
typedef FR_ADC_DATA_CHANNEL_NUMBER_TYPE	fr_chan_channel_number_t
typedef FR_ADC_DATA_DATAVALID_TYPE	fr_chan_data_valid_t
typedef const char *	fr_chan_name_t
typedef FR_ADC_DATA_TIMEOFFSET_TYPE	fr_chan_offset_t
typedef FR_ADC_DATA_SAMPLERATE_TYPE	fr_chan_sample_rate_t
typedef FR_ADC_DATA_TIMEOFFSET_TYPE	fr_chan_time_offset_t
typedef FR_ADC_DATA_N_BITS_TYPE	fr_chan_n_bits_t
typedef FR_PROC_DATA_T_RANGE_TYPE	fr_chan_t_range_t
typedef enum fr_chan_fields_	fr_chan_fields

Enumerations
enum	fr_chan_fields_ {   FR_CHAN_FIELD_CHANNEL_GROUP, FR_CHAN_FIELD_CHANNEL_NUMBER, FR_CHAN_FIELD_COMMENT, FR_CHAN_FIELD_DATA_VALID,   FR_CHAN_FIELD_NAME, FR_CHAN_FIELD_N_BITS, FR_CHAN_FIELD_SAMPLE_RATE, FR_CHAN_FIELD_TIME_OFFSET,   FR_CHAN_FIELD_T_RANGE, FR_CHAN_FIELD_LAST, FR_CHAN_FIELD_CHANNEL_GROUP, FR_CHAN_FIELD_CHANNEL_NUMBER,   FR_CHAN_FIELD_COMMENT, FR_CHAN_FIELD_DATA_VALID, FR_CHAN_FIELD_NAME, FR_CHAN_FIELD_N_BITS,   FR_CHAN_FIELD_SAMPLE_RATE, FR_CHAN_FIELD_TIME_OFFSET, FR_CHAN_FIELD_T_RANGE, FR_CHAN_FIELD_LAST }

Functions
FrChan
fr_chan_t *	FrameCFrChanAlloc (FrameCError **Error, const char *Name, fr_chan_type_t Type, fr_vect_data_types_t DataType, fr_vect_ndata_t NData)
	Alloc an fr_chan_t. More...
fr_chan_t *	FrameCFrProcChanAlloc (FrameCError **Error, const char *Name, fr_proc_type_t Type, fr_proc_sub_type_t SubType, fr_vect_data_types_t DataType, fr_vect_ndata_t NData)
	Alloc an fr_chan_t. More...
fr_chan_t *	FrameCFrProcMimeChanAlloc (FrameCError **Error, const char *Name, const char *MimeTypeName, fr_vect_ndata_t NData, fr_vect_data_t MimeData)
	Alloc an fr_chan_t. More...
void	FrameCFrChanFree (FrameCError **Error, fr_chan_t *Channel)
	Recyle the fr_chan_t structure. More...
void	FrameCFrChanQuery (FrameCError **Error, const fr_chan_t *Channel, int Option,...)
	Retrieve information related to the Channel. More...
fr_chan_t *	FrameCFrChanRead (FrameCError **Error, fr_file_t *restrict Stream, fr_chan_name_t restrict Name, fr_chan_offset_t Pos)
	Read a channel from the stream. More...
void	FrameCFrChanSet (FrameCError **Error, const fr_chan_t *Channel, int Option,...)
	Establish information about the Channel. More...
void	FrameCFrChanVectorAlloc (FrameCError **Error, fr_chan_t *Channel, fr_vect_data_types_t DataType, fr_vect_ndata_t NData)
	Allocate new space for an FrVect. More...
void	FrameCFrChanVectorCompress (FrameCError **Error, fr_chan_t *Channel, fr_vect_compression_schemes_t Scheme)
	Expand the data located in the data vector. More...
void	FrameCFrChanVectorExpand (FrameCError **Error, fr_chan_t *Channel)
	Expand the data located in the data vector. More...
void	FrameCFrChanVectorQuery (FrameCError **Error, const fr_chan_t *Channel, int Option,...)
	Retrieve vector information related to the Channel. More...
void	FrameCFrChanVectorSet (FrameCError **Error, fr_chan_t *Channel, int Option,...)
	Set vector information related to the Channel. More...

FrChan
enum	fr_chan_type {   FR_ADC_CHAN_TYPE, FR_EVENT_CHAN_TYPE, FR_PROC_CHAN_TYPE, FR_SIM_CHAN_TYPE,   FR_SIM_EVENT_CHAN_TYPE, UNKNOWN_CHAN_TYPE, FR_ADC_CHAN_TYPE, FR_EVENT_CHAN_TYPE,   FR_PROC_CHAN_TYPE, FR_SIM_CHAN_TYPE, FR_SIM_EVENT_CHAN_TYPE, UNKNOWN_CHAN_TYPE }
	Enumerated type of channel. More...
enum	fr_proc_type {   FR_PROC_TYPE_UNKNOWN, FR_PROC_TYPE_TIME_SERIES, FR_PROC_TYPE_FREQUENCY_SERIES, FR_PROC_TYPE_OTHER_1D_SERIES,   FR_PROC_TYPE_TIME_FREQUENCY, FR_PROC_TYPE_WAVELET, Fr_PROC_TYPE_MULTI_DIMENSIONAL, FR_PROC_TYPE_UNKNOWN,   FR_PROC_TYPE_TIME_SERIES, FR_PROC_TYPE_FREQUENCY_SERIES, FR_PROC_TYPE_OTHER_1D_SERIES, FR_PROC_TYPE_TIME_FREQUENCY,   FR_PROC_TYPE_WAVELET, Fr_PROC_TYPE_MULTI_DIMENSIONAL }
	Types of FrProcData. More...
enum	fr_proc_sub_type {   FR_PROC_SUB_TYPE_UNKNOWN, FR_PROC_SUB_TYPE_DFT, FR_PROC_SUB_TYPE_AMPLITUDE_SPECTRAL_DENSITY, FR_PROC_SUB_TYPE_POWER_SPECTRAL_DENSITY,   FR_PROC_SUB_TYPE_CROSS_SPECTRAL_DENSITY, FR_PROC_SUB_TYPE_COHERENCE, FR_PROC_SUB_TYPE_TRANSFER_FUNCTION, FR_PROC_SUB_TYPE_UNKNOWN,   FR_PROC_SUB_TYPE_DFT, FR_PROC_SUB_TYPE_AMPLITUDE_SPECTRAL_DENSITY, FR_PROC_SUB_TYPE_POWER_SPECTRAL_DENSITY, FR_PROC_SUB_TYPE_CROSS_SPECTRAL_DENSITY,   FR_PROC_SUB_TYPE_COHERENCE, FR_PROC_SUB_TYPE_TRANSFER_FUNCTION }
	Sub types of FrProcData. More...
typedef enum fr_chan_type	fr_chan_type_t
	Enumerated type of channel. More...
typedef enum fr_proc_type	fr_proc_type_t
	Types of FrProcData. More...
typedef enum fr_proc_sub_type	fr_proc_sub_type_t
	Sub types of FrProcData. More...
typedef struct fr_adc_chan	fr_adc_chan_t
	Type aliasing for FrAdc channel. More...
typedef struct fr_proc_chan	fr_proc_chan_t
	Type aliasing for FrProc channel. More...
typedef struct fr_sim_chan	fr_sim_chan_t
	Type aliasing for FrSimData channel. More...
typedef struct fr_chan	fr_chan_t
	Type aliasing for fr_chan structure. More...

Typedef Documentation

fr_chan_channel_group_t

typedef FR_ADC_DATA_CHANNEL_GROUP_TYPE fr_chan_channel_group_t

fr_chan_channel_number_t

typedef FR_ADC_DATA_CHANNEL_NUMBER_TYPE fr_chan_channel_number_t

fr_chan_comment_t

typedef const char* fr_chan_comment_t

fr_chan_data_valid_t

typedef FR_ADC_DATA_DATAVALID_TYPE fr_chan_data_valid_t

fr_chan_fields

typedef enum fr_chan_fields_ fr_chan_fields

fr_chan_n_bits_t

typedef FR_ADC_DATA_N_BITS_TYPE fr_chan_n_bits_t

fr_chan_name_t

typedef const char* fr_chan_name_t

fr_chan_offset_t

typedef FR_ADC_DATA_TIMEOFFSET_TYPE fr_chan_offset_t

fr_chan_sample_rate_t

typedef FR_ADC_DATA_SAMPLERATE_TYPE fr_chan_sample_rate_t

fr_chan_t_range_t

typedef FR_PROC_DATA_T_RANGE_TYPE fr_chan_t_range_t

fr_chan_time_offset_t

typedef FR_ADC_DATA_TIMEOFFSET_TYPE fr_chan_time_offset_t

Enumeration Type Documentation

fr_chan_fields_

enum fr_chan_fields_

Enumerator
FR_CHAN_FIELD_CHANNEL_GROUP
FR_CHAN_FIELD_CHANNEL_NUMBER
FR_CHAN_FIELD_COMMENT
FR_CHAN_FIELD_DATA_VALID
FR_CHAN_FIELD_NAME
FR_CHAN_FIELD_N_BITS
FR_CHAN_FIELD_SAMPLE_RATE
FR_CHAN_FIELD_TIME_OFFSET
FR_CHAN_FIELD_T_RANGE
FR_CHAN_FIELD_LAST
FR_CHAN_FIELD_CHANNEL_GROUP
FR_CHAN_FIELD_CHANNEL_NUMBER
FR_CHAN_FIELD_COMMENT
FR_CHAN_FIELD_DATA_VALID
FR_CHAN_FIELD_NAME
FR_CHAN_FIELD_N_BITS
FR_CHAN_FIELD_SAMPLE_RATE
FR_CHAN_FIELD_TIME_OFFSET
FR_CHAN_FIELD_T_RANGE
FR_CHAN_FIELD_LAST