enb.plugins.plugin_fpack package

Submodules

enb.plugins.plugin_fpack.fpack_codec module

Codec wrapper for the Fpack lossless and lossy image coder

class enb.plugins.plugin_fpack.fpack_codec.FPACK_Abstract(compressor_path, decompressor_path, param_dict=None, output_invocation_dir=None, signature_in_name=False)

Bases: LosslessCodec, FITSWrapperCodec

assert_valid_data_type(original_file_info)

class enb.plugins.plugin_fpack.fpack_codec.FPACK_GZIP(bin_dir=None)

Bases: FPACK_Abstract

fpack wrapper with gzip compression.

__init__(bin_dir=None)

Parameters:

• compressor_path – path to the executable to be used for compression

• decompressor_path – path to the executable to be used for decompression

• param_dict – name-value mapping of the parameters to be used for compression

• output_invocation_dir – if not None, invocation strings are stored in this directory with name based on the codec and the image’s full path.

Pram signature_in_name:

if True, the default codec name includes part of the hexdigest of the compressor and decompressor binaries being used

get_compression_params(original_path, compressed_path, original_file_info)

Return a string (shell style) with the parameters to be passed to the compressor.

Same parameter semantics as AbstractCodec.compress().

Parameters:

original_file_info – a dict-like object describing original_path’s properties (e.g., geometry), or None

get_decompression_params(compressed_path, reconstructed_path, original_file_info)

Return a string (shell style) with the parameters to be passed to the decompressor. Same parameter semantics as AbstractCodec.decompress().

Parameters:

original_file_info – a dict-like object describing original_path’s properties (e.g., geometry), or None

property label

Label to be displayed for the codec. May not be strictly unique nor fully informative. By default, self’s class name is returned.

property name

Don’t include the binary signature

class enb.plugins.plugin_fpack.fpack_codec.FPACK_HCOMPRESS(bin_dir=None)

Bases: FPACK_Abstract

fpack wrapper with hcompress compression.

__init__(bin_dir=None)

Parameters:

• compressor_path – path to the executable to be used for compression

• decompressor_path – path to the executable to be used for decompression

• param_dict – name-value mapping of the parameters to be used for compression

• output_invocation_dir – if not None, invocation strings are stored in this directory with name based on the codec and the image’s full path.

Pram signature_in_name:

if True, the default codec name includes part of the hexdigest of the compressor and decompressor binaries being used

get_compression_params(original_path, compressed_path, original_file_info)

Return a string (shell style) with the parameters to be passed to the compressor.

Same parameter semantics as AbstractCodec.compress().

Parameters:

original_file_info – a dict-like object describing original_path’s properties (e.g., geometry), or None

get_decompression_params(compressed_path, reconstructed_path, original_file_info)

Return a string (shell style) with the parameters to be passed to the decompressor. Same parameter semantics as AbstractCodec.decompress().

Parameters:

original_file_info – a dict-like object describing original_path’s properties (e.g., geometry), or None

property label

Label to be displayed for the codec. May not be strictly unique nor fully informative. By default, self’s class name is returned.

property name

Don’t include the binary signature

class enb.plugins.plugin_fpack.fpack_codec.FPACK_RICE(bin_dir=None)

Bases: FPACK_Abstract

fpack wrapper with Rice compression.

__init__(bin_dir=None)

Parameters:

• compressor_path – path to the executable to be used for compression

• decompressor_path – path to the executable to be used for decompression

• param_dict – name-value mapping of the parameters to be used for compression

• output_invocation_dir – if not None, invocation strings are stored in this directory with name based on the codec and the image’s full path.

Pram signature_in_name:

if True, the default codec name includes part of the hexdigest of the compressor and decompressor binaries being used

get_compression_params(original_path, compressed_path, original_file_info)

Return a string (shell style) with the parameters to be passed to the compressor.

Same parameter semantics as AbstractCodec.compress().

Parameters:

original_file_info – a dict-like object describing original_path’s properties (e.g., geometry), or None

get_decompression_params(compressed_path, reconstructed_path, original_file_info)

Return a string (shell style) with the parameters to be passed to the decompressor. Same parameter semantics as AbstractCodec.decompress().

Parameters:

original_file_info – a dict-like object describing original_path’s properties (e.g., geometry), or None

property label

Label to be displayed for the codec. May not be strictly unique nor fully informative. By default, self’s class name is returned.

property name

Don’t include the binary signature

Module contents