Slicer
4.11
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
|
MRML node to represent procedurally defined color information. More...
#include <Libs/MRML/Core/vtkMRMLProceduralColorNode.h>
Public Types | |
enum | { DisplayModifiedEvent = 20000 } |
The list of valid procedural types. More... | |
typedef vtkMRMLColorNode | Superclass |
Public Types inherited from vtkMRMLColorNode | |
enum | { TypeModifiedEvent = 20002 } |
TypeModifiedEvent is generated when the type of the colour look up table changes. More... | |
enum | { User = 13, File = 14 } |
typedef vtkMRMLStorableNode | Superclass |
Public Types inherited from vtkMRMLStorableNode | |
typedef vtkMRMLNode | Superclass |
Public Types inherited from vtkMRMLNode | |
enum | { HierarchyModifiedEvent = 16000, IDChangedEvent = 16001, ReferenceAddedEvent, ReferenceModifiedEvent, ReferenceRemovedEvent, ReferencedNodeModifiedEvent } |
typedef vtkObject | Superclass |
Public Member Functions | |
void | Copy (vtkMRMLNode *node) override |
Copy the node's attributes to this object More... | |
vtkMRMLStorageNode * | CreateDefaultStorageNode () override |
Create default storage node or nullptr if does not have one. More... | |
vtkMRMLNode * | CreateNodeInstance () override |
MRMLNode methods. More... | |
virtual const char * | GetClassName () |
bool | GetColor (int entry, double color[4]) override |
Retrieve color transfer function entry value. More... | |
virtual vtkColorTransferFunction * | GetColorTransferFunction () |
vtkLookupTable * | GetLookupTable () override |
const char * | GetNodeTagName () override |
Get node XML tag name (like Volume, Model) More... | |
int | GetNumberOfColors () override |
virtual unsigned int | GetNumberOfTableValues () |
vtkScalarsToColors * | GetScalarsToColors () override |
const char * | GetTypeAsString () override |
return a text string describing the colour look up table type More... | |
virtual int | IsA (const char *type) |
void | PrintSelf (ostream &os, vtkIndent indent) override |
void | ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData) override |
Propagate events generated in mrml. More... | |
void | ReadXMLAttributes (const char **atts) override |
Set node attributes More... | |
virtual void | SetAndObserveColorTransferFunction (vtkColorTransferFunction *ctf) |
bool | SetNameFromColor (int index) override |
virtual void | SetNumberOfTableValues (unsigned int) |
void | UpdateScene (vtkMRMLScene *scene) override |
void | WriteXML (ostream &of, int indent) override |
Write this node's information to a MRML file in XML format. More... | |
Public Member Functions inherited from vtkMRMLColorNode | |
virtual vtkLookupTable * | CreateLookupTableCopy () |
int | GetColorIndexByName (const char *name) |
const char * | GetColorName (int ind) |
std::string | GetColorNameAsFileName (int colorIndex, const char *subst="_") |
std::string | GetColorNameWithoutSpaces (int ind, const char *subst) |
virtual char * | GetFileName () |
virtual int | GetFirstType () |
virtual int | GetLastType () |
bool | GetModifiedSinceRead () override |
virtual int | GetNamesInitialised () |
Get/Set for the flag on names array having been initialised More... | |
virtual char * | GetNoName () |
virtual int | GetType () |
Get for Type More... | |
virtual void | NamesInitialisedOff () |
virtual void | NamesInitialisedOn () |
void | PrintSelf (ostream &os, vtkIndent indent) override |
void | Reset (vtkMRMLNode *defaultNode) override |
int | SetColorName (int ind, const char *name) |
int | SetColorNameWithSpaces (int ind, const char *name, const char *subst) |
virtual void | SetFileName (const char *) |
Name of the file name from which to read color information More... | |
void | SetNamesFromColors () |
Set values in the names vector from the colours in the node More... | |
virtual void | SetNamesInitialised (int) |
virtual void | SetNoName (const char *) |
virtual void | SetType (int type) |
Set Type to type, then build colours and set names More... | |
void | SetTypeToFile () |
void | SetTypeToUser () |
Public Member Functions inherited from vtkMRMLStorableNode | |
void | AddAndObserveStorageNodeID (const char *storageNodeID) |
virtual bool | AddDefaultStorageNode (const char *filename=nullptr) |
virtual vtkMRMLStorageNode * | CreateDefaultSequenceStorageNode () |
virtual std::string | GetDefaultStorageNodeClassName (const char *filename=nullptr) |
vtkMRMLStorageNode * | GetNthStorageNode (int n) |
Get associated display MRML node More... | |
const char * | GetNthStorageNodeID (int n) |
int | GetNumberOfStorageNodes () |
const char * | GetSlicerDataType () |
vtkMRMLStorageNode * | GetStorageNode () |
const char * | GetStorageNodeID () |
virtual vtkTagTable * | GetUserTagTable () |
Methods for user-specified metadata. More... | |
bool | HasStorageNodeID (const char *storageNodeID) |
Return true if storageNodeID is in the storage node ID list. More... | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
void | ProcessMRMLEvents (vtkObject *, unsigned long, void *) override |
alternative method to propagate events generated in Storage nodes More... | |
void | ReadXMLAttributes (const char **atts) override |
Read node attributes from XML file More... | |
void | SetAndObserveNthStorageNodeID (int n, const char *storageNodeID) |
void | SetAndObserveStorageNodeID (const char *storageNodeID) |
String ID of the storage MRML node More... | |
void | SetSlicerDataType (const char *type) |
virtual void | StorableModified () |
void | UpdateScene (vtkMRMLScene *scene) override |
Finds the storage node and read the data More... | |
vtkMRMLCopyContentMacro (vtkMRMLStorableNode) | |
void | WriteXML (ostream &of, int indent) override |
Write this node's information to a MRML file in XML format. More... | |
Public Member Functions inherited from vtkMRMLNode | |
vtkMRMLNode * | AddAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr) |
Add and observe a reference node from this node for a specific referenceRole. More... | |
vtkMRMLNode * | AddNodeReferenceID (const char *referenceRole, const char *referencedNodeID) |
Convenience method that adds a referencedNodeID at the end of the list. More... | |
void | AddNodeReferenceRole (const char *referenceRole, const char *mrmlAttributeName=nullptr, vtkIntArray *events=nullptr) |
Add a referenceRole. More... | |
virtual void | AddToSceneOff () |
virtual void | AddToSceneOn () |
virtual void | CopyContent (vtkMRMLNode *node, bool deepCopy=true) |
Copy node contents from another node of the same type. Does not copy node ID, Scene, Name, SingletonTag, HideFromEditors, AddToScene, UndoEnabled, and node references. If deepCopy is set to false then a shallow copy of bulk data (such as image or mesh data) could be made; copying may be faster but the node may share some data with the source node instead of creating an independent copy. More... | |
virtual void | CopyReferences (vtkMRMLNode *node) |
Copy the references of the node into this. More... | |
void | CopyWithScene (vtkMRMLNode *node) |
Copy everything (including Scene and ID) from another node of the same type. More... | |
void | DisableModifiedEventOff () |
void | DisableModifiedEventOn () |
virtual int | EndModify (int previousDisableModifiedEventState) |
End modifying the node. More... | |
virtual int | GetAddToScene () |
node added to MRML scene. More... | |
const char * | GetAttribute (const char *name) |
Get value of a name value pair attribute. More... | |
std::vector< std::string > | GetAttributeNames () |
Get all attribute names. More... | |
void | GetAttributeNames (vtkStringArray *attributeNames) |
Get all attribute names. Python-wrappable version. More... | |
virtual vtkIntArray * | GetContentModifiedEvents () |
virtual char * | GetDescription () |
virtual int | GetDisableModifiedEvent () |
Turn on/off generating InvokeEvent for set macros. More... | |
virtual int | GetHideFromEditors () |
Describes if the node is hidden. More... | |
virtual char * | GetID () |
ID use by other nodes to reference this node in XML. More... | |
virtual int | GetInMRMLCallbackFlag () |
Flags to avoid event loops. More... | |
virtual int | GetModifiedEventPending () |
virtual char * | GetName () |
vtkMRMLNode * | GetNodeReference (const char *referenceRole) |
const char * | GetNodeReferenceID (const char *referenceRole) |
Utility function that returns the first node id for a specific referenceRole. More... | |
void | GetNodeReferenceIDs (const char *referenceRole, std::vector< const char *> &referencedNodeIDs) |
Return a list of the referenced node IDs. More... | |
void | GetNodeReferenceRoles (std::vector< std::string > &roles) |
void | GetNodeReferences (const char *referenceRole, std::vector< vtkMRMLNode *> &nodes) |
Return a list of the referenced nodes. More... | |
vtkMRMLNode * | GetNthNodeReference (const char *referenceRole, int n) |
Get referenced MRML node for a specific referenceRole. More... | |
const char * | GetNthNodeReferenceID (const char *referenceRole, int n) |
Return the string of the Nth node ID for a specific reference role. More... | |
const char * | GetNthNodeReferenceRole (int n) |
int | GetNumberOfNodeReferenceRoles () |
int | GetNumberOfNodeReferences (const char *referenceRole) |
Return the number of node IDs for a specific reference role (and nodes as they always have the same size). More... | |
virtual int | GetSaveWithScene () |
Save node with MRML scene. More... | |
virtual vtkMRMLScene * | GetScene () |
Get the scene this node has been added to. More... | |
virtual int | GetSelectable () |
Describes if the node is selectable. More... | |
virtual int | GetSelected () |
Get/Set for Selected. More... | |
virtual char * | GetSingletonTag () |
virtual bool | GetUndoEnabled () |
virtual bool | HasCopyContent () const |
Returns true if the class supports deep and shallow copying node content. More... | |
bool | HasNodeReferenceID (const char *referenceRole, const char *referencedNodeID) |
Return true if referencedNodeID is in the node ID list for a specific referenceRole. More... | |
virtual void | HideFromEditorsOff () |
virtual void | HideFromEditorsOn () |
virtual void | InvokeCustomModifiedEvent (int eventId, void *callData=nullptr) |
This method allows the node to compress events. More... | |
virtual int | InvokePendingModifiedEvent () |
Invokes any modified events that are pending . More... | |
bool | IsSingleton () |
void | Modified () override |
Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent. More... | |
virtual void | OnNodeAddedToScene () |
void | PrintSelf (ostream &os, vtkIndent indent) override |
virtual void | ProcessChildNode (vtkMRMLNode *) |
Set dependencies between this node and a child node when parsing XML file. More... | |
void | RemoveAttribute (const char *name) |
Remove attribute with the specified name. More... | |
void | RemoveNodeReferenceIDs (const char *referenceRole) |
Remove all node IDs and associated nodes for a specific referenceRole. More... | |
void | RemoveNthNodeReferenceID (const char *referenceRole, int n) |
Convenience method that removes the Nth node ID from the list. More... | |
virtual void | SaveWithSceneOff () |
virtual void | SaveWithSceneOn () |
virtual void | SelectableOff () |
virtual void | SelectableOn () |
virtual void | SelectedOff () |
virtual void | SelectedOn () |
virtual void | SetAddToScene (int) |
void | SetAddToSceneNoModify (int value) |
vtkMRMLNode * | SetAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr) |
Set and observe a reference node from this node for a specific referenceRole. More... | |
vtkMRMLNode * | SetAndObserveNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID, vtkIntArray *events=nullptr) |
Set and observe the Nth node ID for a specific reference role. More... | |
void | SetAttribute (const char *name, const char *value) |
Set a name value pair attribute. More... | |
virtual void | SetDescription (const char *) |
Text description of this node, to be set by the user. More... | |
void | SetDisableModifiedEvent (int onOff) |
virtual void | SetHideFromEditors (int) |
void | SetInMRMLCallbackFlag (int flag) |
virtual void | SetName (const char *) |
Name of this node, to be set by the user. More... | |
vtkMRMLNode * | SetNodeReferenceID (const char *referenceRole, const char *referencedNodeID) |
Set a reference to a node with specified nodeID from this node for a specific referenceRole. More... | |
vtkMRMLNode * | SetNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID) |
Set a N-th reference from this node with specified referencedNodeID for a specific referenceRole. More... | |
virtual void | SetSaveWithScene (int) |
virtual void | SetScene (vtkMRMLScene *scene) |
This method is for internal use only. Use AddNode method of vtkMRMLScene to add a node to the scene. More... | |
virtual void | SetSceneReferences () |
Update the references of the node to the scene. More... | |
virtual void | SetSelectable (int) |
virtual void | SetSelected (int) |
void | SetSingletonOff () |
void | SetSingletonOn () |
virtual void | SetSingletonTag (const char *) |
Tag that make this node a singleton in the scene. More... | |
virtual void | SetUndoEnabled (bool) |
virtual int | StartModify () |
Start modifying the node. Disable Modify events. More... | |
virtual void | UndoEnabledOff () |
virtual void | UndoEnabledOn () |
virtual void | UpdateReferenceID (const char *oldID, const char *newID) |
Update the stored reference to another node in the scene. More... | |
virtual void | UpdateReferences () |
The method should remove all pointers and observations to all nodes that are not in the scene anymore. More... | |
const char * | URLDecodeString (const char *inString) |
Decode a URL string. More... | |
const char * | URLEncodeString (const char *inString) |
Encode a URL string. More... | |
virtual void | WriteNodeBodyXML (ostream &of, int indent) |
Write this node's body to a MRML file in XML format. More... | |
std::string | XMLAttributeDecodeString (const std::string &inString) |
Decode an XML attribute string. More... | |
std::string | XMLAttributeEncodeString (const std::string &inString) |
Encode an XML attribute string (replaces special characters by code sequences) More... | |
Static Public Member Functions | |
static bool | IsColorMapEqual (vtkColorTransferFunction *tf1, vtkColorTransferFunction *tf2) |
static int | IsTypeOf (const char *type) |
static vtkMRMLProceduralColorNode * | New () |
static vtkMRMLProceduralColorNode * | SafeDownCast (vtkObject *o) |
Static Public Member Functions inherited from vtkMRMLColorNode | |
static int | IsTypeOf (const char *type) |
static vtkMRMLColorNode * | New () |
static vtkMRMLColorNode * | SafeDownCast (vtkObject *o) |
Static Public Member Functions inherited from vtkMRMLStorableNode | |
static int | IsTypeOf (const char *type) |
static vtkMRMLStorableNode * | SafeDownCast (vtkObject *o) |
Static Public Member Functions inherited from vtkMRMLNode | |
static int | IsTypeOf (const char *type) |
static vtkMRMLNode * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
void | operator= (const vtkMRMLProceduralColorNode &) |
vtkMRMLProceduralColorNode () | |
vtkMRMLProceduralColorNode (const vtkMRMLProceduralColorNode &) | |
~vtkMRMLProceduralColorNode () override | |
Protected Member Functions inherited from vtkMRMLColorNode | |
virtual bool | HasNameFromColor (int index) |
void | operator= (const vtkMRMLColorNode &) |
vtkMRMLColorNode () | |
vtkMRMLColorNode (const vtkMRMLColorNode &) | |
~vtkMRMLColorNode () override | |
Protected Member Functions inherited from vtkMRMLStorableNode | |
virtual const char * | GetStorageNodeReferenceMRMLAttributeName () |
virtual const char * | GetStorageNodeReferenceRole () |
virtual vtkTimeStamp | GetStoredTime () |
void | operator= (const vtkMRMLStorableNode &) |
vtkMRMLStorableNode () | |
vtkMRMLStorableNode (const vtkMRMLStorableNode &) | |
~vtkMRMLStorableNode () override | |
Protected Member Functions inherited from vtkMRMLNode | |
virtual const char * | GetMRMLAttributeNameFromReferenceRole (const char *refRole) |
Return the mrml attribute name (if found) associated with a reference role. Return 0 otherwise. More... | |
virtual const char * | GetReferenceRoleFromMRMLAttributeName (const char *attName) |
Return the reference role (if found) associated with the attribute name found in a MRML scene file. Return 0 otherwise. More... | |
virtual char * | GetTempURLString () |
void | GetUpdatedReferencedNodeEventList (int &oldReferencedNodeUseCount, int &newReferencedNodeUseCount, vtkIntArray *oldConsolidatedEventList, vtkIntArray *newConsolidatedEventList, vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkMRMLNodeReference *referenceToIgnore, vtkIntArray *newEvents) |
virtual void | InvalidateNodeReferences () |
virtual bool | IsReferenceRoleGeneric (const char *refRole) |
Return true if the reference role is generic (ends with '/') or false otherwise. More... | |
virtual void | OnNodeReferenceAdded (vtkMRMLNodeReference *reference) |
virtual void | OnNodeReferenceModified (vtkMRMLNodeReference *reference) |
Called when a referenced node pointer is modified. More... | |
virtual void | OnNodeReferenceRemoved (vtkMRMLNodeReference *reference) |
Called when a referenced node pointer is removed (set to nullptr). More... | |
void | operator= (const vtkMRMLNode &) |
void | ParseReferencesAttribute (const char *attValue, std::set< std::string > &references) |
virtual void | SetTempURLString (const char *) |
Get/Set the string used to manage encoding/decoding of strings/URLs with special characters. More... | |
vtkMRMLNode * | UpdateNodeReferenceEventObserver (vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkIntArray *newEvents, vtkMRMLNodeReference *referenceToIgnore) |
virtual void | UpdateNodeReferences (const char *referenceRole=nullptr) |
virtual void | UpdateNthNodeReference (const char *referenceRole, int n) |
vtkMRMLNode () | |
vtkMRMLNode (const vtkMRMLNode &) | |
~vtkMRMLNode () override | |
critical to have a virtual destructor! More... | |
Protected Attributes | |
vtkColorTransferFunction * | ColorTransferFunction |
vtkLookupTable * | ConvertedCTFtoLUT |
unsigned int | NumberOfTableValues |
Protected Attributes inherited from vtkMRMLColorNode | |
char * | FileName |
A file name to read text attributes from More... | |
std::vector< std::string > | Names |
A vector of names for the color table elements More... | |
int | NamesInitialised |
Have the colour names been set? Used to do lazy copy of the Names array. More... | |
char * | NoName |
the string used for an unnamed colour More... | |
int | Type |
Protected Attributes inherited from vtkMRMLStorableNode | |
std::string | SlicerDataType |
vtkTimeStamp | StorableModifiedTime |
vtkTagTable * | UserTagTable |
Protected Attributes inherited from vtkMRMLNode | |
int | AddToScene {1} |
AttributesType | Attributes |
vtkIntArray * | ContentModifiedEvents |
char * | Description {nullptr} |
int | HideFromEditors {0} |
char * | ID {nullptr} |
int | InMRMLCallbackFlag {0} |
Flag to avoid event loops More... | |
vtkCallbackCommand * | MRMLCallbackCommand |
Holders for MRML callbacks. More... | |
vtkObserverManager * | MRMLObserverManager |
char * | Name {nullptr} |
NodeReferenceEventsType | NodeReferenceEvents |
std::map< std::string, std::string > | NodeReferenceMRMLAttributeNames |
NodeReferencesType | NodeReferences |
int | SaveWithScene {true} |
vtkWeakPointer< vtkMRMLScene > | Scene |
int | Selectable {1} |
int | Selected {0} |
bool | UndoEnabled {false} |
Additional Inherited Members | |
Protected Types inherited from vtkMRMLNode | |
typedef std::map< std::string, std::string > | AttributesType |
typedef std::map< std::string, vtkSmartPointer< vtkIntArray > > | NodeReferenceEventsType |
typedef std::vector< vtkSmartPointer< vtkMRMLNodeReference > > | NodeReferenceListType |
typedef std::map< std::string, NodeReferenceListType > | NodeReferencesType |
Static Protected Member Functions inherited from vtkMRMLNode | |
static void | MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData) |
Static Protected Attributes inherited from vtkMRMLStorableNode | |
static const char * | StorageNodeReferenceMRMLAttributeName |
static const char * | StorageNodeReferenceRole |
MRML node to represent procedurally defined color information.
Procedural nodes define methods that are used to map colours to scalar values. Usually they will incorporate a custom subclass of a vtkLookupTable, or a vtkColorTransferFunction.
Definition at line 27 of file vtkMRMLProceduralColorNode.h.
Definition at line 31 of file vtkMRMLProceduralColorNode.h.
anonymous enum |
The list of valid procedural types.
DisplayModifiedEvent is generated when display node parameters is changed
Enumerator | |
---|---|
DisplayModifiedEvent |
Definition at line 73 of file vtkMRMLProceduralColorNode.h.
|
protected |
|
overrideprotected |
|
protected |
|
overridevirtual |
Copy the node's attributes to this object
Reimplemented from vtkMRMLColorNode.
|
overridevirtual |
Create default storage node or nullptr if does not have one.
Reimplemented from vtkMRMLStorableNode.
|
overridevirtual |
MRMLNode methods.
Reimplemented from vtkMRMLColorNode.
|
virtual |
Reimplemented from vtkMRMLColorNode.
Reimplemented in vtkMRMLdGEMRICProceduralColorNode, and vtkMRMLPETProceduralColorNode.
|
overridevirtual |
Retrieve color transfer function entry value.
Reimplemented from vtkMRMLColorNode.
|
virtual |
Get the color transfer function for this node
|
overridevirtual |
Reimplemented vtkMRMLColorNode::GetLookupTable() to convert the continuous color transfer function to a look up table with a number of entries defined by NumberOfTableValues
Reimplemented from vtkMRMLColorNode.
|
inlineoverridevirtual |
Get node XML tag name (like Volume, Model)
Reimplemented from vtkMRMLColorNode.
Definition at line 54 of file vtkMRMLProceduralColorNode.h.
|
overridevirtual |
Returns how many nodes define the color transfer function
Reimplemented from vtkMRMLColorNode.
|
virtual |
Get number of entries used when discretizing the color transfer function into a lookup table
|
overridevirtual |
Reimplemented vtkMRMLColorNode::GetScalarsToColors() to return the transfer function instead of the empty lookuptable
Reimplemented from vtkMRMLColorNode.
|
overridevirtual |
return a text string describing the colour look up table type
Reimplemented from vtkMRMLColorNode.
|
virtual |
Reimplemented from vtkMRMLColorNode.
Reimplemented in vtkMRMLdGEMRICProceduralColorNode, and vtkMRMLPETProceduralColorNode.
|
static |
Compare two color transfer functions Only compares the color map (x->RGB mapping)
|
static |
|
static |
|
protected |
|
override |
|
overridevirtual |
Propagate events generated in mrml.
Reimplemented from vtkMRMLColorNode.
|
overridevirtual |
Set node attributes
Reimplemented from vtkMRMLColorNode.
|
static |
|
virtual |
Set the color transfer function
|
overridevirtual |
set up some names, going from the points defined in the transfer function
Reimplemented from vtkMRMLColorNode.
|
virtual |
Set number of entries used when discretizing the color transfer function into a lookup table
|
overridevirtual |
Updates other nodes in the scene depending on this node or updates this node if it depends on other nodes when the scene is read in This method is called automatically by XML parser after all nodes are created
Reimplemented from vtkMRMLColorNode.
|
overridevirtual |
Write this node's information to a MRML file in XML format.
Reimplemented from vtkMRMLColorNode.
|
protected |
a color transfer function built up by calls to AddRGBPoint and Build
Definition at line 134 of file vtkMRMLProceduralColorNode.h.
|
protected |
A lookup table created by discretizing the continuous color transfer function
Definition at line 139 of file vtkMRMLProceduralColorNode.h.
|
protected |
Number of entries to use when discretizing the color transfer function into a lookup table
Definition at line 145 of file vtkMRMLProceduralColorNode.h.