OpenTissue::image Namespace Reference

Namespaces
namespace	detail
Classes
class	Image
struct	keep_transparency
struct	no_transparency
Functions
void	alpha_modulation (OpenTissue::image::Image< unsigned char > &image, OpenTissue::image::Image< unsigned char > const &alpha)
template<typename image_type >
void	animate_turbulence (image_type &image, float time=0.0f, float freq=4.0f, float amplitude=0.25f, size_t octaves=4u)
template<typename image_type >
size_t	get_max_octaves (image_type const &image)
template<typename image_type >
void	make_fractal_sum_abs_noise (image_type &image, float freq=4.0f, float amplitude=0.25f, size_t octaves=4u)
template<typename image_type >
void	make_fractal_sum_noise (image_type &image, float freq=4.0f, float amplitude=0.25f, size_t octaves=4u)
template<typename image_type >
void	make_noise (image_type &image, float freq=4.0f, float amplitude=1.0f)
boost::shared_ptr < OpenTissue::image::Image < unsigned char > >	screen_capture (keep_transparency const &)
boost::shared_ptr < OpenTissue::image::Image < unsigned char > >	screen_capture (no_transparency const &)
boost::shared_ptr < OpenTissue::image::Image < unsigned char > >	screen_capture ()
bool	read (std::string const &filename, OpenTissue::image::Image< unsigned char > &image, bool show_statistics=true)
bool	write (std::string const &filename, OpenTissue::image::Image< unsigned char > const &image)

---

Function Documentation

void OpenTissue::image::alpha_modulation	(	OpenTissue::image::Image< unsigned char > &	image,
		OpenTissue::image::Image< unsigned char > const &	alpha
	)

Alpha Modulation.

Parameters:

	image	Upon return the alpha channel of this image will have been multiplied with the specified alpha channel image.
	alpha	A alpha channel image.

template<typename image_type >

void OpenTissue::image::animate_turbulence	(	image_type &	image,
		float	time = 0.0f,
		float	freq = 4.0f,
		float	amplitude = 0.25f,
		size_t	octaves = 4u
	)

Animte Turbulence

Parameters:

	image
	time
	freq
	amplitude
	octaves

template<typename image_type >

size_t OpenTissue::image::get_max_octaves

(

image_type const &

image

)

[inline]

Get Maximum Octaves.

Parameters:

image

A reference to the image.

Returns:

The maximum number of octaves that can be seen at the current resolution of the image.

template<typename image_type >

void OpenTissue::image::make_fractal_sum_abs_noise	(	image_type &	image,
		float	freq = 4.0f,
		float	amplitude = 0.25f,
		size_t	octaves = 4u
	)

Genereate Fractal Sum Absolute Noise Image.

Parameters:

	image	A refernece to the image that upon return will be filled with the fractal sum absolute noise.
	freq	The frequency of the noise.
	amplitude	The amplitude of the noise.
	octaves	The numer of octaves to use.

template<typename image_type >

void OpenTissue::image::make_fractal_sum_noise	(	image_type &	image,
		float	freq = 4.0f,
		float	amplitude = 0.25f,
		size_t	octaves = 4u
	)

Genereate Fractal Sum Noise Image.

Parameters:

	image	A refernece to the image that upon return will be filled with the fractal sum noise.
	freq	The frequency of the noise.
	amplitude	The amplitude of the noise.
	octaves	The numer of octaves to use.

template<typename image_type >

void OpenTissue::image::make_noise	(	image_type &	image,
		float	freq = 4.0f,
		float	amplitude = 1.0f
	)

Fill Image with Noise.

Parameters:

	image	Upon return this image will contain the generated noise-image.
	freq	The frequency of the noise.
	amplitude	The amplitude of the noise.

bool OpenTissue::image::read	(	std::string const &	filename,
		OpenTissue::image::Image< unsigned char > &	image,
		bool	show_statistics = true
	)

Read Image.

Parameters:

	filename
	image

Returns:

If succesful then the return value is true otherwise it is false.

boost::shared_ptr<OpenTissue::image::Image<unsigned char> > OpenTissue::image::screen_capture

(

)

Screen Capture. Uses the keep_transparency mode by default.

Returns:

A pointer to an image containing the captured screen.

boost::shared_ptr<OpenTissue::image::Image<unsigned char> > OpenTissue::image::screen_capture

(

no_transparency const &

)

Screen Capture. Ignores any transparency information stored in the frame buffer.

This function was contributed by Christian Iversen, due to problems with ATI drivers on linux/windows.

Returns:

A pointer to an image containing the captured screen.

boost::shared_ptr<OpenTissue::image::Image<unsigned char> > OpenTissue::image::screen_capture

(

keep_transparency const &

)

Screen Capture. This function keeps transparency information from the frame buffer.

Returns:

A pointer to an image containing the captured screen.

bool OpenTissue::image::write	(	std::string const &	filename,
		OpenTissue::image::Image< unsigned char > const &	image
	)

Write Image.

Parameters:

	filename
	image

Returns:

If succesful then the return value is true otherwise it is false.