A.I.M.S algorithms


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

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 >:
Collaboration diagram for aims::singlechannel::SubSamplingImageAlgorithm< T >:

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 &options)
 
virtual void updateOptions (const carto::Object &options)
 
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 AimsData< T > execute (const AimsData< 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)
 
ImageAlgorithmInterfaceoperator= (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
Ttype of voxel that will be subsampled.

Definition at line 56 of file subsamplingimagealgorithm.h.

Member Typedef Documentation

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

Definition at line 130 of file subsamplingimagealgorithm.h.

Constructor & Destructor Documentation

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

Definition at line 160 of file subsamplingimagealgorithm.h.

Definition at line 168 of file subsamplingimagealgorithm.h.

template<typename T >
virtual aims::singlechannel::SubSamplingImageAlgorithm< T >::~SubSamplingImageAlgorithm ( )
inlinevirtual

Definition at line 187 of file subsamplingimagealgorithm.h.

Member Function Documentation

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 152 of file subsamplingimagealgorithm.h.

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
inInput image to process
outOutput image processed

Implements aims::ImageAlgorithmInterface< T >.

Definition at line 198 of file subsamplingimagealgorithm.h.

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

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
Point4dldims 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 138 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.

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
Point4dfvoxelsize 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 145 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.

Member Data Documentation


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