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
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:
Inheritance graph
[legend]
Collaboration diagram for vtkRawRGBVolumeCodec:
Collaboration graph
[legend]

Public Types

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

Public Member Functions

vtkStreamingVolumeCodecCreateCodecInstance () override
 Creates an instance of the codec. More...
 
virtual const char * GetClassName ()
 
std::string GetFourCC () override
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) 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) 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 vtkRawRGBVolumeCodecNew ()
 
static vtkRawRGBVolumeCodecSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkStreamingVolumeCodec
static int IsTypeOf (const char *type)
 
static vtkStreamingVolumeCodecSafeDownCast (vtkObject *o)
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from vtkStreamingVolumeCodec
std::vector< std::string > AvailiableParameterNames
 
std::string DefaultParameterPresetValue
 
vtkSmartPointer< vtkStreamingVolumeFrameLastDecodedFrame
 
std::vector< ParameterPresetParameterPresets
 
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

Definition at line 33 of file vtkRawRGBVolumeCodec.h.

Constructor & Destructor Documentation

◆ vtkRawRGBVolumeCodec()

vtkRawRGBVolumeCodec::vtkRawRGBVolumeCodec ( )
protected

◆ ~vtkRawRGBVolumeCodec()

vtkRawRGBVolumeCodec::~vtkRawRGBVolumeCodec ( )
overrideprotected

Member Function Documentation

◆ CreateCodecInstance()

vtkStreamingVolumeCodec* vtkRawRGBVolumeCodec::CreateCodecInstance ( )
overridevirtual

Creates an instance of the codec.

Implements vtkStreamingVolumeCodec.

◆ DecodeFrameInternal()

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

Decode the compressed frame to an image.

Implements vtkStreamingVolumeCodec.

◆ EncodeImageDataInternal()

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

Encode the image to a compressed frame.

Implements vtkStreamingVolumeCodec.

◆ GetClassName()

virtual const char* vtkRawRGBVolumeCodec::GetClassName ( )
virtual

Reimplemented from vtkStreamingVolumeCodec.

◆ GetFourCC()

std::string vtkRawRGBVolumeCodec::GetFourCC ( )
inlineoverridevirtual

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()

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

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 
)
override

◆ SafeDownCast()

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

◆ UpdateParameterInternal()

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

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: