Slicer  4.11
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
vtkStreamingVolumeFrame Class Reference

VTK object containing a single compressed frame. More...

#include <Libs/vtkAddon/vtkStreamingVolumeFrame.h>

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

Public Types

enum  { IFrame, PFrame, BFrame }
 
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual std::string GetCodecFourCC ()
 
virtual int * GetDimensions ()
 
virtual void GetDimensions (int &, int &, int &)
 
virtual void GetDimensions (int [3])
 
vtkUnsignedCharArray * GetFrameData ()
 
virtual int GetFrameType ()
 
virtual int GetNumberOfComponents ()
 
vtkStreamingVolumeFrameGetPreviousFrame ()
 
virtual int GetVTKScalarType ()
 
virtual int IsA (const char *type)
 
bool IsKeyFrame ()
 Returns true if the frame is a "Keyframe", aka "I-Frame". More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void SetCodecFourCC (std::string)
 FourCC of the codec for the frame. More...
 
virtual void SetDimensions (int [3])
 
virtual void SetDimensions (int, int, int)
 Dimensions of the decoded frame. More...
 
void SetFrameData (vtkUnsignedCharArray *frameData)
 Pointer to the contents of the frame in a compressed codec format. More...
 
virtual void SetFrameType (int)
 Reflects the type of the frame (I-Frame, P-Frame, B-Frame) More...
 
virtual void SetNumberOfComponents (int)
 Number of components for the decoded image. More...
 
void SetPreviousFrame (vtkStreamingVolumeFrame *previousFrame)
 
virtual void SetVTKScalarType (int)
 VTK scalar type of the decoded image. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkStreamingVolumeFrameNew ()
 
static vtkStreamingVolumeFrameSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkStreamingVolumeFrame ()
 
 ~vtkStreamingVolumeFrame () override
 

Protected Attributes

std::string CodecFourCC
 
int Dimensions [3]
 
vtkSmartPointer< vtkUnsignedCharArray > FrameData
 
int FrameType
 
int NumberOfComponents
 
vtkSmartPointer< vtkStreamingVolumeFramePreviousFrame
 
int VTKScalarType
 

Detailed Description

VTK object containing a single compressed frame.

Definition at line 32 of file vtkStreamingVolumeFrame.h.

Member Typedef Documentation

◆ Superclass

Definition at line 37 of file vtkStreamingVolumeFrame.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enum for frame type For more information on frame types see: https://en.wikipedia.org/wiki/Video_compression_picture_types

Enumerator
IFrame 

Uninterpolated keyframe.

PFrame 

Frame interpolated from previous frames.

BFrame 

Frame interpolated from previous and forward frames.

Definition at line 42 of file vtkStreamingVolumeFrame.h.

Constructor & Destructor Documentation

◆ vtkStreamingVolumeFrame()

vtkStreamingVolumeFrame::vtkStreamingVolumeFrame ( )
protected

◆ ~vtkStreamingVolumeFrame()

vtkStreamingVolumeFrame::~vtkStreamingVolumeFrame ( )
overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkStreamingVolumeFrame::GetClassName ( )
virtual

◆ GetCodecFourCC()

virtual std::string vtkStreamingVolumeFrame::GetCodecFourCC ( )
virtual

◆ GetDimensions() [1/3]

virtual void vtkStreamingVolumeFrame::GetDimensions ( int  [3])
virtual

◆ GetDimensions() [2/3]

virtual void vtkStreamingVolumeFrame::GetDimensions ( int &  ,
int &  ,
int &   
)
virtual

◆ GetDimensions() [3/3]

virtual int* vtkStreamingVolumeFrame::GetDimensions ( )
virtual

◆ GetFrameData()

vtkUnsignedCharArray* vtkStreamingVolumeFrame::GetFrameData ( )
inline

Definition at line 55 of file vtkStreamingVolumeFrame.h.

◆ GetFrameType()

virtual int vtkStreamingVolumeFrame::GetFrameType ( )
virtual

◆ GetNumberOfComponents()

virtual int vtkStreamingVolumeFrame::GetNumberOfComponents ( )
virtual

◆ GetPreviousFrame()

vtkStreamingVolumeFrame* vtkStreamingVolumeFrame::GetPreviousFrame ( )
inline

Definition at line 63 of file vtkStreamingVolumeFrame.h.

◆ GetVTKScalarType()

virtual int vtkStreamingVolumeFrame::GetVTKScalarType ( )
virtual

◆ IsA()

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

◆ IsKeyFrame()

bool vtkStreamingVolumeFrame::IsKeyFrame ( )
inline

Returns true if the frame is a "Keyframe", aka "I-Frame".

Definition at line 82 of file vtkStreamingVolumeFrame.h.

◆ IsTypeOf()

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

◆ New()

static vtkStreamingVolumeFrame* vtkStreamingVolumeFrame::New ( )
static

◆ PrintSelf()

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

◆ SafeDownCast()

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

◆ SetCodecFourCC()

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

FourCC of the codec for the frame.

◆ SetDimensions() [1/2]

virtual void vtkStreamingVolumeFrame::SetDimensions ( int  [3])
virtual

◆ SetDimensions() [2/2]

virtual void vtkStreamingVolumeFrame::SetDimensions ( int  ,
int  ,
int   
)
virtual

Dimensions of the decoded frame.

◆ SetFrameData()

void vtkStreamingVolumeFrame::SetFrameData ( vtkUnsignedCharArray *  frameData)

Pointer to the contents of the frame in a compressed codec format.

◆ SetFrameType()

virtual void vtkStreamingVolumeFrame::SetFrameType ( int  )
virtual

Reflects the type of the frame (I-Frame, P-Frame, B-Frame)

◆ SetNumberOfComponents()

virtual void vtkStreamingVolumeFrame::SetNumberOfComponents ( int  )
virtual

Number of components for the decoded image.

◆ SetPreviousFrame()

void vtkStreamingVolumeFrame::SetPreviousFrame ( vtkStreamingVolumeFrame previousFrame)

Pointer to the last frame that must be decoded before this one The pointer of each frame to the previous frame forms a linked list back to the originating keyframe this ensures that each frame provides access the information neccesary to be able to decode it. PreviousFrame does not refer to the frame that should be displayed before the this frame, but the frame that should be decoded immediately before this frame

◆ SetVTKScalarType()

virtual void vtkStreamingVolumeFrame::SetVTKScalarType ( int  )
virtual

VTK scalar type of the decoded image.

Member Data Documentation

◆ CodecFourCC

std::string vtkStreamingVolumeFrame::CodecFourCC
protected

Definition at line 86 of file vtkStreamingVolumeFrame.h.

◆ Dimensions

int vtkStreamingVolumeFrame::Dimensions[3]
protected

Definition at line 82 of file vtkStreamingVolumeFrame.h.

◆ FrameData

vtkSmartPointer<vtkUnsignedCharArray> vtkStreamingVolumeFrame::FrameData
protected

Definition at line 87 of file vtkStreamingVolumeFrame.h.

◆ FrameType

int vtkStreamingVolumeFrame::FrameType
protected

Definition at line 88 of file vtkStreamingVolumeFrame.h.

◆ NumberOfComponents

int vtkStreamingVolumeFrame::NumberOfComponents
protected

Definition at line 89 of file vtkStreamingVolumeFrame.h.

◆ PreviousFrame

vtkSmartPointer<vtkStreamingVolumeFrame> vtkStreamingVolumeFrame::PreviousFrame
protected

Definition at line 90 of file vtkStreamingVolumeFrame.h.

◆ VTKScalarType

int vtkStreamingVolumeFrame::VTKScalarType
protected

Definition at line 91 of file vtkStreamingVolumeFrame.h.


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