UnpackPpdbFlags

class lsst.ap.association.UnpackPpdbFlags(flag_map_file, table_name)

Bases: object

Class for unpacking bits from integer flag fields stored in the Ppdb.

Attributes:

flag_map_file : str

Absolute or relative path to a yaml file specifiying mappings of flags to integer bits.

table_name : str

Name of the Ppdb table the integer bit data are coming from.

Methods Summary

unpack(input_flag_values, flag_name)

Determine individual boolean flags from an input array of unsigned ints.

Methods Documentation

unpack(input_flag_values, flag_name)

Determine individual boolean flags from an input array of unsigned ints.

Parameters:

input_flag_values : array-like of type uint

Input integer flags to unpack.

flag_name : str

Ppdb column name of integer flags to unpack. Names of packed int flags are given by the flag_map_file.

Returns:

output_flags : numpy.ndarray

Numpy named tuple of booleans.