This class is C++ wrapper for a CPL and CLIPM recipes. It provides a simplified interface that allows to call CPL routines from INS applications. More...

#include <recipe.hpp>

Inheritance diagram for ifw::odp::Recipe:

Public Member Functions
	Recipe ()
	Class constructor.

	~Recipe ()
	Class destructor.

void	GetCenterGauss (const odp::Image image, cpl_size llx, cpl_size lly, cpl_size urx, cpl_size ury, CenterGauss cen_gauss, const int robustness=0)
	Compute the center gauss of an image subwindow.

void	GetCenterMoment (const odp::Image image, cpl_size llx, cpl_size lly, cpl_size urx, cpl_size ury, bool wdw_enlarge, double gain, CenterGauss cenMoment)
	Compute the center moment of an image subwindow.

void	GetMultiCenterGauss (const odp::Image image, const odp::Matrix ref, unsigned int areasize, odp::Matrix center, odp::Matrix center_err, odp::Matrix sigma, odp::Matrix sigma_err, odp::Matrix fwhm, odp::Matrix fwhm_err, odp::Matrix intensities, odp::Array err_codes, const int robustness)
	Compute multiple center gauss of an image.

void	GetIqe (const odp::Image image, const cpl_size startX, const cpl_size startY, const cpl_size endX, const cpl_size endY, Iqe iqe)
	Compute image quality estimator over an image subwindow.

void	GetSlitPos (const odp::Image image, const int max_width, SlitPos slit)
	Computes the slit data.

void	AlignPoints (const odp::Matrix matrix1, const odp::Matrix matrix2, unsigned int mode, odp::Matrix trans, odp::Matrix shift, odp::Matrix *rot)
	Linear transformation between two set of points.

void	AlignCorrelate (const odp::Image img1, const odp::Image img2, const odp::Matrix ref, unsigned int wsize, double maxd, unsigned int mode, odp::Matrix trans, odp::Matrix shift, odp::Matrix pixels, odp::Matrix locs, odp::Matrix uncer, odp::Array *err_codes)
	Crosscorrelation of two images.

std::vector< double >	GetRngPoisson2d (int llx, int lly, int urx, int ury, int homogenity, int npairs)
	Generates a set of random numbers within a box.

void	GetRngPoisson2d (double llx, double lly, double urx, double ury, int homogenity, int npairs, void **buffer_ptr, cpl_type cpltype=CPL_TYPE_DOUBLE)
	Generates a set of random numbers within a box.

void	GetRectangularAperture (const odp::Image image, const cpl_size llx, const cpl_size lly, const cpl_size urx, const cpl_size ury, RectAperture aperture, odp::Matrix *stat)
	Wrapper to the CLIPM rectangular characterization.

void	GetCircularAperture (const odp::Image image, const cpl_size llx, const cpl_size lly, const cpl_size urx, const cpl_size ury, CircularAperture aperture, odp::Matrix *stat)
	Wrapper to the CLIPM circular characterization.

void	EstimateBackground (const odp::Image img, const cpl_size llx, const cpl_size lly, const cpl_size urx, const cpl_size ury, double sigma, cpl_size nused, double background)
	Estimate the background in an image region.

void	EstimateFwhm (const odp::Image img, double peak_pos1, double peak_pos2, double bckg_level, double fwhm)
	Estimate the FWHM of a round object.

void	GetBarycentre (const odp::Image img, const cpl_size llx, const cpl_size lly, const cpl_size urx, const cpl_size ury, double bckg_level, double cut_level, double centre[2], double weight, cpl_size *nused)
	Compute the barycentre of an object.

void	DetectCircularApertures (const odp::Image img, const cpl_size llx, const cpl_size lly, const cpl_size urx, const cpl_size ury, odp::Matrix stat)
	Wrapper to the CLIPM detect circular aperture.

Public Member Functions inherited from ifw::odp::Error
	Error ()
	Class constructor.

virtual	~Error ()
	Class destructor.

void	ResetCplError ()
	Reset CPL error and internal error flag.

bool	CheckCplError () const
	Check if there is an error in CPL.

Additional Inherited Members
Protected Member Functions inherited from ifw::odp::Error
std::string	GetErrorMsg () const
	Get CPL error message.

Detailed Description

This class is C++ wrapper for a CPL and CLIPM recipes. It provides a simplified interface that allows to call CPL routines from INS applications.

Recipe - CPL and CLIPM recipe wrapper class

See also: CPL Reference: http://www.eso.org/observing/cpl/reference_3.0/ or above CLIPM library

Constructor & Destructor Documentation

◆ Recipe()

ifw::odp::Recipe::Recipe ( )

Class constructor.

Returns: none

◆ ~Recipe()

ifw::odp::Recipe::~Recipe ( )

Class destructor.

Returns: none

Member Function Documentation

◆ AlignCorrelate()

void ifw::odp::Recipe::AlignCorrelate	(	const odp::Image *	img1,
		const odp::Image *	img2,
		const odp::Matrix *	ref,
		unsigned int	wsize,
		double	maxd,
		unsigned int	mode,
		odp::Matrix *	trans,
		odp::Matrix *	shift,
		odp::Matrix *	pixels,
		odp::Matrix *	locs,
		odp::Matrix *	uncer,
		odp::Array *	err_codes )

Crosscorrelation of two images.

Parameters

[in]	img1	First image to cross-correlate.
[in]	img2	Second image to cross-correlate.
[in]	ref	Reference points.
[in]	wsize	Window size for each of the reference subwindows.
[in]	maxd	Maximum search distance.
[in]	mode	Alignment mode.
[out]	trans	Transformation matrix.
[out]	shift	Shift matrix.
[out]	pixels	Transformation shifting matrix.
[out]	locs	Shift location matrix.
[out]	uncer	Uncertainties matrix for each cetroid.
[out]	err_codes	List of error codes for correlation and centroding.

Interface to a clipm recipe function. It does the cross correlation between two images by correlation of a set of subwindows.

Please note that output matrix objects will be deleted before to point to the new allocated matrices. If output matrix objects are null, they are not going to be created.

See also: CLIPM function: clipm_align_correlate

◆ AlignPoints()

void ifw::odp::Recipe::AlignPoints	(	const odp::Matrix *	matrix1,
		const odp::Matrix *	matrix2,
		unsigned int	mode,
		odp::Matrix *	trans,
		odp::Matrix *	shift,
		odp::Matrix *	rot )

Linear transformation between two set of points.

Parameters

[in]	matrix1	First set of points (CPL matrix).
[in]	matrix2	Second set of points (CPL matrix).
[in]	mode	Aligning mode.
[out]	trans	Output transformation (CPL matrix).
[out]	shift	Output shift (CPL matrix).
[out]	rot	Output residuals (CPL matrix).

Interface to a clipm recipe function. It does the linear transformation between two set of points.

Please note that output matrix objects will be deleted before to point to the new allocated matrices. If output matrix objects are null, they are not going to be created.

See also: CLIPM function: clipm_align_points

◆ DetectCircularApertures()

void ifw::odp::Recipe::DetectCircularApertures	(	const odp::Image *	img,
		const cpl_size	llx,
		const cpl_size	lly,
		const cpl_size	urx,
		const cpl_size	ury,
		odp::Matrix *	stat )

Wrapper to the CLIPM detect circular aperture.

Parameters

[in]	img	Image to analyze.
[in]	llx	Lower left X coordinate of the box
[in]	lly	Lower left Y coordinate of the box
[in]	urx	Upper right X coordinate of the box
[in]	ury	Upper right Y coordinate of the box
[out]	stat	Matrix with the list of circular apertures detected

Interface to a clipm recipe function. This method is a wrapper for the function detecting circular apertures.

See also: CLIPM function: clipm_aperture_detect_circles

◆ EstimateBackground()

void ifw::odp::Recipe::EstimateBackground	(	const odp::Image *	img,
		const cpl_size	llx,
		const cpl_size	lly,
		const cpl_size	urx,
		const cpl_size	ury,
		double *	sigma,
		cpl_size *	nused,
		double *	background )

Estimate the background in an image region.

Parameters

[in]	img	Input image
[in]	llx	Lower left X coordinate of the box
[in]	lly	Lower left Y coordinate of the box
[in]	urx	Upper right X coordinate of the box
[in]	ury	Upper right Y coordinate of the box
[out]	sigma	(Optional output) background sigma, can be nullptr, returns -1.0 in the case of error
[out]	nused	(Optional output) number of found background pixels, can be nullptr, returns 0 in the case of error
[out]	background	Estimated background value.

See also: CLIPM function: clipm_image_signal_estimate_bg_in_region

◆ EstimateFwhm()

void ifw::odp::Recipe::EstimateFwhm	(	const odp::Image *	img,
		double	peak_pos1,
		double	peak_pos2,
		double	bckg_level,
		double *	fwhm )

Estimate the FWHM of a round object.

Parameters

[in]	img	Input image
[in]	peak_pos1	Peak position1
[in]	peak_pos2	Peak position2
[in]	bckg_level	Input background level to subtract
[out]	fwhm	Full with half maximum

See also: CLIPM function: clipm_priv_image_estimate_fwhm_round

◆ GetBarycentre()

void ifw::odp::Recipe::GetBarycentre	(	const odp::Image *	img,
		const cpl_size	llx,
		const cpl_size	lly,
		const cpl_size	urx,
		const cpl_size	ury,
		double	bckg_level,
		double	cut_level,
		double	centre[2],
		double *	weight,
		cpl_size *	nused )

Compute the barycentre of an object.

Parameters

[in]	img	Input image
[in]	llx	Lower left X coordinate of the box
[in]	lly	Lower left Y coordinate of the box
[in]	urx	Upper right X coordinate of the box
[in]	ury	Upper right Y coordinate of the box
[in]	bckg_level	Input background level to subtract
[in]	cut_level	Lower limit of values to use (separately from bckg_level) (values can be equal to or greater)
[out]	centre	Mandatory (double) buffer of size 2 to contain the barycentre position after true
[out]	weight	(Optional) output weight of the peak, can be nullptr
[out]	nused	(Optional output) number of found background pixels, can be nullptr, returns 0 in the case of error

See also: CLIPM function: clipm_priv_image_get_barycentre

◆ GetCenterGauss()

void ifw::odp::Recipe::GetCenterGauss	(	const odp::Image *	image,
		cpl_size	llx,
		cpl_size	lly,
		cpl_size	urx,
		cpl_size	ury,
		CenterGauss *	cen_gauss,
		const int	robustness = 0 )

Compute the center gauss of an image subwindow.

Parameters

[in]	image	Image object to compute the center gauss.
[in]	llx	Lower left X coordinate
[in]	lly	Lower left Y coordinate
[in]	urx	Upper right X coordinate
[in]	ury	Upper right Y coordinate
[out]	cen_gauss	Center gauss information.
[in]	robustness	Algorithm robustness.

Interface to a clipm recipe function. It obtains the center gauss of an image subwindow.

See also: CLIPM function: clipm_centroiding_gauss

◆ GetCenterMoment()

void ifw::odp::Recipe::GetCenterMoment	(	const odp::Image *	image,
		cpl_size	llx,
		cpl_size	lly,
		cpl_size	urx,
		cpl_size	ury,
		bool	wdw_enlarge,
		double	gain,
		CenterGauss *	cenMoment )

Compute the center moment of an image subwindow.

Parameters

[in]	image	Image object to compute the center moment.
[in]	llx	Lower left X coordinate
[in]	lly	Lower left Y coordinate
[in]	urx	Upper right X coordinate
[in]	ury	Upper right Y coordinate
[in]	wdw_enlarge	Flag to allow the function to increase the window size when it detects that the window cuts the wings of the centered object, default should be 0.
[in]	gain	(Optional) detector gain input in unit [1/electrons], required for computation of center error.
[out]	cenMoment	Center moment information.

See also: clipm_centroiding_moment

Interface to a clipm recipe function. It obtains the center moment of an image subwindow.

Warning: {Values fwhm_err and sigma_err of CenterGauss output are not filled by this function so they will be undetermined.}

See also: CLIPM function: clipm_centroiding_moment

◆ GetCircularAperture()

void ifw::odp::Recipe::GetCircularAperture	(	const odp::Image *	image,
		const cpl_size	llx,
		const cpl_size	lly,
		const cpl_size	urx,
		const cpl_size	ury,
		CircularAperture *	aperture,
		odp::Matrix *	stat )

Wrapper to the CLIPM circular characterization.

Parameters

[in]	image	Image to analyze.
[in]	llx	Lower left X coordinate of the box
[in]	lly	Lower left Y coordinate of the box
[in]	urx	Upper right X coordinate of the box
[in]	ury	Upper right Y coordinate of the box
[out]	aperture	Circular aperture data
[out]	stat	Statistical information

Interface to a clipm recipe function. This method is a wrapper for the circular aperture.

See also: CLIPM function: clipm_aperture_characterise_circular

◆ GetIqe()

void ifw::odp::Recipe::GetIqe	(	const odp::Image *	image,
		const cpl_size	startX,
		const cpl_size	startY,
		const cpl_size	endX,
		const cpl_size	endY,
		Iqe *	iqe )

Compute image quality estimator over an image subwindow.

Parameters

[in]	image	Image to compute the IQE
[in]	startX	Lower left X coordinate
[in]	startY	Lower left Y coordinate
[in]	endX	Upper right X coordinate
[in]	endY	Upper right Y coordinate
[out]	iqe	Information about the IQE

Get the image quality estimator using a CPL function.

See also: CPL function: cpl_image_iqe

◆ GetMultiCenterGauss()

void ifw::odp::Recipe::GetMultiCenterGauss	(	const odp::Image *	image,
		const odp::Matrix *	ref,
		unsigned int	areasize,
		odp::Matrix *	center,
		odp::Matrix *	center_err,
		odp::Matrix *	sigma,
		odp::Matrix *	sigma_err,
		odp::Matrix *	fwhm,
		odp::Matrix *	fwhm_err,
		odp::Matrix *	intensities,
		odp::Array *	err_codes,
		const int	robustness )

Compute multiple center gauss of an image.

Parameters

[in]	image	Image to compute the multiple center gauss.
[in]	ref	Matrix containing the reference points.
[in]	areasize	Size of area to compute the center gauss.
[out]	center	Output matrix containing the computed center.
[out]	center_err	Output matrix containing the error of the computed center.
[out]	sigma	Output matrix containing the computed sigma.
[out]	sigma_err	Output matrix containing the error of the computed sigma.
[out]	fwhm	Output matrix containing the computed FWHM.
[out]	fwhm_err	Output matrix containing the error of the computed FWHM.
[out]	intensities	Output matrix containing the computed intesities.
[out]	err_codes	Output array containing the error codes.
[in]	robustness	Algorithm robustness.

Interface to a clipm recipe function. It obtains the center gauss of an image subwindow.

Apply a gaussian fit over a set of image subwindows. CPL matrices are used for input and output data.

Please note that output matrix objects will be deleted before to point to the new allocated matrices. If output matrix objects are null, they are not going to be created.

See also: CLIPM function: clipm_centroiding_multi_gauss

◆ GetRectangularAperture()

void ifw::odp::Recipe::GetRectangularAperture	(	const odp::Image *	image,
		const cpl_size	llx,
		const cpl_size	lly,
		const cpl_size	urx,
		const cpl_size	ury,
		RectAperture *	aperture,
		odp::Matrix *	stat )

Wrapper to the CLIPM rectangular characterization.

Parameters

[in]	image	Image to analyze.
[in]	llx	Lower left X coordinate of the box
[in]	lly	Lower left Y coordinate of the box
[in]	urx	Upper right X coordinate of the box
[in]	ury	Upper right Y coordinate of the box
[out]	aperture	Rectangular aperture data
[out]	stat	Statistical information

Interface to a clipm recipe function. This method is a wrapper for the rectangular aperture.

See also: CLIPM function: clipm_aperture_characterise_rectangular

◆ GetRngPoisson2d() [1/2]

void ifw::odp::Recipe::GetRngPoisson2d	(	double	llx,
		double	lly,
		double	urx,
		double	ury,
		int	homogenity,
		int	npairs,
		void **	buffer_ptr,
		cpl_type	cpltype = CPL_TYPE_DOUBLE )

Generates a set of random numbers within a box.

Parameters

[in]	llx	Lower left X coordinate of the box
[in]	lly	Lower left Y coordinate of the box
[in]	urx	Upper right X coordinate of the box
[in]	ury	Upper right Y coordinate of the box
[in]	homogenity	Homogenity factor
[in]	npairs	Number of pairs.
[out]	buffer_ptr	Output buffer with the random values.
[in]	cpltype	CPL type.

Interface to a clipm recipe function. This is a method that generates a set of random offsets within a box following the Poisson law.

See also: CLIPM function: clipm_math_rng_poisson_pointpattern_2d

◆ GetRngPoisson2d() [2/2]

std::vector< double > ifw::odp::Recipe::GetRngPoisson2d	(	int	llx,
		int	lly,
		int	urx,
		int	ury,
		int	homogenity,
		int	npairs )

Generates a set of random numbers within a box.

Parameters

[in]	llx	Lower left X coordinate of the box
[in]	lly	Lower left Y coordinate of the box
[in]	urx	Upper right X coordinate of the box
[in]	ury	Upper right Y coordinate of the box
[in]	homogenity	Homogenity factor
[in]	npairs	Number of pairs.

Returns: STL vector with the generated data.

Interface to a clipm recipe function. This is a method that generates a set of random offsets within a box following the Poisson law.

See also: CLIPM function: clipm_math_rng_poisson_pointpattern_2d

◆ GetSlitPos()

void ifw::odp::Recipe::GetSlitPos	(	const odp::Image *	image,
		const int	max_width,
		SlitPos *	slit )

Computes the slit data.

Parameters

[in]	image	Image to compute the slit position.
[in]	max_width	Maximum slit width.
[out]	slit	structure with the slit information

Interface to clipm recipe function. It obtain the center position and tilt angle of the slit.

See also: CLIPM function: clipm_aperture_slitpos

The documentation for this class was generated from the following files:

cppcpl/src/include/ifw/odp/cppcpl/recipe.hpp
cppcpl/src/recipe.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Recipe()

◆ ~Recipe()

Member Function Documentation

◆ AlignCorrelate()

◆ AlignPoints()

◆ DetectCircularApertures()

◆ EstimateBackground()

◆ EstimateFwhm()

◆ GetBarycentre()

◆ GetCenterGauss()

◆ GetCenterMoment()

◆ GetCircularAperture()

◆ GetIqe()

◆ GetMultiCenterGauss()

◆ GetRectangularAperture()

◆ GetRngPoisson2d() [1/2]

◆ GetRngPoisson2d() [2/2]

◆ GetSlitPos()