camitk Namespace Reference

Classes
class	AbortException
	Exception class to handle abortion in component instantiation. More...
class	Action
	Action class is an abstract class that enables you to build a action (generally an algorithm that works on specific data, i.e. More...
class	ActionExtension
	This class describes what is a generic Action extension. More...
class	ActionWidget
	Build a default widget for a given action using its Qt properties. More...
class	AnatomicalOrientation
	AnatomicalOrientation describes the relationship between 3D axes of a FrameOfReference and medical image anatomical orientation labels. More...
class	Application
	The generic/default application. More...
class	ArbitrarySingleImageComponent
	This Component manages the specific case of arbitrary orientation of a sub-component of the image component. More...
class	CamiTKFile
	CamiTKFile provides functions to read and write in the CAMITK file format. More...
class	CamiTKLogger
	This is the default logger for CamiTK. More...
class	Component
	A Component represents something that could be included in the explorer view, the interactive 3D viewer, and that could have or not a contextual popup menu (open by a right click in the explorer), a property dialog (to change some properties) Thus, a Component inherits from many abstract classes. More...
class	ComponentExtension
	This class describes what is a generic Component extension. More...
class	ConsoleStream
	Provides a console windows, within the CamiTK application. More...
class	Core
	Core class specifies the basic static information for the CamiTK API. More...
class	CppHotPlugAction
	An Action that can be created on the fly from C++ code It must watch the source code and rebuild when necessary. More...
class	CppHotPlugActionExtension
	An ActionExtension that can be created on the fly from a camitk extension file. More...
class	ExtensionManager
	This class is used to manage all plugins loaded by the application. More...
class	FrameOfReference
	FrameOfReference is only a label for an abstract coordinate system. More...
class	GeometricObject
	A geometric object allows one to create geometric object (sphere, arrow, ...) that can be added directly in the scene using getActor(). More...
class	Geometry
	A 3D representation of a vtkPointSet to be displayed in a InteractiveViewer, this class implements the InterfaceGeometry. More...
class	GraphDisplayWidget
	GraphDisplayWidget is used to manage a Widget to display a graph with nodes and links onto a 2D canvas. More...
class	HistoryComponent
	HistoryComponent class describes the component information (name, type) stored in the history. More...
class	HistoryItem
	HistoryItem class describes the entry of an action used in a pipeline, in the history. More...
class	HotPlugAction
	An Action that can be created on the fly. More...
class	HotPlugActionExtension
	An ActionExtension that can be created on the fly from a camitk extension file. More...
class	HotPlugExtensionManager
	Manages all the HotPlug extension. More...
class	ImageAcquisitionComponent
	This class describes what is a generic Image Acquisition Component which derives from Component. More...
class	ImageAcquisitionComponentExtension
	This class describes what is a generic Image Acquisition Component extension. More...
class	ImageComponent
	The manager of the Image Volume data. More...
class	ImageComponentExtension
	Abstract class created to support export file formats for ImageComponent Any data component plugin creating an ImageComponent should inherit from this class. More...
class	ImageOrientationHelper
	Helper class. More...
class	InteractiveViewer
	InteractiveViewer is used to view 3D objects and slices (anything that provides either a InterfaceBitMap or a InterfaceGeometry). More...
class	InteractiveViewerFrame
	InteractiveViewerFrame is the basic container for the InteractiveViewer widget. More...
class	InterfaceBitMap
	This class describes what are the methods to implement for a BitMap. More...
class	InterfaceFrame
	This class describes the methods to implement in order to manage a Component position in space. More...
class	InterfaceGeometry
	This class describes what are the methods to implement for a Geometry (rendering parameters, input/output, filters, picking parameters...) More...
class	InterfaceLogger
	The CamiTK logger interface provides a flexible tracing system to CamiTK applications. More...
class	InterfaceNode
	This class describe what are the methods to implement for a hierarchical tree node. More...
class	InterfacePersistence
	Interface for all objects that should be serialized by the PersistenceManager. More...
class	InterfaceProperty
	This class describes what are the methods to implement in order to manage dynamic properties. More...
class	ItkProgressObserver
	Allows showing a progress bar when using ITK methods. More...
class	Log
	This class is a log utility. More...
class	LogSyntaxHighlighter
	Simple Syntax highlighter for CamiTK Log syntax. More...
class	MainWindow
	This class is the base class for your application. More...
class	MeshComponent
	Basic component to manage any kind of mesh. More...
class	MeshComponentExtension
	Abstract class created to support export file formats for MeshComponent Any data component plugin creating a MeshComponent should inherit from this class. More...
class	MeshDataFilterModel
	CamiTK intern class to help automatically sort or show specific data. More...
class	MeshDataModel
	Qt model for mesh data. More...
class	MeshDataView
	Qt view for mesh data. More...
class	MeshSelectionModel
	Qt model for mesh selection This class use the Qt model/view design. More...
class	MeshSelectionView
	Qt view for mesh selection. More...
class	ObjectController
	The object controller class. More...
class	ObjectControllerPrivate
class	PlaneC
	This class allows you to transform a plane(translation,rotation around an axis) and visualize it. More...
class	Property
	This class describes a property that can be used in components and actions or any class that needs to be passed to ObjectController. More...
class	PropertyObject
	This class describes a property object. More...
class	RendererWidget
	RendererWidget implements all support methods to use camiTK with Qt interface. More...
class	ScreenshotFormatInfo
	class containing all information concerning exporting images (screenshot) and the different supported format and extension. More...
class	SettingsDialog
	This class controls the settings dialog user interface. More...
class	SimplisticComponent
	This class has been implemented to be able to instantiate a very basic component with NO_REPRESENTATION. More...
class	SingleImageComponent
	This Component manages sub-component of the image component seen as a single orientation only (axial OR sagittal OR coronal). More...
class	Slice
	Display a slice (i.e. More...
class	SliderSpinBoxWidget
	A utility class to have QSpinBox and QSlider synchronized. More...
class	SliderTextWidget
	This widget allows you to use a slider with a lineedit in a Dialog Box. More...
class	SplashScreen
	CamiTK application splash screen. More...
class	SyntaxHighlighter
	Base class for syntax highlighting. More...
class	TestPersistence
class	Transformation
	Transformation represents a geometrical transformation between two FrameOfReferences. More...
class	TransformationManager
	TransformationManager manages frames of reference and transformations for a CamiTK Application. More...
class	Viewer
	Viewer is an abstract class that is the base class for all viewers. More...
class	ViewerDockStyle
	a specific style made for QDockWidget that adds an icon to the dock widget title More...
class	ViewerExtension
	This class describes what is a generic Action extension. More...
class	vtkInteractorStylePick
	Specific backward compatible interactor for CamiTK RendererWidget Interactor used when we are in picking mode. More...

Typedefs
using	ActionList = QList< Action * >
	A list of Action.
using	ActionSet = QSet< Action * >
	A set of Action.
using	ComponentList = QList< Component * >
	A list of Component.
typedef QWidget *(*	GetUIFunction) (Action *)
typedef void(*	ParameterChangedFunction) (Action *self, QString parameterName)
typedef Action::ApplyStatus(*	ProcessFunction) (Action *self)
using	Unit = QString
	Unit is a type that defines the unit used by data (e.g.
using	ViewerList = QList< Viewer * >
	A list of Viewer.
using	ViewerSet = QSet< Viewer * >
	A set of Viewer.
typedef void(*	VoidFunction) (Action *)
	function signatures in the UserActionLib
using	vtkSmartPointerCamera = vtkSmartPointer< vtkCamera >

Functions
bool	actionLessThan (const camitk::Action *a1, const camitk::Action *a2)
char *	toString (const FrameOfReference &frame)
char *	toString (const Transformation &tr)
QString	toString (const vtkSmartPointer< vtkMatrix4x4 > &m)
bool	viewerLessThan (const camitk::Viewer *v1, const camitk::Viewer *v2)
	vtkStandardNewMacro (vtkInteractorStylePick)

Typedef Documentation

ActionList

using camitk::ActionList = typedef QList<Action*>

A list of Action.

ActionSet

using camitk::ActionSet = typedef QSet<Action*>

A set of Action.

ComponentList

using camitk::ComponentList = typedef QList<Component*>

A list of Component.

GetUIFunction

typedef QWidget *(* camitk::GetUIFunction) (Action *)

ParameterChangedFunction

typedef void(* camitk::ParameterChangedFunction) (Action *self, QString parameterName)

ProcessFunction

typedef Action::ApplyStatus(* camitk::ProcessFunction) (Action *self)

Unit

using camitk::Unit = typedef QString

Unit is a type that defines the unit used by data (e.g.

voxel size)

It is a string following the Unified Codes for Units of Measurement standard (https://ucum.org) also used by DICOM.

ViewerList

using camitk::ViewerList = typedef QList<Viewer*>

A list of Viewer.

ViewerSet

using camitk::ViewerSet = typedef QSet<Viewer*>

A set of Viewer.

VoidFunction

typedef void(* camitk::VoidFunction) (Action *)

function signatures in the UserActionLib

vtkSmartPointerCamera

using camitk::vtkSmartPointerCamera = typedef vtkSmartPointer<vtkCamera>

Function Documentation

actionLessThan()

bool camitk::actionLessThan	(	const camitk::Action *	a1,
		const camitk::Action *	a2
	)

References camitk::Action::getName().

Referenced by camitk::Component::getActionMenu(), and camitk::Application::getActions().

Here is the call graph for this function:

Here is the caller graph for this function:

toString() [1/3]

char * camitk::toString

(

const FrameOfReference &

frame

)

References camitk::FrameOfReference::getName().

Referenced by camitk::MeshDataFilterModel::filterAcceptsRow(), camitk::CamiTKFile::getTimestamp(), OpenFile::getWidget(), OpenWorkspaceFile::getWidget(), ActionState::onEntry(), PMLComponent::propertyValueChanged(), camitk::Component::propertyValueChanged(), camitk::Application::saveHistoryAsSCXML(), camitk::InteractiveViewer::screenshot(), and camitk::ActionWidget::showInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

toString() [2/3]

char * camitk::toString

(

const Transformation &

tr

)

References camitk::Transformation::getName(), and camitk::Transformation::getTransform().

Here is the call graph for this function:

toString() [3/3]

QString camitk::toString

(

const vtkSmartPointer< vtkMatrix4x4 > &

m

)

viewerLessThan()

bool camitk::viewerLessThan	(	const camitk::Viewer *	v1,
		const camitk::Viewer *	v2
	)

References camitk::Viewer::getName().

Here is the call graph for this function:

vtkStandardNewMacro()

camitk::vtkStandardNewMacro

(

vtkInteractorStylePick

)