Slicer  5.1
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends
vtkSlicerTerminologiesModuleLogic Class Reference

#include <Modules/Loadable/Terminologies/Logic/vtkSlicerTerminologiesModuleLogic.h>

Inheritance diagram for vtkSlicerTerminologiesModuleLogic:
Inheritance graph
[legend]
Collaboration diagram for vtkSlicerTerminologiesModuleLogic:
Collaboration graph
[legend]

Classes

class  CodeIdentifier
 Information needed to uniquely identify a terminology code. More...
 

Public Types

typedef vtkSlicerModuleLogic Superclass
 
- Public Types inherited from vtkSlicerModuleLogic
typedef vtkMRMLAbstractLogic Superclass
 
- Public Types inherited from vtkMRMLAbstractLogic
typedef vtkObject Superclass
 
typedef void(vtkMRMLAbstractLogic::* TaskFunctionPointer) (void *clientdata)
 

Public Member Functions

bool DeserializeTerminologyEntry (std::string serializedEntry, vtkSlicerTerminologyEntry *entry)
 
bool FindCategoriesInTerminology (std::string terminologyName, std::vector< CodeIdentifier > &categories, std::string search)
 
bool FindRegionsInAnatomicContext (std::string anatomicContextName, std::vector< CodeIdentifier > &regions, std::string search)
 
bool FindTypeInTerminologyBy3dSlicerLabel (std::string terminologyName, std::string slicerLabel, vtkSlicerTerminologyEntry *entry)
 
bool FindTypesInTerminologyCategory (std::string terminologyName, CodeIdentifier categoryId, std::vector< CodeIdentifier > &types, std::string search)
 
bool GetCategoriesInTerminology (std::string terminologyName, std::vector< CodeIdentifier > &categories)
 
bool GetCategoryInTerminology (std::string terminologyName, CodeIdentifier categoryId, vtkSlicerTerminologyCategory *categoryObject)
 
virtual const char * GetClassName ()
 
void GetLoadedAnatomicContextNames (std::vector< std::string > &anatomicContextNames)
 Get context names of loaded anatomic contexts. More...
 
void GetLoadedAnatomicContextNames (vtkStringArray *anatomicContextNames)
 Python accessor variant of. More...
 
void GetLoadedTerminologyNames (std::vector< std::string > &terminologyNames)
 Get context names of loaded terminologies. More...
 
void GetLoadedTerminologyNames (vtkStringArray *terminologyNames)
 Python accessor variant of. More...
 
bool GetNthCategoryInTerminology (std::string terminologyName, int categoryIndex, vtkSlicerTerminologyCategory *category)
 
bool GetNthTypeInTerminologyCategory (std::string terminologyName, vtkSlicerTerminologyCategory *category, int typeIndex, vtkSlicerTerminologyType *type)
 
bool GetNthTypeModifierInTerminologyType (std::string terminologyName, vtkSlicerTerminologyCategory *category, vtkSlicerTerminologyType *type, int typeModifierIndex, vtkSlicerTerminologyType *typeModifier)
 
int GetNumberOfCategoriesInTerminology (std::string terminologyName)
 Get number of categories in a terminology. More...
 
int GetNumberOfTypeModifiersInTerminologyType (std::string terminologyName, vtkSlicerTerminologyCategory *category, vtkSlicerTerminologyType *type)
 Get number of type modifiers for the chosen category and type in a terminology. More...
 
int GetNumberOfTypesInTerminologyCategory (std::string terminologyName, vtkSlicerTerminologyCategory *category)
 Get number of types in the chosen category in a terminology. More...
 
bool GetRegionInAnatomicContext (std::string anatomicContextName, CodeIdentifier regionId, vtkSlicerTerminologyType *regionObject)
 
bool GetRegionModifierInAnatomicRegion (std::string anatomicContextName, CodeIdentifier regionId, CodeIdentifier modifierId, vtkSlicerTerminologyType *regionModifier)
 
bool GetRegionModifiersInAnatomicRegion (std::string anatomicContextName, CodeIdentifier regionId, std::vector< CodeIdentifier > &regionModifiers)
 
bool GetRegionsInAnatomicContext (std::string anatomicContextName, std::vector< CodeIdentifier > &regions)
 
bool GetTypeInTerminologyCategory (std::string terminologyName, CodeIdentifier categoryId, CodeIdentifier typeId, vtkSlicerTerminologyType *typeObject)
 
bool GetTypeModifierInTerminologyType (std::string terminologyName, CodeIdentifier categoryId, CodeIdentifier typeId, CodeIdentifier modifierId, vtkSlicerTerminologyType *typeModifier)
 
bool GetTypeModifiersInTerminologyType (std::string terminologyName, CodeIdentifier categoryId, CodeIdentifier typeId, std::vector< CodeIdentifier > &typeModifiers)
 
bool GetTypesInTerminologyCategory (std::string terminologyName, CodeIdentifier categoryId, std::vector< CodeIdentifier > &types)
 
virtual char * GetUserContextsPath ()
 
virtual int IsA (const char *type)
 
std::string LoadAnatomicContextFromFile (std::string filePath)
 
bool LoadAnatomicContextFromSegmentDescriptorFile (std::string contextName, std::string filePath)
 
bool LoadContextFromFile (std::string filePath)
 
std::string LoadTerminologyFromFile (std::string filePath)
 
bool LoadTerminologyFromSegmentDescriptorFile (std::string contextName, std::string filePath)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void SetUserContextsPath (const char *)
 
- Public Member Functions inherited from vtkSlicerModuleLogic
virtual vtkSlicerApplicationLogicGetApplicationLogic ()
 Get access to overall application state. More...
 
virtual vtkMRMLAbstractLogicGetModuleLogic (const char *moduleName)
 Convenience method for getting another module's logic from the application logic. More...
 
std::string GetModuleShareDirectory () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void SetModuleShareDirectory (const std::string &shareDirectory)
 
- Public Member Functions inherited from vtkMRMLAbstractLogic
virtual vtkMRMLApplicationLogicGetMRMLApplicationLogic () const
 Get access to overall application state. More...
 
vtkMRMLSceneGetMRMLScene () const
 Return a reference to the current MRML scene. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void SetMRMLApplicationLogic (vtkMRMLApplicationLogic *logic)
 
void SetMRMLScene (vtkMRMLScene *newScene)
 Set and observe the MRMLScene. More...
 

Static Public Member Functions

static CodeIdentifier CodeIdentifierFromTerminologyCategory (vtkSlicerTerminologyCategory *category)
 Convert terminology category object to code identifier. More...
 
static CodeIdentifier CodeIdentifierFromTerminologyType (vtkSlicerTerminologyType *type)
 Convert terminology type object to code identifier. More...
 
static const char * GetColorAutoGeneratedAttributeName ()
 Node attribute name for color auto generated. More...
 
static std::string GetInfoStringFromTerminologyEntry (vtkSlicerTerminologyEntry *entry)
 Assemble human readable info string from a terminology entry, for example for tooltips. More...
 
static const char * GetNameAutoGeneratedAttributeName ()
 Node attribute name for name auto generated. More...
 
static int IsTypeOf (const char *type)
 
static vtkSlicerTerminologiesModuleLogicNew ()
 
static vtkSlicerTerminologiesModuleLogicSafeDownCast (vtkObject *o)
 
static std::string SerializeTerminologyEntry (vtkSlicerTerminologyEntry *entry)
 
static std::string SerializeTerminologyEntry (std::string terminologyContextName, std::string categoryValue, std::string categorySchemeDesignator, std::string categoryMeaning, std::string typeValue, std::string typeSchemeDesignator, std::string typeMeaning, std::string modifierValue, std::string modifierSchemeDesignator, std::string modifierMeaning, std::string anatomicContextName, std::string regionValue, std::string regionSchemeDesignator, std::string regionMeaning, std::string regionModifierValue, std::string regionModifierSchemeDesignator, std::string regionModifierMeaning)
 
- Static Public Member Functions inherited from vtkSlicerModuleLogic
static int IsTypeOf (const char *type)
 
static vtkSlicerModuleLogicNew ()
 The Usual vtk class functions. More...
 
static vtkSlicerModuleLogicSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLAbstractLogic
static int IsTypeOf (const char *type)
 
static vtkMRMLAbstractLogicNew ()
 
static vtkMRMLAbstractLogicSafeDownCast (vtkObject *o)
 

Protected Member Functions

void LoadDefaultAnatomicContexts ()
 Load default anatomic context dictionaries from JSON into. More...
 
void LoadDefaultTerminologies ()
 Load default terminology dictionaries from JSON into. More...
 
void LoadUserContexts ()
 Load terminologies and anatomic contexts from the user settings directory. More...
 
void SetMRMLSceneInternal (vtkMRMLScene *newScene) override
 
 vtkSlicerTerminologiesModuleLogic ()
 
 ~vtkSlicerTerminologiesModuleLogic () override
 
- Protected Member Functions inherited from vtkSlicerModuleLogic
 vtkSlicerModuleLogic ()
 
 ~vtkSlicerModuleLogic () override
 
- Protected Member Functions inherited from vtkMRMLAbstractLogic
int EndModify (bool wasModifying)
 
virtual bool EnterMRMLLogicsCallback () const
 
virtual bool EnterMRMLNodesCallback () const
 
virtual bool EnterMRMLSceneCallback () const
 
bool GetDisableModifiedEvent () const
 
int GetInMRMLLogicsCallbackFlag () const
 
int GetInMRMLNodesCallbackFlag () const
 
int GetInMRMLSceneCallbackFlag () const
 
vtkCallbackCommand * GetMRMLLogicsCallbackCommand ()
 
vtkObserverManagerGetMRMLLogicsObserverManager () const
 
vtkCallbackCommand * GetMRMLNodesCallbackCommand ()
 
vtkObserverManagerGetMRMLNodesObserverManager () const
 
vtkCallbackCommand * GetMRMLSceneCallbackCommand ()
 
vtkObserverManagerGetMRMLSceneObserverManager () const
 
int GetPendingModifiedEventCount () const
 
int GetProcessingMRMLSceneEvent () const
 Return the event id currently processed or 0 if any. More...
 
int InvokePendingModifiedEvent ()
 
void Modified () override
 
virtual void ObserveMRMLScene ()
 
virtual void OnMRMLNodeModified (vtkMRMLNode *)
 
virtual void OnMRMLSceneEndBatchProcess ()
 
virtual void OnMRMLSceneEndClose ()
 
virtual void OnMRMLSceneEndImport ()
 
virtual void OnMRMLSceneEndRestore ()
 
virtual void OnMRMLSceneNew ()
 
virtual void OnMRMLSceneNodeAdded (vtkMRMLNode *)
 
virtual void OnMRMLSceneNodeRemoved (vtkMRMLNode *)
 
virtual void OnMRMLSceneStartBatchProcess ()
 
virtual void OnMRMLSceneStartClose ()
 
virtual void OnMRMLSceneStartImport ()
 
virtual void OnMRMLSceneStartRestore ()
 
virtual void ProcessMRMLLogicsEvents (vtkObject *caller, unsigned long event, void *callData)
 
virtual void ProcessMRMLNodesEvents (vtkObject *caller, unsigned long event, void *callData)
 
virtual void ProcessMRMLSceneEvents (vtkObject *caller, unsigned long event, void *callData)
 
virtual void RegisterNodes ()
 
void SetAndObserveMRMLSceneEventsInternal (vtkMRMLScene *newScene, vtkIntArray *events, vtkFloatArray *priorities=nullptr)
 
void SetDisableModifiedEvent (bool onOff)
 
void SetInMRMLLogicsCallbackFlag (int flag)
 
void SetInMRMLNodesCallbackFlag (int flag)
 
void SetInMRMLSceneCallbackFlag (int flag)
 
void SetProcessingMRMLSceneEvent (int event)
 
bool StartModify ()
 
virtual void UnobserveMRMLScene ()
 
virtual void UpdateFromMRMLScene ()
 
 vtkMRMLAbstractLogic ()
 
 ~vtkMRMLAbstractLogic () override
 

Protected Attributes

char * UserContextsPath {nullptr}
 The path from which the json files are automatically loaded on startup. More...
 

Friends

class vtkInternal
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkMRMLAbstractLogic
static void MRMLLogicsCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 MRMLLogicCallback is a static function to relay modified events from the logics. More...
 
static void MRMLNodesCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 MRMLNodesCallback is a static function to relay modified events from the nodes. More...
 
static void MRMLSceneCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 

Detailed Description

Definition at line 39 of file vtkSlicerTerminologiesModuleLogic.h.

Member Typedef Documentation

◆ Superclass

Definition at line 44 of file vtkSlicerTerminologiesModuleLogic.h.

Constructor & Destructor Documentation

◆ vtkSlicerTerminologiesModuleLogic()

vtkSlicerTerminologiesModuleLogic::vtkSlicerTerminologiesModuleLogic ( )
protected

◆ ~vtkSlicerTerminologiesModuleLogic()

vtkSlicerTerminologiesModuleLogic::~vtkSlicerTerminologiesModuleLogic ( )
overrideprotected

Member Function Documentation

◆ CodeIdentifierFromTerminologyCategory()

static CodeIdentifier vtkSlicerTerminologiesModuleLogic::CodeIdentifierFromTerminologyCategory ( vtkSlicerTerminologyCategory category)
static

Convert terminology category object to code identifier.

◆ CodeIdentifierFromTerminologyType()

static CodeIdentifier vtkSlicerTerminologiesModuleLogic::CodeIdentifierFromTerminologyType ( vtkSlicerTerminologyType type)
static

Convert terminology type object to code identifier.

◆ DeserializeTerminologyEntry()

bool vtkSlicerTerminologiesModuleLogic::DeserializeTerminologyEntry ( std::string  serializedEntry,
vtkSlicerTerminologyEntry entry 
)

Populate terminology entry VTK object based on serialized entry Serialized terminology entry consists of the following: terminologyContextName, category (codingScheme, codeValue, codeMeaning triple), type, typeModifier, anatomicContextName, anatomicRegion, anatomicRegionModifier

Returns
Success flag

◆ FindCategoriesInTerminology()

bool vtkSlicerTerminologiesModuleLogic::FindCategoriesInTerminology ( std::string  terminologyName,
std::vector< CodeIdentifier > &  categories,
std::string  search 
)

Find category names (codeMeaning) in terminology containing a given string

Parameters
categoriesOutput argument containing all the
See also
vtkSlicerTerminologyCategory objects created from the categories found in the given terminology
Returns
Success flag

◆ FindRegionsInAnatomicContext()

bool vtkSlicerTerminologiesModuleLogic::FindRegionsInAnatomicContext ( std::string  anatomicContextName,
std::vector< CodeIdentifier > &  regions,
std::string  search 
)

Get all region names (codeMeaning) in an anatomic context

Returns
Success flag

◆ FindTypeInTerminologyBy3dSlicerLabel()

bool vtkSlicerTerminologiesModuleLogic::FindTypeInTerminologyBy3dSlicerLabel ( std::string  terminologyName,
std::string  slicerLabel,
vtkSlicerTerminologyEntry entry 
)

Find terminology type or type modifier based on '3dSlicerLabel' attribute

Parameters
terminologyNameTerminology context in which the attribute is looked for
slicerLabelAttribute to look for
entryTerminology entry populated if the attribute is found
Returns
Flag indicating whether the attribute was found

◆ FindTypesInTerminologyCategory()

bool vtkSlicerTerminologiesModuleLogic::FindTypesInTerminologyCategory ( std::string  terminologyName,
CodeIdentifier  categoryId,
std::vector< CodeIdentifier > &  types,
std::string  search 
)

Get all type names (codeMeaning) in a terminology category

Parameters
typeCollectionOutput argument containing all the
See also
vtkSlicerTerminologyType objects created from the types found in the given terminology category
Returns
Success flag

◆ GetCategoriesInTerminology()

bool vtkSlicerTerminologiesModuleLogic::GetCategoriesInTerminology ( std::string  terminologyName,
std::vector< CodeIdentifier > &  categories 
)

Get terminology categories from a terminology as collection of

See also
vtkSlicerTerminologyCategory container objects
Parameters
categoriesOutput argument containing all the
See also
vtkSlicerTerminologyCategory objects created from the categories found in the given terminology
Returns
Success flag

◆ GetCategoryInTerminology()

bool vtkSlicerTerminologiesModuleLogic::GetCategoryInTerminology ( std::string  terminologyName,
CodeIdentifier  categoryId,
vtkSlicerTerminologyCategory categoryObject 
)

Get a category with given name from a terminology

Parameters
categoryOutput argument containing the details of the found category if any (if return value is true)
Returns
Success flag

◆ GetClassName()

virtual const char* vtkSlicerTerminologiesModuleLogic::GetClassName ( )
virtual

Reimplemented from vtkSlicerModuleLogic.

◆ GetColorAutoGeneratedAttributeName()

static const char* vtkSlicerTerminologiesModuleLogic::GetColorAutoGeneratedAttributeName ( )
inlinestatic

Node attribute name for color auto generated.

Definition at line 66 of file vtkSlicerTerminologiesModuleLogic.h.

◆ GetInfoStringFromTerminologyEntry()

static std::string vtkSlicerTerminologiesModuleLogic::GetInfoStringFromTerminologyEntry ( vtkSlicerTerminologyEntry entry)
static

Assemble human readable info string from a terminology entry, for example for tooltips.

◆ GetLoadedAnatomicContextNames() [1/2]

void vtkSlicerTerminologiesModuleLogic::GetLoadedAnatomicContextNames ( std::vector< std::string > &  anatomicContextNames)

Get context names of loaded anatomic contexts.

◆ GetLoadedAnatomicContextNames() [2/2]

void vtkSlicerTerminologiesModuleLogic::GetLoadedAnatomicContextNames ( vtkStringArray *  anatomicContextNames)

Python accessor variant of.

See also
GetLoadedAnatomicContextNames

◆ GetLoadedTerminologyNames() [1/2]

void vtkSlicerTerminologiesModuleLogic::GetLoadedTerminologyNames ( std::vector< std::string > &  terminologyNames)

Get context names of loaded terminologies.

◆ GetLoadedTerminologyNames() [2/2]

void vtkSlicerTerminologiesModuleLogic::GetLoadedTerminologyNames ( vtkStringArray *  terminologyNames)

Python accessor variant of.

See also
GetLoadedTerminologyNames

◆ GetNameAutoGeneratedAttributeName()

static const char* vtkSlicerTerminologiesModuleLogic::GetNameAutoGeneratedAttributeName ( )
inlinestatic

Node attribute name for name auto generated.

Definition at line 64 of file vtkSlicerTerminologiesModuleLogic.h.

◆ GetNthCategoryInTerminology()

bool vtkSlicerTerminologiesModuleLogic::GetNthCategoryInTerminology ( std::string  terminologyName,
int  categoryIndex,
vtkSlicerTerminologyCategory category 
)

Get a category from a terminology by index.

Parameters
categoryIndexspecifies which category to return
categorycategory is returned in this object
Returns
Success flag

◆ GetNthTypeInTerminologyCategory()

bool vtkSlicerTerminologiesModuleLogic::GetNthTypeInTerminologyCategory ( std::string  terminologyName,
vtkSlicerTerminologyCategory category,
int  typeIndex,
vtkSlicerTerminologyType type 
)

Get a terminology type by index

Parameters
terminologyNameinput terminology name
categoryinput category
typeIndexindex of type to return
typeObjectoutput type
Returns
Success flag

◆ GetNthTypeModifierInTerminologyType()

bool vtkSlicerTerminologiesModuleLogic::GetNthTypeModifierInTerminologyType ( std::string  terminologyName,
vtkSlicerTerminologyCategory category,
vtkSlicerTerminologyType type,
int  typeModifierIndex,
vtkSlicerTerminologyType typeModifier 
)

Get a terminology type by index

Parameters
terminologyNameinput terminology name
categoryinput category
typeObjectinput type
typeModifierIndexindex of type modifier to return
typeModifieroutput type modifier
Returns
Success flag

◆ GetNumberOfCategoriesInTerminology()

int vtkSlicerTerminologiesModuleLogic::GetNumberOfCategoriesInTerminology ( std::string  terminologyName)

Get number of categories in a terminology.

◆ GetNumberOfTypeModifiersInTerminologyType()

int vtkSlicerTerminologiesModuleLogic::GetNumberOfTypeModifiersInTerminologyType ( std::string  terminologyName,
vtkSlicerTerminologyCategory category,
vtkSlicerTerminologyType type 
)

Get number of type modifiers for the chosen category and type in a terminology.

◆ GetNumberOfTypesInTerminologyCategory()

int vtkSlicerTerminologiesModuleLogic::GetNumberOfTypesInTerminologyCategory ( std::string  terminologyName,
vtkSlicerTerminologyCategory category 
)

Get number of types in the chosen category in a terminology.

◆ GetRegionInAnatomicContext()

bool vtkSlicerTerminologiesModuleLogic::GetRegionInAnatomicContext ( std::string  anatomicContextName,
CodeIdentifier  regionId,
vtkSlicerTerminologyType regionObject 
)

Get a region with given name from an anatomic context

Parameters
regionOutput argument containing the details of the found region if any (if return value is true)
Returns
Success flag

◆ GetRegionModifierInAnatomicRegion()

bool vtkSlicerTerminologiesModuleLogic::GetRegionModifierInAnatomicRegion ( std::string  anatomicContextName,
CodeIdentifier  regionId,
CodeIdentifier  modifierId,
vtkSlicerTerminologyType regionModifier 
)

Get a region modifier with given name from an anatomic region

Parameters
regionModifierOutput argument containing the details of the found region modifier if any (if return value is true)
Returns
Success flag

◆ GetRegionModifiersInAnatomicRegion()

bool vtkSlicerTerminologiesModuleLogic::GetRegionModifiersInAnatomicRegion ( std::string  anatomicContextName,
CodeIdentifier  regionId,
std::vector< CodeIdentifier > &  regionModifiers 
)

Get region modifiers from an anatomic region as collection of

See also
vtkSlicerTerminologyType container objects
Parameters
regionModifierCollectionOutput argument containing all the
See also
vtkSlicerTerminologyType objects created from the region modifiers found in the given anatomic region
Returns
Success flag

◆ GetRegionsInAnatomicContext()

bool vtkSlicerTerminologiesModuleLogic::GetRegionsInAnatomicContext ( std::string  anatomicContextName,
std::vector< CodeIdentifier > &  regions 
)

Get anatomic regions from an anatomic context as collection of

See also
vtkSlicerTerminologyType container objects
Parameters
regionCollectionOutput argument containing all the
See also
vtkSlicerTerminologyType objects created from the regions found in the given anatomic context
Returns
Success flag

◆ GetTypeInTerminologyCategory()

bool vtkSlicerTerminologiesModuleLogic::GetTypeInTerminologyCategory ( std::string  terminologyName,
CodeIdentifier  categoryId,
CodeIdentifier  typeId,
vtkSlicerTerminologyType typeObject 
)

Get a type with given name from a terminology category

Parameters
typeOutput argument containing the details of the found type if any (if return value is true)
Returns
Success flag

◆ GetTypeModifierInTerminologyType()

bool vtkSlicerTerminologiesModuleLogic::GetTypeModifierInTerminologyType ( std::string  terminologyName,
CodeIdentifier  categoryId,
CodeIdentifier  typeId,
CodeIdentifier  modifierId,
vtkSlicerTerminologyType typeModifier 
)

Get a type modifier with given name from a terminology type

Parameters
typeModifierOutput argument containing the details of the found type modifier if any (if return value is true)
Returns
Success flag

◆ GetTypeModifiersInTerminologyType()

bool vtkSlicerTerminologiesModuleLogic::GetTypeModifiersInTerminologyType ( std::string  terminologyName,
CodeIdentifier  categoryId,
CodeIdentifier  typeId,
std::vector< CodeIdentifier > &  typeModifiers 
)

Get terminology type modifiers from a terminology type as collection of

See also
vtkSlicerTerminologyType container objects
Parameters
typeModifierCollectionOutput argument containing all the
See also
vtkSlicerTerminologyType objects created from the type modifiers found in the given terminology type
Returns
Success flag

◆ GetTypesInTerminologyCategory()

bool vtkSlicerTerminologiesModuleLogic::GetTypesInTerminologyCategory ( std::string  terminologyName,
CodeIdentifier  categoryId,
std::vector< CodeIdentifier > &  types 
)

Get terminology types from a terminology category as collection of

See also
vtkSlicerTerminologyType container objects
Parameters
typeCollectionOutput argument containing all the
See also
vtkSlicerTerminologyType objects created from the types found in the given terminology category
Returns
Success flag

◆ GetUserContextsPath()

virtual char* vtkSlicerTerminologiesModuleLogic::GetUserContextsPath ( )
virtual

◆ IsA()

virtual int vtkSlicerTerminologiesModuleLogic::IsA ( const char *  type)
virtual

Reimplemented from vtkSlicerModuleLogic.

◆ IsTypeOf()

static int vtkSlicerTerminologiesModuleLogic::IsTypeOf ( const char *  type)
static

◆ LoadAnatomicContextFromFile()

std::string vtkSlicerTerminologiesModuleLogic::LoadAnatomicContextFromFile ( std::string  filePath)

Load anatomic context dictionaries from JSON into

See also
LoadedAnatomicContexts
Parameters
filePathFile containing the anatomic context to load
Returns
Context name (AnatomicContextName) of the loaded anatomic context. Empty string on failure.

◆ LoadAnatomicContextFromSegmentDescriptorFile()

bool vtkSlicerTerminologiesModuleLogic::LoadAnatomicContextFromSegmentDescriptorFile ( std::string  contextName,
std::string  filePath 
)

Load anatomic context dictionary from segmentation descriptor JSON file into

See also
LoadedAnatomicContexts. See also
LoadTerminologyFromSegmentDescriptorFile

◆ LoadContextFromFile()

bool vtkSlicerTerminologiesModuleLogic::LoadContextFromFile ( std::string  filePath)

Load terminology or anatomic context from JSON file. Note: Separate generic loader function was created so that the file does not need to be loaded twice in case the type of the context in the JSON file is not known

Parameters
filePathFile containing the context to load
Returns
Success flag

◆ LoadDefaultAnatomicContexts()

void vtkSlicerTerminologiesModuleLogic::LoadDefaultAnatomicContexts ( )
protected

Load default anatomic context dictionaries from JSON into.

See also
LoadedAnatomicContexts

◆ LoadDefaultTerminologies()

void vtkSlicerTerminologiesModuleLogic::LoadDefaultTerminologies ( )
protected

Load default terminology dictionaries from JSON into.

See also
LoadedTerminologies

◆ LoadTerminologyFromFile()

std::string vtkSlicerTerminologiesModuleLogic::LoadTerminologyFromFile ( std::string  filePath)

Load terminology dictionary from JSON terminology context file into

See also
LoadedTerminologies.
Parameters
filePathFile containing the terminology to load
Returns
Context name (SegmentationCategoryTypeContextName) of the loaded terminology. Empty string on failure.

◆ LoadTerminologyFromSegmentDescriptorFile()

bool vtkSlicerTerminologiesModuleLogic::LoadTerminologyFromSegmentDescriptorFile ( std::string  contextName,
std::string  filePath 
)

Load terminology dictionary from segmentation descriptor JSON file into

See also
LoadedTerminologies.
Parameters
Terminologycontext name (the descriptor file does not contain information about that)
filePathFile containing the terminology to load
Returns
Success flag

◆ LoadUserContexts()

void vtkSlicerTerminologiesModuleLogic::LoadUserContexts ( )
protected

Load terminologies and anatomic contexts from the user settings directory.

See also
UserContextsPath

◆ New()

static vtkSlicerTerminologiesModuleLogic* vtkSlicerTerminologiesModuleLogic::New ( )
static

◆ PrintSelf()

void vtkSlicerTerminologiesModuleLogic::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
override

◆ SafeDownCast()

static vtkSlicerTerminologiesModuleLogic* vtkSlicerTerminologiesModuleLogic::SafeDownCast ( vtkObject *  o)
static

◆ SerializeTerminologyEntry() [1/2]

static std::string vtkSlicerTerminologiesModuleLogic::SerializeTerminologyEntry ( vtkSlicerTerminologyEntry entry)
static

Convert terminology entry VTK object to string containing identifiers Serialized terminology entry consists of the following: terminologyContextName, category (codingScheme, codeValue, codeMeaning triple), type, typeModifier, anatomicContextName, anatomicRegion, anatomicRegionModifier

◆ SerializeTerminologyEntry() [2/2]

static std::string vtkSlicerTerminologiesModuleLogic::SerializeTerminologyEntry ( std::string  terminologyContextName,
std::string  categoryValue,
std::string  categorySchemeDesignator,
std::string  categoryMeaning,
std::string  typeValue,
std::string  typeSchemeDesignator,
std::string  typeMeaning,
std::string  modifierValue,
std::string  modifierSchemeDesignator,
std::string  modifierMeaning,
std::string  anatomicContextName,
std::string  regionValue,
std::string  regionSchemeDesignator,
std::string  regionMeaning,
std::string  regionModifierValue,
std::string  regionModifierSchemeDesignator,
std::string  regionModifierMeaning 
)
static

Assemble terminology string from terminology codes Note: The order of the attributes are inconsistent with the codes used in this class for compatibility reasons (to vtkMRMLColorLogic::AddTermToTerminology)

◆ SetMRMLSceneInternal()

void vtkSlicerTerminologiesModuleLogic::SetMRMLSceneInternal ( vtkMRMLScene newScene)
overrideprotectedvirtual

Called each time a new scene is set. Can be reimplemented in derivated classes. Doesn't observe the scene by default, that means that UpdateFromMRMLScene() won't be called by default when a scene is imported, closed or restored, only when a new scene is set.

See also
SetAndObserveMRMLSceneInternal() SetAndObserveMRMLSceneEventsInternal()
UpdateFromMRMLScene()

Reimplemented from vtkMRMLAbstractLogic.

◆ SetUserContextsPath()

virtual void vtkSlicerTerminologiesModuleLogic::SetUserContextsPath ( const char *  )
virtual

Friends And Related Function Documentation

◆ vtkInternal

friend class vtkInternal
friend

Definition at line 256 of file vtkSlicerTerminologiesModuleLogic.h.

Member Data Documentation

◆ UserContextsPath

char* vtkSlicerTerminologiesModuleLogic::UserContextsPath {nullptr}
protected

The path from which the json files are automatically loaded on startup.

Definition at line 248 of file vtkSlicerTerminologiesModuleLogic.h.


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