mitk::MultiLabelSegmentationMappingHelper Namespace Reference

Typedefs
typedef ::map::core::RegistrationBase	RegistrationType
typedef ::mitk::MAPRegistrationWrapper	MITKRegistrationType
typedef ::mitk::BaseGeometry	ResultGeometryType

Functions
MITKMATCHPOINTREGISTRATION_EXPORT MultiLabelSegmentation::Pointer	map (const MultiLabelSegmentation *input, const RegistrationType *registration, bool throwOnOutOfInputAreaError=false, const ResultGeometryType *resultGeometry=nullptr, bool throwOnMappingError=true, const MultiLabelSegmentation::LabelValueType &errorValue=0)
MITKMATCHPOINTREGISTRATION_EXPORT MultiLabelSegmentation::Pointer	map (const MultiLabelSegmentation *input, const MITKRegistrationType *registration, bool throwOnOutOfInputAreaError=false, const ResultGeometryType *resultGeometry=nullptr, bool throwOnMappingError=true, const MultiLabelSegmentation::LabelValueType &errorValue=0)

Typedef Documentation

MITKRegistrationType

typedef ::mitk::MAPRegistrationWrapper mitk::MultiLabelSegmentationMappingHelper::MITKRegistrationType

Definition at line 31 of file mitkMultiLabelSegmentationMappingHelper.h.

RegistrationType

typedef ::map::core::RegistrationBase mitk::MultiLabelSegmentationMappingHelper::RegistrationType

Definition at line 30 of file mitkMultiLabelSegmentationMappingHelper.h.

ResultGeometryType

typedef ::mitk::BaseGeometry mitk::MultiLabelSegmentationMappingHelper::ResultGeometryType

Definition at line 33 of file mitkMultiLabelSegmentationMappingHelper.h.

Function Documentation

map() [1/2]

MITKMATCHPOINTREGISTRATION_EXPORT MultiLabelSegmentation::Pointer mitk::MultiLabelSegmentationMappingHelper::map	(	const MultiLabelSegmentation *	input,
		const MITKRegistrationType *	registration,
		bool	throwOnOutOfInputAreaError = false,
		const ResultGeometryType *	resultGeometry = nullptr,
		bool	throwOnMappingError = true,
		const MultiLabelSegmentation::LabelValueType &	errorValue = 0
	)

Helper that maps a given input image. This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

input	Image that should be mapped.
registration	Pointer to the registration instance that should be used for mapping
throwOnOutOfInputAreaError	Indicates if mapping should fail with an exception (true), if the input image does not cover the whole requested region to be mapped into the result image.
resultGeometry	Pointer to the Geometry object that specifies the grid of the result image. If not defined the geometry of the input image will be used.
throwOnMappingError	Indicates if mapping should fail with an exception (true), if the registration does not cover/support the whole requested region for mapping into the result image.
errorValue	Indicates the value that should be used if an mapping error occurs (and throwOnMappingError is false).

Precondition

input must be valid

registration must be valid

Dimensionality of the registration must match with the input image must be valid

Remarks

Depending in the settings of throwOnOutOfInputAreaError and throwOnMappingError it may also throw due to inconsistencies in the mapping process. See parameter description.

Returns

Pointer to the resulting mapped image.h

map() [2/2]

MITKMATCHPOINTREGISTRATION_EXPORT MultiLabelSegmentation::Pointer mitk::MultiLabelSegmentationMappingHelper::map	(	const MultiLabelSegmentation *	input,
		const RegistrationType *	registration,
		bool	throwOnOutOfInputAreaError = false,
		const ResultGeometryType *	resultGeometry = nullptr,
		bool	throwOnMappingError = true,
		const MultiLabelSegmentation::LabelValueType &	errorValue = 0
	)

Helper that maps a given input image

Parameters

input	Image that should be mapped.
registration	Pointer to the registration instance that should be used for mapping
throwOnOutOfInputAreaError	Indicates if mapping should fail with an exception (true), if the input image does not cover the whole requested region to be mapped into the result image.
resultGeometry	Pointer to the Geometry object that specifies the grid of the result image. If not defined the geometry of the input image will be used.
throwOnMappingError	Indicates if mapping should fail with an exception (true), if the registration does not cover/support the whole requested region for mapping into the result image.
errorValue	Indicates the value that should be used if an mapping error occurs (and throwOnMappingError is false).

Precondition

input must be valid

registration must be valid

Dimensionality of the registration must match with the input image must be valid

Remarks

Depending in the settings of throwOnOutOfInputAreaError and throwOnMappingError it may also throw due to inconsistencies in the mapping process. See parameter description.

Returns

Pointer to the resulting mapped image.h