compression:zfp decompression

Version: 0.0.0

Description

zfp decompression using the information about compression written into the properties of the field(s)

Inputs

This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. Some inputs are required, while others are optional and provide additional configuration. Each parameter is detailed in the sections that follow the table.

dataIn (Pin 0)

• Required: Yes
• Expected type(s): custom_type_fields_container

custom type field container from zfp_compression operator to decompress

Outputs

This table lists the output pins for this operator. Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. Each output is detailed in the sections that follow the table.

dataOut (Pin 0)

• Expected type(s): field, fields_container

the output entity is a field or a fields container; it contains decompressed data

decompress_speed (Pin 1)

• Expected type(s): double

the output entity is a double, containing decompression speed (mb/sec)

Configurations

This operator supports configuration options that modify its behavior.

mutex

• Expected type(s): bool
• Default value: false

If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads.

Scripting

This operator can be accessed through scripting interfaces using these identifiers.

Category: compression

Plugin: core

Scripting name: zfp_decompress

Full name: compression.zfp_decompress

Internal name: zfp_decompress

License: None

Examples

These examples demonstrate how to use this operator in different programming environments. Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output.

#include "dpf_api.h"

ansys::dpf::Operator op("zfp_decompress"); // operator instantiation
op.connect(0, my_dataIn);
ansys::dpf::Field my_dataOut = op.getOutput<ansys::dpf::Field>(0);
double my_decompress_speed = op.getOutput<double>(1);

import ansys.dpf.core as dpf

op = dpf.operators.compression.zfp_decompress() # operator instantiation
op.inputs.dataIn.connect(my_dataIn)
my_dataOut_as_field = op.outputs.dataOut_as_field()
my_decompress_speed = op.outputs.decompress_speed()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.compression.zfp_decompress() # operator instantiation
op.inputs.dataIn.Connect(my_dataIn)
my_dataOut = op.outputs.dataOut.GetData()
my_decompress_speed = op.outputs.decompress_speed.GetData()

Changelog

• Version 0.0.0: Initial release.