aimsalgo: aims::singlechannel::SubSamplingImageAlgorithm< T > Class Template Reference

aimsalgo 5.1.2

Neuroimaging image processing

aims::singlechannel::SubSamplingImageAlgorithm is the algorithm to apply subsampling on single channel image. More...

#include <aims/resampling/subsamplingimagealgorithm.h>

Inheritance diagram for aims::singlechannel::SubSamplingImageAlgorithm< T >:

Inheritance graph

[legend]

Collaboration diagram for aims::singlechannel::SubSamplingImageAlgorithm< T >:

Collaboration graph

[legend]

Public Types
typedef T	VoxelType

Public Types inherited from aims::ImageAlgorithmInterface< T >
typedef T	VoxelType

Public Member Functions
virtual void	execute (const carto::VolumeRef< T > &in, carto::VolumeRef< T > &out) const
	`ImageAlgorithmInterface<T>` Pure virtual method. More...

virtual Point4dl	getOutputImageDimensions (const Point4dl &dims) const
	Returns the output dimensions of the processed image. More...

virtual Point4df	getOutputImageVoxelSize (const Point4df &voxelsize) const
	Returns the output voxel size of the processed image. More...

virtual SubSamplingImageAlgorithm< T > *	clone () const
	`ImageAlgorithmInterface<T>` Pure virtual method. More...

	SubSamplingImageAlgorithm (int sx, int sy, int sz, const FilteringFunctionInterface< T > &f)

	SubSamplingImageAlgorithm (const SubSamplingImageAlgorithm &other)

SubSamplingImageAlgorithm< T > &	operator= (const SubSamplingImageAlgorithm &other)

virtual	~SubSamplingImageAlgorithm ()

Public Member Functions inherited from aims::ImageAlgorithmInterface< T >
virtual void	setOptions (const carto::Object &)

virtual void	updateOptions (const carto::Object &)

virtual Point4dl	getOutputImageDimensions (const long &dx=1, const long &dy=1, const long &dz=1, const long &dt=1) const

virtual Point4df	getOutputImageVoxelSize (const float &vx=1.0, const float &vy=1.0, const float &vz=1.0, const float &vt=1.0) const

virtual carto::VolumeRef< T >	execute (const carto::VolumeRef< T > &in) const

virtual void	setVerbose (int level)

virtual void	setQuiet ()

virtual	~ImageAlgorithmInterface ()

Protected Attributes
int	_win_size_x

int	_win_size_y

int	_win_size_z

carto::rc_ptr< FilteringFunctionInterface< T > >	_func

Protected Attributes inherited from aims::ImageAlgorithmInterface< T >
int	_verbose

Additional Inherited Members
Protected Member Functions inherited from aims::ImageAlgorithmInterface< T >
	ImageAlgorithmInterface ()

	ImageAlgorithmInterface (const ImageAlgorithmInterface &other)

ImageAlgorithmInterface &	operator= (const ImageAlgorithmInterface &other)

Detailed Description

template<typename T>
class aims::singlechannel::SubSamplingImageAlgorithm< T >

aims::singlechannel::SubSamplingImageAlgorithm is the algorithm to apply subsampling on single channel image.

The aims::SubSamplingImageAlgorithm class is used to subsample a single channel image.

Template Parameters

T	type of voxel that will be subsampled.

Definition at line 123 of file subsamplingimagealgorithm.h.

Member Typedef Documentation

◆ VoxelType

template<typename T >

typedef T aims::singlechannel::SubSamplingImageAlgorithm< T >::VoxelType

Definition at line 129 of file subsamplingimagealgorithm.h.

Constructor & Destructor Documentation

◆ SubSamplingImageAlgorithm() [1/2]

template<typename T >

aims::singlechannel::SubSamplingImageAlgorithm< T >::SubSamplingImageAlgorithm	(	int	sx,
		int	sy,
		int	sz,
		const FilteringFunctionInterface< T > &	f
	)

inline

Definition at line 159 of file subsamplingimagealgorithm.h.

◆ SubSamplingImageAlgorithm() [2/2]

template<typename T >

aims::singlechannel::SubSamplingImageAlgorithm< T >::SubSamplingImageAlgorithm ( const SubSamplingImageAlgorithm< T > & other )

inline

Definition at line 168 of file subsamplingimagealgorithm.h.

◆ ~SubSamplingImageAlgorithm()

template<typename T >

virtual aims::singlechannel::SubSamplingImageAlgorithm< T >::~SubSamplingImageAlgorithm ( )

inlinevirtual

Definition at line 188 of file subsamplingimagealgorithm.h.

Member Function Documentation

◆ clone()

template<typename T >

virtual SubSamplingImageAlgorithm<T>* aims::singlechannel::SubSamplingImageAlgorithm< T >::clone ( ) const

inlinevirtual

ImageAlgorithmInterface<T> Pure virtual method.

Clone the object

Implements aims::ImageAlgorithmInterface< T >.

Definition at line 151 of file subsamplingimagealgorithm.h.

◆ execute()

template<typename T >

void aims::singlechannel::SubSamplingImageAlgorithm< T >::execute	(	const carto::VolumeRef< T > &	in,
		carto::VolumeRef< T > &	out
	)		const

inlinevirtual

ImageAlgorithmInterface<T> Pure virtual method.

Returns the image processed by an algorithm on the input image into an already allocated output volume.

Parameters

in	Input image to process
out	Output image processed

Implements aims::ImageAlgorithmInterface< T >.

Definition at line 199 of file subsamplingimagealgorithm.h.

References carto::VolumeRef< class >::getSizeT(), carto::VolumeRef< class >::getSizeX(), carto::VolumeRef< class >::getSizeY(), carto::VolumeRef< class >::getSizeZ(), and carto::VolumeRef< class >::setPosInRefVolume().

◆ getOutputImageDimensions()

template<typename T >

virtual Point4dl aims::singlechannel::SubSamplingImageAlgorithm< T >::getOutputImageDimensions ( const Point4dl & dims ) const

inlinevirtual

Returns the output dimensions of the processed image.

This is used when output image does not have the same dimensions as input image.

Parameters

Point4dl dims dimensions of the input image.

Returns: Point4dl dimensions of the output image.

The default implementation returns same dimensions as input.

Reimplemented from aims::ImageAlgorithmInterface< T >.

Definition at line 137 of file subsamplingimagealgorithm.h.

References aims::singlechannel::SubSamplingImageAlgorithm< T >::_win_size_x, aims::singlechannel::SubSamplingImageAlgorithm< T >::_win_size_y, and aims::singlechannel::SubSamplingImageAlgorithm< T >::_win_size_z.

◆ getOutputImageVoxelSize()

template<typename T >

virtual Point4df aims::singlechannel::SubSamplingImageAlgorithm< T >::getOutputImageVoxelSize ( const Point4df & voxelsize ) const

inlinevirtual

Returns the output voxel size of the processed image.

This is used when output image does not have the same voxel size as input image.

Parameters

Point4df voxelsize voxel size of the input image.

Returns: Point4df voxel size of the output image.

The default implementation returns same voxel size as input.

Reimplemented from aims::ImageAlgorithmInterface< T >.

Definition at line 144 of file subsamplingimagealgorithm.h.

References aims::singlechannel::SubSamplingImageAlgorithm< T >::_win_size_x, aims::singlechannel::SubSamplingImageAlgorithm< T >::_win_size_y, and aims::singlechannel::SubSamplingImageAlgorithm< T >::_win_size_z.

◆ operator=()

template<typename T >

SubSamplingImageAlgorithm<T>& aims::singlechannel::SubSamplingImageAlgorithm< T >::operator= ( const SubSamplingImageAlgorithm< T > & other )

inline

Definition at line 176 of file subsamplingimagealgorithm.h.

References aims::singlechannel::SubSamplingImageAlgorithm< T >::_func, aims::singlechannel::SubSamplingImageAlgorithm< T >::_win_size_x, aims::singlechannel::SubSamplingImageAlgorithm< T >::_win_size_y, aims::singlechannel::SubSamplingImageAlgorithm< T >::_win_size_z, and ASSERT.

Member Data Documentation

◆ _func

template<typename T >

carto::rc_ptr<FilteringFunctionInterface<T> > aims::singlechannel::SubSamplingImageAlgorithm< T >::_func

protected

Definition at line 194 of file subsamplingimagealgorithm.h.

Referenced by aims::singlechannel::SubSamplingImageAlgorithm< T >::operator=().

◆ _win_size_x

template<typename T >

int aims::singlechannel::SubSamplingImageAlgorithm< T >::_win_size_x

protected

Definition at line 191 of file subsamplingimagealgorithm.h.

Referenced by aims::singlechannel::SubSamplingImageAlgorithm< T >::getOutputImageDimensions(), aims::singlechannel::SubSamplingImageAlgorithm< T >::getOutputImageVoxelSize(), and aims::singlechannel::SubSamplingImageAlgorithm< T >::operator=().

◆ _win_size_y

template<typename T >

int aims::singlechannel::SubSamplingImageAlgorithm< T >::_win_size_y

protected

Definition at line 192 of file subsamplingimagealgorithm.h.

Referenced by aims::singlechannel::SubSamplingImageAlgorithm< T >::getOutputImageDimensions(), aims::singlechannel::SubSamplingImageAlgorithm< T >::getOutputImageVoxelSize(), and aims::singlechannel::SubSamplingImageAlgorithm< T >::operator=().

◆ _win_size_z

template<typename T >

int aims::singlechannel::SubSamplingImageAlgorithm< T >::_win_size_z

protected

Definition at line 193 of file subsamplingimagealgorithm.h.

Referenced by aims::singlechannel::SubSamplingImageAlgorithm< T >::getOutputImageDimensions(), aims::singlechannel::SubSamplingImageAlgorithm< T >::getOutputImageVoxelSize(), and aims::singlechannel::SubSamplingImageAlgorithm< T >::operator=().

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

aims/resampling/subsamplingimagealgorithm.h