Radial Profiles

Radial profiles of images

Functions
template<typename vecT , typename eigenImT1 , typename eigenImT2 , typename eigenImT3 >
void	mx::improc::radprof (vecT &rad, vecT &prof, const eigenImT1 &im, const eigenImT2 &radim, const eigenImT3 *mask, bool mean=false, typename eigenImT1::Scalar minr=0)
	Calculate the the radial profile.
template<typename vecT , typename eigenImT1 , typename eigenImT2 >
void	mx::improc::radprof (vecT &rad, vecT &prof, const eigenImT1 &im, const eigenImT2 &mask, bool mean=false)
	Calculate the the radial profile.
template<typename vecT , typename eigenImT1 >
void	mx::improc::radprof (vecT &rad, vecT &prof, const eigenImT1 &im, bool mean=false, double dr=1)
	Calculate the the radial profile.
template<typename radprofT , typename eigenImT1 , typename eigenImT2 , typename eigenImT3 >
void	mx::improc::radprofim (radprofT &radprofIm, eigenImT1 &im, const eigenImT2 &rad, const eigenImT3 *mask, bool subtract, bool mean=false)
	Form a radial profile image, and optionally subtract it from the input.
template<typename radprofT , typename eigenImT >
void	mx::improc::radprofim (radprofT &radprof, eigenImT &im, bool subtract=false, bool mean=false)
	Form a radial profile image, and optionally subtract it from the input.

Function Documentation

radprof() [1/3]

template<typename vecT , typename eigenImT1 >

void mx::improc::radprof	(	vecT &	rad,
		vecT &	prof,
		const eigenImT1 &	im,
		bool	mean = false,
		double	dr = 1
	)

Calculate the the radial profile.

The median radial profile is calculated by rebinning to a 1 pixel grid. This version calculates a centered radius image.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Template Parameters

vecT	the std::vector-like type to contain the profile
eigenImT1	the eigen-array-like type of the input image

Parameters

[out]	rad	the radius points for the profile. Should be empty.
[out]	prof	the median image value at the corresponding radius. Should be empty.
[in]	im	the image of which to calculate the profile
[in]	mean	[optional] set to true to use the mean. If false (default) the median is used.

Definition at line 1024 of file imageFilters.hpp.

References mx::improc::radiusImage(), and mx::improc::radprof().

radprof() [2/3]

template<typename vecT , typename eigenImT1 , typename eigenImT2 >

void mx::improc::radprof	(	vecT &	rad,
		vecT &	prof,
		const eigenImT1 &	im,
		const eigenImT2 &	mask,
		bool	mean = false
	)

Calculate the the radial profile.

The median radial profile is calculated by rebinning to a 1 pixel grid. This version calculates a centered radius image.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Template Parameters

vecT	the std::vector-like type to contain the profile
eigenImT1	the eigen-array-like type of the input image
eigenImT2	the eigen-array-like type of the radius and mask image
eigenImT3	the eigen-array-like type of the mask image

Parameters

[out]	rad	the radius points for the profile. Should be empty.
[out]	prof	the median image value at the corresponding radius. Should be empty.
[in]	im	the image of which to calculate the profile
[in]	mask	1/0 mask, only pixels with a value of 1 are included in the profile
[in]	mean	[optional] set to true to use the mean. If false (default) the median is used.

Definition at line 996 of file imageFilters.hpp.

References mx::improc::radiusImage(), and mx::improc::radprof().

radprof() [3/3]

template<typename vecT , typename eigenImT1 , typename eigenImT2 , typename eigenImT3 >

void mx::improc::radprof	(	vecT &	rad,
		vecT &	prof,
		const eigenImT1 &	im,
		const eigenImT2 &	radim,
		const eigenImT3 *	mask,
		bool	mean = false,
		typename eigenImT1::Scalar	minr = 0
	)

Calculate the the radial profile.

The median radial profile is calculated by rebinning to a 1 pixel grid.

Template Parameters

vecT	the std::vector-like type to contain the profile
eigenImT1	the eigen-array-like type of the input image
eigenImT2	the eigen-array-like type of the radius and mask image
eigenImT3	the eigen-array-like type of the mask image

Parameters

[out]	rad	the radius points for the profile. Should be empty.
[out]	prof	the median image value at the corresponding radius. Should be empty.
[in]	im	the image of which to calculate the profile
[in]	radim	image of radius values per pixel
[in]	mask	[optional] 1/0 mask, only pixels with a value of 1 are included in the profile. Set to 0 to not use.
[in]	mean	[optional] set to true to use the mean. If false (default) the median is used.

Definition at line 872 of file imageFilters.hpp.

Referenced by mx::improc::radprof(), mx::improc::radprof(), mx::improc::radprofim(), and mx::improc::radprofim().

radprofim() [1/2]

template<typename radprofT , typename eigenImT >

void mx::improc::radprofim	(	radprofT &	radprof,
		eigenImT &	im,
		bool	subtract = false,
		bool	mean = false
	)

Form a radial profile image, and optionally subtract it from the input.

The radial profile is calculated using linear interpolation on a 1 pixel grid. This version calculates a centered radius image.

Template Parameters

radprofT	the eigen array type of the output
eigenImT	the eigen array type of the input

Parameters

[out]	radprof	the radial profile image. This will be resized.
[in]	im	the image to form the profile of.
[in]	subtract	[optional] if true, then on ouput im will have had its radial profile subtracted.
[in]	mean	[optional] set to true to use the mean. If false (default) the median is used.

Definition at line 1101 of file imageFilters.hpp.

References mx::improc::radiusImage(), mx::improc::radprof(), and mx::improc::radprofim().

radprofim() [2/2]

template<typename radprofT , typename eigenImT1 , typename eigenImT2 , typename eigenImT3 >

void mx::improc::radprofim	(	radprofT &	radprofIm,
		eigenImT1 &	im,
		const eigenImT2 &	rad,
		const eigenImT3 *	mask,
		bool	subtract,
		bool	mean = false
	)

Form a radial profile image, and optionally subtract it from the input.

The radial profile is calculated using linear interpolation on a 1 pixel grid

Template Parameters

radprofT	the eigen array type of the output
eigenImT1	the eigen array type of the input image
eigenImT2	the eigen array type of the radius image
eigenImT3	the eigen array type of the mask image

Parameters

[out]	radprofIm	the radial profile image. This will be resized.
	im	[in the image to form the profile of.
[in]	rad	an array of radius values for each pixel
[in]	mask	[optional 1/0 mask, only pixels with a value of 1 are included in the profile. Can be nullptr.
[in]	subtract	if true, then on ouput im will have had its radial profile subtracted.
[in]	mean	[optional] set to true to use the mean. If false (default) the median is used.

Definition at line 1051 of file imageFilters.hpp.

References mx::improc::radprof().

Referenced by mx::improc::radprofim().