itk::ProgressTransformer Class Reference

#include <itkProgressTransformer.h>

Detailed Description

Transforms progress updates from [0%, 100%] to desired scale.

This class is designed to be allocated on the stack. Code sample:

ProgressTransformer progress2( 0.55f, 0.6f, this ); multiThreader->ParallelizeArray(0, m_SomeArray.size(), [this]( SizeValueType index ) { this->ComputeInParallel( index ); }, progress2.GetProcessObject() );

See also

ProgressReporter, ProcessObject

Definition at line 41 of file itkProgressTransformer.h.

Collaboration diagram for itk::ProgressTransformer:

Public Member Functions
ProcessObject *	GetProcessObject ()
	ProgressTransformer (float start, float end, ProcessObject *targetFilter)
void	UpdateProgress ()
	~ProgressTransformer ()

Private Types
using	CommandType = SimpleMemberCommand< ProgressTransformer >

Private Attributes
ProcessObject::Pointer	m_Dummy
float	m_End
CommandType::Pointer	m_ProgressCommand
unsigned long	m_ProgressTag
float	m_Start
ProcessObject *	m_TargetFilter

Member Typedef Documentation

CommandType

using itk::ProgressTransformer::CommandType = SimpleMemberCommand<ProgressTransformer>

private

Definition at line 68 of file itkProgressTransformer.h.

Constructor & Destructor Documentation

ProgressTransformer()

itk::ProgressTransformer::ProgressTransformer	(	float	start,
		float	end,
		ProcessObject *	targetFilter
	)

~ProgressTransformer()

itk::ProgressTransformer::~ProgressTransformer

(

)

Member Function Documentation

GetProcessObject()

ProcessObject* itk::ProgressTransformer::GetProcessObject ( )

inline

Definition at line 50 of file itkProgressTransformer.h.

UpdateProgress()

void itk::ProgressTransformer::UpdateProgress

(

)

Member Data Documentation

m_Dummy

ProcessObject::Pointer itk::ProgressTransformer::m_Dummy

private

Definition at line 66 of file itkProgressTransformer.h.

m_End

float itk::ProgressTransformer::m_End

private

Definition at line 62 of file itkProgressTransformer.h.

m_ProgressCommand

CommandType::Pointer itk::ProgressTransformer::m_ProgressCommand

private

Definition at line 69 of file itkProgressTransformer.h.

m_ProgressTag

unsigned long itk::ProgressTransformer::m_ProgressTag

private

Definition at line 71 of file itkProgressTransformer.h.

m_Start

float itk::ProgressTransformer::m_Start

private

Definition at line 61 of file itkProgressTransformer.h.

m_TargetFilter

ProcessObject* itk::ProgressTransformer::m_TargetFilter

private

Definition at line 64 of file itkProgressTransformer.h.

---

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

• itkProgressTransformer.h