mitk::LabelsChangedEvent Class Reference

Event emitted once after a batch of label changes in a MultiLabelSegmentation. More...

#include <mitkMultiLabelEvents.h>

Inheritance diagram for mitk::LabelsChangedEvent:

Collaboration diagram for mitk::LabelsChangedEvent:

Public Types
using	Self = LabelsChangedEvent
using	Superclass = itk::ModifiedEvent

Public Member Functions
	LabelsChangedEvent ()=default
	LabelsChangedEvent (std::vector< Label::PixelType > labelValues)
	Constructor with a vector of affected label values. More...
	LabelsChangedEvent (const Self &s)
	Copy constructor. More...
	~LabelsChangedEvent () override
const char *	GetEventName () const override
	Returns the name of this event class. More...
bool	CheckEvent (const itk::EventObject *e) const override
	Checks if a given event matches this event type. More...
itk::EventObject *	MakeObject () const override
	Creates a copy of this event. More...
void	SetLabelValues (std::vector< Label::PixelType > labelValues)
	Sets the label values this event refers to. More...
std::vector< Label::PixelType >	GetLabelValues () const
	Returns the label values this event refers to. More...

Detailed Description

Event emitted once after a batch of label changes in a MultiLabelSegmentation.

Unlike LabelAddedEvent, LabelModifiedEvent, and LabelRemovedEvent (which are emitted per label), LabelsChangedEvent is sent only once after all modifications in an operation are complete. For example, even if 4 labels are changed by a merge operation, this event is sent only once with all affected label values.

See also

AnyLabelEvent, LabelAddedEvent, LabelModifiedEvent, LabelRemovedEvent

Definition at line 154 of file mitkMultiLabelEvents.h.

Member Typedef Documentation

Self

using mitk::LabelsChangedEvent::Self = LabelsChangedEvent

Definition at line 157 of file mitkMultiLabelEvents.h.

Superclass

using mitk::LabelsChangedEvent::Superclass = itk::ModifiedEvent

Definition at line 158 of file mitkMultiLabelEvents.h.

Constructor & Destructor Documentation

LabelsChangedEvent() [1/3]

mitk::LabelsChangedEvent::LabelsChangedEvent ( )

default

LabelsChangedEvent() [2/3]

mitk::LabelsChangedEvent::LabelsChangedEvent

(

std::vector< Label::PixelType >

labelValues

)

Constructor with a vector of affected label values.

Parameters

[in]

labelValues

The label values affected by the change.

LabelsChangedEvent() [3/3]

mitk::LabelsChangedEvent::LabelsChangedEvent

(

const Self &

s

)

Copy constructor.

~LabelsChangedEvent()

mitk::LabelsChangedEvent::~LabelsChangedEvent ( )

override

Member Function Documentation

CheckEvent()

bool mitk::LabelsChangedEvent::CheckEvent ( const itk::EventObject *  e ) const

override

Checks if a given event matches this event type.

Parameters

[in]

e

The event to check against.

Returns

true if the event matches.

GetEventName()

const char* mitk::LabelsChangedEvent::GetEventName ( ) const

override

Returns the name of this event class.

GetLabelValues()

std::vector<Label::PixelType> mitk::LabelsChangedEvent::GetLabelValues

(

)

const

Returns the label values this event refers to.

Returns

Vector of affected label values.

MakeObject()

itk::EventObject* mitk::LabelsChangedEvent::MakeObject ( ) const

override

Creates a copy of this event.

SetLabelValues()

void mitk::LabelsChangedEvent::SetLabelValues

(

std::vector< Label::PixelType >

labelValues

)

Sets the label values this event refers to.

Parameters

[in]

labelValues

Vector of affected label values.

---

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

• mitkMultiLabelEvents.h