:class:`ICVoutReader`
=====================


.. py:class:: ansys.health.heart.post.dpf_utils.ICVoutReader(fn: str)

   
   Read control volume data from the binout file.
















   ..
       !! processed by numpydoc !!


.. py:currentmodule:: ICVoutReader

Overview
--------

.. tab-set::



   .. tab-item:: Methods

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~get_time`
            - Get time array.
          * - :py:attr:`~get_pressure`
            - Get pressure array.
          * - :py:attr:`~get_volume`
            - Get volume array.
          * - :py:attr:`~get_flowrate`
            - Get flow rate array.








Import detail
-------------

.. code-block:: python

    from ansys.health.heart.post.dpf_utils import ICVoutReader



Method detail
-------------

.. py:method:: get_time() -> numpy.ndarray

   
   Get time array.





   :Returns:

       :obj:`np.ndarray <numpy.ndarray>`
           time array











   ..
       !! processed by numpydoc !!

.. py:method:: get_pressure(icv_id: int) -> numpy.ndarray

   
   Get pressure array.


   :Parameters:

       **icv_id** : :class:`python:int`
           Control volume ID.



   :Returns:

       :obj:`np.ndarray <numpy.ndarray>`
           Pressure array.











   ..
       !! processed by numpydoc !!

.. py:method:: get_volume(icv_id: int) -> numpy.ndarray

   
   Get volume array.


   :Parameters:

       **icv_id** : :class:`python:int`
           Control volume ID.



   :Returns:

       :obj:`np.ndarray <numpy.ndarray>`
           Volume array.











   ..
       !! processed by numpydoc !!

.. py:method:: get_flowrate(icvi_id: int) -> numpy.ndarray

   
   Get flow rate array.


   :Parameters:

       **icvi_id** : :class:`python:int`
           Control volume interaction ID.



   :Returns:

       :obj:`np.ndarray <numpy.ndarray>`
           Flow rate array.











   ..
       !! processed by numpydoc !!