WholeDomainOutputStream.h

Go to the documentation of this file.

/**
 * @file      WholeDomainOutputStream.h
 *
 * @author    Jiri Jaros \n
 *            Faculty of Information Technology \n
 *            Brno University of Technology \n
 *            jarosjir@fit.vutbr.cz
 *
 * @brief     The header file of the class saving whole RealMatrix into the output HDF5 file, e.g. p_max_all.
 *
 * @version   kspaceFirstOrder3D 2.16
 *
 * @date      26 August    2017, 16:55 (created) \n
 *            04 September 2017, 11:10 (revised)
 *
 * @copyright Copyright (C) 2017 Jiri Jaros and Bradley Treeby.
 *
 * This file is part of the C++ extension of the [k-Wave Toolbox](http://www.k-wave.org).
 *
 * This file is part of the k-Wave. k-Wave is free software: you can redistribute it and/or modify it under the terms
 * of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * k-Wave is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
 * more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along with k-Wave.
 * If not, see [http://www.gnu.org/licenses/](http://www.gnu.org/licenses/).
 */

#ifndef WHOLE_DOMAIN_OUTPUT_STREAM_H
#define WHOLE_DOMAIN_OUTPUT_STREAM_H

#include <OutputStreams/BaseOutputStream.h>

/**
 * @class  WholeDomainOutputStream
 * @brief  Output stream for quantities sampled in the whole domain.
 *
 * Output stream for quantities sampled in the whole domain. The data is stored in a single dataset
 * (aggregated quantities only).
 */
class WholeDomainOutputStream : public BaseOutputStream
{
  public:
    /// Default constructor not allowed.
    WholeDomainOutputStream() = delete;

    /** @brief Constructor links the HDF5 File, SourceMatrix, and SensorMask together.
      * @param [in] file          - HDF5 file to write the output to
      * @param [in] datasetName   - The name of the HDF5 group. This group contains datasets for particular cuboids
      * @param [in] sourceMatrix  - Source matrix to be sampled
      * @param [in] reductionOp   - Reduction operator
      * @param [in] bufferToReuse - If there is a memory space to be reused, provide a pointer
      */
    WholeDomainOutputStream(Hdf5File&            file,
                            MatrixName&          datasetName,
                            const RealMatrix&    sourceMatrix,
                            const ReduceOperator reductionOp,
                            float*               bufferToReuse=nullptr);

    /// Copy constructor not allowed.
    WholeDomainOutputStream(const WholeDomainOutputStream&) = delete;

    /// Destructor.
    virtual ~WholeDomainOutputStream();

    /// operator= is not allowed.
    WholeDomainOutputStream& operator=(const WholeDomainOutputStream&) = delete;

    /// Create a HDF5 stream and allocate data for it.
    virtual void create();

    /// Reopen the output stream after restart and reload data.
    virtual void reopen();

    /// Sample data into buffer and apply reduction, or flush to disk (no sensor mask here).
    virtual void sample();

    /// Apply post-processing on the buffer and flush it to the file.
    virtual void postProcess();

    ///Checkpoint the stream and close.
    virtual void checkpoint();

    /// Close stream (apply post-processing if necessary, flush data and close).
    virtual void close();

  protected:
    /// Flush the buffer to the file.
    virtual void flushBufferToFile();

    /// Handle to a HDF5 dataset.
    hid_t  mDataset;

    /// Time step to store (N/A for aggregated).
    size_t mSampledTimeStep;
};// end of WholeDomainOutputStream
//----------------------------------------------------------------------------------------------------------------------

#endif  /* WHOLE_DOMAIN_OUTPUT_STREAM_H */