Models API

Functions
DLL_EXPORT void	vlbi_get_uv_plot (void *ctx, const char *name, int u, int v, double *target, double freq, double sr, int nodelay, int moving_baseline, vlbi_func2_t delegate, int *interrupt)
	Fill a fourier plane with an aperture synthesis projection of the baselines during the integration time and save it into a new model with the given name. More...
DLL_EXPORT void	vlbi_add_model (vlbi_context ctx, dsp_stream_p Stream, const char *name)
	Add a model into the current OpenVLBI context. More...
DLL_EXPORT void	vlbi_copy_model (void *ctx, const char *name, const char *node)
	Copy a model into a new one. More...
DLL_EXPORT void	vlbi_del_model (vlbi_context ctx, const char *name)
	Remove a model from the current OpenVLBI context. More...
DLL_EXPORT int	vlbi_get_models (void *ctx, dsp_stream_p **models)
	List all models of the current OpenVLBI context. More...
DLL_EXPORT dsp_stream_p	vlbi_get_model (void *ctx, const char *name)
	Get a single model from the current OpenVLBI context. More...
DLL_EXPORT int	vlbi_has_model (void *ctx, const char *name)
	Determine if a model is present into the current OpenVLBI context. More...
DLL_EXPORT void	vlbi_get_ifft (vlbi_context ctx, const char *name, const char *magnitude, const char *phase)
	Save into name an inverse fourier transform of the uv plot using its current magnitude and phase components. More...
DLL_EXPORT void	vlbi_get_fft (vlbi_context ctx, const char *model, const char *magnitude, const char *phase)
	Get the fourier transform of the given model and save its magnitude and phase components into two new models named so. More...
DLL_EXPORT void	vlbi_apply_mask (vlbi_context ctx, const char *name, const char *model, const char *mask)
	Mask the stream with the content of the mask stream, by multiplication of each element. More...
DLL_EXPORT void	vlbi_apply_convolution_matrix (vlbi_context ctx, const char *name, const char *model, const char *matrix)
	Convolute a model with a convolution matrix. More...
DLL_EXPORT void	vlbi_stack_models (vlbi_context ctx, const char *name, const char *model1, const char *model2)
	Stack two models into a new one. More...
DLL_EXPORT void	vlbi_diff_models (vlbi_context ctx, const char *name, const char *model1, const char *model2)
	Diff two models into a new one. More...
DLL_EXPORT void	vlbi_shift (vlbi_context ctx, const char *name)
	Shift a model by its dimensions. More...
DLL_EXPORT void	vlbi_add_model_from_png (void *ctx, char *filename, const char *name)
	Add a model from a png file. More...
DLL_EXPORT void	vlbi_add_model_from_jpeg (void *ctx, char *filename, const char *name)
	Add a model from a jpeg file. More...
DLL_EXPORT void	vlbi_add_model_from_fits (void *ctx, char *filename, const char *name)
	Add a model from a fits file. More...
DLL_EXPORT void	vlbi_get_model_to_png (void *ctx, char *filename, const char *name)
	Write a model to a png file. More...
DLL_EXPORT void	vlbi_get_model_to_jpeg (void *ctx, char *filename, const char *name)
	Write a model to a jpeg file. More...
DLL_EXPORT void	vlbi_get_model_to_fits (void *ctx, char *filename, const char *name)
	Write a model to a fits file. More...

Detailed Description

Function Documentation

vlbi_add_model()

DLL_EXPORT void vlbi_add_model	(	vlbi_context	ctx,
		dsp_stream_p	Stream,
		const char *	name
	)

Parameters

ctx	The OpenVLBI context
Stream	The OpenDSP stream to add
name	A friendly name of this model

vlbi_add_model_from_fits()

DLL_EXPORT void vlbi_add_model_from_fits	(	void *	ctx,
		char *	filename,
		const char *	name
	)

Parameters

ctx	The OpenVLBI context
filename	The file name of the picture to read
name	The name of the newly created model.

vlbi_add_model_from_jpeg()

DLL_EXPORT void vlbi_add_model_from_jpeg	(	void *	ctx,
		char *	filename,
		const char *	name
	)

Parameters

ctx	The OpenVLBI context
filename	The file name of the picture to read
name	The name of the newly created model.

vlbi_add_model_from_png()

DLL_EXPORT void vlbi_add_model_from_png	(	void *	ctx,
		char *	filename,
		const char *	name
	)

Parameters

ctx	The OpenVLBI context
filename	The file name of the picture to read
name	The name of the newly created model.

vlbi_apply_convolution_matrix()

DLL_EXPORT void vlbi_apply_convolution_matrix	(	vlbi_context	ctx,
		const char *	name,
		const char *	model,
		const char *	matrix
	)

Parameters

ctx	The OpenVLBI context
name	The name of the newly created model.
model	The name of the model to convolute.
matrix	The name of the convolution matrix model.

vlbi_apply_mask()

DLL_EXPORT void vlbi_apply_mask	(	vlbi_context	ctx,
		const char *	name,
		const char *	model,
		const char *	mask
	)

Parameters

ctx	The OpenVLBI context
name	The name of the newly created model.
model	The name of the model containing the data to be masked.
mask	The name of the model containing the mask.

vlbi_copy_model()

DLL_EXPORT void vlbi_copy_model	(	void *	ctx,
		const char *	name,
		const char *	node
	)

Parameters

ctx	The OpenVLBI context
name	The model name of the copy
node	The name of the model to copy

vlbi_del_model()

DLL_EXPORT void vlbi_del_model	(	vlbi_context	ctx,
		const char *	name
	)

Parameters

ctx	The OpenVLBI context
name	The friendly name of the model to be removed

vlbi_diff_models()

DLL_EXPORT void vlbi_diff_models	(	vlbi_context	ctx,
		const char *	name,
		const char *	model1,
		const char *	model2
	)

Parameters

ctx	The OpenVLBI context
name	The name of the newly created model.
model1	The name of the first model.
model2	The name of the second model to subtract.

vlbi_get_fft()

DLL_EXPORT void vlbi_get_fft	(	vlbi_context	ctx,
		const char *	model,
		const char *	magnitude,
		const char *	phase
	)

Parameters

ctx	The OpenVLBI context
model	The name of the model from which extract the magnitude and phase.
magnitude	The name of the model where to save the magnitude.
phase	The name of the model where to save the phase.

vlbi_get_ifft()

DLL_EXPORT void vlbi_get_ifft	(	vlbi_context	ctx,
		const char *	name,
		const char *	magnitude,
		const char *	phase
	)

Parameters

ctx	The OpenVLBI context
name	The name of the newly created model.
magnitude	The magnitude model.
phase	The phase model.

vlbi_get_model()

DLL_EXPORT dsp_stream_p vlbi_get_model	(	void *	ctx,
		const char *	name
	)

Parameters

ctx	The OpenVLBI context
name	The name of the chosen model

Returns

the model chosen as dsp_stream_p

vlbi_get_model_to_fits()

DLL_EXPORT void vlbi_get_model_to_fits	(	void *	ctx,
		char *	filename,
		const char *	name
	)

Parameters

ctx	The OpenVLBI context
filename	The file name of the picture to write
name	The name of the model chosen.

vlbi_get_model_to_jpeg()

DLL_EXPORT void vlbi_get_model_to_jpeg	(	void *	ctx,
		char *	filename,
		const char *	name
	)

Parameters

ctx	The OpenVLBI context
filename	The file name of the picture to write
name	The name of the model chosen.

vlbi_get_model_to_png()

DLL_EXPORT void vlbi_get_model_to_png	(	void *	ctx,
		char *	filename,
		const char *	name
	)

Parameters

ctx	The OpenVLBI context
filename	The file name of the picture to write
name	The name of the model chosen.

vlbi_get_models()

DLL_EXPORT int vlbi_get_models	(	void *	ctx,
		dsp_stream_p **	models
	)

Parameters

ctx	The OpenVLBI context
models	The model array pointer to be filled

Returns

the number of models in the current context

vlbi_get_uv_plot()

DLL_EXPORT void vlbi_get_uv_plot	(	void *	ctx,
		const char *	name,
		int	u,
		int	v,
		double *	target,
		double	freq,
		double	sr,
		int	nodelay,
		int	moving_baseline,
		vlbi_func2_t	delegate,
		int *	interrupt
	)

Parameters

ctx	The OpenVLBI context
name	The name of the new model
u	The U size of the resulting UV plot
v	The V size of the resulting UV plot
target	The target position int Ra/Dec/Dist celestial coordinates
freq	The frequency observed. This parameter will scale the plot inverserly.
sr	The sampling rate per second. This parameter will be used as meter for the elements of the streams.
nodelay	if 1 no delay calculation should be done. streams entered are already synced.
moving_baseline	if 1 the location field of all the dsp_stream_p is an array of dsp_location for each element of the dsp_stream_p->buf array.
interrupt	If the value pointed by this parameter changes to 1, then abort plotting.
delegate	The delegate function to be executed on each node stream buffer element.

vlbi_has_model()

DLL_EXPORT int vlbi_has_model	(	void *	ctx,
		const char *	name
	)

Parameters

ctx	The OpenVLBI context
name	The name of the model to check

Returns

Non-zero if the model is present in the passed context

vlbi_shift()

DLL_EXPORT void vlbi_shift	(	vlbi_context	ctx,
		const char *	name
	)

Parameters

ctx	The OpenVLBI context
name	The name of the model to be shifted.

vlbi_stack_models()

DLL_EXPORT void vlbi_stack_models	(	vlbi_context	ctx,
		const char *	name,
		const char *	model1,
		const char *	model2
	)

Parameters

ctx	The OpenVLBI context
name	The name of the newly created model.
model1	The name of the first model to stack.
model2	The name of the second model to stack.