iRoCS Toolbox  1.1.0
Public Member Functions | Data Fields
ChannelMetaData Struct Reference

#include <HDF5DataIO.hh>

Inheritance diagram for ChannelMetaData:
Collaboration diagram for ChannelMetaData:

Public Member Functions

 ChannelMetaData ()
 
 ChannelMetaData (ChannelSpecs *specs)
 
virtual ~ChannelMetaData ()
 
virtual void load (const std::string &h5FileName, int index)
 Load the general metadata of channel with index <index> out of the .labelling_qt4 group of the hdf5 file specified by filename. More...
 
virtual int save (const std::string &h5FileName)
 Save the general metadata stored in this struct into the .labelling_qt4 group of the hdf5 file specified by filename. More...
 

Data Fields

float alpha
 
std::string channelName
 
std::string channelType
 
bool visible
 

Detailed Description

Definition at line 51 of file HDF5DataIO.hh.

Constructor & Destructor Documentation

◆ ChannelMetaData() [1/2]

ChannelMetaData::ChannelMetaData ( )

◆ ChannelMetaData() [2/2]

ChannelMetaData::ChannelMetaData ( ChannelSpecs specs)

◆ ~ChannelMetaData()

virtual ChannelMetaData::~ChannelMetaData ( )
virtual

Member Function Documentation

◆ load()

virtual void ChannelMetaData::load ( const std::string &  h5FileName,
int  index 
)
virtual

Load the general metadata of channel with index <index> out of the .labelling_qt4 group of the hdf5 file specified by filename.

Parameters
h5FileNameThe name of the hdf5 file to read the metadata from
indexThe channel index
Exceptions
BlitzH5Errorwhen something goes wrong

Reimplemented in IRoCSSCTChannelMetaData, IRoCSChannelMetaData, SplineCurveChannelMetaData, VisualizationChannelMetaData, AnnotationChannelMetaData, RGBChannelMetaData, and DataChannelMetaData.

◆ save()

virtual int ChannelMetaData::save ( const std::string &  h5FileName)
virtual

Save the general metadata stored in this struct into the .labelling_qt4 group of the hdf5 file specified by filename.

If a .labelling_qt4 group exists an entry with corresponding channelName is searched and updated if found. If not a new set of attributes is created, and the nChannels attribute is incremented.

Parameters
h5FileNameThe name of the hdf5 file to write the metadata to
Exceptions
BlitzH5Errorwhen something goes wrong
Returns
The index of the channel within the structure

Reimplemented in IRoCSSCTChannelMetaData, IRoCSChannelMetaData, SplineCurveChannelMetaData, VisualizationChannelMetaData, AnnotationChannelMetaData, RGBChannelMetaData, and DataChannelMetaData.

Field Documentation

◆ channelName

std::string ChannelMetaData::channelName

Definition at line 88 of file HDF5DataIO.hh.

◆ channelType

std::string ChannelMetaData::channelType

Definition at line 89 of file HDF5DataIO.hh.

◆ alpha

float ChannelMetaData::alpha

Definition at line 90 of file HDF5DataIO.hh.

◆ visible

bool ChannelMetaData::visible

Definition at line 91 of file HDF5DataIO.hh.


The documentation for this struct was generated from the following file: