VTK  9.3.20240518
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkToImplicitTypeErasureStrategy Class Referencefinal

A strategy for compressing arrays by type when applicable (int -> unsigned char for example) and wrapping them behind a vtkImplicitArray to furnish the same interface. More...

#include <vtkToImplicitTypeErasureStrategy.h>

Inheritance diagram for vtkToImplicitTypeErasureStrategy:
[legend]
Collaboration diagram for vtkToImplicitTypeErasureStrategy:
[legend]

Public Types

typedef vtkToImplicitStrategy Superclass
 
- Public Types inherited from vtkToImplicitStrategy
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkToImplicitTypeErasureStrategyNewInstance () const
 
void PrintSelf (std::ostream &os, vtkIndent indent) override
 
vtkToImplicitStrategy::Optional EstimateReduction (vtkDataArray *) override
 Parent API implementing the strategy.
 
vtkSmartPointer< vtkDataArrayReduce (vtkDataArray *) override
 Parent API implementing the strategy.
 
- Public Member Functions inherited from vtkToImplicitStrategy
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkToImplicitStrategyNewInstance () const
 
void PrintSelf (std::ostream &os, vtkIndent indent) override
 
virtual Optional EstimateReduction (vtkDataArray *)=0
 Estimate the reduction (if possible) that can be obtained on the array using this strategy.
 
virtual vtkSmartPointer< vtkDataArrayReduce (vtkDataArray *)=0
 Return a reduced version of the input array.
 
virtual void ClearCache ()
 Destroy any cached variables present in the object (useful for storing calculation results in-between the estimation and reduction phases).
 
virtual void SetTolerance (double)
 Getter/Setter for tolerance parameter.
 
virtual double GetTolerance ()
 Getter/Setter for tolerance parameter.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkToImplicitTypeErasureStrategyNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkToImplicitTypeErasureStrategySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkToImplicitStrategy
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkToImplicitStrategySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkToImplicitTypeErasureStrategy ()=default
 
 ~vtkToImplicitTypeErasureStrategy () override=default
 
- Protected Member Functions inherited from vtkToImplicitStrategy
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkToImplicitStrategy ()=default
 
 ~vtkToImplicitStrategy () override=default
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Protected Attributes inherited from vtkToImplicitStrategy
double Tolerance = 0.001
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

A strategy for compressing arrays by type when applicable (int -> unsigned char for example) and wrapping them behind a vtkImplicitArray to furnish the same interface.

Arrays are able to be compressed when they are integral and their range (max_val - min_val) is able to be represented in a type that takes less memory than the original type. For example, a vtkIntArray with minimum 342 and maximum 416 has a range of 74 and can therefore be represented by its minimal value and an array of differences stored as chars.

See also
vtkImplicitArray vtkToImplicitArrayFilter vtkToImplicitStrategy
Tests:
vtkToImplicitTypeErasureStrategy (Tests)

Definition at line 28 of file vtkToImplicitTypeErasureStrategy.h.

Member Typedef Documentation

◆ Superclass

Definition at line 33 of file vtkToImplicitTypeErasureStrategy.h.

Constructor & Destructor Documentation

◆ vtkToImplicitTypeErasureStrategy()

vtkToImplicitTypeErasureStrategy::vtkToImplicitTypeErasureStrategy ( )
protecteddefault

◆ ~vtkToImplicitTypeErasureStrategy()

vtkToImplicitTypeErasureStrategy::~vtkToImplicitTypeErasureStrategy ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkToImplicitTypeErasureStrategy * vtkToImplicitTypeErasureStrategy::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkToImplicitTypeErasureStrategy::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkToImplicitTypeErasureStrategy::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkToImplicitStrategy.

◆ SafeDownCast()

static vtkToImplicitTypeErasureStrategy * vtkToImplicitTypeErasureStrategy::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkToImplicitTypeErasureStrategy::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkToImplicitStrategy.

◆ NewInstance()

vtkToImplicitTypeErasureStrategy * vtkToImplicitTypeErasureStrategy::NewInstance ( ) const

◆ PrintSelf()

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

◆ EstimateReduction()

vtkToImplicitStrategy::Optional vtkToImplicitTypeErasureStrategy::EstimateReduction ( vtkDataArray )
overridevirtual

Parent API implementing the strategy.

Implements vtkToImplicitStrategy.

◆ Reduce()

vtkSmartPointer< vtkDataArray > vtkToImplicitTypeErasureStrategy::Reduce ( vtkDataArray )
overridevirtual

Parent API implementing the strategy.

Implements vtkToImplicitStrategy.


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