actsnclass.build_snpcc_canonical¶
-
actsnclass.
build_snpcc_canonical
(path_to_raw_data: str, path_to_features: str, output_canonical_file: str, output_info_file='', compute=True, save=True, input_info_file='', features_method='Bazin')¶ Build canonical sample for SNPCC data.
Parameters: - path_to_raw_data (str) – Complete path to raw data directory.
- path_to_features (str) – Complete path to Bazin features files.
- output_canonical_file (str) – Complete path to output canonical sample file.
- output_info_file (str) – Complete path to output metadata file for canonical sample. This includes SNR and simulated peak magnitude for each filter.
- compute (bool (optional)) – If True, compute metadata information on SNR and sim peak mag. If False, read info from file. Default is True.
- save (bool (optional)) – Save simulation metadata information to file. Default is True.
- input_info_file (str (optional)) – Complete path to sim metadata file. This must be provided if save == False.
- features_method (str (optional)) – Method for feature extraction. Only ‘Bazin’ is implemented.
Returns: actsnclass.Canonical – Updated canonical object with the attribute ‘canonical_sample’.
Return type: obj