if_fnm.h File Reference

External C interface for creation of apertures and computation of continous-wave fields. More...

#include <fnm/config.h>
#include <fnm/fnm_export.h>
#include <stddef.h>
#include <complex.h>
#include <stdarg.h>
#include <sps/cenv.h>

Include dependency graph for if_fnm.h:

This graph shows which files directly or indirectly include this file:

Typedefs
typedef struct Aperture	Aperture

Functions
int	ApertureCreate (Aperture **obj)
int	ApertureLinearCreate (Aperture **obj, size_t nElements, float width, float kerf, float height)
int	ApertureDestroy (Aperture *obj)
int	FreeCArray (void *pData)
int	ApertureNDivWSet (Aperture *obj, size_t nDiv)
size_t	ApertureNDivWGet (Aperture *obj)
int	ApertureNDivHSet (Aperture *obj, size_t nDiv)
size_t	ApertureNDivHGet (Aperture *obj)
size_t	ApertureNThreadsGet (Aperture *obj)
int	ApertureNThreadsSet (Aperture *obj, size_t nThreads)
int	ApertureFocusingTypeSet (Aperture *obj, int ftype)
int	ApertureCalcCwFieldRef (Aperture *obj, float *pos, size_t nPositions, size_t nDim, SPS_FCOMPLEX **odata, size_t *nOutPositions)
int	ApertureCalcCwFieldFast (Aperture *obj, float *pos, size_t nPositions, size_t nDim, SPS_FCOMPLEX **odata, size_t *nOutPositions)

Detailed Description

External C interface for creation of apertures and computation of continous-wave fields.

Author

Jens Munk Hansen jens..nosp@m.munk.nosp@m..hans.nosp@m.en@g.nosp@m.mail..nosp@m.com

Date

Fri Sep 8 21:14:16 2017

Typedef Documentation

Aperture

typedef struct Aperture Aperture

Function Documentation

ApertureCalcCwFieldFast()

int ApertureCalcCwFieldFast	(	Aperture *	obj,
		float *	pos,
		size_t	nPositions,
		size_t	nDim,
		SPS_FCOMPLEX **	odata,
		size_t *	nOutPositions
	)

Parameters

obj
pos
nPositions
nDim
odata
nOutPositions

Returns

ApertureCalcCwFieldRef()

int ApertureCalcCwFieldRef	(	Aperture *	obj,
		float *	pos,
		size_t	nPositions,
		size_t	nDim,
		SPS_FCOMPLEX **	odata,
		size_t *	nOutPositions
	)

Parameters

obj
pos
nPositions
nDim
odata
nOutPositions

Returns

ApertureCreate()

int ApertureCreate

(

Aperture **

obj

)

Constructor

Returns

error code

ApertureDestroy()

int ApertureDestroy

(

Aperture *

obj

)

Destructor

Parameters

obj

object

ApertureFocusingTypeSet()

int ApertureFocusingTypeSet	(	Aperture *	obj,
		int	ftype
	)

Parameters

obj
ftype

Returns

ApertureLinearCreate()

int ApertureLinearCreate	(	Aperture **	obj,
		size_t	nElements,
		float	width,
		float	kerf,
		float	height
	)

Create Linear Array.

See also

fnm::FocusedLinearArray

Parameters

obj
nElements
width
kerf
height

Returns

error code

ApertureNDivHGet()

size_t ApertureNDivHGet

(

Aperture *

obj

)

Parameters

obj

Returns

ApertureNDivHSet()

int ApertureNDivHSet	(	Aperture *	obj,
		size_t	nDiv
	)

Parameters

obj
nDiv

Returns

ApertureNDivWGet()

size_t ApertureNDivWGet

(

Aperture *

obj

)

ApertureNDivWSet

See fnm::Aperture<T>::ApertureNDivWSet

Parameters

obj

Returns

ApertureNDivWSet()

int ApertureNDivWSet	(	Aperture *	obj,
		size_t	nDiv
	)

ApertureNDivWSet

See fnm::Aperture<T>::ApertureNDivWSet

Parameters

obj
nDiv

Returns

ApertureNThreadsGet()

size_t ApertureNThreadsGet

(

Aperture *

obj

)

Parameters

obj

Returns

ApertureNThreadsSet()

int ApertureNThreadsSet	(	Aperture *	obj,
		size_t	nThreads
	)

Parameters

[in]	obj
[in]	nThreads

Returns

FreeCArray()

int FreeCArray

(

void *

pData

)