Editor to select a transfer function. More...

#include <TransferFunctionEditor.hpp>

Inheritance diagram for uiTF::TransferFunctionEditor:

Collaboration diagram for uiTF::TransferFunctionEditor:

Public Member Functions
virtual bool	isA (const std::string &type) const override

UITF_API	TransferFunctionEditor ()
	Basic constructor, do nothing.

virtual UITF_API	~TransferFunctionEditor () noexcept
	Basic destructor, do nothing.

Public Member Functions inherited from fwGui::editor::IEditor
Public Member Functions inherited from fwGui::IGuiContainerSrv
FWGUI_API std::shared_ptr< ::fwGui::container::fwContainer >	getContainer ()

FWGUI_API void	setParent (std::string wid)

Public Member Functions inherited from fwServices::IService
FWSERVICES_API void	registerInput (const ::fwData::Object::csptr &obj, const std::string &key, const bool autoConnect=false, const bool optional=false)
	Register an input object for this service. More...

FWSERVICES_API void	registerInOut (const ::fwData::Object::sptr &obj, const std::string &key, const bool autoConnect=false, const bool optional=false)
	Register an in/out object for this service. More...

FWSERVICES_API void	setConfiguration (const ::fwRuntime::ConfigurationElement::sptr _cfgElement)
	Affect the configuration, using a generic XML like structure. More...

FWSERVICES_API void	setConfiguration (const Config &_configuration)
	Set the configuration. More...

FWSERVICES_API void	setConfiguration (const ConfigType &ptree)
	Affect the configuration, using a boost property tree. More...

FWSERVICES_API void	configure ()
	Invoke configuring() if m_globalState == STOPPED. Invoke reconfiguring() if m_globalState == STARTED. Does nothing otherwise. More...

FWSERVICES_API SharedFutureType	start ()
	Invoke starting() if m_globalState == STOPPED. Does nothing otherwise. More...

FWSERVICES_API SharedFutureType	stop ()
	Invoke stopping() if m_globalState == STARTED. Does nothing otherwise. Stops all observations. More...

FWSERVICES_API SharedFutureType	update ()
	Invoke updating() if m_globalState == STARTED. Does nothing otherwise. More...

FWSERVICES_API SharedFutureType	swap (::fwData::Object::sptr _obj)
	Associate the service to another object. More...

FWSERVICES_API SharedFutureType	swapKey (const KeyType &_key,::fwData::Object::sptr _obj)
	Associate the service to another object. More...

FWSERVICES_API GlobalStatus	getStatus () const noexcept
	Return the global process status. More...

FWSERVICES_API bool	isStarted () const noexcept
	Test if the service is started or not. More...

FWSERVICES_API bool	isStopped () const noexcept
	Test if the service is stopped or not. More...

FWSERVICES_API ConfigurationStatus	getConfigurationStatus () const noexcept
	Return the configuration process status. More...

FWSERVICES_API UpdatingStatus	getUpdatingStatus () const noexcept
	Return the update process status. More...

FWSERVICES_API::fwRuntime::ConfigurationElement::sptr	getConfiguration () const
	Return the configuration, in an xml format read using runtime library. More...

FWSERVICES_API ConfigType	getConfigTree () const
	Return the configuration, in an boost property tree.

FWSERVICES_API::fwData::Object::sptr	getObject ()
	Return the object associated to service. More...

template<class DATATYPE >
std::shared_ptr< DATATYPE >	getObject ()
	Return the object associated to service. The object is casted. More...

FWSERVICES_API const InputMapType &	getInputs () const
	Return the inputs map associated to service. More...

FWSERVICES_API const InOutMapType &	getInOuts () const
	Return the inouts map associated to service. More...

FWSERVICES_API const OutputMapType &	getOutputs () const
	Return the outouts map associated to service. More...

FWSERVICES_API std::vector< ::fwData::Object::csptr >	getObjects () const
	Return the objects associated to service. More...

template<class DATATYPE >
std::shared_ptr< const DATATYPE >	getInput (const KeyType &key) const
	Return the input object at the given key. Asserts if the data is not of the right type. More...

template<class DATATYPE >
std::shared_ptr< DATATYPE >	getInOut (const KeyType &key) const
	Return the inout object at the given key. Asserts if the data is not of the right type. More...

template<class DATATYPE >
std::shared_ptr< DATATYPE >	getOutput (const KeyType &key) const
	Return the output object at the given key. Asserts if the data is not of the right type. More...

template<class DATATYPE >
std::shared_ptr< const DATATYPE >	getInput (const KeyType &keybase, size_t index) const
	Return the input object at the given key. Asserts if the data is not of the right type. More...

template<class DATATYPE >
std::shared_ptr< DATATYPE >	getInOut (const KeyType &keybase, size_t index) const
	Return the inout object at the given key. Asserts if the data is not of the right type. More...

template<class DATATYPE >
std::shared_ptr< DATATYPE >	getOutput (const KeyType &keybase, size_t index) const
	Return the output object at the given key. Asserts if the data is not of the right type. More...

FWSERVICES_API void	setOutput (const ::fwServices::IService::KeyType &key, const ::fwData::Object::sptr &object, size_t index=0)
	Register an output object at a given key in the OSR, replacing it if it already exists. More...

size_t	getKeyGroupSize (const KeyType &keybase) const
	Return the number of key in a group of keys. More...

FWSERVICES_API void	setWorker (std::shared_ptr< ::fwThread::Worker > worker)
	Initializes m_associatedWorker and associates this worker to all service slots.

FWSERVICES_API std::shared_ptr< ::fwThread::Worker >	getWorker () const
	Returns associate worker.

virtual FWSERVICES_API KeyConnectionsType	getObjSrvConnections () const
	Returns proposals to connect service slots to associated object signals, this method is used for obj/srv auto connection. More...

FWSERVICES_API bool	hasObjectId (const KeyType &_key) const
	Return true if the object with the given key has an identifier. More...

FWSERVICES_API IdType	getObjectId (const KeyType &_key) const
	Return the id of the object, throw if it is not found.

FWSERVICES_API void	setObjectId (const KeyType &_key, const IdType &_id)
	Set the id of an object key.

Public Member Functions inherited from fwTools::Object
Public Member Functions inherited from fwCore::BaseObject
Public Member Functions inherited from fwCom::HasSlots
std::shared_ptr< SlotBase >	slot (const Slots::SlotKeyType &key) const

template<typename SlotType >
std::shared_ptr< SlotType >	slot (const Slots::SlotKeyType &key) const

template<typename F , typename A >
std::shared_ptr< Slot< typename::fwCom::util::convert_function_type< F >::type > >	newSlot (const Slots::SlotKeyType &key, F f, A a)

Public Member Functions inherited from fwCom::HasSignals
std::shared_ptr< SignalBase >	signal (const Signals::SignalKeyType &key) const

template<typename SignalType >
std::shared_ptr< SignalType >	signal (const Signals::SignalKeyType &key) const

template<typename SignalType >
std::shared_ptr< SignalType >	newSignal (const Signals::SignalKeyType &key)

Static Public Member Functions
static bool	isTypeOf (const std::string &type)

Static Public Member Functions inherited from fwGui::editor::IEditor
static bool	isTypeOf (const std::string &type)

static const std::string &	leafClassname ()
	return object's classname without its namespace, i.e. BaseObject

static const std::string &	classname ()
	return object's classname without its namespace, i.e. BaseObject

Static Public Member Functions inherited from fwGui::IGuiContainerSrv
static bool	isTypeOf (const std::string &type)

static const std::string &	leafClassname ()
	return object's classname without its namespace, i.e. BaseObject

static const std::string &	classname ()
	return object's classname without its namespace, i.e. BaseObject

Static Public Member Functions inherited from fwServices::IService
static bool	isTypeOf (const std::string &type)

static const std::string &	leafClassname ()
	return object's classname without its namespace, i.e. BaseObject

static const std::string &	classname ()
	return object's classname without its namespace, i.e. BaseObject

Static Public Member Functions inherited from fwTools::Object
static bool	isTypeOf (const std::string &type)

static const std::string &	classname ()
	return full object's classname with its namespace, i.e. fwCore::BaseObject

Static Public Member Functions inherited from fwCore::BaseObject
static bool	isTypeOf (const std::string &type)

static const std::string &	leafClassname ()
	return object's classname without its namespace, i.e. BaseObject

static const std::string &	classname ()
	return object's classname without its namespace, i.e. BaseObject

Protected Member Functions
virtual UITF_API void	configuring () override
	Configure the transfer function editor.

virtual UITF_API void	starting () override
	Start the TransferFunctionEditor, create Container, place in Buttons, ComboBox, Layout, and connect them.

virtual UITF_API void	updating () override
	Update the TransferFunctionEditor, do nothing.

virtual UITF_API void	stopping () override
	Stop the TransferFunctionEditor, disconnect Buttons and Combo Box, delete them and clean the container.

UITF_API void	swapping (const KeyType &key) override
	Selects the current transfer function.

virtual UITF_API KeyConnectionsMap	getAutoConnections () const override
	Returns proposals to connect service slots to associated object signals, this method is used for obj/srv auto connection. More...

UITF_API void	initTransferFunctions ()
	Initialize the transfer functions. More...

UITF_API bool	hasTransferFunctionName (const std::string &_sName) const
	Check if the image contain the specified TF.

UITF_API std::string	createTransferFunctionName (const std::string &_sBasename) const

UITF_API void	updateTransferFunction ()
	Update the output transferFunction with the selected TF in the ComboBox.

UITF_API void	updateTransferFunctionPreset ()
	Update the TF preset from the TF pool.

Protected Member Functions inherited from fwGui::editor::IEditor
	IEditor () noexcept
	Constructor. Do nothing (Just initialize parameters).

virtual	~IEditor () noexcept
	Destructor. Do nothing.

Protected Member Functions inherited from fwGui::IGuiContainerSrv
FWGUI_API void	initialize ()
	Initialize managers. More...

FWGUI_API void	create ()
	Creates view, sub-views and toolbar containers. Manages sub-views and toobar services. More...

FWGUI_API void	destroy ()
	Stops sub-views and toobar services. Destroys view, sub-views and toolbar containers.

FWGUI_API void	setEnabled (bool isEnabled)
	SLOT: enable/disable the container.

FWGUI_API void	enable ()
	SLOT: enable the container.

FWGUI_API void	disable ()
	SLOT: disable the container.

FWGUI_API void	setVisible (bool isVisible)
	SLOT: show/hide the container.

FWGUI_API void	show ()
	SLOT: show the container.

FWGUI_API void	hide ()
	SLOT: hide the container.

Protected Member Functions inherited from fwServices::IService
FWSERVICES_API	IService ()
	IService constructor. More...

virtual FWSERVICES_API	~IService ()
	IService desctructor. More...

virtual void	swapping ()
	Swap the service from associated object to another object. More...

virtual FWSERVICES_API void	reconfiguring ()
	Reconfigure the service activity when is started. More...

virtual FWSERVICES_API void	info (std::ostream &_sstream)
	Write information in a stream. More...

Protected Member Functions inherited from fwTools::fwID
FWTOOLS_API bool	hasID () const
	Return true if the object has an id set. More...

FWTOOLS_API IDType	getID (Policy policy=GENERATE) const
	Returns the id of the object. If it is not set and the policy value is. More...

virtual FWTOOLS_API void	setID (IDType newID)
	Set a newID for the object, (newID must not exist in fwID), the oldest one is released. More...

FWTOOLS_API void	resetID ()
	Release the id for the object. More...

	fwID ()
	Constructor : does nothing.

Protected Member Functions inherited from fwCom::HasSlots
	HasSlots (const HasSlots &)
	Copy constructor forbidden.

HasSlots &	operator= (const HasSlots &)
	Copy operator forbidden.

Protected Member Functions inherited from fwCom::HasSignals
	HasSignals (const HasSignals &)
	Copy constructor forbidden.

HasSignals &	operator= (const HasSignals &)
	Copy operator forbidden.

Friends
template<class , class , class >
class	::fwTools::ClassFactory

class	::fwTools::Factory

Demangling methods
virtual const std::string &	getLeafClassname () const override
	return object's classname without its namespace, i.e. BaseObject

virtual const std::string &	getClassname () const override
	return full object's classname with its namespace, i.e. fwCore::BaseObject

static const std::string &	leafClassname ()
	return object's classname without its namespace, i.e. BaseObject

static const std::string &	classname ()
	return object's classname without its namespace, i.e. BaseObject

Additional Inherited Members
Public Types inherited from fwServices::IService
enum	AccessType : std::uint8_t { INPUT, OUTPUT, INOUT }

typedef ::boost::property_tree::ptree	ConfigType

typedef std::string	IdType

typedef std::string	KeyType

typedef std::map< KeyType, std::weak_ptr< const ::fwData::Object > >	InputMapType

typedef std::map< KeyType, std::weak_ptr< ::fwData::Object > >	InOutMapType

typedef std::map< KeyType, std::shared_ptr< ::fwData::Object > >	OutputMapType

enum	GlobalStatus { STARTED, STARTING, SWAPPING, STOPPED, STOPPING }
	Defines all possible global status for a service, including transitions. More...

enum	UpdatingStatus { UPDATING, NOTUPDATING }
	Defines all possible status for an update process. More...

enum	ConfigurationStatus { CONFIGURING, CONFIGURED, UNCONFIGURED }
	Defines all possible status for a configuration process. More...

typedef ::fwCom::Signal< void()>	StartedSignalType

typedef ::fwCom::Signal< void()>	UpdatedSignalType

typedef ::fwCom::Signal< void()>	StoppedSignalType

typedef std::shared_future< void >	SharedFutureType
	Slot to call start method.

typedef std::packaged_task< void()>	PackagedTaskType
	Slot to call start method.

typedef std::future< void >	UniqueFutureType
	Slot to call start method.

typedef ::fwCom::Slot< SharedFutureType()>	StartSlotType
	Slot to call start method.

typedef ::fwCom::Slot< SharedFutureType()>	StopSlotType
	Slot to call start method.

typedef ::fwCom::Slot< SharedFutureType()>	UpdateSlotType
	Slot to call start method.

typedef ::fwCom::Slot< SharedFutureType(::fwData::Object::sptr)>	SwapSlotType
	Slot to call start method.

typedef ::fwCom::Slot< SharedFutureType(const KeyType &,::fwData::Object::sptr)>	SwapKeySlotType
	Slot to call start method.

typedef ::fwCom::helper::SigSlotConnection::KeyConnectionsType	KeyConnectionsType
	Returns proposals to connect service slots to associated object signals, this method is used for obj/srv auto connection. More...

Public Types inherited from fwCom::HasSlots
typedef std::shared_ptr< HasSlots >	sptr

typedef std::shared_ptr< const HasSlots >	csptr

Public Types inherited from fwCom::HasSignals
typedef std::shared_ptr< HasSignals >	sptr

typedef std::shared_ptr< const HasSignals >	csptr

Static Public Attributes inherited from fwServices::IService
static FWSERVICES_API const std::string	s_DEFAULT_OBJECT = "defaultObject"

static FWSERVICES_APIconst::fwCom::Slots::SlotKeyType	s_STARTED_SIG = "started"

static FWSERVICES_APIconst::fwCom::Slots::SlotKeyType	s_UPDATED_SIG = "updated"

static FWSERVICES_APIconst::fwCom::Slots::SlotKeyType	s_STOPPED_SIG = "stopped"

static FWSERVICES_APIconst::fwCom::Slots::SlotKeyType	s_START_SLOT = "start"
	Slot to call start method.

static FWSERVICES_APIconst::fwCom::Slots::SlotKeyType	s_STOP_SLOT = "stop"
	Slot to call start method.

static FWSERVICES_APIconst::fwCom::Slots::SlotKeyType	s_UPDATE_SLOT = "update"
	Slot to call start method.

static FWSERVICES_APIconst::fwCom::Slots::SlotKeyType	s_SWAP_SLOT = "swap"
	Slot to call start method.

static FWSERVICES_APIconst::fwCom::Slots::SlotKeyType	s_SWAPKEY_SLOT = "swapKey"
	Slot to call start method.

Protected Types inherited from fwGui::IGuiContainerSrv
typedef ::fwRuntime::ConfigurationElement::sptr	ConfigurationType

Protected Types inherited from fwTools::fwID
enum	Policy { EMPTY = 1, GENERATE, MUST_EXIST }

typedef std::string	IDType

Static Protected Member Functions inherited from fwTools::fwID
static bool	isTypeOf (const std::string &type)

static FWTOOLS_API bool	exist (IDType _id)

static FWTOOLS_API std::shared_ptr< ::fwTools::Object >	getObject (IDType requestID)
	Retrieve the object attached to the given id. Return a null sptr if no correspondence exist. More...

static const std::string &	leafClassname ()
	return object's classname without its namespace, i.e. BaseObject

static const std::string &	classname ()
	return object's classname without its namespace, i.e. BaseObject

Protected Attributes inherited from fwServices::IService
::fwRuntime::ConfigurationElement::sptr	m_configuration
	Configuration element used to configure service internal state using a generic XML like structure TODO Make this const, we are not supposed to edit that !

::fwData::Object::wptr	m_associatedObject
	associated object of service More...

StartSlotType::sptr	m_slotStart
	Slot to call start method.

StopSlotType::sptr	m_slotStop
	Slot to call stop method.

UpdateSlotType::sptr	m_slotUpdate
	Slot to call update method.

SwapSlotType::sptr	m_slotSwap
	Slot to call swap method.

SwapKeySlotType::sptr	m_slotSwapKey
	Slot to call swap method.

std::shared_ptr< ::fwThread::Worker >	m_associatedWorker
	Associated worker.

Protected Attributes inherited from fwTools::Object
std::shared_ptr< ::fwTools::UUID >	m_uuid
	UUID used to identify the object, notably for serialization.

Protected Attributes inherited from fwCom::HasSlots
Slots	m_slots

Protected Attributes inherited from fwCom::HasSignals
Signals	m_signals

Static Protected Attributes inherited from fwGui::IGuiContainerSrv
static FWGUI_APIconst::fwCom::Slots::SlotKeyType	s_SET_ENABLED_SLOT = "setEnabled"
	Slot to enable/disable the action.

static FWGUI_APIconst::fwCom::Slots::SlotKeyType	s_ENABLE_SLOT = "enable"
	Slot to enable the container.

static FWGUI_APIconst::fwCom::Slots::SlotKeyType	s_DISABLE_SLOT = "disable"
	Slot to disable the container.

static FWGUI_APIconst::fwCom::Slots::SlotKeyType	s_SET_VISIBLE_SLOT = "setVisible"
	Slot to show/hide the container.

static FWGUI_APIconst::fwCom::Slots::SlotKeyType	s_SHOW_SLOT = "show"
	Slot to show the container.

static FWGUI_APIconst::fwCom::Slots::SlotKeyType	s_HIDE_SLOT = "hide"
	Slot to hide the container.

Detailed Description

Editor to select a transfer function.

The available transfer function are stored in a composite (transferFunctionPool), if it contains at most one transfert function, this service will read transfer function from the given pathes.

XML Configuration

 <service type="::uiTF::TransferFunctionEditor">
     <in key="currentTF" uid="..." optional="yes" />
     <inout key="tfPool" uid="..." />
     <out key="tf" uid="..." />
     <config useDefaultPath="yes">
         <path>....</path>
         <path>....</path>
         <path>....</path>
     </config>
 </service>

Input

currentTF [fwData::TransferFunction](optional) : current transfer function used to change editor selection. It should be the same TF as the output. If it is not set, the default GreyLevel will be selected at start and the editor will not listen the change of TF in another service. Don't forget to set 'optional="yes"' when you use this input, otherwise the service will not start if a TF is not previously defined.

In-Out

tfPool [fwData::Composite]: composite containing the transfer function.

Output

tf [fwData::TransferFunction]: selected transfer function.

Configuration

useDefaultPath (optional)(default = yes): if true, load tf files from uiTF bundle.
path (optional): path to a directory containing tf files.

Definition at line 62 of file TransferFunctionEditor.hpp.

Member Function Documentation

std::string uiTF::TransferFunctionEditor::createTransferFunctionName ( const std::string & _sBasename ) const

protected

Create a string that represents a TF name not already present in the composite. For example, if blabla is already used, it will return blabla_1.

Definition at line 556 of file TransferFunctionEditor.cpp.

References hasTransferFunctionName().

Referenced by initTransferFunctions(), and swapping().

Here is the call graph for this function:

Here is the caller graph for this function:

fwServices::IService::KeyConnectionsMap uiTF::TransferFunctionEditor::getAutoConnections ( ) const

overrideprotectedvirtual

Returns proposals to connect service slots to associated object signals, this method is used for obj/srv auto connection.

Connect Composite::s_ADDED_OBJECTS_SIG to this::s_UPDATE_SLOT Connect Composite::s_CHANGED_OBJECTS_SIG to this::s_UPDATE_SLOT Connect Composite::s_REMOVED_OBJECTS_SIG to this::s_UPDATE_SLOT

Reimplemented from fwServices::IService.

Definition at line 596 of file TransferFunctionEditor.cpp.

References fwData::Composite::s_ADDED_OBJECTS_SIG, fwData::Composite::s_CHANGED_OBJECTS_SIG, fwData::Composite::s_REMOVED_OBJECTS_SIG, and fwServices::IService::s_UPDATE_SLOT.

void uiTF::TransferFunctionEditor::initTransferFunctions ( )

protected

Initialize the transfer functions.

Add their names to the ComboBox. If the composite does not contain any TF (or only the default grey level TF, the service creates a few from the ressources of the Bundle.

Definition at line 441 of file TransferFunctionEditor.cpp.

References fwDataTools::helper::Composite::add(), createTransferFunctionName(), hasTransferFunctionName(), fwDataTools::helper::Composite::notify(), fwData::TransferFunction::s_DEFAULT_TF_NAME, SLM_ASSERT, and updateTransferFunctionPreset().

Referenced by starting(), and swapping().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Demangling methods