vtkRawRGBVolumeCodec Class Reference

Codec for storing imagedata in an 24-bit RGB format (8-bit color depth, no compression) More...

#include <Libs/vtkAddon/vtkRawRGBVolumeCodec.h>

Inheritance diagram for vtkRawRGBVolumeCodec:

Collaboration diagram for vtkRawRGBVolumeCodec:

Public Types
typedef vtkStreamingVolumeCodec	Superclass
Public Types inherited from vtkStreamingVolumeCodec
enum	{ ParameterModifiedEvent = 18003 }
typedef vtkObject	Superclass

Public Member Functions
virtual vtkStreamingVolumeCodec *	CreateCodecInstance () VTK_OVERRIDE
	Creates an instance of the codec. More...
virtual const char *	GetClassName ()
virtual std::string	GetFourCC () VTK_OVERRIDE
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
Public Member Functions inherited from vtkStreamingVolumeCodec
virtual bool	DecodeFrame (vtkStreamingVolumeFrame *frame, vtkImageData *outputImageData)
virtual bool	EncodeImageData (vtkImageData *inputImageData, vtkStreamingVolumeFrame *outputStreamingFrame, bool forceKeyFrame=false)
virtual std::string	GetDefaultParameterPresetValue ()
int	GetNumberOfParameterPresets () const
	Get the number of parameter presets. More...
virtual bool	GetParameter (std::string parameterName, std::string &parameterValue)
virtual std::string	GetParameterDescription (std::string parameterName)=0
std::string	GetParameterPresetName (const std::string &presetValue) const
std::vector< std::string >	GetParameterPresetNames () const
	Returns a list of the human readable names of the supported parameter presets. More...
std::string	GetParameterPresetValue (const std::string &presetName) const
virtual std::string	GetParametersAsString ()
void	PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
virtual bool	SetParameter (std::string parameterName, std::string parameterValue)
virtual void	SetParameters (std::map< std::string, std::string > parameters)
virtual bool	SetParametersFromPresetValue (const std::string &presetValue)
virtual void	SetParametersFromString (std::string parameterString)
	vtkGetStdVectorMacro (AvailiableParameterNames, std::vector< std::string >)
	Returns a list of availiable parameter names for the codec. More...
	vtkGetStdVectorMacro (ParameterPresets, const std::vector< ParameterPreset >)

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkRawRGBVolumeCodec *	New ()
static vtkRawRGBVolumeCodec *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkStreamingVolumeCodec
static int	IsTypeOf (const char *type)
static vtkStreamingVolumeCodec *	SafeDownCast (vtkObject *o)

Protected Member Functions
virtual bool	DecodeFrameInternal (vtkStreamingVolumeFrame *inputFrame, vtkImageData *outputImageData, bool saveDecodedImage=true) VTK_OVERRIDE
	Decode the compressed frame to an image. More...
virtual bool	EncodeImageDataInternal (vtkImageData *outputImageData, vtkStreamingVolumeFrame *inputFrame, bool forceKeyFrame) VTK_OVERRIDE
	Encode the image to a compressed frame. More...
virtual std::string	GetParameterDescription (std::string vtkNotUsed(parameterName))
virtual bool	UpdateParameterInternal (std::string vtkNotUsed(parameterValue), std::string vtkNotUsed(parameterName)) VTK_OVERRIDE
	vtkRawRGBVolumeCodec ()
	~vtkRawRGBVolumeCodec ()
Protected Member Functions inherited from vtkStreamingVolumeCodec
virtual bool	UpdateParameterInternal (std::string parameterName, std::string parameterValue)=0
	vtkStreamingVolumeCodec ()
	~vtkStreamingVolumeCodec ()

Additional Inherited Members
Protected Attributes inherited from vtkStreamingVolumeCodec
std::vector< std::string >	AvailiableParameterNames
std::string	DefaultParameterPresetValue
vtkSmartPointer< vtkStreamingVolumeFrame >	LastDecodedFrame
std::vector< ParameterPreset >	ParameterPresets
std::map< std::string, std::string >	Parameters

Detailed Description

Codec for storing imagedata in an 24-bit RGB format (8-bit color depth, no compression)

Definition at line 28 of file vtkRawRGBVolumeCodec.h.

Member Typedef Documentation

Superclass

typedef vtkStreamingVolumeCodec vtkRawRGBVolumeCodec::Superclass

Definition at line 33 of file vtkRawRGBVolumeCodec.h.

Constructor & Destructor Documentation

vtkRawRGBVolumeCodec()

vtkRawRGBVolumeCodec::vtkRawRGBVolumeCodec ( )

protected

~vtkRawRGBVolumeCodec()

vtkRawRGBVolumeCodec::~vtkRawRGBVolumeCodec ( )

protected

Member Function Documentation

CreateCodecInstance()

virtual vtkStreamingVolumeCodec* vtkRawRGBVolumeCodec::CreateCodecInstance ( )

virtual

Creates an instance of the codec.

Implements vtkStreamingVolumeCodec.

DecodeFrameInternal()

virtual bool vtkRawRGBVolumeCodec::DecodeFrameInternal ( vtkStreamingVolumeFrame *  inputFrame, vtkImageData *  outputImageData, bool  saveDecodedImage = true  )

protectedvirtual

Decode the compressed frame to an image.

Implements vtkStreamingVolumeCodec.

EncodeImageDataInternal()

virtual bool vtkRawRGBVolumeCodec::EncodeImageDataInternal ( vtkImageData *  outputImageData, vtkStreamingVolumeFrame *  inputFrame, bool  forceKeyFrame  )

protectedvirtual

Encode the image to a compressed frame.

Implements vtkStreamingVolumeCodec.

GetClassName()

virtual const char* vtkRawRGBVolumeCodec::GetClassName ( )

virtual

Reimplemented from vtkStreamingVolumeCodec.

GetFourCC()

virtual std::string vtkRawRGBVolumeCodec::GetFourCC ( )

inlinevirtual

Returns the FourCC code representing the codec See https://www.fourcc.org/codecs.php for an incomplete list

Implements vtkStreamingVolumeCodec.

Definition at line 38 of file vtkRawRGBVolumeCodec.h.

GetParameterDescription()

virtual std::string vtkRawRGBVolumeCodec::GetParameterDescription ( std::string   vtkNotUsedparameterName )

inlineprotectedvirtual

Return the codec parameter description There are no parameters to update within this codec

Definition at line 56 of file vtkRawRGBVolumeCodec.h.

IsA()

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

virtual

Reimplemented from vtkStreamingVolumeCodec.

IsTypeOf()

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

static

New()

static vtkRawRGBVolumeCodec* vtkRawRGBVolumeCodec::New ( )

static

PrintSelf()

void vtkRawRGBVolumeCodec::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

SafeDownCast()

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

static

UpdateParameterInternal()

virtual bool vtkRawRGBVolumeCodec::UpdateParameterInternal ( std::string   vtkNotUsedparameterValue, std::string   vtkNotUsedparameterName  )

inlineprotectedvirtual

Update the codec parameters There are no parameters to update within this codec

Definition at line 52 of file vtkRawRGBVolumeCodec.h.

---

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

• Libs/vtkAddon/vtkRawRGBVolumeCodec.h