Resamples along z-axis a 3d image with regularly spaced z-plans. More...

IPSDKIPLGEOMETRICTRANSFORM_API image::ImagePtr	ipsdk::imaproc::gtrans::resampleRegularZStack3dImg (const image::ImageConstPtr &pInImg, ipReal32 zScaleFactor, const ipsdk::imaproc::attr::eInterpolationPolicy &interpolationPolicy)
	wrapper function for Resamples along z-axis a 3d image with regularly spaced z-plans More...

IPSDKIPLGEOMETRICTRANSFORM_API void	ipsdk::imaproc::gtrans::resampleRegularZStack3dImg (const image::ImageConstPtr &pInImg, ipReal32 zScaleFactor, const ipsdk::imaproc::attr::eInterpolationPolicy &interpolationPolicy, const image::ImagePtr &pOutImg)
	wrapper function for Resamples along z-axis a 3d image with regularly spaced z-plans More...

IPSDKIPLGEOMETRICTRANSFORM_API void	ipsdk::imaproc::gtrans::resampleRegularZStack3dImg (const image::ImageConstPtr &pInImg, const ipsdk::imaproc::attr::eInterpolationPolicy &interpolationPolicy, const image::ImagePtr &pOutImg)
	wrapper function for Resamples along z-axis a 3d image with regularly spaced z-plans More...

Detailed Description

Resamples along z-axis a 3d image with regularly spaced z-plans.

This algorithm allows to resample along z-axis a 3d image with regularly spaced z-plans.

The parameters of this algorithm are:

: integral value, strictly positive, specifying the size of the resulting image along its z-axis. This parameter is used only if the geometry of the output image is initialized by the algorithm, not by the user. If this parameter is initialized, the must be left unspecified,
: floating value, strictly positive, specifying the scale factor to apply for the resampling along the z-axis. If this parameter is initialized, the must be left unspecified,
: enumerate permitting to specify the interpolation method used to resample the image. The following interpolation methods are available:
- eInterpolationPolicy::eIP_NearestNeighbour: the voxel value of the output image at position (xOut, yOut, zOut) equals to the value of the voxel nearest to the associated position in the input image along the z-axis. This is the certainly one of the fastest methods, but it generates a coarse image, with aliasing,
- eInterpolationPolicy::eIP_Linear: for each voxel of the output image, the voxel value is computed by doing a linear interpolation on the 2 nearest neighbours along the z-axis. It gives satisfying results, and it is a good compromise between speed and quality,
- eInterpolationPolicy::eIP_Cubic: for each voxel of the output image, the voxel value is computed by doing a cubic interpolation on the 4 nearest neighbours along the z-axis. This method is slower than the linear interpolation, but it usually gives better results, generating sharper edges than linear interpolation.

If the user allocates the output image, this last one must satisfy the following criterions:

its sizes along x-axis and y-axis must equal to the sizes of the input image along x-axis and y-axis,
its temporal size must equal to the temporal size of the input image,
the number of its color channel must equal to the number of color channels of the input image,
if the parameter is specified, the size along z-axis of the output image must equal to the integer part of .

Attributes description

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InImg3d	[Input] 3d image for operation	X
ipsdk::imaproc::attr::InInterpolationPolicy	[Input] interpolation policy used to extract local data from image	X
ipsdk::imaproc::attr::InOptOutputImg3dZSize	[Input Optional] z-size of 3d output image	X
ipsdk::imaproc::attr::InOptZScaleFactor	[Input Optional] z-size of 3d output image	X
ipsdk::imaproc::attr::OutImg	[Output] image for processing operation	customOutput (_pOutImg, outputZoom3dZ(_pInImg3d,_pInOptZScaleFactor,_pInOptOutputImg3dZSize))

Global Rule description

Global rule description for algorithm :
ipsdk::imaproc::noInSitu (_pInImg3d,_pOutImg) &&
ipsdk::processor::If (ipsdk::processor::isNotEqual<InOptOutputImg3dZSize>(_pInOptOutputImg3dZSize,0), _pInOptZScaleFactor==.0f,_pInOptZScaleFactor!=.0f) &&
ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_CT,_pInImg3d,_pOutImg) &&
ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_2d,_pInImg3d,_pOutImg) &&
ipsdk::imaproc::customImageProperty (_pOutImg,
matchZScaleFactor (_pInImg3d,_pInOptZScaleFactor,_pInOptOutputImg3dZSize))

Example of Python code :

Example imports

import PyIPSDK

import PyIPSDK.IPSDKIPLGeometricTransform as gtrans

Code Example

    # define input 3d image from file path    
    inputImgPath = os.path.join(utImagesCommonPath,  "Rope3d.tif")
    
    # load input 3d image from file
    inImg = PyIPSDK.loadTiffImageFile(inputImgPath)
    
    # apply linear resampling on input image along z-axis with a scale factor of 1.234
    zScaleFactor = 1.234
    outImg = gtrans.resampleRegularZStack3dImg(inImg, zScaleFactor, PyIPSDK.eInterpolationPolicy.eIP_Linear)

Example of C++ code :

Example informations

Associated library

IPSDKIPLGeometricTransform

Header file

#include <IPSDKIPL/IPSDKIPLGeometricTransform/Processor/ResampleRegularZStack3dImg/ResampleRegularZStack3dImg.h>

Code Example

    // load input 3d image from file
    ImagePtr pInImg = image::file::loadTiffImageFile(inImgFilePath);
    const ipReal32 zScaleFactor = 1.234f;
    // apply linear resampling on input image along z-axis with a scale factor of 1.234
    ImagePtr pOutImg = resampleRegularZStack3dImg(pInImg, zScaleFactor, attr::eInterpolationPolicy::eIP_Linear);

See also: ResampleRegularZStack3dImgLvl1

Function Documentation

◆ resampleRegularZStack3dImg() [1/3]

IPSDKIPLGEOMETRICTRANSFORM_API image::ImagePtr ipsdk::imaproc::gtrans::resampleRegularZStack3dImg	(	const image::ImageConstPtr &	pInImg,
		ipReal32	zScaleFactor,
		const ipsdk::imaproc::attr::eInterpolationPolicy &	interpolationPolicy
	)

wrapper function for Resamples along z-axis a 3d image with regularly spaced z-plans

Exceptions

ipsdk::processor::IPSDKBaseProcessingException on failure

◆ resampleRegularZStack3dImg() [2/3]

IPSDKIPLGEOMETRICTRANSFORM_API void ipsdk::imaproc::gtrans::resampleRegularZStack3dImg	(	const image::ImageConstPtr &	pInImg,
		ipReal32	zScaleFactor,
		const ipsdk::imaproc::attr::eInterpolationPolicy &	interpolationPolicy,
		const image::ImagePtr &	pOutImg
	)

wrapper function for Resamples along z-axis a 3d image with regularly spaced z-plans

Exceptions

ipsdk::processor::IPSDKBaseProcessingException on failure

◆ resampleRegularZStack3dImg() [3/3]

IPSDKIPLGEOMETRICTRANSFORM_API void ipsdk::imaproc::gtrans::resampleRegularZStack3dImg	(	const image::ImageConstPtr &	pInImg,
		const ipsdk::imaproc::attr::eInterpolationPolicy &	interpolationPolicy,
		const image::ImagePtr &	pOutImg
	)

wrapper function for Resamples along z-axis a 3d image with regularly spaced z-plans

Exceptions

ipsdk::processor::IPSDKBaseProcessingException on failure