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

#include <Modules/Loadable/CropVolume/MRML/vtkMRMLCropVolumeParametersNode.h>

Inheritance diagram for vtkMRMLCropVolumeParametersNode:
Inheritance graph
Collaboration diagram for vtkMRMLCropVolumeParametersNode:
Collaboration graph

Public Types

enum  { InterpolationNearestNeighbor = 1, InterpolationLinear = 2, InterpolationWindowedSinc = 3, InterpolationBSpline = 4 }
typedef vtkMRMLNode Superclass
- Public Types inherited from vtkMRMLNode
enum  {
  HierarchyModifiedEvent = 16000, IDChangedEvent = 16001, ReferenceAddedEvent, ReferenceModifiedEvent,
  ReferenceRemovedEvent, ReferencedNodeModifiedEvent
typedef vtkObject Superclass

Public Member Functions

vtkMRMLNodeCreateNodeInstance () override
 Create instance of the default node. Like New only virtual. More...
void DeleteROIAlignmentTransformNode ()
virtual const char * GetClassName ()
virtual double GetFillValue ()
vtkMRMLVolumeNodeGetInputVolumeNode ()
const char * GetInputVolumeNodeID ()
 Get volume node to be cropped. More...
virtual int GetInterpolationMode ()
virtual bool GetIsotropicResampling ()
const char * GetNodeTagName () override
 Get node XML tag name (like Volume, Model) More...
vtkMRMLVolumeNodeGetOutputVolumeNode ()
const char * GetOutputVolumeNodeID ()
 Get resulting cropped volume node. More...
vtkMRMLTransformNodeGetROIAlignmentTransformNode ()
const char * GetROIAlignmentTransformNodeID ()
vtkMRMLDisplayableNodeGetROINode ()
const char * GetROINodeID ()
 Get cropping region of interest. More...
virtual double GetSpacingScalingConst ()
virtual bool GetVoxelBased ()
virtual int IsA (const char *type)
virtual void IsotropicResamplingOff ()
virtual void IsotropicResamplingOn ()
void PrintSelf (ostream &os, vtkIndent indent) override
void ReadXMLAttributes (const char **atts) override
 Set node attributes from XML attributes. More...
virtual void SetFillValue (double)
void SetInputVolumeNodeID (const char *nodeID)
 Set volume node to be cropped. More...
virtual void SetInterpolationMode (int)
virtual void SetIsotropicResampling (bool)
void SetOutputVolumeNodeID (const char *nodeID)
 Set resulting cropped volume node. More...
void SetROIAlignmentTransformNodeID (const char *nodeID)
void SetROINodeID (const char *nodeID)
virtual void SetSpacingScalingConst (double)
virtual void SetVoxelBased (bool)
virtual void VoxelBasedOff ()
virtual void VoxelBasedOn ()
 vtkMRMLCopyContentMacro (vtkMRMLCropVolumeParametersNode)
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
vtkMRMLNodeAddAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Add and observe a reference node from this node for a specific referenceRole. More...
vtkMRMLNodeAddNodeReferenceID (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 Copy (vtkMRMLNode *node)
 Copy node contents from another node of the same type. Does not copy node ID and Scene. Performs deep copy - an independent copy is created from all data, including bulk data. More...
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 ()
int GetCustomModifiedEventPending (int eventId)
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 ()
vtkMRMLNodeGetNodeReference (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...
vtkMRMLNodeGetNthNodeReference (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 vtkMRMLSceneGetScene ()
 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 const char * GetTypeDisplayName ()
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...
virtual void ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData)
 Propagate events generated in mrml. 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 Reset (vtkMRMLNode *defaultNode)
 Reset node attributes to the initial state as defined in the constructor or the passed default node. 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)
vtkMRMLNodeSetAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Set and observe a reference node from this node for a specific referenceRole. More...
vtkMRMLNodeSetAndObserveNthNodeReferenceID (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...
vtkMRMLNodeSetNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Set a reference to a node with specified nodeID from this node for a specific referenceRole. More...
vtkMRMLNodeSetNthNodeReferenceID (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...
virtual void UpdateScene (vtkMRMLScene *)
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 int IsTypeOf (const char *type)
static vtkMRMLCropVolumeParametersNodeNew ()
static vtkMRMLCropVolumeParametersNodeSafeDownCast (vtkObject *o)
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
static vtkMRMLNodeSafeDownCast (vtkObject *o)

Protected Member Functions

void operator= (const vtkMRMLCropVolumeParametersNode &)
 vtkMRMLCropVolumeParametersNode ()
 vtkMRMLCropVolumeParametersNode (const vtkMRMLCropVolumeParametersNode &)
 ~vtkMRMLCropVolumeParametersNode () 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)
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. More...
vtkMRMLNodeUpdateNodeReferenceEventObserver (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

double FillValue
int InterpolationMode
bool IsotropicResampling
double SpacingScalingConst
bool VoxelBased
- 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...
char * Name {nullptr}
NodeReferenceEventsType NodeReferenceEvents
std::map< std::string, std::string > NodeReferenceMRMLAttributeNames
NodeReferencesType NodeReferences
int SaveWithScene {true}
vtkWeakPointer< vtkMRMLSceneScene
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, NodeReferenceListTypeNodeReferencesType
- Static Protected Member Functions inherited from vtkMRMLNode
static void MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)

Detailed Description

Definition at line 28 of file vtkMRMLCropVolumeParametersNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 40 of file vtkMRMLCropVolumeParametersNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Definition at line 31 of file vtkMRMLCropVolumeParametersNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLCropVolumeParametersNode() [1/2]

vtkMRMLCropVolumeParametersNode::vtkMRMLCropVolumeParametersNode ( )

◆ ~vtkMRMLCropVolumeParametersNode()

vtkMRMLCropVolumeParametersNode::~vtkMRMLCropVolumeParametersNode ( )

◆ vtkMRMLCropVolumeParametersNode() [2/2]

vtkMRMLCropVolumeParametersNode::vtkMRMLCropVolumeParametersNode ( const vtkMRMLCropVolumeParametersNode )

Member Function Documentation

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLCropVolumeParametersNode::CreateNodeInstance ( )

Create instance of the default node. Like New only virtual.

Subclasses should implement this method

Implements vtkMRMLNode.

◆ DeleteROIAlignmentTransformNode()

void vtkMRMLCropVolumeParametersNode::DeleteROIAlignmentTransformNode ( )

◆ GetClassName()

virtual const char* vtkMRMLCropVolumeParametersNode::GetClassName ( )

Reimplemented from vtkMRMLNode.

◆ GetFillValue()

virtual double vtkMRMLCropVolumeParametersNode::GetFillValue ( )

◆ GetInputVolumeNode()

vtkMRMLVolumeNode* vtkMRMLCropVolumeParametersNode::GetInputVolumeNode ( )

◆ GetInputVolumeNodeID()

const char* vtkMRMLCropVolumeParametersNode::GetInputVolumeNodeID ( )

Get volume node to be cropped.

◆ GetInterpolationMode()

virtual int vtkMRMLCropVolumeParametersNode::GetInterpolationMode ( )

◆ GetIsotropicResampling()

virtual bool vtkMRMLCropVolumeParametersNode::GetIsotropicResampling ( )

◆ GetNodeTagName()

const char* vtkMRMLCropVolumeParametersNode::GetNodeTagName ( )

Get node XML tag name (like Volume, Model)

Implements vtkMRMLNode.

Definition at line 56 of file vtkMRMLCropVolumeParametersNode.h.

◆ GetOutputVolumeNode()

vtkMRMLVolumeNode* vtkMRMLCropVolumeParametersNode::GetOutputVolumeNode ( )

◆ GetOutputVolumeNodeID()

const char* vtkMRMLCropVolumeParametersNode::GetOutputVolumeNodeID ( )

Get resulting cropped volume node.

◆ GetROIAlignmentTransformNode()

vtkMRMLTransformNode* vtkMRMLCropVolumeParametersNode::GetROIAlignmentTransformNode ( )

◆ GetROIAlignmentTransformNodeID()

const char* vtkMRMLCropVolumeParametersNode::GetROIAlignmentTransformNodeID ( )

◆ GetROINode()

vtkMRMLDisplayableNode* vtkMRMLCropVolumeParametersNode::GetROINode ( )

◆ GetROINodeID()

const char* vtkMRMLCropVolumeParametersNode::GetROINodeID ( )

Get cropping region of interest.

◆ GetSpacingScalingConst()

virtual double vtkMRMLCropVolumeParametersNode::GetSpacingScalingConst ( )

◆ GetVoxelBased()

virtual bool vtkMRMLCropVolumeParametersNode::GetVoxelBased ( )

◆ IsA()

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

Reimplemented from vtkMRMLNode.

◆ IsotropicResamplingOff()

virtual void vtkMRMLCropVolumeParametersNode::IsotropicResamplingOff ( )

◆ IsotropicResamplingOn()

virtual void vtkMRMLCropVolumeParametersNode::IsotropicResamplingOn ( )

◆ IsTypeOf()

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

◆ New()

static vtkMRMLCropVolumeParametersNode* vtkMRMLCropVolumeParametersNode::New ( )

◆ operator=()

void vtkMRMLCropVolumeParametersNode::operator= ( const vtkMRMLCropVolumeParametersNode )

◆ PrintSelf()

void vtkMRMLCropVolumeParametersNode::PrintSelf ( ostream &  os,
vtkIndent  indent 

◆ ReadXMLAttributes()

void vtkMRMLCropVolumeParametersNode::ReadXMLAttributes ( const char **  atts)

Set node attributes from XML attributes.

Reimplemented from vtkMRMLNode.

◆ SafeDownCast()

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

◆ SetFillValue()

virtual void vtkMRMLCropVolumeParametersNode::SetFillValue ( double  )

◆ SetInputVolumeNodeID()

void vtkMRMLCropVolumeParametersNode::SetInputVolumeNodeID ( const char *  nodeID)

Set volume node to be cropped.

◆ SetInterpolationMode()

virtual void vtkMRMLCropVolumeParametersNode::SetInterpolationMode ( int  )

◆ SetIsotropicResampling()

virtual void vtkMRMLCropVolumeParametersNode::SetIsotropicResampling ( bool  )

◆ SetOutputVolumeNodeID()

void vtkMRMLCropVolumeParametersNode::SetOutputVolumeNodeID ( const char *  nodeID)

Set resulting cropped volume node.

◆ SetROIAlignmentTransformNodeID()

void vtkMRMLCropVolumeParametersNode::SetROIAlignmentTransformNodeID ( const char *  nodeID)

Set transform node that may be used for aligning the ROI with the input volume.

◆ SetROINodeID()

void vtkMRMLCropVolumeParametersNode::SetROINodeID ( const char *  nodeID)

Set cropping region of interest. It can be either vtkMRMLAnnotationROINode or vtkMRMLMarkupsROINode.

◆ SetSpacingScalingConst()

virtual void vtkMRMLCropVolumeParametersNode::SetSpacingScalingConst ( double  )

◆ SetVoxelBased()

virtual void vtkMRMLCropVolumeParametersNode::SetVoxelBased ( bool  )

◆ VoxelBasedOff()

virtual void vtkMRMLCropVolumeParametersNode::VoxelBasedOff ( )

◆ VoxelBasedOn()

virtual void vtkMRMLCropVolumeParametersNode::VoxelBasedOn ( )

◆ vtkMRMLCopyContentMacro()

vtkMRMLCropVolumeParametersNode::vtkMRMLCopyContentMacro ( vtkMRMLCropVolumeParametersNode  )

Copy node content (excludes basic data, such as name and node references).

See also

◆ WriteXML()

void vtkMRMLCropVolumeParametersNode::WriteXML ( ostream &  of,
int  indent 

Write this node's information to a MRML file in XML format.

Reimplemented from vtkMRMLNode.

Member Data Documentation

◆ FillValue

double vtkMRMLCropVolumeParametersNode::FillValue

Definition at line 112 of file vtkMRMLCropVolumeParametersNode.h.

◆ InterpolationMode

int vtkMRMLCropVolumeParametersNode::InterpolationMode

Definition at line 109 of file vtkMRMLCropVolumeParametersNode.h.

◆ IsotropicResampling

bool vtkMRMLCropVolumeParametersNode::IsotropicResampling

Definition at line 110 of file vtkMRMLCropVolumeParametersNode.h.

◆ SpacingScalingConst

double vtkMRMLCropVolumeParametersNode::SpacingScalingConst

Definition at line 111 of file vtkMRMLCropVolumeParametersNode.h.

◆ VoxelBased

bool vtkMRMLCropVolumeParametersNode::VoxelBased

Definition at line 108 of file vtkMRMLCropVolumeParametersNode.h.

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