RTC Toolkit 5.0.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
FitsConverterIf Class Referenceabstract

#include <fitsConverterIf.hpp>

Inheritance diagram for FitsConverterIf:
GenericCamera LisaCamera

Public Member Functions

 FitsConverterIf (const std::string &directory, bool split_files)
 Construct a FITS converter.
 
virtual ~FitsConverterIf ()
 
virtual void WriteData (const PacketData &data)=0
 Write data into the FITS file(s).
 
void SetStoreSampleIds (bool store)
 Enable or disable storage of sample ids as keywords.
 
void SetStoreTimestamps (bool store)
 Enable or disable storage of timestamps as keywords.
 
bool GetStoreSampleIds ()
 Get current setting for storing sample ids as keywords.
 
bool GetStoreTimestamps ()
 Get current setting for storing timestamps as keywords.
 
bool GetSplitFiles ()
 Get the setting for splitting files.
 
const std::string & GetDirectory ()
 Get the path to the output directory.
 

Protected Member Functions

const bool IsOpen ()
 
void Open (const std::string &file)
 
void Close ()
 
void SetFitsHandle (std::unique_ptr< CCfits::FITS > &&handle)
 
CCfits::FITS & GetFitsHandle ()
 

Constructor & Destructor Documentation

◆ FitsConverterIf()

FitsConverterIf::FitsConverterIf ( const std::string & directory,
bool split_files )

Construct a FITS converter.

Parameters
directoryString containing the path to the output directory.
split_filesfalse: save all data in one file, true: split samples into extra files.

◆ ~FitsConverterIf()

FitsConverterIf::~FitsConverterIf ( )
virtual

Member Function Documentation

◆ Close()

void FitsConverterIf::Close ( )
protected

◆ GetDirectory()

const std::string & FitsConverterIf::GetDirectory ( )
inline

Get the path to the output directory.

◆ GetFitsHandle()

CCfits::FITS & FitsConverterIf::GetFitsHandle ( )
protected

◆ GetSplitFiles()

bool FitsConverterIf::GetSplitFiles ( )
inline

Get the setting for splitting files.

◆ GetStoreSampleIds()

bool FitsConverterIf::GetStoreSampleIds ( )
inline

Get current setting for storing sample ids as keywords.

◆ GetStoreTimestamps()

bool FitsConverterIf::GetStoreTimestamps ( )
inline

Get current setting for storing timestamps as keywords.

◆ IsOpen()

const bool FitsConverterIf::IsOpen ( )
inlineprotected

◆ Open()

void FitsConverterIf::Open ( const std::string & file)
protected

◆ SetFitsHandle()

void FitsConverterIf::SetFitsHandle ( std::unique_ptr< CCfits::FITS > && handle)
protected

◆ SetStoreSampleIds()

void FitsConverterIf::SetStoreSampleIds ( bool store)
inline

Enable or disable storage of sample ids as keywords.

Parameters
storeenable or disable sampleid storage.

◆ SetStoreTimestamps()

void FitsConverterIf::SetStoreTimestamps ( bool store)
inline

Enable or disable storage of timestamps as keywords.

Parameters
storeenable or disable timestamp storage.

◆ WriteData()

virtual void FitsConverterIf::WriteData ( const PacketData & data)
pure virtual

Write data into the FITS file(s).

Parameters
dataThe data to store in the fits file.

Implemented in GenericCamera, and LisaCamera.


The documentation for this class was generated from the following files: