iufIqPattern.c File Reference

#include <stdlib.h>
#include <math.h>
#include <string.h>
#include <iuf.h>
#include <iufIqPatternPrivate.h>

Data Structures
struct	IufIqPattern

Functions
iuiqpa_t	iufIqPatternCreate (float timeInFrame, const char *pPulseLabel, const char *pSourceLabel, const char *pChannelMapLabel, const char *pApodizationLabel, const char *pDemodulationLabel)
	create a pattern at time timeInFrame using labels to reference a pulse, source, channelMap, apodization and receiveSettings respectively More...
int	iufIqPatternDelete (iuiqpa_t iqPattern)
	Delete a pattern. More...
int	iufIqPatternCompare (iuiqpa_t reference, iuiqpa_t actual)
	Compare two patterns with each other. More...
int	iufIqPatternSave (iuiqpa_t pattern, hid_t handle)
iuiqpa_t	iufIqPatternLoad (hid_t handle)
const char *	iufIqPatternGetPulseLabel (iuiqpa_t iqPattern)
	Get the pulse label of the IufPattern. More...
const char *	iufIqPatternGetSourceLabel (iuiqpa_t iqPattern)
	Get the source label of the IufPattern. More...
const char *	iufIqPatternGetChannelMapLabel (iuiqpa_t iqPattern)
	Get the receiveChannelMap label of the IufPattern. More...
const char *	iufIqPatternGetApodizationLabel (iuiqpa_t iqPattern)
	Get the apodization label of the IufPattern. More...
const char *	iufIqPatternGetDemodulationLabel (iuiqpa_t iqPattern)
	Get the receiveSettings label of the IufPattern. More...
float	iufIqPatternGetTimeInFrame (iuiqpa_t iqPattern)
	Get the time of the IufPattern in the frame. More...

---

Data Structure Documentation

IufIqPattern

struct IufIqPattern

Data Fields
const char *	pApodizationLabel
const char *	pChannelMapLabel
const char *	pDemodulationLabel
const char *	pPulseLabel
const char *	pSourceLabel
float	timeInFrame

Function Documentation

iufIqPatternCompare()

int iufIqPatternCompare	(	iuiqpa_t	reference,
		iuiqpa_t	actual
	)

Compare two patterns with each other.

Returns

Returns IUF_TRUE when the patterns are equal and IUF_FALSE otherwise.

Parameters

reference	The IufPattern to compare to
actual	The IufPattern to compare with

iufIqPatternCreate()

iuiqpa_t iufIqPatternCreate	(	float	timeInFrame,
		const char *	pPulseLabel,
		const char *	pSourceLabel,
		const char *	pChannelMapLabel,
		const char *	pApodizationLabel,
		const char *	pDemodulationLabel
	)

create a pattern at time timeInFrame using labels to reference a pulse, source, channelMap, apodization and receiveSettings respectively

Returns

Returns the created IufPattern or IUPA_INVALID in case of an error.

Parameters

timeInFrame	relative time (s) in a frame
pPulseLabel	the name of the pulse
pSourceLabel	the name of the source
pChannelMapLabel	the name of the channelMap
pApodizationLabel	the name of the apodization
pDemodulationLabel	the name of the receiveSettings

iufIqPatternDelete()

int iufIqPatternDelete

(

iuiqpa_t

iufIqPattern

)

Delete a pattern.

Returns

Returns IUF_E_OK in case of success and IUF_ERR_VALUE in case of an error.

Parameters

iqPattern

The IufPattern of interest

iufIqPatternGetApodizationLabel()

const char* iufIqPatternGetApodizationLabel

(

iuiqpa_t

iufIqPattern

)

Get the apodization label of the IufPattern.

Returns

Returns the label or NULL if the argument is invalid.

Parameters

iqPattern

The IufPattern of interest

iufIqPatternGetChannelMapLabel()

const char* iufIqPatternGetChannelMapLabel

(

iuiqpa_t

iufIqPattern

)

Get the receiveChannelMap label of the IufPattern.

Returns

Returns the label or NULL if the argument is invalid.

Parameters

iqPattern

The IufPattern of interest

iufIqPatternGetDemodulationLabel()

const char* iufIqPatternGetDemodulationLabel

(

iuiqpa_t

iufIqPattern

)

Get the receiveSettings label of the IufPattern.

Returns

Returns the label or NULL if the argument is invalid.

Parameters

iqPattern

The IufPattern of interest

iufIqPatternGetPulseLabel()

const char* iufIqPatternGetPulseLabel

(

iuiqpa_t

iufIqPattern

)

Get the pulse label of the IufPattern.

Returns

Returns the label or NULL if the argument is invalid.

Parameters

iqPattern

The IufPattern of interest

iufIqPatternGetSourceLabel()

const char* iufIqPatternGetSourceLabel

(

iuiqpa_t

iufIqPattern

)

Get the source label of the IufPattern.

Returns

Returns the label or NULL if the argument is invalid.

Parameters

iqPattern

The IufPattern of interest

iufIqPatternGetTimeInFrame()

float iufIqPatternGetTimeInFrame

(

iuiqpa_t

iufIqPattern

)

Get the time of the IufPattern in the frame.

Returns

Returns the timestamp of the pattern in seconds or NAN in case of an error.

Parameters

iqPattern

The IufPattern of interest

iufIqPatternLoad()

iuiqpa_t iufIqPatternLoad

(

hid_t

handle

)

iufIqPatternSave()

int iufIqPatternSave	(	iuiqpa_t	pattern,
		hid_t	handle
	)