Welcome to ltcodecs’s documentation!

There are aliases for each codec that can be used in codec yaml files. Note that there are multiple aliases for some codec classes.

Alias	Codec Class
integer	VarintCodec
fixedint	FixedIntCodec
varint	VarintCodec
float	FloatCodec
linspace_float	LinspaceFloatCodec
linspace	LinspaceFloatCodec
uint8	UInt8Codec
uint16	UInt16Codec
uint32	UInt32Codec
uint64	UInt64Codec
int8	Int8Codec
int16	Int16Codec
int32	Int32Codec
int64	Int64Codec
egint	ExponentialGolombIntegerCodec
float32	IeeeFloat32Codec
float64	IeeeFloat64Codec
bool	BoolCodec
string	AsciiStringCodec
ascii	AsciiStringCodec
bytes	BytesCodec
msg	RosMsgFieldCodec
ros_msg	RosMsgFieldCodec
variable_len_array	VariableLenArrayCodec
fixed_len_array	FixedLenArrayCodec
ccl_latlon	CclLatLonCodec,
ccl_latlon_bcd	CclLatLonBcdCodec
pad	PaddingCodec
padding	PaddingCodec
time	RosTimeCodec
rostime	RosTimeCodec
string_enum	StringEnumCodec
lzma	LzmaCodec
optional	OptionalFieldCodec

Contents:

• ltcodecs
  • ltcodecs.bool_codec module
  • ltcodecs.bytes_codec module
    • ltcodecs.bytes_codec
    • BytesCodec
      • BytesCodec.decode()
      • BytesCodec.encode()
      • BytesCodec.max_length_bits
      • BytesCodec.min_length_bits
  • ltcodecs.ccl_latlon_bcd_codec module
  • ltcodecs.ccl_latlon_codec module
  • ltcodecs.exceptions module
    • ltcodecs.exceptions
    • EncodingFailed
  • ltcodecs.exponentialgolomb_integer_codec module
    • ltcodecs.exponentialgolomb_integer_codec
    • ExponentialGolombIntegerCodec
      • ExponentialGolombIntegerCodec.decode()
      • ExponentialGolombIntegerCodec.encode()
      • ExponentialGolombIntegerCodec.max_length_bits
      • ExponentialGolombIntegerCodec.min_length_bits
  • ltcodecs.field_codec module
    • FieldCodec
      • FieldCodec.decode()
      • FieldCodec.encode()
      • FieldCodec.max_length_bits
      • FieldCodec.min_length_bits
  • ltcodecs.fixed_len_array_codec module
    • ltcodecs.fixed_len_array_codec
    • FixedLenArrayCodec
      • FixedLenArrayCodec.decode()
      • FixedLenArrayCodec.encode()
      • FixedLenArrayCodec.max_length_bits
      • FixedLenArrayCodec.min_length_bits
  • ltcodecs.fixedint_codec module
    • ltcodecs.fixedint_codec
    • FixedIntCodec
    • Int16Codec
    • Int32Codec
    • Int64Codec
    • Int8Codec
    • UInt16Codec
    • UInt32Codec
    • UInt64Codec
    • UInt8Codec
  • ltcodecs.float_codec module
    • ltcodecs.float_codec
    • FloatCodec
      • FloatCodec.decode()
      • FloatCodec.encode()
      • FloatCodec.max_length_bits
      • FloatCodec.min_length_bits
  • ltcodecs.ieee_float_codec module
    • ltcodecs.ieee_float_codec
    • IeeeFloat32Codec
    • IeeeFloat64Codec
    • IeeeFloatCodec
      • IeeeFloatCodec.decode()
      • IeeeFloatCodec.encode()
      • IeeeFloatCodec.max_length_bits
      • IeeeFloatCodec.min_length_bits
  • ltcodecs.linspace_float_codec module
    • ltcodecs.linspace_float_codec
    • LinspaceFloatCodec
      • LinspaceFloatCodec.decode()
      • LinspaceFloatCodec.encode()
      • LinspaceFloatCodec.max_length_bits
      • LinspaceFloatCodec.min_length_bits
  • ltcodecs.lzma_codec module
  • ltcodecs.optional_field_codec module
  • ltcodecs.padding_codec module
  • ltcodecs.ros_message_codec module
  • ltcodecs.ros_msg_field_codec module
  • ltcodecs.rostime_codec module
  • ltcodecs.string_codecs module
    • ltcodecs.string_codecs
    • AsciiStringCodec
      • AsciiStringCodec.decode()
      • AsciiStringCodec.encode()
      • AsciiStringCodec.max_length_bits
      • AsciiStringCodec.min_length_bits
    • from_sixbit_ascii()
    • to_sixbit_ascii()
  • ltcodecs.string_enum_codec module
    • ltcodecs.string_enum_codec
    • StringEnumCodec
      • StringEnumCodec.decode()
      • StringEnumCodec.encode()
      • StringEnumCodec.max_length_bits
      • StringEnumCodec.min_length_bits
  • ltcodecs.variable_len_array_codec module
    • variable_len_array_codec.py
    • VariableLenArrayCodec
      • VariableLenArrayCodec.decode()
      • VariableLenArrayCodec.encode()
      • VariableLenArrayCodec.max_length_bits
      • VariableLenArrayCodec.min_length_bits
  • ltcodecs.varint_codec module
    • ltcodecs.varint_codec
    • VarintCodec
      • VarintCodec.decode()
      • VarintCodec.encode()
      • VarintCodec.max_length_bits
      • VarintCodec.min_length_bits
• ltcodec tests
  • Submodules
  • tests.test_codecs module
  • Module contents