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

#include <HDF5DataIO.hh>

Inheritance diagram for DataChannelMetaData:
Collaboration diagram for DataChannelMetaData:

Public Member Functions

 DataChannelMetaData ()
 
 DataChannelMetaData (DataChannelSpecs *specs)
 
 ~DataChannelMetaData ()
 
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...
 
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
 
blitz::TinyVector< double, 3 > color
 
float displayMax
 
float displayMin
 
float gamma
 
bool showExposureProblems
 
bool visible
 

Detailed Description

Definition at line 96 of file HDF5DataIO.hh.

Constructor & Destructor Documentation

◆ DataChannelMetaData() [1/2]

DataChannelMetaData::DataChannelMetaData ( )

◆ DataChannelMetaData() [2/2]

DataChannelMetaData::DataChannelMetaData ( DataChannelSpecs specs)

◆ ~DataChannelMetaData()

DataChannelMetaData::~DataChannelMetaData ( )

Member Function Documentation

◆ load()

void DataChannelMetaData::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 from ChannelMetaData.

◆ save()

int DataChannelMetaData::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 from ChannelMetaData.

Field Documentation

◆ color

blitz::TinyVector<double,3> DataChannelMetaData::color

Definition at line 105 of file HDF5DataIO.hh.

◆ displayMin

float DataChannelMetaData::displayMin

Definition at line 106 of file HDF5DataIO.hh.

◆ displayMax

float DataChannelMetaData::displayMax

Definition at line 106 of file HDF5DataIO.hh.

◆ gamma

float DataChannelMetaData::gamma

Definition at line 107 of file HDF5DataIO.hh.

◆ showExposureProblems

bool DataChannelMetaData::showExposureProblems

Definition at line 108 of file HDF5DataIO.hh.

◆ channelName

std::string ChannelMetaData::channelName
inherited

Definition at line 88 of file HDF5DataIO.hh.

◆ channelType

std::string ChannelMetaData::channelType
inherited

Definition at line 89 of file HDF5DataIO.hh.

◆ alpha

float ChannelMetaData::alpha
inherited

Definition at line 90 of file HDF5DataIO.hh.

◆ visible

bool ChannelMetaData::visible
inherited

Definition at line 91 of file HDF5DataIO.hh.


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