:py:mod:`smsh5_file_reader`
===========================

.. py:module:: smsh5_file_reader


Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   smsh5_file_reader.num_parts
   smsh5_file_reader.file_version
   smsh5_file_reader.particle
   smsh5_file_reader.date
   smsh5_file_reader.description
   smsh5_file_reader.has_power_measurement
   smsh5_file_reader.power_measurement
   smsh5_file_reader.has_intensity
   smsh5_file_reader.raster_scan_coord
   smsh5_file_reader.user
   smsh5_file_reader.abstimes
   smsh5_file_reader.abstimes2
   smsh5_file_reader.microtimes
   smsh5_file_reader.microtimes2
   smsh5_file_reader.tcspc_card
   smsh5_file_reader.has_raster_scan
   smsh5_file_reader.raster_scan
   smsh5_file_reader.has_spectra
   smsh5_file_reader.spectra
   smsh5_file_reader.int_trace
   smsh5_file_reader.__get_rs_dataset
   smsh5_file_reader.rs_integration_time
   smsh5_file_reader.rs_pixels_per_line
   smsh5_file_reader.rs_range
   smsh5_file_reader.rs_x_start
   smsh5_file_reader.rs_y_start
   smsh5_file_reader.spectra_exposure_time
   smsh5_file_reader.spectra_abstimes
   smsh5_file_reader.spectra_wavelengths



.. py:function:: num_parts(dataset: smsh5.H5dataset) -> numpy.int32


.. py:function:: file_version(dataset: smsh5.H5dataset) -> str


.. py:function:: particle(particle_num: int, dataset: smsh5.H5dataset) -> h5pickle.Dataset


.. py:function:: date(particle: smsh5.Particle) -> str


.. py:function:: description(particle: smsh5.Particle) -> str


.. py:function:: has_power_measurement(particle: smsh5.Particle) -> bool


.. py:function:: power_measurement(particle: smsh5.Particle) -> numpy.ndarray


.. py:function:: has_intensity(particle: smsh5.Particle) -> bool


.. py:function:: raster_scan_coord(particle: smsh5.Particle) -> numpy.ndarray


.. py:function:: user(particle: smsh5.Particle) -> str


.. py:function:: abstimes(particle: smsh5.Particle) -> h5pickle.Dataset


.. py:function:: abstimes2(particle: smsh5.Particle) -> h5pickle.Dataset


.. py:function:: microtimes(particle: smsh5.Particle) -> h5pickle.Dataset


.. py:function:: microtimes2(particle: smsh5.Particle) -> h5pickle.Dataset


.. py:function:: tcspc_card(particle: smsh5.Particle) -> str


.. py:function:: has_raster_scan(particle: Union[smsh5.Particle, h5pickle.Dataset]) -> bool


.. py:function:: raster_scan(particle: Union[smsh5.Particle, h5pickle.Dataset]) -> h5pickle.Dataset


.. py:function:: has_spectra(particle: smsh5.Particle) -> bool


.. py:function:: spectra(particle: smsh5.Particle) -> h5pickle.Dataset


.. py:function:: int_trace(particle: smsh5.Particle) -> h5pickle.Dataset


.. py:function:: __get_rs_dataset(part_or_rs: Union[smsh5.Particle, smsh5.RasterScan]) -> h5pickle.Dataset


.. py:function:: rs_integration_time(part_or_rs: Union[smsh5.Particle, smsh5.RasterScan]) -> numpy.float64


.. py:function:: rs_pixels_per_line(part_or_rs: Union[smsh5.Particle, smsh5.RasterScan]) -> numpy.int32


.. py:function:: rs_range(part_or_rs: Union[smsh5.Particle, smsh5.RasterScan]) -> numpy.float64


.. py:function:: rs_x_start(part_or_rs: Union[smsh5.Particle, smsh5.RasterScan]) -> numpy.float64


.. py:function:: rs_y_start(part_or_rs: Union[smsh5.Particle, smsh5.RasterScan]) -> numpy.float64


.. py:function:: spectra_exposure_time(particle: smsh5.Particle) -> numpy.float32


.. py:function:: spectra_abstimes(particle: smsh5.Particle) -> numpy.ndarray


.. py:function:: spectra_wavelengths(particle: smsh5.Particle) -> numpy.ndarray