nabu.pipeline.helical.utils module

class nabu.pipeline.helical.utils.WriterConfiguratorHelical(output_dir, file_prefix, file_format='hdf5', overwrite=False, start_index=None, logger=None, nx_info=None, write_histogram=False, histogram_entry='entry', writer_options=None, extra_options=None, heights_above_stage_mm=None)[source]

Bases: WriterConfigurator

Create a Writer from a set of parameters.

Parameters:

  • output_dir (str) – Directory where the file(s) will be written.

  • file_prefix (str) – File prefix (without leading path)

  • start_index (int, optional) – Index to start the files numbering (filename_0123.ext). Default is 0. Ignored for HDF5 extension.

  • logger (nabu.resources.logger.Logger, optional) – Logger object

  • nx_info (dict, optional) – Dictionary containing the nexus information.

  • write_histogram (bool, optional) – Whether to also write a histogram of data. If set to True, it will configure an additional “writer”.

  • histogram_entry (str, optional) – Name of the HDF5 entry for the output histogram file, if write_histogram is True. Ignored if the output format is already HDF5 : in this case, nx_info[“entry”] is taken.

  • writer_options (dict, optional) – Other advanced options to pass to Writer class.