actsnclass.build_canonical

actsnclass.build_canonical(user_choices)

Build canonical sample for SNPCC data set fitted with Bazin features.

Parameters:

• -c (bool) – If True, compute metadata on SNR and peak mag.
• -d (str (optional)) – Path to raw data directory. Needed only if “compute == False”.
• -f (str) – Path to features file.
• -i (str (optional)) – Path to read metadata on SNR and peak mag from file. It is only used if “compute == False”.
• -m (str (optional)) – Path to output file where to store metadata on SNR and peak mag. Only used if “save == True”.
• -o (str) – Path to store full canonical sample.
• -p (str (optional)) – File to store comparison plot. If not provided plot is shown on screen.
• -s (bool) – If True, save to file metadata on SNR and peakmag.

Examples

Use directly from the command line:

>>> build_canonical.py -c <if True compute metadata>
>>>       -d <path to raw data dir>
>>>       -f <input features file> -m <output file for metadata>
>>>       -o <output file for canonical sample> -p <comparison plot file>
>>>       -s <if True save metadata to file>