process_holography_dataset.py

#!/usr/bin/env python

import argparse
import logging
from lofar.calibration.common.utils import *
import lofar.calibration.processing as processing
import sys
DEFAULT_SLEEP_TIME = 1

logger = logging.getLogger('mshologextract')


def main():
    cla_parser = specify_command_line_arguments()
    arguments = parse_command_line_arguments_and_set_verbose_logging(cla_parser)

    process_holography_dataset(input_path=arguments.input_path,
                               output_path=arguments.output_path,
                               average_window=arguments.average_samples,
                               time_average_step=arguments.time_average_step)


def parse_command_line_arguments_and_set_verbose_logging(parser):
    """
    Given a parser it parses the command line arguments and return the result of the parsing.

    :param parser: command line parser
    :type parser: argparse.ArgumentParser
    :return: the parsed arguments
    :rtype: argparse.Namespace
    """
    arguments=parser.parse_args()
    if arguments.v:
        logging.basicConfig(level=logging.DEBUG)
    else:
        logging.basicConfig(level=logging.INFO)

    logger.debug('The selected arguments are %s', arguments)


    if arguments.average_samples is not None and arguments.time_average_step is not None:
        logger.error('Please specify either the average window in samples'
                     ' or the time average step in seconds')
        sys.exit(1)

    if arguments.average_samples is None and arguments.time_average_step is None:
        logger.error('Please specify at least one between the average window in samples'
                     ' or the time average step in seconds')
        sys.exit(1)

    return arguments


def specify_command_line_arguments():
    """
    Setup the command argument parser and returns it
    :return: the parser for the command line arguments
    :rtype: argparse.ArgumentParser
    """
    parser = argparse.ArgumentParser(description='This program is meant for convert the Holography'
                                                 ' observation\'s data into an holography dataset')
    parser.add_argument('input_path', help='path to the holography observation data')
    parser.add_argument('output_path', help='path to the holography observation data')
    parser.add_argument('--time_average_step',
                        help='average window for the crosscorrelation in seconds', default=None)
    parser.add_argument('--average_samples',
                        help='number of samples to perform one average step of the'
                             'cross correlations', default=None, type=int)

    parser.add_argument('--num_proc', help='number of processes used to convert the holography'
                                           ' observation', type=int)
    parser.add_argument('-v', help='verbose logging', action='store_true')

    return parser


def process_holography_dataset(input_path, output_path, average_window, time_average_step):
    """

    :param infile_path: path to the input file
    :param outfile_path: path to the output file
    :param average_window: averaging sample step
    :param time_average_step: averaging time window
    :return:
    """
    if average_window is not None:
        logger.info('Averaging %s with a time sample window of %s', input_path, average_window)
        output_hds = processing.average_dataset_by_sample(input_path, average_window)
        logger.info('Averaged %s with a time sample window of %s', input_path, output_path)

        logger.info('Storing processed file %s in %s', input_path, output_path)
        output_hds.store_to_file(output_path)
        logger.info('Stored processed file %s in %s', input_path, output_path)


if __name__ == '__main__':
    logging.basicConfig(format='%(asctime)s %(levelname)s %(message)s', level=logging.DEBUG)
    main()