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
vtkMRMLStreamingVolumeNode Class Reference

MRML node for representing a single compressed video frame that can be decoded to an image representation In this context, a frame is considered to be a compressed image that may require additional frames to decode to an image, and an image is the uncompressed pixel based representation. A video codec can be used to decode and encode between frame and image representations. More...

#include <Libs/MRML/Core/vtkMRMLStreamingVolumeNode.h>

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

Public Types

enum  { FrameModifiedEvent = 18002 }
 
typedef vtkMRMLVectorVolumeNode Superclass
 
- Public Types inherited from vtkMRMLVectorVolumeNode
typedef vtkMRMLTensorVolumeNode Superclass
 
- Public Types inherited from vtkMRMLTensorVolumeNode
typedef vtkMRMLScalarVolumeNode Superclass
 
- Public Types inherited from vtkMRMLScalarVolumeNode
typedef vtkMRMLVolumeNode Superclass
 
- Public Types inherited from vtkMRMLVolumeNode
enum  {
  VoxelVectorTypeUndefined, VoxelVectorTypeSpatial, VoxelVectorTypeColorRGB, VoxelVectorTypeColorRGBA,
  VoxelVectorType_Last
}
 
enum  { ImageDataModifiedEvent = 18001 }
 ImageDataModifiedEvent is generated when image data is changed. More...
 
typedef vtkMRMLDisplayableNode Superclass
 
- Public Types inherited from vtkMRMLDisplayableNode
enum  { DisplayModifiedEvent = 17000 }
 
typedef vtkMRMLTransformableNode Superclass
 
- Public Types inherited from vtkMRMLTransformableNode
enum  { TransformModifiedEvent = 15000 }
 TransformModifiedEvent is send when the parent transform is modidied. More...
 
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

vtkMRMLNodeCreateNodeInstance () override
 MRMLNode methods. More...
 
virtual bool DecodeFrame ()
 
virtual bool EncodeImageData (bool forceKeyFrame=false)
 
virtual const char * GetClassName ()
 
vtkStreamingVolumeCodec * GetCodec ()
 
virtual std::string GetCodecFourCC ()
 
std::string GetCodecParameterString ()
 
vtkStreamingVolumeFrame * GetFrame ()
 Returns a pointer to the current frame. More...
 
vtkImageData * GetImageData () override
 
vtkAlgorithmOutput * GetImageDataConnection () override
 Return the input image data pipeline. More...
 
const char * GetNodeTagName () override
 Get node XML tag name (like Volume, Model) More...
 
virtual int IsA (const char *type)
 
virtual bool IsKeyFrame ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData) override
 
alternative method to propagate events generated in Display nodes More...
 
void ReadXMLAttributes (const char **atts) override
 Set node attributes. More...
 
void SetAndObserveFrame (vtkStreamingVolumeFrame *frame)
 
void SetAndObserveImageData (vtkImageData *imageData) override
 
virtual void SetCodec (vtkStreamingVolumeCodec *)
 Instance of the code that is. More...
 
virtual void SetCodecFourCC (std::string)
 
void SetCodecParameterString (std::string parameterString)
 
 vtkMRMLCopyContentMacro (vtkMRMLStreamingVolumeNode)
 
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 vtkMRMLVectorVolumeNode
void Copy (vtkMRMLNode *node) override
 
Copy the node's attributes to this object More...
 
void CreateDefaultDisplayNodes () override
 
Create and observe default display node More...
 
vtkMRMLStorageNodeCreateDefaultStorageNode () override
 
Create default storage node or nullptr if does not have one More...
 
vtkMRMLNodeCreateNodeInstance () override
 MRMLNode methods. More...
 
const char * GetNodeTagName () override
 
Get node XML tag name (like Volume, Model) More...
 
virtual vtkMRMLVectorVolumeDisplayNodeGetVectorVolumeDisplayNode ()
 
Associated display MRML node More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ReadXMLAttributes (const char **atts) override
 
Set node attributes More...
 
 vtkMRMLCopyContentDefaultMacro (vtkMRMLVectorVolumeNode)
 
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 vtkMRMLTensorVolumeNode
void GetMeasurementFrameMatrix (double mf[3][3])
 
void GetMeasurementFrameMatrix (vtkMatrix4x4 *mat)
 
virtual int GetOrder ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void SetMeasurementFrameMatrix (const double mf[3][3])
 
Set the Measurement frame matrix from 3x3 array More...
 
void SetMeasurementFrameMatrix (const double xr, const double xa, const double xs, const double yr, const double ya, const double ys, const double zr, const double za, const double zs)
 
void SetMeasurementFrameMatrix (vtkMatrix4x4 *mat)
 
Set/Get the measurement frame matrix from a vtk 4x4 matrix More...
 
virtual void SetOrder (int)
 
void UpdateReferenceID (const char *oldID, const char *newID) override
 
void UpdateReferences () override
 
 vtkMRMLCopyContentMacro (vtkMRMLTensorVolumeNode)
 
- Public Member Functions inherited from vtkMRMLScalarVolumeNode
virtual vtkMRMLScalarVolumeDisplayNodeGetScalarVolumeDisplayNode ()
 
Associated display MRML node More...
 
virtual vtkCodedEntryGetVoxelValueQuantity ()
 
virtual vtkCodedEntryGetVoxelValueUnits ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void SetVoxelValueQuantity (vtkCodedEntry *)
 
void SetVoxelValueUnits (vtkCodedEntry *)
 
 vtkMRMLCopyContentDefaultMacro (vtkMRMLScalarVolumeNode)
 
- Public Member Functions inherited from vtkMRMLVolumeNode
bool AddCenteringTransform ()
 
virtual void ApplyNonLinearTransform (vtkAbstractTransform *transform)
 
void ApplyTransform (vtkAbstractTransform *transform) override
 
void ApplyTransformMatrix (vtkMatrix4x4 *transformMatrix) override
 
bool CanApplyNonLinearTransforms () const override
 
void CopyOrientation (vtkMRMLVolumeNode *node)
 
Copy the node's attributes to this object More...
 
void CreateDefaultSequenceDisplayNodes () override
 Creates the most appropriate display node class for storing a sequence of these nodes. More...
 
void GetBounds (double bounds[6]) override
 
void GetIJKToRASDirectionMatrix (vtkMatrix4x4 *mat)
 
void GetIJKToRASDirections (double dirs[3][3])
 
void GetIJKToRASMatrix (vtkMatrix4x4 *mat)
 
virtual double GetImageBackgroundScalarComponentAsDouble (int component)
 
void GetIToRASDirection (double dirs[3])
 
void GetJToRASDirection (double dirs[3])
 
void GetKToRASDirection (double dirs[3])
 
double GetMaxSpacing ()
 
Utility function that returns the max spacing between the 3 orientations More...
 
const itk::MetaDataDictionary & GetMetaDataDictionary () const
 
double GetMinSpacing ()
 
Utility function that returns the min spacing between the 3 orientations More...
 
bool GetModifiedSinceRead () override
 
virtual void GetOrigin (double &, double &, double &)
 
virtual void GetOrigin (double [3])
 
virtual double * GetOrigin ()
 
void GetRASBounds (double bounds[6]) override
 
void GetRASToIJKMatrix (vtkMatrix4x4 *mat)
 
void GetSliceBounds (double bounds[6], vtkMatrix4x4 *rasToSlice, bool useVoxelCenter=false)
 
virtual void GetSpacing (double &, double &, double &)
 
virtual double * GetSpacing ()
 
virtual void GetSpacing (double [3])
 
virtual vtkMRMLVolumeDisplayNodeGetVolumeDisplayNode ()
 
Associated display MRML node More...
 
virtual int GetVoxelVectorType ()
 
bool IsCentered ()
 Returns true if the volume center is in the origin. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ProcessMRMLEvents (vtkObject *, unsigned long, void *) override
 
alternative method to propagate events generated in Display nodes More...
 
void ReadXMLAttributes (const char **atts) override
 
Read node attributes from XML file More...
 
void SetIJKToRASDirectionMatrix (vtkMatrix4x4 *mat)
 
void SetIJKToRASDirections (double dirs[3][3])
 
void SetIJKToRASDirections (double ir, double ia, double is, double jr, double ja, double js, double kr, double ka, double ks)
 
void SetIJKToRASMatrix (vtkMatrix4x4 *mat)
 
virtual void SetImageDataConnection (vtkAlgorithmOutput *inputPort)
 
void SetIToRASDirection (double ir, double ia, double is)
 
void SetJToRASDirection (double jr, double ja, double js)
 
void SetKToRASDirection (double kr, double ka, double ks)
 
void SetMetaDataDictionary (const itk::MetaDataDictionary &)
 
Set/Get the ITK MetaDataDictionary More...
 
virtual void SetOrigin (double arg1, double arg2, double arg3)
 
virtual void SetOrigin (double arg[3])
 
void SetRASToIJKMatrix (vtkMatrix4x4 *mat)
 
virtual void SetSpacing (double arg1, double arg2, double arg3)
 
virtual void SetSpacing (double arg[3])
 
virtual void SetVoxelVectorType (int)
 
void ShiftImageDataExtentToZeroStart ()
 
void UpdateScene (vtkMRMLScene *scene) override
 
Finds the storage node and read the data More...
 
 vtkMRMLCopyContentMacro (vtkMRMLVolumeNode)
 
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 vtkMRMLDisplayableNode
void AddAndObserveDisplayNodeID (const char *displayNodeID)
 
virtual int GetDisplayClassVisibility (const char *nodeClass)
 
vtkMRMLDisplayNodeGetDisplayNode ()
 
const char * GetDisplayNodeID ()
 
virtual const char * GetDisplayNodeReferenceRole ()
 
virtual int GetDisplayVisibility ()
 
vtkMRMLDisplayNodeGetNthDisplayNode (int n)
 
const char * GetNthDisplayNodeID (int n)
 
int GetNumberOfDisplayNodes ()
 
bool HasDisplayNodeID (const char *displayNodeID)
 
Return true if displayNodeID is in the display node ID list. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void RemoveAllDisplayNodeIDs ()
 
Remove all display node IDs and associated display nodes. More...
 
void RemoveNthDisplayNodeID (int n)
 
void SetAndObserveDisplayNodeID (const char *displayNodeID)
 
void SetAndObserveNthDisplayNodeID (int n, const char *displayNodeID)
 
virtual void SetDisplayClassVisibility (const char *nodeClass, int visible)
 
virtual void SetDisplayVisibility (int visible)
 
void SetSelectable (int) override
 
virtual void WriteCLI (std::vector< std::string > &vtkNotUsed(commandLine), std::string vtkNotUsed(prefix), int vtkNotUsed(coordinateSystemFlag)=vtkMRMLStorageNode::CoordinateSystemRAS, int vtkNotUsed(multipleFlag)=1)
 
- Public Member Functions inherited from vtkMRMLTransformableNode
vtkMRMLTransformNodeGetParentTransformNode ()
 
Associated transform MRML node More...
 
const char * GetTransformNodeID ()
 Get referenced transform node id. More...
 
bool HardenTransform ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
bool SetAndObserveTransformNodeID (const char *transformNodeID)
 
virtual void TransformPointFromWorld (const double inWorld[3], double outLocal[3])
 
virtual void TransformPointFromWorld (const vtkVector3d &inWorld, vtkVector3d &outLocal)
 
virtual void TransformPointToWorld (const double inLocal[3], double outWorld[3])
 
virtual void TransformPointToWorld (const vtkVector3d &inLocal, vtkVector3d &outWorld)
 
- Public Member Functions inherited from vtkMRMLStorableNode
void AddAndObserveStorageNodeID (const char *storageNodeID)
 
virtual bool AddDefaultStorageNode (const char *filename=nullptr)
 
virtual vtkMRMLStorageNodeCreateDefaultSequenceStorageNode ()
 
virtual std::string GetDefaultSequenceStorageNodeClassName ()
 
virtual std::string GetDefaultStorageNodeClassName (const char *filename=nullptr)
 
vtkMRMLStorageNodeGetNthStorageNode (int n)
 
Get associated display MRML node More...
 
const char * GetNthStorageNodeID (int n)
 
int GetNumberOfStorageNodes ()
 
const char * GetSlicerDataType ()
 
vtkMRMLStorageNodeGetStorageNode ()
 
const char * GetStorageNodeID ()
 
virtual vtkTagTableGetUserTagTable ()
 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 SetAndObserveNthStorageNodeID (int n, const char *storageNodeID)
 
void SetAndObserveStorageNodeID (const char *storageNodeID)
 
String ID of the storage MRML node More...
 
virtual void SetDefaultSequenceStorageNodeClassName (std::string)
 
void SetSlicerDataType (const char *type)
 
virtual void StorableModified ()
 
 vtkMRMLCopyContentMacro (vtkMRMLStorableNode)
 
- 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 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...
 
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 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 ()
 
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 void FrameModifiedCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 
static int IsTypeOf (const char *type)
 
static vtkMRMLStreamingVolumeNodeNew ()
 
static vtkMRMLStreamingVolumeNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLVectorVolumeNode
static int IsTypeOf (const char *type)
 
static vtkMRMLVectorVolumeNodeNew ()
 
static vtkMRMLVectorVolumeNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLTensorVolumeNode
static int IsTypeOf (const char *type)
 
static vtkMRMLTensorVolumeNodeNew ()
 
static vtkMRMLTensorVolumeNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLScalarVolumeNode
static void CreateNoneNode (vtkMRMLScene *scene)
 
Make a 'None' volume node with blank image data More...
 
static int IsTypeOf (const char *type)
 
static vtkMRMLScalarVolumeNodeNew ()
 
static vtkMRMLScalarVolumeNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLVolumeNode
static bool ComputeIJKToRASFromScanOrder (const char *order, const double *spacing, const int *dims, bool centerImage, vtkMatrix4x4 *IJKToRAS)
 RAS->IJK Matrix Calculation. More...
 
static const char * ComputeScanOrderFromIJKToRAS (vtkMatrix4x4 *IJKToRAS)
 
static const char * GetVoxelVectorTypeAsString (int id)
 Convert between voxel type ID and name. More...
 
static int GetVoxelVectorTypeFromString (const char *name)
 
static int IsTypeOf (const char *type)
 
static vtkMRMLVolumeNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLDisplayableNode
static int IsTypeOf (const char *type)
 
static vtkMRMLDisplayableNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLTransformableNode
static int IsTypeOf (const char *type)
 
static vtkMRMLTransformableNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLStorableNode
static int IsTypeOf (const char *type)
 
static vtkMRMLStorableNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (vtkObject *o)
 

Protected Member Functions

void AllocateImageForFrame (vtkImageData *imageData)
 Allocates the vtkImageData so that the compressed image data can be decoded. More...
 
bool HasExternalImageObserver ()
 Returns true if the number of observers on the ImageData or ImageDataConnection is greater than the default expected number. More...
 
void operator= (const vtkMRMLStreamingVolumeNode &)
 
 vtkMRMLStreamingVolumeNode ()
 
 vtkMRMLStreamingVolumeNode (const vtkMRMLStreamingVolumeNode &)
 
 ~vtkMRMLStreamingVolumeNode () override
 
- Protected Member Functions inherited from vtkMRMLVectorVolumeNode
void operator= (const vtkMRMLVectorVolumeNode &)
 
 vtkMRMLVectorVolumeNode ()
 
 vtkMRMLVectorVolumeNode (const vtkMRMLVectorVolumeNode &)
 
 ~vtkMRMLVectorVolumeNode () override
 
- Protected Member Functions inherited from vtkMRMLTensorVolumeNode
void operator= (const vtkMRMLTensorVolumeNode &)
 
 vtkMRMLTensorVolumeNode ()
 
 vtkMRMLTensorVolumeNode (const vtkMRMLTensorVolumeNode &)
 
 ~vtkMRMLTensorVolumeNode () override
 
- Protected Member Functions inherited from vtkMRMLScalarVolumeNode
void operator= (const vtkMRMLScalarVolumeNode &)
 
 vtkMRMLScalarVolumeNode ()
 
 vtkMRMLScalarVolumeNode (const vtkMRMLScalarVolumeNode &)
 
 ~vtkMRMLScalarVolumeNode () override
 
- Protected Member Functions inherited from vtkMRMLVolumeNode
virtual void GetBoundsInternal (double bounds[6], vtkMatrix4x4 *rasToSlice, bool useTransform, bool useVoxelCenter=false)
 
void GetCenterPositionRAS (double *centerPositionRAS, bool useParentTransform=true)
 
virtual int GetResamplingInterpolationMode ()
 
void OnNodeReferenceAdded (vtkMRMLNodeReference *reference) override
 
Called when a node reference ID is added (list size increased). More...
 
void OnNodeReferenceModified (vtkMRMLNodeReference *reference) override
 
Called when a node reference ID is modified. More...
 
void operator= (const vtkMRMLVolumeNode &)
 
void SetImageDataToDisplayNode (vtkMRMLVolumeDisplayNode *displayNode)
 
void SetImageDataToDisplayNodes ()
 Set the image data pipeline to all the display nodes. More...
 
virtual void UpdateDisplayNodeImageData (vtkMRMLDisplayNode *dnode)
 
 vtkMRMLVolumeNode ()
 
 vtkMRMLVolumeNode (const vtkMRMLVolumeNode &)
 
 ~vtkMRMLVolumeNode () override
 
- Protected Member Functions inherited from vtkMRMLDisplayableNode
virtual const char * GetDisplayNodeReferenceMRMLAttributeName ()
 
void OnNodeReferenceRemoved (vtkMRMLNodeReference *reference) override
 
Called after a node reference ID is removed (list size decreased). More...
 
void operator= (const vtkMRMLDisplayableNode &)
 
 vtkMRMLDisplayableNode ()
 
 vtkMRMLDisplayableNode (const vtkMRMLDisplayableNode &)
 
 ~vtkMRMLDisplayableNode () override
 
- Protected Member Functions inherited from vtkMRMLTransformableNode
virtual const char * GetTransformNodeReferenceMRMLAttributeName ()
 
virtual const char * GetTransformNodeReferenceRole ()
 
void OnNodeReferenceRemoved (vtkMRMLNodeReference *reference) override
 
Called after a node reference ID is removed (list size decreased). More...
 
virtual void OnTransformNodeReferenceChanged (vtkMRMLTransformNode *transformNode)
 Called when transform node reference added/modified/removed. More...
 
void operator= (const vtkMRMLTransformableNode &)
 
 vtkMRMLTransformableNode ()
 
 vtkMRMLTransformableNode (const vtkMRMLTransformableNode &)
 
 ~vtkMRMLTransformableNode () 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...
 
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

vtkSmartPointer< vtkStreamingVolumeCodec > Codec
 
std::string CodecFourCC
 
vtkSmartPointer< vtkStreamingVolumeFrame > Frame
 
bool FrameDecoded {false}
 
bool FrameDecodingInProgress {false}
 
vtkSmartPointer< vtkCallbackCommand > FrameModifiedCallbackCommand
 
- Protected Attributes inherited from vtkMRMLTensorVolumeNode
double MeasurementFrameMatrix [3][3]
 
int Order
 
- Protected Attributes inherited from vtkMRMLScalarVolumeNode
vtkCodedEntryVoxelValueQuantity {nullptr}
 
vtkCodedEntryVoxelValueUnits {nullptr}
 
- Protected Attributes inherited from vtkMRMLVolumeNode
vtkEventForwarderCommand * DataEventForwarder
 
itk::MetaDataDictionary Dictionary
 
double IJKToRASDirections [3][3]
 these are unit length direction cosines More...
 
vtkAlgorithmOutput * ImageDataConnection
 
double Origin [3]
 
double Spacing [3]
 these are mappings to mm space More...
 
int VoxelVectorType
 
- Protected Attributes inherited from vtkMRMLStorableNode
std::string DefaultSequenceStorageNodeClassName
 
std::string SlicerDataType
 
vtkTimeStamp StorableModifiedTime
 
vtkTagTableUserTagTable
 
- 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...
 
vtkObserverManagerMRMLObserverManager
 
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)
 
- Static Protected Attributes inherited from vtkMRMLDisplayableNode
static const char * DisplayNodeReferenceMRMLAttributeName
 
static const char * DisplayNodeReferenceRole
 
- Static Protected Attributes inherited from vtkMRMLTransformableNode
static const char * TransformNodeReferenceMRMLAttributeName
 
static const char * TransformNodeReferenceRole
 
- Static Protected Attributes inherited from vtkMRMLStorableNode
static const char * StorageNodeReferenceMRMLAttributeName
 
static const char * StorageNodeReferenceRole
 

Detailed Description

MRML node for representing a single compressed video frame that can be decoded to an image representation In this context, a frame is considered to be a compressed image that may require additional frames to decode to an image, and an image is the uncompressed pixel based representation. A video codec can be used to decode and encode between frame and image representations.

Definition at line 45 of file vtkMRMLStreamingVolumeNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 49 of file vtkMRMLStreamingVolumeNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
FrameModifiedEvent 

Definition at line 98 of file vtkMRMLStreamingVolumeNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLStreamingVolumeNode() [1/2]

vtkMRMLStreamingVolumeNode::vtkMRMLStreamingVolumeNode ( )
protected

◆ ~vtkMRMLStreamingVolumeNode()

vtkMRMLStreamingVolumeNode::~vtkMRMLStreamingVolumeNode ( )
overrideprotected

◆ vtkMRMLStreamingVolumeNode() [2/2]

vtkMRMLStreamingVolumeNode::vtkMRMLStreamingVolumeNode ( const vtkMRMLStreamingVolumeNode )
protected

Member Function Documentation

◆ AllocateImageForFrame()

void vtkMRMLStreamingVolumeNode::AllocateImageForFrame ( vtkImageData *  imageData)
protected

Allocates the vtkImageData so that the compressed image data can be decoded.

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLStreamingVolumeNode::CreateNodeInstance ( )
overridevirtual

MRMLNode methods.

Reimplemented from vtkMRMLScalarVolumeNode.

◆ DecodeFrame()

virtual bool vtkMRMLStreamingVolumeNode::DecodeFrame ( )
virtual

Decodes the current frame and stores the contents in the volume node as vtkImageData Returns true if the frame is successfully decoded

◆ EncodeImageData()

virtual bool vtkMRMLStreamingVolumeNode::EncodeImageData ( bool  forceKeyFrame = false)
virtual

Encodes the current vtkImageData as a compressed frame using the specified codec Returns true if the image is successfully encoded

◆ FrameModifiedCallback()

static void vtkMRMLStreamingVolumeNode::FrameModifiedCallback ( vtkObject *  caller,
unsigned long  eid,
void *  clientData,
void *  callData 
)
static

Callback that is called if the current frame is modified Invokes FrameModifiedEvent

◆ GetClassName()

virtual const char* vtkMRMLStreamingVolumeNode::GetClassName ( )
virtual

Reimplemented from vtkMRMLVectorVolumeNode.

◆ GetCodec()

vtkStreamingVolumeCodec* vtkMRMLStreamingVolumeNode::GetCodec ( )

◆ GetCodecFourCC()

virtual std::string vtkMRMLStreamingVolumeNode::GetCodecFourCC ( )
virtual

The FourCC representing the codec that should be used See https://www.fourcc.org/codecs.php

◆ GetCodecParameterString()

std::string vtkMRMLStreamingVolumeNode::GetCodecParameterString ( )

◆ GetFrame()

vtkStreamingVolumeFrame* vtkMRMLStreamingVolumeNode::GetFrame ( )
inline

Returns a pointer to the current frame.

Definition at line 81 of file vtkMRMLStreamingVolumeNode.h.

◆ GetImageData()

vtkImageData* vtkMRMLStreamingVolumeNode::GetImageData ( )
overridevirtual

Reimplemented from vtkMRMLVolumeNode.

◆ GetImageDataConnection()

vtkAlgorithmOutput* vtkMRMLStreamingVolumeNode::GetImageDataConnection ( )
overridevirtual

Return the input image data pipeline.

Reimplemented from vtkMRMLVolumeNode.

◆ GetNodeTagName()

const char* vtkMRMLStreamingVolumeNode::GetNodeTagName ( )
inlineoverridevirtual

Get node XML tag name (like Volume, Model)

Reimplemented from vtkMRMLScalarVolumeNode.

Definition at line 67 of file vtkMRMLStreamingVolumeNode.h.

◆ HasExternalImageObserver()

bool vtkMRMLStreamingVolumeNode::HasExternalImageObserver ( )
protected

Returns true if the number of observers on the ImageData or ImageDataConnection is greater than the default expected number.

◆ IsA()

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

Reimplemented from vtkMRMLVectorVolumeNode.

◆ IsKeyFrame()

virtual bool vtkMRMLStreamingVolumeNode::IsKeyFrame ( )
virtual

Returns true if the current frame is a keyframe Keyframes are not interpolated and don't require any additional frames in order to be decoded to an uncompressed image

◆ IsTypeOf()

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

◆ New()

static vtkMRMLStreamingVolumeNode* vtkMRMLStreamingVolumeNode::New ( )
static

◆ operator=()

void vtkMRMLStreamingVolumeNode::operator= ( const vtkMRMLStreamingVolumeNode )
protected

◆ PrintSelf()

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

◆ ProcessMRMLEvents()

void vtkMRMLStreamingVolumeNode::ProcessMRMLEvents ( vtkObject *  ,
unsigned long  long,
void *   
)
overridevirtual


alternative method to propagate events generated in Display nodes

Deprecated:
GetDisplayNodes Obsolete utility function that provides an unsafe API. Please use GetNumberOfDisplayNodes() and GetNthDisplayNode() instead const std::vector<vtkMRMLDisplayNode*>& GetDisplayNodes();
See also
GetNumberOfDisplayNodes, GetNthDisplayNode

Reimplemented from vtkMRMLDisplayableNode.

◆ ReadXMLAttributes()

void vtkMRMLStreamingVolumeNode::ReadXMLAttributes ( const char **  atts)
overridevirtual

Set node attributes.

Reimplemented from vtkMRMLScalarVolumeNode.

◆ SafeDownCast()

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

◆ SetAndObserveFrame()

void vtkMRMLStreamingVolumeNode::SetAndObserveFrame ( vtkStreamingVolumeFrame *  frame)

Set and observe the frame object containing the compressed image data

Parameters
frameObject containing the compressed video frame info

◆ SetAndObserveImageData()

void vtkMRMLStreamingVolumeNode::SetAndObserveImageData ( vtkImageData *  imageData)
overridevirtual

Set/Get the observed image data object and and image data connections

See also
vtkMRMLVolumeNode::SetAndObserveImageData(), vtkMRMLVolumeNode::GetImageData(), vtkMRMLVolumeNode::GetImageDataConnection()

Reimplemented from vtkMRMLVolumeNode.

◆ SetCodec()

virtual void vtkMRMLStreamingVolumeNode::SetCodec ( vtkStreamingVolumeCodec *  )
virtual

Instance of the code that is.

◆ SetCodecFourCC()

virtual void vtkMRMLStreamingVolumeNode::SetCodecFourCC ( std::string  )
virtual

◆ SetCodecParameterString()

void vtkMRMLStreamingVolumeNode::SetCodecParameterString ( std::string  parameterString)

String representing the parameters that are currently being used by the codec Format is "ParameterName1:ParameterValue1;ParameterName2;ParameterValue2;ParameterNameN:ParameterValueN"

◆ vtkMRMLCopyContentMacro()

vtkMRMLStreamingVolumeNode::vtkMRMLCopyContentMacro ( vtkMRMLStreamingVolumeNode  )

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

See also
vtkMRMLNode::CopyContent

◆ WriteXML()

void vtkMRMLStreamingVolumeNode::WriteXML ( ostream &  of,
int  indent 
)
overridevirtual

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

Reimplemented from vtkMRMLScalarVolumeNode.

Member Data Documentation

◆ Codec

vtkSmartPointer<vtkStreamingVolumeCodec> vtkMRMLStreamingVolumeNode::Codec
protected

Definition at line 130 of file vtkMRMLStreamingVolumeNode.h.

◆ CodecFourCC

std::string vtkMRMLStreamingVolumeNode::CodecFourCC
protected

Definition at line 131 of file vtkMRMLStreamingVolumeNode.h.

◆ Frame

vtkSmartPointer<vtkStreamingVolumeFrame> vtkMRMLStreamingVolumeNode::Frame
protected

Definition at line 132 of file vtkMRMLStreamingVolumeNode.h.

◆ FrameDecoded

bool vtkMRMLStreamingVolumeNode::FrameDecoded {false}
protected

Definition at line 133 of file vtkMRMLStreamingVolumeNode.h.

◆ FrameDecodingInProgress

bool vtkMRMLStreamingVolumeNode::FrameDecodingInProgress {false}
protected

Definition at line 134 of file vtkMRMLStreamingVolumeNode.h.

◆ FrameModifiedCallbackCommand

vtkSmartPointer<vtkCallbackCommand> vtkMRMLStreamingVolumeNode::FrameModifiedCallbackCommand
protected

Definition at line 135 of file vtkMRMLStreamingVolumeNode.h.


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