ConvenienceProcessors.hpp File Reference

#include <ImLib3D/ImageProcessor.hpp>
#include <ImLib3D/ConvenienceProcessors.hxx>

Include dependency graph for ConvenienceProcessors.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	IP3D
Functions
template<class ImageType1, class ImageType2>
void	ImageTypeConversion (const ImageType1 &src, ImageType2 &res)
template<class ImageType>
void	Crop (const ImageType &src, const RectZone3Di &zone, ImageType &res0)
template<class ImageType>
void	FindFirstDifference (const ImageType &src1, const ImageType &src2, bool &found, Vect3Di &pos)
template<class ImageType>
void	FindMinMax (const ImageType &src, typename ImageType::value_type &vmin, typename ImageType::value_type &vmax, Vect3Di *posMin=NULL, Vect3Di *posMax=NULL)
template<class ImageType>
void	L2Norm (const ImageType &src, double &energy)
template<class ImageType>
void	SetAllVoxels (const ImageType &src, const typename ImageType::value_type &v, ImageType &res)
template<class ImageType>
void	AddMask (const ImageType &src, ImageType &res, const Mask3D *mask=NULL)
template<class ImageType>
void	GetMask (const ImageType &src, Mask3D &res)
template<class ImageType>
void	ApplyMask (const ImageType &src, ImageType &res, byte maskvalue=0, const Mask3D *optmask=NULL)
template<class ImageType>
void	SetDefaultInterpolator (const ImageType &src, const string &name, ImageType &res)
template<class ComplexImageType>
void	ExtractFromComplexImage (const ComplexImageType &src, const string &type, Image3Df &res)
template<class ImageType>
void	SetProperty (const ImageType &src, const string &name, const string &typeName, string value, ImageType &res)
template<class ImageType>
void	RemoveProperty (const ImageType &src, const string &name, ImageType &res)
template<class ImageType>
void	Pad (const ImageType &src, Vect3Di paddingV, ImageType &res, bool padLinear=false)

---

Detailed Description

Definition in file ConvenienceProcessors.hpp.

---

Function Documentation

template<class ImageType1, class ImageType2> void IP3D::ImageTypeConversion (  const ImageType1 &  src, ImageType2 &  res )

#&ImageTypeConversion&# Converts one image type to another. The conversion must be valid (ie. a conversion operator must exist for the contaned types). Examples use: converting a mask into a floating point image. Source image type:ImageType Result image type:ImageType Result typename type:ImageTypeName ~ Definition at line 40 of file ConvenienceProcessors.hpp.

template<class ImageType> void IP3D::Crop (  const ImageType &  src, const RectZone3Di &  zone, ImageType &  res0 )

#&Crop&# Extract part of an image. (x0,y0,z0) and (x1,y1,z1) Are the bounding boints of the subimage. Both are included. Properties are copied and mask is croped too. Source image type:ImageType zone type:RectZone3Di Result image type:ImageType ~

template<class ImageType> void IP3D::FindFirstDifference (  const ImageType &  src1, const ImageType &  src2, bool &  found, Vect3Di &  pos )

#&FindFirstDifference&# Compares two images til it finds a difference, and returns position. Images must have same size. Ignores masks. Source image1 type:ImageType Source image2 type:ImageType found difference type:bool position type:Vect3Di ~ Definition at line 71 of file ConvenienceProcessors.hpp.

template<class ImageType> void IP3D::FindMinMax (  const ImageType &  src, typename ImageType::value_type &  vmin, typename ImageType::value_type &  vmax, Vect3Di *  posMin = NULL, Vect3Di *  posMax = NULL )

#&FindMinMax&# Finds minimum and maximum values of an image. Optionally resturns position of those values Ignores masks. Source image type:ImageType min type:Im3DValue max type:Im3DValue min position type:Vect3Di max position type:Vect3Di ~ Definition at line 95 of file ConvenienceProcessors.hpp. Referenced by ProbabilityDistribution::SetWithImage3Dlinear3().

template<class ImageType> void IP3D::L2Norm (  const ImageType &  src, double &  energy )

#&L2Norm&# ~ Definition at line 121 of file ConvenienceProcessors.hpp.

template<class ImageType> void IP3D::SetAllVoxels (  const ImageType &  src, const typename ImageType::value_type &  v, ImageType &  res )

#&SetAllVoxels&# Sets all voxels of image to a specified value. Value is constructed from string argument using the FromString overloaded template. Source image type:ImageType v type:Im3DValue Result image type:ImageType ~ Definition at line 139 of file ConvenienceProcessors.hpp.

template<class ImageType> void IP3D::AddMask (  const ImageType &  src, ImageType &  res, const Mask3D *  mask = NULL )

#&AddMask&# Adds a mask to an image. Mask image can be specified by an optional third argument. Otherwise mask is intialized to 1. If image already contains a mask, this mask will be assigned the optional argument or will be left untouched. Source image type:ImageType Result image type:ImageType Mask type:Mask3D ~ Definition at line 159 of file ConvenienceProcessors.hpp.

template<class ImageType> void IP3D::GetMask (  const ImageType &  src, Mask3D &  res )

#&GetMask&# Gets the mask of an image. Source image type:ImageType Result Mask type:Mask3D ~ Definition at line 180 of file ConvenienceProcessors.hpp. References Image3D::Mask().

template<class ImageType> void IP3D::ApplyMask (  const ImageType &  src, ImageType &  res, byte  maskvalue = 0, const Mask3D *  optmask = NULL )

#&ApplyMask&# Applies a mask on an image. For maskvalue=0, image will be masked for all non-zero mask values. For maskvalues > 0, the mask will be first thresholded so that a mask corresponding to the label maskvalue will be used for masking. If no mask is provided the mask of the source will be used. Source image type:ImageType Result image type:ImageType Mask value type:byte Mask type:Mask3D ~

template<class ImageType> void IP3D::SetDefaultInterpolator (  const ImageType &  src, const string &  name, ImageType &  res )

#&SetDefaultInterpolator&# Sets the default interpolator type name. By default spline degree 5 interpolation is used (this can be slow). Source image type:ImageType Interpolator type name type:string Result image type:ImageType ~ Definition at line 216 of file ConvenienceProcessors.hpp.

template<class ComplexImageType> void IP3D::ExtractFromComplexImage (  const ComplexImageType &  src, const string &  type, Image3Df &  res )

#&ExtractFromComplexImage&# Extracts Imag, Real, Norm2 or Module from a complex valued image into a Image3Df. No masks Source image type:Image3Dcomplexf result type type:string Result image type:Image3Df ~

template<class ImageType> void IP3D::SetProperty (  const ImageType &  src, const string &  name, const string &  typeName, string  value, ImageType &  res )

#&SetProperty&# Set a named image property. Image properties are referenced by name, have a type (float,int, string etc.). Source image type:ImageType name type:string typeName type:string value type:string Result image type:ImageType ~ Definition at line 252 of file ConvenienceProcessors.hpp.

template<class ImageType> void IP3D::RemoveProperty (  const ImageType &  src, const string &  name, ImageType &  res )

#&RemoveProperty&# Sets the default interpolator type name. By default spline degree 5 interpolation is used (this can be slow). Source image type:ImageType Interpolator type name type:string Result image type:ImageType ~ Definition at line 276 of file ConvenienceProcessors.hpp.

template<class ImageType> void IP3D::Pad (  const ImageType &  src, Vect3Di  paddingV, ImageType &  res, bool  padLinear = false )

#&Pad&# Add space around an image. If padLinear is true, the border will be filled with linearly decreasing values. The padding argument gives the amount of space to be added in each 6 directions. Source image type:ImageType padding type:Vect3Di Result image type:ImageType pad linear type:bool ~ Definition at line 298 of file ConvenienceProcessors.hpp. References IP3D::InsertImage(), Vect3D< Value, Real >::Norm(), Vect3D< Value, Real >::x, Vect3D< Value, Real >::y, and Vect3D< Value, Real >::z.

---