FLImagingCLR::ImageProcessing::CMask Class Reference

A class that performs Mask an image. More...

#include <Mask.h>

Inheritance diagram for FLImagingCLR::ImageProcessing::CMask:

Public Member Functions
	CMask ()
	CMask (CMask^ pMask)
virtual	~CMask ()
virtual CResult ^	Assign (CMask^ pMask)
virtual CResult ^	Clear () override
virtual CResult ^	Execute () override
virtual CResult ^	SetMask (int32_t i32Mask)
virtual CResult ^	SetMask (int64_t i64Mask)
virtual CResult ^	SetMask (uint32_t u32Mask)
virtual CResult ^	SetMask (uint64_t u64Mask)
virtual CResult ^	SetMask (float f32Mask)
virtual CResult ^	SetMask (double f64Mask)
virtual CResult ^	SetMask ()
CResult ^	SetMask (Base::CMultiVar< int32_t >^ mvMask)
CResult ^	SetMask (Base::CMultiVar< int64_t >^ mvMask)
CResult ^	SetMask (Base::CMultiVar< uint32_t >^ mvMask)
CResult ^	SetMask (Base::CMultiVar< uint64_t >^ mvMask)
CResult ^	SetMask (Base::CMultiVar< float >^ mvMask)
CResult ^	SetMask (Base::CMultiVar< double >^ mvMask)
CResult ^	GetMask (CLR_OUT Base::CMultiVar< int32_t >^% pMvMask)
CResult ^	GetMask (CLR_OUT Base::CMultiVar< int64_t >^% pMvMask)
CResult ^	GetMask (CLR_OUT Base::CMultiVar< uint32_t >^% pMvMask)
CResult ^	GetMask (CLR_OUT Base::CMultiVar< uint64_t >^% pMvMask)
CResult ^	GetMask (CLR_OUT Base::CMultiVar< float >^% pMvMask)
CResult ^	GetMask (CLR_OUT Base::CMultiVar< double >^% pMvMask)
Public Member Functions inherited from FLImagingCLR::ImageProcessing::CAlgorithmFeature_SR_BAT
virtual CResult ^	Assign (CAlgorithmFeature_SR_BAT^ pAib)
Public Member Functions inherited from FLImagingCLR::ImageProcessing::CAlgorithmFeature_SR
virtual CResult ^	Assign (CAlgorithmFeature_SR^ pAib)
virtual CResult ^	SetSourceROI (Foundation::CFLFigure^ pFlfSourceROI)
virtual Foundation::CFLFigure ^	GetSourceROI ()
Public Member Functions inherited from FLImagingCLR::Foundation::CAlgorithmFeatureBase
virtual	~CAlgorithmFeatureBase ()
virtual CResult ^	SetSourceImage (Base::CFLImage^% pFliSource)
virtual Base::CFLImage ^	GetSourceImage ()
virtual void	SetROIUtilities (CROIUtilities^ pROIUtilities)
virtual void	SetROIUtilities (CAlgorithmFeatureBase^ pAlgorithmFeatureBase)
virtual CROIUtilities ^	GetROIUtilities ()
virtual CResult ^	Assign (CAlgorithmFeatureBase^ pAlgorithmFeatureBase)
virtual double	GetLastExecutionTimeInMilliSecond ()
virtual double	GetLastExecutionTimeInMicroSecond ()
virtual CResult ^	ReportToCSV (CReportDescriptor^ pWrd)
	The execution result of the algorithm is recorded in a file according to the options recorded in the ReportDescriptor object. Not all algorithms support this function. If not supported, return EResult.DidNotImplement.
virtual CResult ^	EnableThreadSynchronization (bool bEnable)
virtual bool	IsThreadSynchronizationEnabled ()
virtual CResult ^	EnableImageFigureTransformation (bool bEnable)
virtual bool	IsImageFigureTransformationEnabled ()
virtual int64_t	GetRequiredGPUMemory () override
Public Member Functions inherited from FLImagingCLR::Foundation::CAlgorithmBase
virtual	~CAlgorithmBase ()
virtual CResult ^	Assign (CAlgorithmBase^ pPufb)
virtual EProcessingUnitFeatures	GetOptimalProcessingUnit ()
virtual int32_t	GetOptimalThreadCount ()
Public Member Functions inherited from FLImagingCLR::Base::CFLBase
virtual	~CFLBase ()
	Destructor.
	!CFLBase ()
	Destructor.
virtual CProcessingUnitBase ^	GetProcessingUnit ()
	Returns the set ProcessingUnit.
virtual CResult ^	SetProcessingUnit (CProcessingUnitBase^ pPub)
	set the ProcessingUnit
virtual void	ResetProcessingUnit ()
	Rest the ProcessingUnit.
virtual bool	IsValid ()
	Validate the object.
virtual void	OnReceiveBroadcast (CBroadcastMessage^ pMessage)
	Callback function. A function that receives a BroadcastMessage.
void	Lock ()
	Set a lock on an object.
bool	TryLock ()
	Try to lock the object.
void	Unlock ()
	Unlock the object.
virtual CFLBase ^	DuplicateObject ()
	Duplicate an object identical to itself.
virtual CFLBase ^	CreateNewObject ()
	Creating an object of the same type as oneself.
virtual bool	IsLicenseAvailable ()
	Returns whether the algorithm can be used with the current license.

Detailed Description

A class that performs Mask an image.

Constructor & Destructor Documentation

CMask() [1/2]

FLImagingCLR::ImageProcessing::CMask::CMask

(

)

Default constructor

CMask() [2/2]

FLImagingCLR::ImageProcessing::CMask::CMask

(

CMask^

pMask

)

Copy constructor by pointer

~CMask()

virtual FLImagingCLR::ImageProcessing::CMask::~CMask ( )

virtual

Destructor

Member Function Documentation

Assign()

virtual CResult ^ FLImagingCLR::ImageProcessing::CMask::Assign ( CMask^ pMask )

virtual

Assign another CMask object. (By Pointer)

Parameters

[in]

pMask

Pointer of CMask

Return values

FLImagingCLR::CResult^

Information about execution results

Clear()

virtual CResult ^ FLImagingCLR::ImageProcessing::CMask::Clear ( )

overridevirtual

Clear the object to the same state as the initial creation state.

Return values

FLImagingCLR::CResult^

Information about execution results

See also

FLImagingCLR::CResult

Reimplemented from FLImagingCLR::ImageProcessing::CAlgorithmFeature_SR_BAT.

Execute()

virtual CResult ^ FLImagingCLR::ImageProcessing::CMask::Execute ( )

overridevirtual

Main procedure executor

Return values

FLImagingCLR::CResult^

Information about execution results

See also

FLImagingCLR::CResult

Reimplemented from FLImagingCLR::Foundation::CAlgorithmFeatureBase.

GetMask() [1/6]

CResult ^ FLImagingCLR::ImageProcessing::CMask::GetMask

(

CLR_OUT Base::CMultiVar< double >^%

pMvMask

)

Masking value getter

Parameters

[in]

pMvMask

Value to mask (64bit floating, pointer)

Return values

FLImagingCLR::CResult^

Information about execution results

See also

FLImagingCLR::CResult

FLImagingCLR::Base::CMultiVar

GetMask() [2/6]

CResult ^ FLImagingCLR::ImageProcessing::CMask::GetMask

(

CLR_OUT Base::CMultiVar< float >^%

pMvMask

)

Masking value getter

Parameters

[in]

pMvMask

Value to mask (32bit floating, pointer)

Return values

FLImagingCLR::CResult^

Information about execution results

See also

FLImagingCLR::CResult

FLImagingCLR::Base::CMultiVar

GetMask() [3/6]

CResult ^ FLImagingCLR::ImageProcessing::CMask::GetMask

(

CLR_OUT Base::CMultiVar< int32_t >^%

pMvMask

)

Masking value getter

Parameters

[in]

pMvMask

Value to mask (32bit Signed integer, pointer)

Return values

FLImagingCLR::CResult^

Information about execution results

See also

FLImagingCLR::CResult

FLImagingCLR::Base::CMultiVar

GetMask() [4/6]

CResult ^ FLImagingCLR::ImageProcessing::CMask::GetMask

(

CLR_OUT Base::CMultiVar< int64_t >^%

pMvMask

)

Masking value getter

Parameters

[in]

pMvMask

Value to mask (64bit Signed integer, pointer)

Return values

FLImagingCLR::CResult^

Information about execution results

See also

FLImagingCLR::CResult

FLImagingCLR::Base::CMultiVar

GetMask() [5/6]

CResult ^ FLImagingCLR::ImageProcessing::CMask::GetMask

(

CLR_OUT Base::CMultiVar< uint32_t >^%

pMvMask

)

Masking value getter

Parameters

[in]

pMvMask

Value to mask (32bit Unsigned integer, pointer)

Return values

FLImagingCLR::CResult^

Information about execution results

See also

FLImagingCLR::CResult

FLImagingCLR::Base::CMultiVar

GetMask() [6/6]

CResult ^ FLImagingCLR::ImageProcessing::CMask::GetMask

(

CLR_OUT Base::CMultiVar< uint64_t >^%

pMvMask

)

Masking value getter

Parameters

[in]

pMvMask

Value to mask (64bit Unsigned integer, pointer)

Return values

FLImagingCLR::CResult^

Information about execution results

See also

FLImagingCLR::CResult

FLImagingCLR::Base::CMultiVar

SetMask() [1/13]

virtual CResult ^ FLImagingCLR::ImageProcessing::CMask::SetMask ( )

virtual

Masking value setter (Default 0)

Return values

FLImagingCLR::CResult^

Information about execution results

See also

FLImagingCLR::CResult

SetMask() [2/13]

CResult ^ FLImagingCLR::ImageProcessing::CMask::SetMask

(

Base::CMultiVar< double >^

mvMask

)

Masking value setter

Parameters

[in]

mvMask

Value to mask (double)

Return values

FLImagingCLR::CResult^

Information about execution results

See also

FLImagingCLR::CResult

FLImagingCLR::Base::CMultiVar

SetMask() [3/13]

CResult ^ FLImagingCLR::ImageProcessing::CMask::SetMask

(

Base::CMultiVar< float >^

mvMask

)

Masking value setter

Parameters

[in]

mvMask

Value to mask (float)

Return values

FLImagingCLR::CResult^

Information about execution results

See also

FLImagingCLR::CResult

FLImagingCLR::Base::CMultiVar

SetMask() [4/13]

CResult ^ FLImagingCLR::ImageProcessing::CMask::SetMask

(

Base::CMultiVar< int32_t >^

mvMask

)

Masking value setter

Parameters

[in]

mvMask

Value to mask (int32_t)

Return values

FLImagingCLR::CResult^

Information about execution results

See also

FLImagingCLR::CResult

FLImagingCLR::Base::CMultiVar

SetMask() [5/13]

CResult ^ FLImagingCLR::ImageProcessing::CMask::SetMask

(

Base::CMultiVar< int64_t >^

mvMask

)

Masking value setter

Parameters

[in]

mvMask

Value to mask (int64_t)

Return values

FLImagingCLR::CResult^

Information about execution results

See also

FLImagingCLR::CResult

FLImagingCLR::Base::CMultiVar

SetMask() [6/13]

CResult ^ FLImagingCLR::ImageProcessing::CMask::SetMask

(

Base::CMultiVar< uint32_t >^

mvMask

)

Masking value setter

Parameters

[in]

mvMask

Value to mask (uint32_t)

Return values

FLImagingCLR::CResult^

Information about execution results

See also

FLImagingCLR::CResult

FLImagingCLR::Base::CMultiVar

SetMask() [7/13]

CResult ^ FLImagingCLR::ImageProcessing::CMask::SetMask

(

Base::CMultiVar< uint64_t >^

mvMask

)

Masking value setter

Parameters

[in]

mvMask

Value to mask (uint64_t)

Return values

FLImagingCLR::CResult^

Information about execution results

See also

FLImagingCLR::CResult

FLImagingCLR::Base::CMultiVar

SetMask() [8/13]

virtual CResult ^ FLImagingCLR::ImageProcessing::CMask::SetMask ( double f64Mask )

virtual

Masking value setter

Parameters

[in]

f64Mask

Value to mask

Return values

FLImagingCLR::CResult^

Information about execution results

See also

FLImagingCLR::CResult

SetMask() [9/13]

virtual CResult ^ FLImagingCLR::ImageProcessing::CMask::SetMask ( float f32Mask )

virtual

Masking value setter

Parameters

[in]

f32Mask

Value to mask

Return values

FLImagingCLR::CResult^

Information about execution results

See also

FLImagingCLR::CResult

SetMask() [10/13]

virtual CResult ^ FLImagingCLR::ImageProcessing::CMask::SetMask ( int32_t i32Mask )

virtual

Masking value setter

Parameters

[in]

i32Mask

Value to mask

Return values

FLImagingCLR::CResult^

Information about execution results

See also

FLImagingCLR::CResult

SetMask() [11/13]

virtual CResult ^ FLImagingCLR::ImageProcessing::CMask::SetMask ( int64_t i64Mask )

virtual

Masking value setter

Parameters

[in]

i64Mask

Value to mask

Return values

FLImagingCLR::CResult^

Information about execution results

See also

FLImagingCLR::CResult

SetMask() [12/13]

virtual CResult ^ FLImagingCLR::ImageProcessing::CMask::SetMask ( uint32_t u32Mask )

virtual

Masking value setter

Parameters

[in]

u32Mask

Value to mask

Return values

FLImagingCLR::CResult^

Information about execution results

See also

FLImagingCLR::CResult

SetMask() [13/13]

virtual CResult ^ FLImagingCLR::ImageProcessing::CMask::SetMask ( uint64_t u64Mask )

virtual

Masking value setter

Parameters

[in]

u64Mask

Value to mask

Return values

FLImagingCLR::CResult^

Information about execution results

See also

FLImagingCLR::CResult