![]() |
Slicer 5.9
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
|
A superclass for other storage nodes. More...
#include <Libs/MRML/Core/vtkMRMLStorageNode.h>
Classes | |
struct | CompressionPreset |
Public Types | |
enum | { Idle , Pending , Scheduled , Transferring , TransferDone , Cancelled , SkippedNoData } |
enum | { CoordinateSystemRAS = 0 , RAS = 0 , CoordinateSystemLPS = 1 , LPS = 1 , CoordinateSystemType_Last } |
typedef vtkMRMLNode | Superclass |
![]() | |
enum | { HierarchyModifiedEvent = 16000 , IDChangedEvent = 16001 , ReferenceAddedEvent , ReferenceModifiedEvent , ReferenceRemovedEvent , ReferencedNodeModifiedEvent } |
enum | ContentModifiedObserveType { ContentModifiedObserveUndefined = -1 , ContentModifiedObserveDisabled = 0 , ContentModifiedObserveEnabled = 1 } |
typedef std::map< std::string, std::string > | ReferencePropertiesType |
Get the node reference properties for a specific referenceRole. | |
typedef vtkObject | Superclass |
Public Member Functions | |
unsigned int | AddFileName (const char *fileName) |
Add in another file name to the list of file names. | |
unsigned int | AddURI (const char *uri) |
Add in another URI to the list of URI's. | |
virtual bool | CanReadInReferenceNode (vtkMRMLNode *refNode)=0 |
virtual bool | CanWriteFromReferenceNode (vtkMRMLNode *refNode) |
virtual void | ConfigureForDataExchange () |
void | Copy (vtkMRMLNode *node) override |
Copy the node's attributes to this object. | |
vtkMRMLNode * | CreateNodeInstance () override=0 |
Create instance of the default node. Like New only virtual. | |
int | FileNameIsInList (const char *fileName) |
const char * | GetAbsoluteFilePath (const char *inputPath) |
virtual const char * | GetClassName () |
virtual std::string | GetCompressionParameter () |
virtual std::string | GetCompressionParameterFromDisplayName (const std::string &name) |
Returns a string representing the specified preset. | |
virtual std::vector< std::string > | GetCompressionPresetDisplayNames () |
Returns a list of displayable names of the supported compression presets. | |
virtual const std::vector< CompressionPreset > | GetCompressionPresets () |
Get a list of all supported compression presets. | |
virtual const char * | GetDefaultWriteFileExtension () |
virtual std::string | GetDisplayNameFromCompressionParameter (const std::string &preset) |
Returns the name of the specified preset. | |
virtual void | GetFileExtensionsFromFileTypes (vtkStringArray *inputFileTypes, vtkStringArray *outputFileExtensions) |
virtual char * | GetFileName () |
std::string | GetFileNameWithoutExtension (const char *fileName=nullptr) |
std::string | GetFullNameFromFileName () |
std::string | GetFullNameFromNthFileName (int n) |
const char * | GetNodeTagName () override=0 |
Get node XML tag name (like Storage, Model) | |
const char * | GetNthFileName (int n) const |
return the nth file name, null if doesn't exist | |
const char * | GetNthURI (int n) |
Get the nth URI from the list of URI's. | |
virtual int | GetNumberOfCompressionPresets () |
Get the number of compression presets. | |
int | GetNumberOfFileNames () const |
See how many file names were generated during ExecuteInformation. | |
int | GetNumberOfURIs () |
Return how many URI names this storage node holds in it's list. | |
virtual int | GetReadState () |
Get/Set the state of reading. | |
const char * | GetReadStateAsString () |
const char * | GetStateAsString (int state) |
virtual vtkMRMLStorableNode * | GetStorableNode () |
vtkTimeStamp | GetStoredTime () |
virtual std::string | GetSupportedFileExtension (const char *fileName=nullptr, bool includeReadable=true, bool includeWriteable=true) |
virtual vtkStringArray * | GetSupportedReadFileTypes () |
virtual vtkStringArray * | GetSupportedWriteFileTypes () |
virtual char * | GetTempFileName () |
virtual char * | GetURI () |
virtual vtkURIHandler * | GetURIHandler () |
virtual int | GetUseCompression () |
vtkMRMLMessageCollection * | GetUserMessages () |
const vtkMRMLMessageCollection * | GetUserMessages () const |
virtual char * | GetWriteFileFormat () |
virtual int | GetWriteState () |
const char * | GetWriteStateAsString () |
void | InvalidateFile () |
virtual int | IsA (const char *type) |
int | IsFilePathRelative (const char *filepath) |
void | PrintSelf (ostream &os, vtkIndent indent) override |
void | ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData) override |
Propagate Progress Event generated in ReadData. | |
virtual int | ReadData (vtkMRMLNode *refNode, bool temporaryFile=false) |
void | ReadXMLAttributes (const char **atts) override |
Read node attributes from XML file. | |
void | ResetFileNameList () |
Clear the array of file names. | |
void | ResetNthFileName (int n, const char *fileName) |
Set the nth file in FileNameList, checks that it is already defined. | |
void | ResetNthURI (int n, const char *uri) |
Set the nth URI in URIList, checks that it is already defined. | |
void | ResetURIList () |
Clear the array of URIs. | |
virtual void | SetCompressionParameter (std::string) |
Compression parameter that is used to save the node. | |
void | SetDataDirectory (const char *dataDirName) |
Set a new data directory for all files. | |
virtual void | SetDefaultWriteFileExtension (const char *ext) |
virtual void | SetFileName (const char *) |
virtual void | SetReadState (int) |
void | SetReadStateCancelled () |
void | SetReadStateIdle () |
void | SetReadStatePending () |
void | SetReadStateScheduled () |
void | SetReadStateSkippedNoData () |
void | SetReadStateTransferDone () |
void | SetReadStateTransferring () |
virtual void | SetTempFileName (const char *) |
A temporary file name used to calculate absolute paths. | |
virtual void | SetURI (const char *) |
Location of the remote copy of this file. | |
virtual void | SetURIHandler (vtkURIHandler *uriHandler) |
void | SetURIPrefix (const char *uriPrefix) |
Set a new URI base for all URI's. | |
virtual void | SetUseCompression (int) |
virtual void | SetWriteFileFormat (const char *writeFileFormat) |
void | SetWriteState (int writeState) |
void | SetWriteStateCancelled () |
void | SetWriteStateIdle () |
void | SetWriteStatePending () |
void | SetWriteStateScheduled () |
void | SetWriteStateSkippedNoData () |
void | SetWriteStateTransferDone () |
void | SetWriteStateTransferring () |
virtual int | SupportedFileType (const char *fileName) |
virtual void | UseCompressionOff () |
virtual void | UseCompressionOn () |
Use compression on write. | |
virtual int | WriteData (vtkMRMLNode *refNode) |
void | WriteXML (ostream &of, int indent) override |
Write this node's information to a MRML file in XML format. | |
![]() | |
vtkMRMLNode * | AddAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr, ContentModifiedObserveType observeContentModifiedEvents=ContentModifiedObserveUndefined) |
Add and observe a reference node from this node for a specific referenceRole. | |
vtkMRMLNode * | AddNodeReferenceID (const char *referenceRole, const char *referencedNodeID) |
Convenience method that adds a referencedNodeID at the end of the list. | |
void | AddNodeReferenceRole (const char *referenceRole, const char *mrmlAttributeName=nullptr, vtkIntArray *events=nullptr, bool observeContentModifiedEvents=false) |
Add a referenceRole. | |
virtual void | AddToSceneOff () |
virtual void | AddToSceneOn () |
void | ClearNodeReferenceProperties (const std::string &referenceRole) |
Remove all node reference properties for a specific referenceRole. | |
void | ClearNthNodeReferenceProperties (const std::string &referenceRole, int n) |
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. | |
virtual void | CopyReferences (vtkMRMLNode *node) |
Copy the references of the node into this. | |
void | CopyWithScene (vtkMRMLNode *node) |
Copy everything (including Scene and ID) from another node of the same type. | |
void | DisableModifiedEventOff () |
void | DisableModifiedEventOn () |
virtual int | EndModify (int previousDisableModifiedEventState) |
End modifying the node. | |
virtual int | GetAddToScene () |
node added to MRML scene. | |
const char * | GetAttribute (const char *name) |
Get value of a name value pair attribute. | |
std::vector< std::string > | GetAttributeNames () |
Get all attribute names. | |
void | GetAttributeNames (vtkStringArray *attributeNames) |
Get all attribute names. Python-wrappable version. | |
virtual vtkIntArray * | GetContentModifiedEvents () |
int | GetCustomModifiedEventPending (int eventId) |
virtual char * | GetDescription () |
virtual int | GetDisableModifiedEvent () |
Turn on/off generating InvokeEvent for set macros. | |
virtual int | GetHideFromEditors () |
Describes if the node is hidden. | |
virtual char * | GetID () |
ID use by other nodes to reference this node in XML. | |
virtual int | GetInMRMLCallbackFlag () |
Flags to avoid event loops. | |
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. | |
void | GetNodeReferenceIDs (const char *referenceRole, std::vector< const char * > &referencedNodeIDs) |
Return a list of the referenced node IDs. | |
const ReferencePropertiesType * | GetNodeReferenceProperties (const char *referenceRole) |
std::string | GetNodeReferenceProperty (const std::string &referenceRole, const std::string &propertyName) |
Get the node reference property for a specific referenceRole. | |
std::string | GetNodeReferencePropertyName (const std::string &referenceRole, int propertyIndex) |
Get the name of the Nth node reference property for a specific referenceRole. | |
std::vector< std::string > | GetNodeReferencePropertyNames (const std::string &referenceRole) |
Get the names of all node reference properties for a specific referenceRole. | |
void | GetNodeReferenceRoles (std::vector< std::string > &roles) |
void | GetNodeReferences (const char *referenceRole, std::vector< vtkMRMLNode * > &nodes) |
Return a list of the referenced nodes. | |
vtkMRMLNode * | GetNthNodeReference (const char *referenceRole, int n) |
Get referenced MRML node for a specific referenceRole. | |
const char * | GetNthNodeReferenceID (const char *referenceRole, int n) |
Return the string of the Nth node ID for a specific reference role. | |
const ReferencePropertiesType * | GetNthNodeReferenceProperties (const char *referenceRole, int n) |
std::string | GetNthNodeReferenceProperty (const std::string &referenceRole, int n, const std::string &propertyName) |
std::string | GetNthNodeReferencePropertyName (const std::string &referenceRole, int referenceIndex, int propertyIndex) |
std::vector< std::string > | GetNthNodeReferencePropertyNames (const std::string &referenceRole, int n) |
const char * | GetNthNodeReferenceRole (int n) |
int | GetNumberOfNodeReferenceProperties (const std::string &referenceRole) |
Get the number of node reference properties for a specific referenceRole. | |
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). | |
int | GetNumberOfNthNodeReferenceProperties (const std::string &referenceRole, int n) |
virtual int | GetSaveWithScene () |
Save node with MRML scene. | |
virtual vtkMRMLScene * | GetScene () |
Get the scene this node has been added to. | |
virtual int | GetSelectable () |
Describes if the node is selectable. | |
virtual int | GetSelected () |
Get/Set for Selected. | |
virtual char * | GetSingletonTag () |
virtual const char * | GetTypeDisplayName () |
virtual bool | GetUndoEnabled () |
virtual bool | HasCopyContent () const |
Returns true if the class supports deep and shallow copying node content. | |
bool | HasNodeReferenceID (const char *referenceRole, const char *referencedNodeID) |
Return true if referencedNodeID is in the node ID list for a specific referenceRole. | |
virtual void | HideFromEditorsOff () |
virtual void | HideFromEditorsOn () |
virtual void | InvokeCustomModifiedEvent (int eventId, void *callData=nullptr) |
This method allows the node to compress events. | |
virtual int | InvokePendingModifiedEvent () |
Invokes any modified events that are pending . | |
bool | IsSingleton () |
void | Modified () override |
Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent. | |
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. | |
void | RemoveAttribute (const char *name) |
Remove attribute with the specified name. | |
void | RemoveNodeReferenceIDs (const char *referenceRole) |
Remove all node IDs and associated nodes for a specific referenceRole. | |
void | RemoveNodeReferenceProperty (const std::string &referenceRole, const std::string &propertyName) |
Remove a node reference property for a specific referenceRole. | |
void | RemoveNthNodeReferenceID (const char *referenceRole, int n) |
Convenience method that removes the Nth node ID from the list. | |
void | RemoveNthNodeReferenceProperty (const std::string &referenceRole, int n, const std::string &propertyName) |
virtual void | Reset (vtkMRMLNode *defaultNode) |
Reset node attributes to the initial state as defined in the constructor or the passed default node. | |
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, ContentModifiedObserveType observeContentModifiedEvents=ContentModifiedObserveUndefined) |
Set and observe a reference node from this node for a specific referenceRole. | |
vtkMRMLNode * | SetAndObserveNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID, vtkIntArray *events=nullptr, ContentModifiedObserveType observeContentModifiedEvents=ContentModifiedObserveUndefined) |
Set and observe the Nth node ID for a specific reference role. | |
void | SetAttribute (const char *name, const char *value) |
Set a name value pair attribute. | |
virtual void | SetDescription (const char *) |
Text description of this node, to be set by the user. | |
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. | |
vtkMRMLNode * | SetNodeReferenceID (const char *referenceRole, const char *referencedNodeID) |
Set a reference to a node with specified nodeID from this node for a specific referenceRole. | |
void | SetNodeReferenceProperty (const std::string &referenceRole, const std::string &propertyName, const std::string &value) |
Set the node reference property for a specific referenceRole. | |
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. | |
void | SetNthNodeReferenceProperty (const std::string &referenceRole, int n, const std::string &propertyName, const std::string &value) |
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. | |
virtual void | SetSceneReferences () |
Update the references of the node to the scene. | |
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. | |
virtual void | SetUndoEnabled (bool) |
virtual int | StartModify () |
Start modifying the node. Disable Modify events. | |
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. | |
virtual void | UpdateReferences () |
The method should remove all pointers and observations to all nodes that are not in the scene anymore. | |
virtual void | UpdateScene (vtkMRMLScene *) |
const char * | URLDecodeString (const char *inString) |
Decode a URL string. | |
const char * | URLEncodeString (const char *inString) |
Encode a URL string. | |
virtual void | WriteNodeBodyXML (ostream &of, int indent) |
Write this node's body to a MRML file in XML format. | |
std::string | XMLAttributeDecodeString (const std::string &inString) |
Decode an XML attribute string. | |
std::string | XMLAttributeEncodeString (const std::string &inString) |
Encode an XML attribute string (replaces special characters by code sequences) | |
Static Public Member Functions | |
static std::string | ClampFileName (const std::string &filename, int extensionLength, int maxFileNameLength, int hashLength=4) |
static const char * | GetCoordinateSystemTypeAsString (int id) |
Convert between coordinate system ID and name. | |
static int | GetCoordinateSystemTypeFromString (const char *name) |
static std::string | GetLowercaseExtensionFromFileName (const std::string &filename) |
static int | IsTypeOf (const char *type) |
static vtkMRMLStorageNode * | SafeDownCast (vtkObject *o) |
![]() | |
static int | IsTypeOf (const char *type) |
static vtkMRMLNode * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
virtual void | InitializeSupportedReadFileTypes () |
virtual void | InitializeSupportedWriteFileTypes () |
void | operator= (const vtkMRMLStorageNode &) |
virtual int | ReadDataInternal (vtkMRMLNode *refNode) |
void | StageReadData (vtkMRMLNode *refNode) |
void | StageWriteData (vtkMRMLNode *refNode) |
virtual void | UpdateCompressionPresets () |
vtkMRMLStorageNode () | |
vtkMRMLStorageNode (const vtkMRMLStorageNode &) | |
virtual int | WriteDataInternal (vtkMRMLNode *refNode) |
~vtkMRMLStorageNode () override | |
![]() | |
virtual const char * | GetMRMLAttributeNameFromReferenceRole (const char *refRole) |
Return the mrml attribute name (if found) associated with a reference role. Return 0 otherwise. | |
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. | |
virtual char * | GetTempURLString () |
void | GetUpdatedReferencedNodeEventList (int &oldReferencedNodeUseCount, int &newReferencedNodeUseCount, vtkIntArray *oldConsolidatedEventList, vtkIntArray *newConsolidatedEventList, vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkMRMLNodeReference *referenceToIgnore, vtkIntArray *newEvents, bool newObserveContentModifiedEvents) |
virtual void | InvalidateNodeReferences () |
virtual bool | IsReferenceRoleGeneric (const char *refRole) |
Return true if the reference role is generic (ends with '/') or false otherwise. | |
std::string | NodeReferencePropertyDecodeString (const std::string &inString) |
Decode a node reference property string. | |
std::string | NodeReferencePropertyEncodeString (const std::string &inString) |
Encode a node reference property string (replaces special characters by code sequences) | |
virtual void | OnNodeReferenceAdded (vtkMRMLNodeReference *reference) |
virtual void | OnNodeReferenceModified (vtkMRMLNodeReference *reference) |
Called when a referenced node pointer is modified. | |
virtual void | OnNodeReferenceRemoved (vtkMRMLNodeReference *reference) |
Called when a referenced node pointer is removed (set to nullptr). | |
void | operator= (const vtkMRMLNode &) |
void | ParseReferencesAttribute (const char *attValue, std::set< std::string > &references) |
void | RemoveInvalidReferences (const std::set< std::string > &validNodeIDs) |
virtual void | SetTempURLString (const char *) |
Get/Set the string used to manage encoding/decoding of strings/URLs with special characters. | |
vtkMRMLNode * | UpdateNodeReferenceEventObserver (vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkIntArray *newEvents, bool newObserveContentModifiedEvents, 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! | |
Protected Attributes | |
std::string | CompressionParameter |
std::vector< CompressionPreset > | CompressionPresets |
std::string | DefaultWriteFileExtension |
List of supported extensions to write in. | |
char * | FileName |
std::vector< std::string > | FileNameList |
An array of file names, should contain the FileName but may not. | |
vtkWeakPointer< vtkMRMLStorableNode > | LastFoundStorableNode |
int | ReadState |
vtkTimeStamp * | StoredTime |
vtkStringArray * | SupportedReadFileTypes |
List of supported extensions to read in. | |
vtkStringArray * | SupportedWriteFileTypes |
char * | TempFileName |
char * | URI |
vtkURIHandler * | URIHandler |
std::vector< std::string > | URIList |
An array of URI's, should contain the URI but may not. | |
int | UseCompression |
vtkMRMLMessageCollection * | UserMessages |
char * | WriteFileFormat |
int | WriteState |
![]() | |
int | AddToScene {1} |
AttributesType | Attributes |
vtkIntArray * | ContentModifiedEvents |
char * | Description {nullptr} |
int | HideFromEditors {0} |
char * | ID {nullptr} |
int | InMRMLCallbackFlag {0} |
Flag to avoid event loops. | |
vtkCallbackCommand * | MRMLCallbackCommand |
Holders for MRML callbacks. | |
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 | |
![]() | |
typedef std::map< std::string, std::string > | AttributesType |
typedef std::map< std::string, NodeReferenceEventList > | NodeReferenceEventsType |
typedef std::vector< vtkSmartPointer< vtkMRMLNodeReference > > | NodeReferenceListType |
typedef std::map< std::string, NodeReferenceListType > | NodeReferencesType |
![]() | |
static void | MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData) |
A superclass for other storage nodes.
A superclass for other storage nodes like volume and model.
Definition at line 35 of file vtkMRMLStorageNode.h.
Definition at line 38 of file vtkMRMLStorageNode.h.
anonymous enum |
Possible Read and Write states Idle: not currently working on any data, ready for the next transfer Pending: the data is remote, waiting for a transfer to be scheduled Scheduled: the data is remote, and is scheduled for download Transferring: data is remote, and the transfer is working to completion TransferDone: the data is on disk and ready to be read Cancelled: the user cancelled the remote data transfer SkippedNoData: writing or reading was skipped due to data not present. This is a valid state used if and only if the data node is empty and there is nothing to be written or read.
Enumerator | |
---|---|
Idle | |
Pending | |
Scheduled | |
Transferring | |
TransferDone | |
Cancelled | |
SkippedNoData |
Definition at line 126 of file vtkMRMLStorageNode.h.
anonymous enum |
Coordinate system options LPS coordinate system is used the most commonly in medical image computing. Slicer is moving towards using this coordinate system in all files by default (while keep using RAS coordinate system internally). RAS coordinate system is used in Slicer internally. For many years, Slicer used this coordinate system in files that it created, too.
Enumerator | |
---|---|
CoordinateSystemRAS | |
RAS | for backward compatibility |
CoordinateSystemLPS | |
LPS | for backward compatibility |
CoordinateSystemType_Last |
Definition at line 368 of file vtkMRMLStorageNode.h.
|
protected |
|
overrideprotected |
|
protected |
unsigned int vtkMRMLStorageNode::AddFileName | ( | const char * | fileName | ) |
Add in another file name to the list of file names.
unsigned int vtkMRMLStorageNode::AddURI | ( | const char * | uri | ) |
Add in another URI to the list of URI's.
|
pure virtual |
Return true if the node can be read in. Used by ReadData to know if the file can be read into the reference node. Subclasses must reimplement the method. Typically it's a check on the node type (e.g. the model storage node can only read in model nodes)
Implemented in vtkMRMLAnnotationControlPointsStorageNode, vtkMRMLAnnotationFiducialsStorageNode, vtkMRMLAnnotationLinesStorageNode, vtkMRMLAnnotationRulerStorageNode, vtkMRMLAnnotationSnapshotStorageNode, vtkMRMLAnnotationStorageNode, vtkMRMLColorTableStorageNode, vtkMRMLHierarchyStorageNode, vtkMRMLLinearTransformSequenceStorageNode, vtkMRMLMarkupsFiducialStorageNode, vtkMRMLMarkupsJsonStorageNode, vtkMRMLMarkupsPlaneJsonStorageNode, vtkMRMLMarkupsROIJsonStorageNode, vtkMRMLMarkupsStorageNode, vtkMRMLModelStorageNode, vtkMRMLNRRDStorageNode, vtkMRMLProceduralColorStorageNode, vtkMRMLSceneViewStorageNode, vtkMRMLSegmentationStorageNode, vtkMRMLSequenceStorageNode, vtkMRMLShaderPropertyStorageNode, vtkMRMLTableSQLiteStorageNode, vtkMRMLTableStorageNode, vtkMRMLTextStorageNode, vtkMRMLTransformStorageNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLVolumePropertyStorageNode, and vtkMRMLVolumeSequenceStorageNode.
|
virtual |
Return true if the node can be written from. Used by WriteData to know if the file can be written from the reference node. By default it returns the same than CanReadInReferenceNode. Subclasses can reimplement the method.
Reimplemented in vtkMRMLLinearTransformSequenceStorageNode, vtkMRMLTextStorageNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLVolumeHeaderlessStorageNode, and vtkMRMLVolumeSequenceStorageNode.
|
static |
Ensures that the file name (excluding the extension) is shorter than the maximum allowed length. If the filename is shorter than the maximum allowed length then it is returned unchanged. If the filename is longer than the maximum allowed length then the filename is shortened by using the following format: [first maxFileNameLength-hashLength-1 characters of the base name]_[hashLength long hash code].[extension] The full base name of the file will be exactly maxFileNameLength characters long. maxFileNameLength must be 8 or higher. If extensionLength is not known then GetSupportedFileExtension() method can be used to get it from the filename.
|
inlinevirtual |
Configure the storage node for data exchange. This is an opportunity to optimize the storage node's settings, for instance to turn off compression.
Reimplemented in vtkMRMLNRRDStorageNode, and vtkMRMLVolumeArchetypeStorageNode.
Definition at line 317 of file vtkMRMLStorageNode.h.
|
overridevirtual |
Copy the node's attributes to this object.
Reimplemented from vtkMRMLNode.
Reimplemented in vtkMRMLTransformStorageNode, vtkMRMLVolumeArchetypeStorageNode, and vtkMRMLVolumeHeaderlessStorageNode.
|
overridepure virtual |
Create instance of the default node. Like New only virtual.
Implements vtkMRMLNode.
Implemented in vtkMRMLAnnotationControlPointsStorageNode, vtkMRMLAnnotationFiducialsStorageNode, vtkMRMLAnnotationLinesStorageNode, vtkMRMLAnnotationRulerStorageNode, vtkMRMLAnnotationSnapshotStorageNode, vtkMRMLAnnotationStorageNode, vtkMRMLColorTableStorageNode, vtkMRMLHierarchyStorageNode, vtkMRMLLinearTransformSequenceStorageNode, vtkMRMLMarkupsFiducialStorageNode, vtkMRMLMarkupsJsonStorageNode, vtkMRMLMarkupsPlaneJsonStorageNode, vtkMRMLMarkupsROIJsonStorageNode, vtkMRMLModelStorageNode, vtkMRMLNRRDStorageNode, vtkMRMLProceduralColorStorageNode, vtkMRMLSceneViewStorageNode, vtkMRMLSegmentationStorageNode, vtkMRMLSequenceStorageNode, vtkMRMLShaderPropertyStorageNode, vtkMRMLTableSQLiteStorageNode, vtkMRMLTableStorageNode, vtkMRMLTextStorageNode, vtkMRMLTransformStorageNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLVolumePropertyStorageNode, and vtkMRMLVolumeSequenceStorageNode.
int vtkMRMLStorageNode::FileNameIsInList | ( | const char * | fileName | ) |
is filename in the filename list already? returns 1 if yes, 0 if no
const char * vtkMRMLStorageNode::GetAbsoluteFilePath | ( | const char * | inputPath | ) |
Calculates and the absolute path to the input file if the input path is relative and the scene is defined with a root directory. Sets and then return TempFileName. Returns null if the input path is null or the path is relative and the scene is not defined. Returns inputPath if it's absolute.
|
virtual |
Reimplemented from vtkMRMLNode.
Reimplemented in vtkMRMLAnnotationControlPointsStorageNode, vtkMRMLAnnotationFiducialsStorageNode, vtkMRMLAnnotationLinesStorageNode, vtkMRMLAnnotationRulerStorageNode, vtkMRMLAnnotationSnapshotStorageNode, vtkMRMLAnnotationStorageNode, vtkMRMLColorTableStorageNode, vtkMRMLHierarchyStorageNode, vtkMRMLLinearTransformSequenceStorageNode, vtkMRMLMarkupsFiducialStorageNode, vtkMRMLMarkupsJsonStorageNode, vtkMRMLMarkupsPlaneJsonStorageNode, vtkMRMLMarkupsROIJsonStorageNode, vtkMRMLMarkupsStorageNode, vtkMRMLModelStorageNode, vtkMRMLNRRDStorageNode, vtkMRMLProceduralColorStorageNode, vtkMRMLSceneViewStorageNode, vtkMRMLSegmentationStorageNode, vtkMRMLSequenceStorageNode, vtkMRMLShaderPropertyStorageNode, vtkMRMLTableSQLiteStorageNode, vtkMRMLTableStorageNode, vtkMRMLTextStorageNode, vtkMRMLTransformStorageNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLVolumePropertyStorageNode, and vtkMRMLVolumeSequenceStorageNode.
|
virtual |
|
virtual |
Returns a string representing the specified preset.
|
virtual |
Returns a list of displayable names of the supported compression presets.
|
virtual |
Get a list of all supported compression presets.
|
static |
Convert between coordinate system ID and name.
|
static |
|
virtual |
Return default file extension for writing. Does not include the leading dot (e.g., it returns "txt" and not ".txt").
Reimplemented in vtkMRMLLinearTransformSequenceStorageNode, vtkMRMLSegmentationStorageNode, vtkMRMLSequenceStorageNode, vtkMRMLTextStorageNode, and vtkMRMLVolumeSequenceStorageNode.
|
virtual |
Returns the name of the specified preset.
|
virtual |
Get all file extensions from file types list returned by GetSupportedReadFileTypes() or GetSupportedWriteFileTypes(). Always includes a dot. If extension is not specified for a type or .* is specified then .* will be returned.
|
virtual |
std::string vtkMRMLStorageNode::GetFileNameWithoutExtension | ( | const char * | fileName = nullptr | ) |
Remove supported extension from filename. If filename is not specified then the current FileName will be used.
std::string vtkMRMLStorageNode::GetFullNameFromFileName | ( | ) |
Get the file's absolute path from the file name and the mrml scene root dir. GetFullNameFromFileName calls GetFullNameFromNthFileName with -1.
std::string vtkMRMLStorageNode::GetFullNameFromNthFileName | ( | int | n | ) |
|
static |
Helper function for getting extension from a full filename. It always returns lowercase extension.
|
overridepure virtual |
Get node XML tag name (like Storage, Model)
Implements vtkMRMLNode.
Implemented in vtkMRMLAnnotationControlPointsStorageNode, vtkMRMLAnnotationFiducialsStorageNode, vtkMRMLAnnotationLinesStorageNode, vtkMRMLAnnotationRulerStorageNode, vtkMRMLAnnotationSnapshotStorageNode, vtkMRMLAnnotationStorageNode, vtkMRMLColorTableStorageNode, vtkMRMLHierarchyStorageNode, vtkMRMLLinearTransformSequenceStorageNode, vtkMRMLMarkupsFiducialStorageNode, vtkMRMLMarkupsJsonStorageNode, vtkMRMLMarkupsPlaneJsonStorageNode, vtkMRMLMarkupsROIJsonStorageNode, vtkMRMLModelStorageNode, vtkMRMLNRRDStorageNode, vtkMRMLProceduralColorStorageNode, vtkMRMLSceneViewStorageNode, vtkMRMLSegmentationStorageNode, vtkMRMLSequenceStorageNode, vtkMRMLShaderPropertyStorageNode, vtkMRMLTableSQLiteStorageNode, vtkMRMLTableStorageNode, vtkMRMLTextStorageNode, vtkMRMLTransformStorageNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLVolumePropertyStorageNode, and vtkMRMLVolumeSequenceStorageNode.
const char * vtkMRMLStorageNode::GetNthFileName | ( | int | n | ) | const |
return the nth file name, null if doesn't exist
const char * vtkMRMLStorageNode::GetNthURI | ( | int | n | ) |
Get the nth URI from the list of URI's.
|
virtual |
Get the number of compression presets.
|
inline |
See how many file names were generated during ExecuteInformation.
Definition at line 219 of file vtkMRMLStorageNode.h.
|
inline |
Return how many URI names this storage node holds in it's list.
Definition at line 243 of file vtkMRMLStorageNode.h.
|
virtual |
Get/Set the state of reading.
|
inline |
Definition at line 149 of file vtkMRMLStorageNode.h.
const char * vtkMRMLStorageNode::GetStateAsString | ( | int | state | ) |
|
virtual |
Returns the first storable node that is associated to this storage node
vtkTimeStamp vtkMRMLStorageNode::GetStoredTime | ( | ) |
Return the last time stamp when a reference node has been read in or written from.
|
virtual |
Return complete file extension for the specified filename. Longest matched extension will be returned (.seg.nrrd will be returned if both .nrrd and .seg.nrrd are matched), including dot. If filename is not specified then the current FileName will be used. If there is no match then empty is returned.
|
virtual |
Get all the supported read file types Subclasses should overwrite InitializeSupportedReadFileTypes().
|
virtual |
Get all the supported write file types Subclasses should overwrite InitializeSupportedWriteFileTypes().
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
inline |
Definition at line 383 of file vtkMRMLStorageNode.h.
|
inline |
Definition at line 382 of file vtkMRMLStorageNode.h.
|
virtual |
|
virtual |
Get/Set the state of writing. This is a transient property (that is expected to change and is not considered as a node change that needs to be stored persistently).
|
inline |
Definition at line 164 of file vtkMRMLStorageNode.h.
|
protectedvirtual |
Initialize all the supported read file types Subclasses can derive this method to initialize SupportedReadFileTypes
Reimplemented in vtkMRMLAnnotationSnapshotStorageNode, vtkMRMLAnnotationStorageNode, vtkMRMLColorTableStorageNode, vtkMRMLHierarchyStorageNode, vtkMRMLLinearTransformSequenceStorageNode, vtkMRMLMarkupsFiducialStorageNode, vtkMRMLMarkupsJsonStorageNode, vtkMRMLModelStorageNode, vtkMRMLNRRDStorageNode, vtkMRMLProceduralColorStorageNode, vtkMRMLSceneViewStorageNode, vtkMRMLSegmentationStorageNode, vtkMRMLSequenceStorageNode, vtkMRMLShaderPropertyStorageNode, vtkMRMLTableSQLiteStorageNode, vtkMRMLTableStorageNode, vtkMRMLTextStorageNode, vtkMRMLVolumePropertyStorageNode, and vtkMRMLVolumeSequenceStorageNode.
|
protectedvirtual |
Initialize all the supported write file types Subclasses should use this method to initialize SupportedWriteFileTypes.
Reimplemented in vtkMRMLAnnotationFiducialsStorageNode, vtkMRMLAnnotationSnapshotStorageNode, vtkMRMLAnnotationStorageNode, vtkMRMLColorTableStorageNode, vtkMRMLHierarchyStorageNode, vtkMRMLLinearTransformSequenceStorageNode, vtkMRMLMarkupsFiducialStorageNode, vtkMRMLMarkupsJsonStorageNode, vtkMRMLModelStorageNode, vtkMRMLNRRDStorageNode, vtkMRMLProceduralColorStorageNode, vtkMRMLSceneViewStorageNode, vtkMRMLSegmentationStorageNode, vtkMRMLSequenceStorageNode, vtkMRMLShaderPropertyStorageNode, vtkMRMLTableSQLiteStorageNode, vtkMRMLTableStorageNode, vtkMRMLTextStorageNode, vtkMRMLTransformStorageNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLVolumePropertyStorageNode, and vtkMRMLVolumeSequenceStorageNode.
void vtkMRMLStorageNode::InvalidateFile | ( | ) |
Inform that the file that has been last read or write has been deleted. Use with care, typically called by the cache manager.
|
virtual |
Reimplemented from vtkMRMLNode.
Reimplemented in vtkMRMLAnnotationControlPointsStorageNode, vtkMRMLAnnotationFiducialsStorageNode, vtkMRMLAnnotationLinesStorageNode, vtkMRMLAnnotationRulerStorageNode, vtkMRMLAnnotationSnapshotStorageNode, vtkMRMLAnnotationStorageNode, vtkMRMLColorTableStorageNode, vtkMRMLHierarchyStorageNode, vtkMRMLLinearTransformSequenceStorageNode, vtkMRMLMarkupsFiducialStorageNode, vtkMRMLMarkupsJsonStorageNode, vtkMRMLMarkupsPlaneJsonStorageNode, vtkMRMLMarkupsROIJsonStorageNode, vtkMRMLMarkupsStorageNode, vtkMRMLModelStorageNode, vtkMRMLNRRDStorageNode, vtkMRMLProceduralColorStorageNode, vtkMRMLSceneViewStorageNode, vtkMRMLSegmentationStorageNode, vtkMRMLSequenceStorageNode, vtkMRMLShaderPropertyStorageNode, vtkMRMLTableSQLiteStorageNode, vtkMRMLTableStorageNode, vtkMRMLTextStorageNode, vtkMRMLTransformStorageNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLVolumePropertyStorageNode, and vtkMRMLVolumeSequenceStorageNode.
int vtkMRMLStorageNode::IsFilePathRelative | ( | const char * | filepath | ) |
Checks is file path is a relative path by calling appropriate method on the scene depending on whether the scene pointer is valid. returns 0 if it's not relative or the input is null, 1 if it is relative
|
static |
|
protected |
|
override |
|
overridevirtual |
Propagate Progress Event generated in ReadData.
Reimplemented from vtkMRMLNode.
|
virtual |
Read data from FileName and set it in the referenced node. If temporaryFile is true, it informs the reader that the file to read is from a temporary directory. It means that the node should probably be saved by the user before leaving the application as the file might already be deleted or be deleted soon after. Return 1 on success, 0 on failure.
|
protectedvirtual |
Does the actual reading. Returns 1 on success, 0 otherwise. Returns 0 by default (read not supported). To be reimplemented in subclass.
Reimplemented in vtkMRMLAnnotationControlPointsStorageNode, vtkMRMLAnnotationFiducialsStorageNode, vtkMRMLAnnotationLinesStorageNode, vtkMRMLAnnotationRulerStorageNode, vtkMRMLAnnotationSnapshotStorageNode, vtkMRMLAnnotationStorageNode, vtkMRMLColorTableStorageNode, vtkMRMLHierarchyStorageNode, vtkMRMLLinearTransformSequenceStorageNode, vtkMRMLMarkupsFiducialStorageNode, vtkMRMLMarkupsJsonStorageNode, vtkMRMLModelStorageNode, vtkMRMLNRRDStorageNode, vtkMRMLProceduralColorStorageNode, vtkMRMLSceneViewStorageNode, vtkMRMLSegmentationStorageNode, vtkMRMLSequenceStorageNode, vtkMRMLShaderPropertyStorageNode, vtkMRMLTableSQLiteStorageNode, vtkMRMLTableStorageNode, vtkMRMLTextStorageNode, vtkMRMLTransformStorageNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLVolumePropertyStorageNode, and vtkMRMLVolumeSequenceStorageNode.
|
overridevirtual |
Read node attributes from XML file.
Reimplemented from vtkMRMLNode.
Reimplemented in vtkMRMLTextStorageNode, vtkMRMLTransformStorageNode, vtkMRMLVolumeArchetypeStorageNode, and vtkMRMLVolumeHeaderlessStorageNode.
void vtkMRMLStorageNode::ResetFileNameList | ( | ) |
Clear the array of file names.
void vtkMRMLStorageNode::ResetNthFileName | ( | int | n, |
const char * | fileName ) |
Set the nth file in FileNameList, checks that it is already defined.
void vtkMRMLStorageNode::ResetNthURI | ( | int | n, |
const char * | uri ) |
Set the nth URI in URIList, checks that it is already defined.
void vtkMRMLStorageNode::ResetURIList | ( | ) |
Clear the array of URIs.
|
static |
|
virtual |
Compression parameter that is used to save the node.
void vtkMRMLStorageNode::SetDataDirectory | ( | const char * | dataDirName | ) |
Set a new data directory for all files.
|
virtual |
Set default file extension for writing. It is just a hint, the storage node may choose a different extension if the provided extension is not suitable.
|
virtual |
A file name or the archetype file name for a series used for read or write
|
virtual |
|
inline |
Definition at line 146 of file vtkMRMLStorageNode.h.
|
inline |
Definition at line 142 of file vtkMRMLStorageNode.h.
|
inline |
Definition at line 141 of file vtkMRMLStorageNode.h.
|
inline |
Definition at line 143 of file vtkMRMLStorageNode.h.
|
inline |
Definition at line 147 of file vtkMRMLStorageNode.h.
|
inline |
Definition at line 145 of file vtkMRMLStorageNode.h.
|
inline |
Definition at line 144 of file vtkMRMLStorageNode.h.
|
virtual |
A temporary file name used to calculate absolute paths.
|
virtual |
Location of the remote copy of this file.
|
virtual |
void vtkMRMLStorageNode::SetURIPrefix | ( | const char * | uriPrefix | ) |
Set a new URI base for all URI's.
|
virtual |
|
virtual |
Allow to set specific file format that this node will write output. This is a transient property (that is expected to change and is not a reason for saving the node again if modified).
void vtkMRMLStorageNode::SetWriteState | ( | int | writeState | ) |
|
inline |
Definition at line 162 of file vtkMRMLStorageNode.h.
|
inline |
Definition at line 158 of file vtkMRMLStorageNode.h.
|
inline |
Definition at line 157 of file vtkMRMLStorageNode.h.
|
inline |
Definition at line 159 of file vtkMRMLStorageNode.h.
|
inline |
Definition at line 163 of file vtkMRMLStorageNode.h.
|
inline |
Definition at line 161 of file vtkMRMLStorageNode.h.
|
inline |
Definition at line 160 of file vtkMRMLStorageNode.h.
|
protected |
If the URI is not null, fetch it and save it to the node's FileName location or load directly into the reference node.
|
protected |
Copy data from the local file location (node->FileName) or node to the remote location specified by the URI
|
virtual |
Check to see if this storage node can handle the file type in the input string. If input string is null, check URI, then check FileName. Returns nonzero if supported, 0 otherwise. The higher the value, the higher the confidence that this reader is the most suitable for reading the file. Typically, the confidence is the length of the file matched file extension (including the dot). So, for example for .nrrd file extension the returned value is 5, for .seg.nrrd the returned value is 9. If a reader looks into the file content then it may return with much higher confidence values. Subclasses should implement this method.
|
protectedvirtual |
Update list of supported compression presets. It is called before each access to the preset list. Subclasses can use this method to set presets based on storable node content.
|
virtual |
|
virtual |
Use compression on write.
|
virtual |
Write data from a referenced node Return 1 on success, 0 on failure. NOTE: Subclasses should implement WriteDataInternal(), not this method.
|
protectedvirtual |
Does the actual writing. Returns 1 on success, 0 otherwise. Returns 0 by default (write not supported). To be reimplemented in subclass.
Reimplemented in vtkMRMLAnnotationSnapshotStorageNode, vtkMRMLAnnotationStorageNode, vtkMRMLColorTableStorageNode, vtkMRMLHierarchyStorageNode, vtkMRMLLinearTransformSequenceStorageNode, vtkMRMLMarkupsFiducialStorageNode, vtkMRMLMarkupsJsonStorageNode, vtkMRMLModelStorageNode, vtkMRMLNRRDStorageNode, vtkMRMLProceduralColorStorageNode, vtkMRMLSceneViewStorageNode, vtkMRMLSegmentationStorageNode, vtkMRMLSequenceStorageNode, vtkMRMLShaderPropertyStorageNode, vtkMRMLTableSQLiteStorageNode, vtkMRMLTableStorageNode, vtkMRMLTextStorageNode, vtkMRMLTransformStorageNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLVolumePropertyStorageNode, and vtkMRMLVolumeSequenceStorageNode.
|
overridevirtual |
Write this node's information to a MRML file in XML format.
Reimplemented from vtkMRMLNode.
Reimplemented in vtkMRMLTextStorageNode, vtkMRMLTransformStorageNode, vtkMRMLVolumeArchetypeStorageNode, and vtkMRMLVolumeHeaderlessStorageNode.
|
protected |
Definition at line 429 of file vtkMRMLStorageNode.h.
|
protected |
Definition at line 430 of file vtkMRMLStorageNode.h.
|
protected |
List of supported extensions to write in.
Definition at line 442 of file vtkMRMLStorageNode.h.
|
protected |
Definition at line 422 of file vtkMRMLStorageNode.h.
|
protected |
An array of file names, should contain the FileName but may not.
Definition at line 434 of file vtkMRMLStorageNode.h.
|
protected |
Definition at line 465 of file vtkMRMLStorageNode.h.
|
protected |
Definition at line 427 of file vtkMRMLStorageNode.h.
|
protected |
Time when data was last read or written. This is used by the storable node to know when it needs to save its data Can be reset with InvalidateFile.
Definition at line 463 of file vtkMRMLStorageNode.h.
|
protected |
List of supported extensions to read in.
Definition at line 439 of file vtkMRMLStorageNode.h.
|
protected |
Definition at line 443 of file vtkMRMLStorageNode.h.
|
protected |
Definition at line 423 of file vtkMRMLStorageNode.h.
|
protected |
Definition at line 424 of file vtkMRMLStorageNode.h.
|
protected |
Definition at line 425 of file vtkMRMLStorageNode.h.
|
protected |
An array of URI's, should contain the URI but may not.
Definition at line 437 of file vtkMRMLStorageNode.h.
|
protected |
Definition at line 426 of file vtkMRMLStorageNode.h.
|
protected |
Definition at line 469 of file vtkMRMLStorageNode.h.
|
protected |
Definition at line 444 of file vtkMRMLStorageNode.h.
|
protected |
Definition at line 428 of file vtkMRMLStorageNode.h.