.. java:import:: java.io File

.. java:import:: java.io IOException

.. java:import:: java.io FileWriter

.. java:import:: java.io PrintWriter

.. java:import:: java.util ArrayList

FrameLogger
===========

.. java:package:: ch.epfl.leb.sass.loggers
   :noindex:

.. java:type:: public class FrameLogger extends AbstractLogger

   Reports the positions of all fluorophores visible in each frame in a file The FrameLogger is a singleton.

   :author: Baptiste Ottino

Methods
-------
getBrightness
^^^^^^^^^^^^^

.. java:method:: public ArrayList<Double> getBrightness()
   :outertype: FrameLogger

getFrame
^^^^^^^^

.. java:method:: public ArrayList<Integer> getFrame()
   :outertype: FrameLogger

getFrameInfo
^^^^^^^^^^^^

.. java:method:: public ArrayList<FrameInfo> getFrameInfo()
   :outertype: FrameLogger

   Returns all the logged arrays in a single data structure. This method is provided for convenience when all frame information is required.

   :return: A FramInfo data structure containing all the logged data.

getId
^^^^^

.. java:method:: public ArrayList<Integer> getId()
   :outertype: FrameLogger

getInstance
^^^^^^^^^^^

.. java:method:: public static FrameLogger getInstance()
   :outertype: FrameLogger

   :return: An instance of the singleton.

getLogCurrentFrameOnly
^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: public boolean getLogCurrentFrameOnly()
   :outertype: FrameLogger

   Indicates whether only the current frame or all frames are logged.

   :return: If return value is true, only information about the current frame is returned.

getTimeOn
^^^^^^^^^

.. java:method:: public ArrayList<Double> getTimeOn()
   :outertype: FrameLogger

getX
^^^^

.. java:method:: public ArrayList<Double> getX()
   :outertype: FrameLogger

getY
^^^^

.. java:method:: public ArrayList<Double> getY()
   :outertype: FrameLogger

getZ
^^^^

.. java:method:: public ArrayList<Double> getZ()
   :outertype: FrameLogger

logFrame
^^^^^^^^

.. java:method:: public void logFrame(int frame, int id, double x, double y, double z, double brightness, double timeOn)
   :outertype: FrameLogger

   Logs emitter information for each full frame. Correct operation of this method when logCurrentFrameOnly is true assumes that values for the frame argument either are the same as previous calls to this method or monotonically increasing.

   :param frame: The current frame
   :param id: The emitter's unique ID.
   :param x: x-position of the emitter
   :param y: y-position of the emitter
   :param z: z-position of the emitter
   :param brightness: the apparent brightness of the fluorophore on the frame in number of photons
   :param timeOn: the amount of time the emitter "id" stays on in the current frame

reset
^^^^^

.. java:method:: @Override public void reset()
   :outertype: FrameLogger

   Resets the logger to its initial state.

saveLogFile
^^^^^^^^^^^

.. java:method:: @Override public void saveLogFile() throws IOException
   :outertype: FrameLogger

   Saves the state of the logger to a file.

   :throws IOException:

setLogCurrentFrameOnly
^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: public void setLogCurrentFrameOnly(boolean logCurrentFrame)
   :outertype: FrameLogger

   Toggles whether only the current frame or all frames should be logged. Setting this to true will erase any information already held by the FrameLogger.

   :param logCurrentFrame: If true, only information on the current frame is retained.